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
|
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2015-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 (
"fmt"
"net/http"
"github.com/snapcore/snapd/client"
"github.com/snapcore/snapd/jsonutil"
"github.com/snapcore/snapd/overlord/auth"
"github.com/snapcore/snapd/overlord/configstate"
"github.com/snapcore/snapd/overlord/configstate/config"
"github.com/snapcore/snapd/overlord/configstate/configcore"
"github.com/snapcore/snapd/overlord/state"
"github.com/snapcore/snapd/overlord/swfeats"
"github.com/snapcore/snapd/snap"
"github.com/snapcore/snapd/strutil"
)
var (
snapConfCmd = &Command{
Path: "/v2/snaps/{name}/conf",
GET: getSnapConf,
PUT: setSnapConf,
ReadAccess: authenticatedAccess{Polkit: polkitActionManageConfiguration},
WriteAccess: authenticatedAccess{Polkit: polkitActionManageConfiguration},
}
)
var configureSnapChangeKind = swfeats.RegisterChangeKind("configure-snap")
func getSnapConf(c *Command, r *http.Request, user *auth.UserState) Response {
vars := muxVars(r)
snapName := configstate.RemapSnapFromRequest(vars["name"])
keys := strutil.CommaSeparatedList(r.URL.Query().Get("keys"))
s := c.d.overlord.State()
s.Lock()
tr := config.NewTransaction(s)
s.Unlock()
currentConfValues := make(map[string]any)
// Special case - return root document
if len(keys) == 0 {
keys = []string{""}
}
for _, key := range keys {
var value any
if err := tr.Get(snapName, key, &value); err != nil {
if config.IsNoOption(err) {
if key == "" {
// no configuration - return empty document
currentConfValues = make(map[string]any)
break
}
return &apiError{
Status: 400,
Message: err.Error(),
Kind: client.ErrorKindConfigNoSuchOption,
Value: err,
}
} else {
return InternalError("%v", err)
}
}
// Hide experimental features that are no longer required because it was
// either accepted or rejected
if snapName == "core" {
value = pruneExperimentalFlags(key, value)
}
if key == "" {
if len(keys) > 1 {
return BadRequest("keys contains zero-length string")
}
return SyncResponse(value)
}
currentConfValues[key] = value
}
return SyncResponse(currentConfValues)
}
// pruneExperimentalFlags returns a copy of val with unsupported experimental
// features removed from the experimental configuration. This applies to
// generic queries, where the key is either an empty string ("") or "experimental".
// Exact queries (e.g. "core.experimental.old-flag") are not pruned to avoid breaking
// snaps that gate some behaviour behind a flag check.
//
// This helper should only be called for core configurations. Any errors when parsing
// core config are ignored and val is returned without modification.
func pruneExperimentalFlags(key string, val any) any {
if val == nil {
return val
}
if key != "" && key != "experimental" {
// We only care about config that might contain old experimental features
// and exact queries (e.g. core.experimental.old-flag) are not pruned to
// avoid breaking snaps that gate some behaviour behind a flag check.
return val
}
experimentalFlags, ok := val.(map[string]any)
if !ok {
// XXX: This should never happen, skip cleaning
return val
}
if key == "" {
experimentalFlags, ok = experimentalFlags["experimental"].(map[string]any)
if !ok {
// No experimental key, do nothing
return val
}
}
for flag := range experimentalFlags {
if !configcore.IsSupportedExperimentalFlag(flag) {
// Hide the no longer supported experimental flag
delete(experimentalFlags, flag)
}
}
// Changes in experimentalFlags should reflect in values
return val
}
func setSnapConf(c *Command, r *http.Request, user *auth.UserState) Response {
vars := muxVars(r)
snapName := configstate.RemapSnapFromRequest(vars["name"])
var patchValues map[string]any
if err := jsonutil.DecodeWithNumber(r.Body, &patchValues); err != nil {
return BadRequest("cannot decode request body into patch values: %v", err)
}
st := c.d.overlord.State()
st.Lock()
defer st.Unlock()
taskset, err := configstate.ConfigureInstalled(st, snapName, patchValues, 0)
if err != nil {
// TODO: just return snap-not-installed instead ?
if _, ok := err.(*snap.NotInstalledError); ok {
return SnapNotFound(snapName, err)
}
return errToResponse(err, []string{snapName}, InternalError, "%v")
}
summary := fmt.Sprintf("Change configuration of %q snap", snapName)
change := newChange(st, configureSnapChangeKind, summary, []*state.TaskSet{taskset}, []string{snapName})
st.EnsureBefore(0)
return AsyncResponse(nil, change.ID())
}
|