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
|
package instructions
import (
"strconv"
"strings"
"github.com/docker/go-units"
"github.com/moby/buildkit/util/suggest"
"github.com/pkg/errors"
"github.com/tonistiigi/go-csvvalue"
)
type MountType string
const (
MountTypeBind MountType = "bind"
MountTypeCache MountType = "cache"
MountTypeTmpfs MountType = "tmpfs"
MountTypeSecret MountType = "secret"
MountTypeSSH MountType = "ssh"
)
var allowedMountTypes = map[MountType]struct{}{
MountTypeBind: {},
MountTypeCache: {},
MountTypeTmpfs: {},
MountTypeSecret: {},
MountTypeSSH: {},
}
type ShareMode string
const (
MountSharingShared ShareMode = "shared"
MountSharingPrivate ShareMode = "private"
MountSharingLocked ShareMode = "locked"
)
var allowedSharingModes = map[ShareMode]struct{}{
MountSharingShared: {},
MountSharingPrivate: {},
MountSharingLocked: {},
}
type mountsKeyT string
var mountsKey = mountsKeyT("dockerfile/run/mounts")
func init() {
parseRunPreHooks = append(parseRunPreHooks, runMountPreHook)
parseRunPostHooks = append(parseRunPostHooks, runMountPostHook)
}
func allShareModes() []string {
types := make([]string, 0, len(allowedSharingModes))
for k := range allowedSharingModes {
types = append(types, string(k))
}
return types
}
func allMountTypes() []string {
types := make([]string, 0, len(allowedMountTypes))
for k := range allowedMountTypes {
types = append(types, string(k))
}
return types
}
func runMountPreHook(cmd *RunCommand, req parseRequest) error {
st := &mountState{}
st.flag = req.flags.AddStrings("mount")
cmd.setExternalValue(mountsKey, st)
return nil
}
func runMountPostHook(cmd *RunCommand, req parseRequest) error {
return setMountState(cmd, nil)
}
func setMountState(cmd *RunCommand, expander SingleWordExpander) error {
st := getMountState(cmd)
if st == nil {
return errors.Errorf("no mount state")
}
mounts := make([]*Mount, len(st.flag.StringValues))
for i, str := range st.flag.StringValues {
m, err := parseMount(str, expander)
if err != nil {
return err
}
mounts[i] = m
}
st.mounts = mounts
return nil
}
func getMountState(cmd *RunCommand) *mountState {
v := cmd.getExternalValue(mountsKey)
if v == nil {
return nil
}
return v.(*mountState)
}
func GetMounts(cmd *RunCommand) []*Mount {
return getMountState(cmd).mounts
}
type mountState struct {
flag *Flag
mounts []*Mount
}
type Mount struct {
Type MountType
From string
Source string
Target string
ReadOnly bool
SizeLimit int64
CacheID string
CacheSharing ShareMode
Required bool
Mode *uint64
UID *uint64
GID *uint64
}
func parseMount(val string, expander SingleWordExpander) (*Mount, error) {
fields, err := csvvalue.Fields(val, nil)
if err != nil {
return nil, errors.Wrap(err, "failed to parse csv mounts")
}
m := &Mount{Type: MountTypeBind}
roAuto := true
for _, field := range fields {
key, value, ok := strings.Cut(field, "=")
key = strings.ToLower(key)
if !ok {
if expander == nil {
continue // evaluate later
}
switch key {
case "readonly", "ro":
m.ReadOnly = true
roAuto = false
continue
case "readwrite", "rw":
m.ReadOnly = false
roAuto = false
continue
case "required":
if m.Type == MountTypeSecret || m.Type == MountTypeSSH {
m.Required = true
continue
} else {
return nil, errors.Errorf("unexpected key '%s' for mount type '%s'", key, m.Type)
}
default:
// any other option requires a value.
return nil, errors.Errorf("invalid field '%s' must be a key=value pair", field)
}
}
// check for potential variable
if expander != nil {
value, err = expander(value)
if err != nil {
return nil, err
}
} else if key == "from" {
if idx := strings.IndexByte(value, '$'); idx != -1 && idx != len(value)-1 {
return nil, errors.Errorf("'%s' doesn't support variable expansion, define alias stage instead", key)
}
} else {
// if we don't have an expander, defer evaluation to later
continue
}
switch key {
case "type":
v := MountType(strings.ToLower(value))
if _, ok := allowedMountTypes[v]; !ok {
return nil, suggest.WrapError(errors.Errorf("unsupported mount type %q", value), value, allMountTypes(), true)
}
m.Type = v
case "from":
m.From = value
case "source", "src":
m.Source = value
case "target", "dst", "destination":
m.Target = value
case "readonly", "ro":
m.ReadOnly, err = strconv.ParseBool(value)
if err != nil {
return nil, errors.Errorf("invalid value for %s: %s", key, value)
}
roAuto = false
case "readwrite", "rw":
rw, err := strconv.ParseBool(value)
if err != nil {
return nil, errors.Errorf("invalid value for %s: %s", key, value)
}
m.ReadOnly = !rw
roAuto = false
case "required":
if m.Type == MountTypeSecret || m.Type == MountTypeSSH {
m.Required, err = strconv.ParseBool(value)
if err != nil {
return nil, errors.Errorf("invalid value for %s: %s", key, value)
}
} else {
return nil, errors.Errorf("unexpected key '%s' for mount type '%s'", key, m.Type)
}
case "size":
if m.Type == MountTypeTmpfs {
m.SizeLimit, err = units.RAMInBytes(value)
if err != nil {
return nil, errors.Errorf("invalid value for %s: %s", key, value)
}
} else {
return nil, errors.Errorf("unexpected key '%s' for mount type '%s'", key, m.Type)
}
case "id":
m.CacheID = value
case "sharing":
v := ShareMode(strings.ToLower(value))
if _, ok := allowedSharingModes[v]; !ok {
return nil, suggest.WrapError(errors.Errorf("unsupported sharing value %q", value), value, allShareModes(), true)
}
m.CacheSharing = v
case "mode":
mode, err := strconv.ParseUint(value, 8, 32)
if err != nil {
return nil, errors.Errorf("invalid value %s for mode", value)
}
m.Mode = &mode
case "uid":
uid, err := strconv.ParseUint(value, 10, 32)
if err != nil {
return nil, errors.Errorf("invalid value %s for uid", value)
}
m.UID = &uid
case "gid":
gid, err := strconv.ParseUint(value, 10, 32)
if err != nil {
return nil, errors.Errorf("invalid value %s for gid", value)
}
m.GID = &gid
default:
allKeys := []string{
"type", "from", "source", "target", "readonly", "id", "sharing", "required", "mode", "uid", "gid", "src", "dst", "ro", "rw", "readwrite",
}
return nil, suggest.WrapError(errors.Errorf("unexpected key '%s' in '%s'", key, field), key, allKeys, true)
}
}
fileInfoAllowed := m.Type == MountTypeSecret || m.Type == MountTypeSSH || m.Type == MountTypeCache
if !fileInfoAllowed {
if m.Mode != nil {
return nil, errors.Errorf("mode not allowed for %q type mounts", m.Type)
}
if m.UID != nil {
return nil, errors.Errorf("uid not allowed for %q type mounts", m.Type)
}
if m.GID != nil {
return nil, errors.Errorf("gid not allowed for %q type mounts", m.Type)
}
}
if roAuto {
if m.Type == MountTypeCache || m.Type == MountTypeTmpfs {
m.ReadOnly = false
} else {
m.ReadOnly = true
}
}
if m.Type == MountTypeSecret {
if m.From != "" {
return nil, errors.Errorf("secret mount should not have a from")
}
if m.CacheSharing != "" {
return nil, errors.Errorf("secret mount should not define sharing")
}
if m.Source == "" && m.Target == "" && m.CacheID == "" {
return nil, errors.Errorf("invalid secret mount. one of source, target required")
}
if m.Source != "" && m.CacheID != "" {
return nil, errors.Errorf("both source and id can't be set")
}
}
if m.CacheSharing != "" && m.Type != MountTypeCache {
return nil, errors.Errorf("invalid cache sharing set for %v mount", m.Type)
}
return m, nil
}
|