1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2020 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package daemon
import (
"encoding/json"
"errors"
"fmt"
"net/http"
"sort"
"strconv"
"github.com/snapcore/snapd/asserts"
"github.com/snapcore/snapd/asserts/snapasserts"
"github.com/snapcore/snapd/client"
"github.com/snapcore/snapd/overlord/assertstate"
"github.com/snapcore/snapd/overlord/auth"
"github.com/snapcore/snapd/overlord/snapstate"
"github.com/snapcore/snapd/overlord/state"
"github.com/snapcore/snapd/release"
)
var (
validationSetsListCmd = &Command{
Path: "/v2/validation-sets",
GET: listValidationSets,
ReadAccess: authenticatedAccess{},
}
validationSetsCmd = &Command{
Path: "/v2/validation-sets/{account}/{name}",
GET: getValidationSet,
POST: applyValidationSet,
Actions: []string{"forget", "apply"},
ReadAccess: authenticatedAccess{},
WriteAccess: authenticatedAccess{},
}
)
type validationSetResult struct {
AccountID string `json:"account-id"`
Name string `json:"name"`
PinnedAt int `json:"pinned-at,omitempty"`
Mode string `json:"mode,omitempty"`
Sequence int `json:"sequence,omitempty"`
Valid bool `json:"valid"`
// TODO: attributes for Notes column
}
func modeString(mode assertstate.ValidationSetMode) (string, error) {
switch mode {
case assertstate.Monitor:
return "monitor", nil
case assertstate.Enforce:
return "enforce", nil
}
return "", fmt.Errorf("internal error: unhandled mode %d", mode)
}
func validationSetNotFound(accountID, name string, sequence int) Response {
v := map[string]any{
"account-id": accountID,
"name": name,
}
if sequence != 0 {
v["sequence"] = sequence
}
return &apiError{
Status: 404,
Message: "validation set not found",
Kind: client.ErrorKindValidationSetNotFound,
Value: v,
}
}
func listValidationSets(c *Command, r *http.Request, _ *auth.UserState) Response {
st := c.d.overlord.State()
st.Lock()
defer st.Unlock()
validationSets, err := assertstate.ValidationSets(st)
if err != nil {
return InternalError("accessing validation sets failed: %v", err)
}
names := make([]string, 0, len(validationSets))
for k := range validationSets {
names = append(names, k)
}
sort.Strings(names)
snaps, _, err := snapstate.InstalledSnaps(st)
if err != nil {
return InternalError(err.Error())
}
results := make([]validationSetResult, len(names))
for i, vs := range names {
tr := validationSets[vs]
sets, err := validationSetsForTracking(st, tr)
if err != nil {
return InternalError("cannot get assertion for validation set tracking %s/%s/%d: %v", tr.AccountID, tr.Name, tr.Sequence(), err)
}
// do not pass ignore validation map, we don't want to ignore validation and show invalid ones.
validErr := checkInstalledSnaps(sets, snaps, nil)
modeStr, err := modeString(tr.Mode)
if err != nil {
return InternalError(err.Error())
}
results[i] = validationSetResult{
AccountID: tr.AccountID,
Name: tr.Name,
PinnedAt: tr.PinnedAt,
Mode: modeStr,
Sequence: tr.Sequence(),
Valid: validErr == nil,
}
}
return SyncResponse(results)
}
var checkInstalledSnaps = func(vsets *snapasserts.ValidationSets, snaps []*snapasserts.InstalledSnap, ignoreValidation map[string]bool) error {
return vsets.CheckInstalledSnaps(snaps, ignoreValidation)
}
func validationSetResultFromTracking(st *state.State, tr *assertstate.ValidationSetTracking) (*validationSetResult, error) {
modeStr, err := modeString(tr.Mode)
if err != nil {
return nil, err
}
sets, err := validationSetsForTracking(st, tr)
if err != nil {
return nil, err
}
snaps, _, err := snapstate.InstalledSnaps(st)
if err != nil {
return nil, err
}
validErr := checkInstalledSnaps(sets, snaps, nil)
return &validationSetResult{
AccountID: tr.AccountID,
Name: tr.Name,
PinnedAt: tr.PinnedAt,
Mode: modeStr,
Sequence: tr.Sequence(),
Valid: validErr == nil,
}, nil
}
func getValidationSet(c *Command, r *http.Request, user *auth.UserState) Response {
vars := muxVars(r)
accountID := vars["account"]
name := vars["name"]
if !asserts.IsValidAccountID(accountID) {
return BadRequest("invalid account ID %q", accountID)
}
if !asserts.IsValidValidationSetName(name) {
return BadRequest("invalid name %q", name)
}
query := r.URL.Query()
// sequence is optional
sequenceStr := query.Get("sequence")
var sequence int
if sequenceStr != "" {
var err error
sequence, err = strconv.Atoi(sequenceStr)
if err != nil {
return BadRequest("invalid sequence argument")
}
if sequence < 0 {
return BadRequest("invalid sequence argument: %d", sequence)
}
}
st := c.d.overlord.State()
st.Lock()
defer st.Unlock()
var tr assertstate.ValidationSetTracking
err := assertstate.GetValidationSet(st, accountID, name, &tr)
if errors.Is(err, state.ErrNoState) || (err == nil && sequence != 0 && sequence != tr.PinnedAt) {
// not available locally, try to find in the store.
return validateAgainstStore(st, accountID, name, sequence, user)
}
if err != nil {
return InternalError("accessing validation sets failed: %v", err)
}
// evaluate against installed snaps
res, err := validationSetResultFromTracking(st, &tr)
if err != nil {
return InternalError(err.Error())
}
return SyncResponse(*res)
}
type validationSetApplyRequest struct {
Action string `json:"action"`
Mode string `json:"mode"`
Sequence int `json:"sequence,omitempty"`
}
func applyValidationSet(c *Command, r *http.Request, user *auth.UserState) Response {
vars := muxVars(r)
accountID := vars["account"]
name := vars["name"]
if !asserts.IsValidAccountID(accountID) {
return BadRequest("invalid account ID %q", accountID)
}
if !asserts.IsValidValidationSetName(name) {
return BadRequest("invalid name %q", name)
}
var req validationSetApplyRequest
decoder := json.NewDecoder(r.Body)
if err := decoder.Decode(&req); err != nil {
return BadRequest("cannot decode request body into validation set action: %v", err)
}
if decoder.More() {
return BadRequest("extra content found in request body")
}
if req.Sequence < 0 {
return BadRequest("invalid sequence argument: %d", req.Sequence)
}
st := c.d.overlord.State()
st.Lock()
defer st.Unlock()
switch req.Action {
case "forget":
return forgetValidationSet(st, accountID, name, req.Sequence)
case "apply":
return updateValidationSet(st, accountID, name, req.Mode, req.Sequence, user)
default:
return BadRequest("unsupported action %q", req.Action)
}
}
var assertstateMonitorValidationSet = assertstate.MonitorValidationSet
var assertstateFetchAndApplyEnforcedValidationSet = assertstate.FetchAndApplyEnforcedValidationSet
var assertstateTryEnforcedValidationSets = assertstate.TryEnforcedValidationSets
// updateValidationSet handles snap validate --monitor and --enforce accountId/name[=sequence].
func updateValidationSet(st *state.State, accountID, name string, reqMode string, sequence int, user *auth.UserState) Response {
var mode assertstate.ValidationSetMode
switch reqMode {
case "monitor":
mode = assertstate.Monitor
case "enforce":
mode = assertstate.Enforce
default:
return BadRequest("invalid mode %q", reqMode)
}
userID := 0
if user != nil {
userID = user.ID
}
if mode == assertstate.Enforce {
return enforceValidationSet(st, accountID, name, sequence, userID)
}
tr, err := assertstateMonitorValidationSet(st, accountID, name, sequence, userID)
if err != nil {
return BadRequest("cannot monitor validation set %v: %v", assertstate.ValidationSetKey(accountID, name), err)
}
res, err := validationSetResultFromTracking(st, tr)
if err != nil {
return InternalError(err.Error())
}
return SyncResponse(*res)
}
// forgetValidationSet forgets the validation set.
// The state needs to be locked by the caller.
func forgetValidationSet(st *state.State, accountID, name string, sequence int) Response {
// check if it exists first
var tr assertstate.ValidationSetTracking
err := assertstate.GetValidationSet(st, accountID, name, &tr)
if errors.Is(err, state.ErrNoState) || (err == nil && sequence != 0 && sequence != tr.PinnedAt) {
return validationSetNotFound(accountID, name, sequence)
}
if err != nil {
return InternalError("accessing validation sets failed: %v", err)
}
if err := assertstate.ForgetValidationSet(st, accountID, name, assertstate.ForgetValidationSetOpts{}); err != nil {
return BadRequest("cannot forget validation set %v: %v", assertstate.ValidationSetKey(accountID, name), err)
}
return SyncResponse(nil)
}
func validationSetsForTracking(st *state.State, tr *assertstate.ValidationSetTracking) (*snapasserts.ValidationSets, error) {
as, err := validationSetAssertFromDb(st, tr.AccountID, tr.Name, tr.Sequence())
if err != nil {
return nil, err
}
sets := snapasserts.NewValidationSets()
if err := sets.Add(as); err != nil {
return nil, err
}
return sets, nil
}
func validationSetAssertFromDb(st *state.State, accountID, name string, sequence int) (*asserts.ValidationSet, error) {
headers := map[string]string{
"series": release.Series,
"account-id": accountID,
"name": name,
"sequence": fmt.Sprintf("%d", sequence),
}
db := assertstate.DB(st)
as, err := db.Find(asserts.ValidationSetType, headers)
if err != nil {
return nil, err
}
vset := as.(*asserts.ValidationSet)
return vset, nil
}
func validateAgainstStore(st *state.State, accountID, name string, sequence int, user *auth.UserState) Response {
// get from the store
as, err := getSingleSeqFormingAssertion(st, accountID, name, sequence, user)
if _, ok := err.(*asserts.NotFoundError); ok {
// not in the store - try to find in the database
as, err = validationSetAssertFromDb(st, accountID, name, sequence)
if _, ok := err.(*asserts.NotFoundError); ok {
return validationSetNotFound(accountID, name, sequence)
}
}
if err != nil {
return InternalError(err.Error())
}
sets := snapasserts.NewValidationSets()
vset := as.(*asserts.ValidationSet)
if err := sets.Add(vset); err != nil {
return InternalError(err.Error())
}
snaps, _, err := snapstate.InstalledSnaps(st)
if err != nil {
return InternalError(err.Error())
}
validErr := checkInstalledSnaps(sets, snaps, nil)
res := validationSetResult{
AccountID: vset.AccountID(),
Name: vset.Name(),
Sequence: vset.Sequence(),
// TODO: pass actual err details and implement "verbose" mode
// for the client?
Valid: validErr == nil,
}
return SyncResponse(res)
}
func getSingleSeqFormingAssertion(st *state.State, accountID, name string, sequence int, user *auth.UserState) (asserts.Assertion, error) {
sto := snapstate.Store(st, nil)
at := asserts.Type("validation-set")
if at == nil {
panic("validation-set assert type not found")
}
sequenceKey := []string{release.Series, accountID, name}
st.Unlock()
as, err := sto.SeqFormingAssertion(at, sequenceKey, sequence, user)
st.Lock()
if err != nil {
return nil, err
}
return as, nil
}
func enforceValidationSet(st *state.State, accountID, name string, sequence, userID int) Response {
snaps, ignoreValidation, err := snapstate.InstalledSnaps(st)
if err != nil {
return InternalError(err.Error())
}
tr, err := assertstateFetchAndApplyEnforcedValidationSet(st, accountID, name, sequence, userID, snaps, ignoreValidation)
if err != nil {
// XXX: provide more specific error kinds? This would probably require
// assertstate.ValidationSetAssertionForEnforce tuning too.
return BadRequest("cannot enforce validation set: %v", err)
}
res, err := validationSetResultFromTracking(st, tr)
if err != nil {
return InternalError(err.Error())
}
return SyncResponse(*res)
}
|