forked from openshift/origin
-
Notifications
You must be signed in to change notification settings - Fork 1
/
extract.go
660 lines (571 loc) · 18.8 KB
/
extract.go
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
package extract
import (
"archive/tar"
"context"
"fmt"
"io"
"math"
"os"
"os/user"
"path"
"path/filepath"
"regexp"
"strconv"
"strings"
"github.com/golang/glog"
"github.com/spf13/cobra"
"github.com/docker/distribution"
dockerarchive "github.com/docker/docker/pkg/archive"
digest "github.com/opencontainers/go-digest"
"k8s.io/client-go/rest"
"k8s.io/kubernetes/pkg/kubectl/cmd/templates"
kcmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
"k8s.io/kubernetes/pkg/kubectl/genericclioptions"
"github.com/openshift/origin/pkg/image/apis/image/docker10"
imagereference "github.com/openshift/origin/pkg/image/apis/image/reference"
"github.com/openshift/origin/pkg/image/registryclient"
"github.com/openshift/origin/pkg/image/registryclient/dockercredentials"
"github.com/openshift/origin/pkg/oc/cli/image/archive"
imagemanifest "github.com/openshift/origin/pkg/oc/cli/image/manifest"
"github.com/openshift/origin/pkg/oc/cli/image/workqueue"
)
var (
desc = templates.LongDesc(`
Extract the contents of an image to disk
Download an image or parts of an image to the filesystem. Allows users to access the
contents of images without requiring a container runtime engine running.
Pass images to extract as arguments. The --paths flag allows you to define multiple
source to destination directory mappings. The source section may be either a file, a
directory (ends with a '/'), or a file pattern within a directory. The destination
section is a directory to extract to. Both source and destination must be specified.
If the specified image supports multiple operating systems, the image that matches the
current operating system will be chosen. Otherwise you must pass --filter-by-os to
select the desired image.
You may further qualify the image by adding a layer selector to the end of the image
string to only extract specific layers within an image. The supported selectors are:
[<index>] - select the layer at the provided index (zero-indexed)
[<from_index>,<to_index>] - select layers by index, exclusive
[~<prefix>] - select the layer with the matching prefix or return an error
Negative indices are counted from the end of the list, e.g. [-1] selects the last
layer.
Experimental: This command is under active development and may change without notice.`)
example = templates.Examples(`
# Extract the busybox image into the current directory
%[1]s docker.io/library/busybox:latest
# Extract the busybox image to a temp directory (must exist)
%[1]s docker.io/library/busybox:latest --path /:/tmp/busybox
# Extract a single file from the image into the current directory
%[1]s docker.io/library/centos:7 --path /bin/bash:.
# Extract all .repo files from the image's /etc/yum.repos.d/ folder.
%[1]s docker.io/library/centos:7 --path /etc/yum.repos.d/*.repo:.
# Extract the last layer in the image
%[1]s docker.io/library/centos:7[-1]
# Extract the first three layers of the image
%[1]s docker.io/library/centos:7[:3]
# Extract the last three layers of the image
%[1]s docker.io/library/centos:7[-3:]
`)
)
// TarEntryFunc is called once per entry in the tar file. It may return
// an error, or false to stop processing.
type TarEntryFunc func(*tar.Header, io.Reader) (cont bool, err error)
type Options struct {
Mappings []Mapping
Paths []string
OnlyFiles bool
RemovePermissions bool
FilterOptions imagemanifest.FilterOptions
MaxPerRegistry int
DryRun bool
Insecure bool
genericclioptions.IOStreams
// ImageMetadataCallback is invoked once per image retrieved, and may be called in parallel if
// MaxPerRegistry is set higher than 1.
ImageMetadataCallback func(m *Mapping, dgst digest.Digest, imageConfig *docker10.DockerImageConfig)
// TarEntryCallback, if set, is passed each entry in the viewed layers. Entries will be filtered
// by name and only the entry in the highest layer will be passed to the callback. Returning false
// will halt processing of the image.
TarEntryCallback TarEntryFunc
}
func NewOptions(streams genericclioptions.IOStreams) *Options {
return &Options{
Paths: []string{"/:."},
IOStreams: streams,
MaxPerRegistry: 1,
}
}
// New creates a new command
func New(name string, streams genericclioptions.IOStreams) *cobra.Command {
o := NewOptions(streams)
cmd := &cobra.Command{
Use: "extract",
Short: "Copy files from an image to the filesystem",
Long: desc,
Example: fmt.Sprintf(example, name),
Run: func(c *cobra.Command, args []string) {
kcmdutil.CheckErr(o.Complete(c, args))
kcmdutil.CheckErr(o.Run())
},
}
flag := cmd.Flags()
o.FilterOptions.Bind(flag)
flag.BoolVar(&o.DryRun, "dry-run", o.DryRun, "Print the actions that would be taken and exit without writing any contents.")
flag.BoolVar(&o.Insecure, "insecure", o.Insecure, "Allow pull operations to registries to be made over HTTP")
flag.StringSliceVar(&o.Paths, "path", o.Paths, "Extract only part of an image. Must be SRC:DST where SRC is the path within the image and DST a local directory. If not specified the default is to extract everything to the current directory.")
flag.BoolVar(&o.OnlyFiles, "only-files", o.OnlyFiles, "Only extract regular files and directories from the image.")
return cmd
}
type LayerFilter interface {
Filter(layers []distribution.Descriptor) ([]distribution.Descriptor, error)
}
type Mapping struct {
// Name is provided for caller convenience for associating image callback metadata with a mapping
Name string
// Image is the raw input image to extract
Image string
// ImageRef is the parsed version of the raw input image
ImageRef imagereference.DockerImageReference
// LayerFilter can select which images to load
LayerFilter LayerFilter
// From is the directory or file in the image to extract
From string
// To is the directory to extract the contents of the directory or the named file into.
To string
// ConditionFn is invoked before extracting the content and allows the set of images to be filtered.
ConditionFn func(m *Mapping, dgst digest.Digest, imageConfig *docker10.DockerImageConfig) (bool, error)
}
func parseMappings(images, paths []string) ([]Mapping, error) {
layerFilter := regexp.MustCompile(`^(.*)\[([^\]]*)\](.*)$`)
var mappings []Mapping
for _, image := range images {
for _, arg := range paths {
parts := strings.SplitN(arg, ":", 2)
var mapping Mapping
switch len(parts) {
case 2:
mapping = Mapping{Image: image, From: parts[0], To: parts[1]}
default:
return nil, fmt.Errorf("--paths must be of the form SRC:DST")
}
if matches := layerFilter.FindStringSubmatch(mapping.Image); len(matches) > 0 {
if len(matches[1]) == 0 || len(matches[2]) == 0 || len(matches[3]) != 0 {
return nil, fmt.Errorf("layer selectors must be of the form IMAGE[\\d:\\d]")
}
mapping.Image = matches[1]
var err error
mapping.LayerFilter, err = parseLayerFilter(matches[2])
if err != nil {
return nil, err
}
}
if len(mapping.From) > 0 {
mapping.From = strings.TrimPrefix(mapping.From, "/")
}
if len(mapping.To) > 0 {
fi, err := os.Stat(mapping.To)
if err != nil {
return nil, fmt.Errorf("invalid argument: %s", err)
}
if !fi.IsDir() {
return nil, fmt.Errorf("invalid argument: %s is not a directory", arg)
}
}
src, err := imagereference.Parse(mapping.Image)
if err != nil {
return nil, err
}
if len(src.Tag) == 0 && len(src.ID) == 0 {
return nil, fmt.Errorf("source image must point to an image ID or image tag")
}
mapping.ImageRef = src
mappings = append(mappings, mapping)
}
}
return mappings, nil
}
func (o *Options) Complete(cmd *cobra.Command, args []string) error {
if err := o.FilterOptions.Complete(cmd.Flags()); err != nil {
return err
}
if len(args) == 0 {
return fmt.Errorf("you must specify at least one image to extract as an argument")
}
var err error
o.Mappings, err = parseMappings(args, o.Paths)
if err != nil {
return err
}
return nil
}
func (o *Options) Run() error {
preserveOwnership := false
u, err := user.Current()
if err != nil {
fmt.Fprintf(os.Stderr, "warning: Could not load current user information: %v\n", err)
}
if u != nil {
if uid, err := strconv.Atoi(u.Uid); err == nil && uid == 0 {
preserveOwnership = true
}
}
rt, err := rest.TransportFor(&rest.Config{})
if err != nil {
return err
}
insecureRT, err := rest.TransportFor(&rest.Config{TLSClientConfig: rest.TLSClientConfig{Insecure: true}})
if err != nil {
return err
}
creds := dockercredentials.NewLocal()
ctx := context.Background()
fromContext := registryclient.NewContext(rt, insecureRT).WithCredentials(creds)
stopCh := make(chan struct{})
defer close(stopCh)
q := workqueue.New(o.MaxPerRegistry, stopCh)
return q.Try(func(q workqueue.Try) {
for i := range o.Mappings {
mapping := o.Mappings[i]
from := mapping.ImageRef
q.Try(func() error {
repo, err := fromContext.Repository(ctx, from.DockerClientDefaults().RegistryURL(), from.RepositoryName(), o.Insecure)
if err != nil {
return err
}
srcManifest, srcDigest, location, err := imagemanifest.FirstManifest(ctx, from, repo, o.FilterOptions.Include)
if err != nil {
return fmt.Errorf("unable to read image %s: %v", from, err)
}
imageConfig, layers, err := imagemanifest.ManifestToImageConfig(ctx, srcManifest, repo.Blobs(ctx), location)
if err != nil {
return fmt.Errorf("unable to parse image %s: %v", from, err)
}
if mapping.ConditionFn != nil {
ok, err := mapping.ConditionFn(&mapping, srcDigest, imageConfig)
if err != nil {
return fmt.Errorf("unable to check whether to include image %s: %v", from, err)
}
if !ok {
glog.V(2).Infof("Filtered out image %s with digest %s from being extracted", from, srcDigest)
return nil
}
}
var alter alterations
if o.OnlyFiles {
alter = append(alter, filesOnly{})
}
if len(mapping.From) > 0 {
switch {
case strings.HasSuffix(mapping.From, "/"):
alter = append(alter, newCopyFromDirectory(mapping.From))
default:
name, parent := path.Base(mapping.From), path.Dir(mapping.From)
if name == "." || parent == "." {
return fmt.Errorf("unexpected directory from mapping %s", mapping.From)
}
alter = append(alter, newCopyFromPattern(parent, name))
}
}
filteredLayers := layers
if mapping.LayerFilter != nil {
filteredLayers, err = mapping.LayerFilter.Filter(filteredLayers)
if err != nil {
return fmt.Errorf("unable to filter layers for %s: %v", from, err)
}
}
if o.RemovePermissions {
alter = append(alter, removePermissions{})
}
var byEntry TarEntryFunc = o.TarEntryCallback
if o.DryRun {
path := mapping.To
out := o.Out
byEntry = func(hdr *tar.Header, r io.Reader) (bool, error) {
if len(hdr.Name) == 0 {
return true, nil
}
mode := hdr.FileInfo().Mode().String()
switch hdr.Typeflag {
case tar.TypeDir:
fmt.Fprintf(out, "%s %12d %s\n", mode, hdr.Size, filepath.Join(path, hdr.Name))
case tar.TypeReg, tar.TypeRegA:
fmt.Fprintf(out, "%s %12d %s\n", mode, hdr.Size, filepath.Join(path, hdr.Name))
case tar.TypeLink:
fmt.Fprintf(out, "%s %12d %s -> %s\n", mode, hdr.Size, hdr.Name, filepath.Join(path, hdr.Linkname))
case tar.TypeSymlink:
fmt.Fprintf(out, "%s %12d %s -> %s\n", mode, hdr.Size, hdr.Name, filepath.Join(path, hdr.Linkname))
default:
fmt.Fprintf(out, "%s %12d %s %x\n", mode, hdr.Size, filepath.Join(path, hdr.Name), hdr.Typeflag)
}
return true, nil
}
}
// walk the layers in reverse order, only showing a given path once
alreadySeen := make(map[string]struct{})
if byEntry != nil {
for i, j := 0, len(filteredLayers)-1; i < j; i, j = i+1, j-1 {
filteredLayers[i], filteredLayers[j] = filteredLayers[j], filteredLayers[i]
}
}
for i := range filteredLayers {
layer := &filteredLayers[i]
cont, err := func() (bool, error) {
fromBlobs := repo.Blobs(ctx)
glog.V(5).Infof("Extracting from layer: %#v", layer)
// source
r, err := fromBlobs.Open(ctx, layer.Digest)
if err != nil {
return false, fmt.Errorf("unable to access the source layer %s: %v", layer.Digest, err)
}
defer r.Close()
options := &archive.TarOptions{
AlterHeaders: alter,
Chown: preserveOwnership,
}
if byEntry != nil {
return layerByEntry(r, options, byEntry, alreadySeen)
}
glog.V(4).Infof("Extracting layer %s with options %#v", layer.Digest, options)
if _, err := archive.ApplyLayer(mapping.To, r, options); err != nil {
return false, err
}
return true, nil
}()
if err != nil {
return err
}
if !cont {
break
}
}
if o.ImageMetadataCallback != nil {
o.ImageMetadataCallback(&mapping, srcDigest, imageConfig)
}
return nil
})
}
})
}
func layerByEntry(r io.Reader, options *archive.TarOptions, fn TarEntryFunc, alreadySeen map[string]struct{}) (bool, error) {
rc, err := dockerarchive.DecompressStream(r)
if err != nil {
return false, err
}
defer rc.Close()
tr := tar.NewReader(rc)
for {
hdr, err := tr.Next()
if err != nil {
if err == io.EOF {
return true, nil
}
return false, err
}
glog.V(6).Infof("Printing layer entry %#v", hdr)
if options.AlterHeaders != nil {
ok, err := options.AlterHeaders.Alter(hdr)
if err != nil {
return false, err
}
if !ok {
glog.V(5).Infof("Exclude entry %s %x %d", hdr.Name, hdr.Typeflag, hdr.Size)
continue
}
}
// prevent duplicates from being sent to the handler
if _, ok := alreadySeen[hdr.Name]; ok {
continue
}
alreadySeen[hdr.Name] = struct{}{}
// TODO: need to do prefix filtering for whiteouts
cont, err := fn(hdr, tr)
if err != nil {
return false, err
}
if !cont {
return false, nil
}
}
}
type alterations []archive.AlterHeader
func (a alterations) Alter(hdr *tar.Header) (bool, error) {
for _, item := range a {
ok, err := item.Alter(hdr)
if err != nil {
return false, err
}
if !ok {
return false, nil
}
}
return true, nil
}
type removePermissions struct{}
func (_ removePermissions) Alter(hdr *tar.Header) (bool, error) {
switch hdr.Typeflag {
case tar.TypeReg, tar.TypeRegA:
hdr.Mode = int64(os.FileMode(0640))
default:
hdr.Mode = int64(os.FileMode(0755))
}
return true, nil
}
type copyFromDirectory struct {
From string
}
func newCopyFromDirectory(from string) archive.AlterHeader {
if !strings.HasSuffix(from, "/") {
from = from + "/"
}
return ©FromDirectory{From: from}
}
func (n *copyFromDirectory) Alter(hdr *tar.Header) (bool, error) {
return changeTarEntryParent(hdr, n.From), nil
}
type copyFromPattern struct {
Base string
Name string
}
func newCopyFromPattern(dir, name string) archive.AlterHeader {
if !strings.HasSuffix(dir, "/") {
dir = dir + "/"
}
return ©FromPattern{Base: dir, Name: name}
}
func (n *copyFromPattern) Alter(hdr *tar.Header) (bool, error) {
if !changeTarEntryParent(hdr, n.Base) {
return false, nil
}
matchName := hdr.Name
if i := strings.Index(matchName, "/"); i != -1 {
matchName = matchName[:i]
}
if ok, err := path.Match(n.Name, matchName); !ok || err != nil {
glog.V(5).Infof("Excluded %s due to filter %s", hdr.Name, n.Name)
return false, err
}
return true, nil
}
func changeTarEntryParent(hdr *tar.Header, from string) bool {
if !strings.HasPrefix(hdr.Name, from) {
glog.V(5).Infof("Exclude %s due to missing prefix %s", hdr.Name, from)
return false
}
if len(hdr.Linkname) > 0 {
if strings.HasPrefix(hdr.Linkname, from) {
hdr.Linkname = strings.TrimPrefix(hdr.Linkname, from)
glog.V(5).Infof("Updated link to %s", hdr.Linkname)
} else {
glog.V(4).Infof("Name %s won't correctly point to %s outside of %s", hdr.Name, hdr.Linkname, from)
}
}
hdr.Name = strings.TrimPrefix(hdr.Name, from)
glog.V(5).Infof("Updated name %s", hdr.Name)
return true
}
type filesOnly struct {
}
func (_ filesOnly) Alter(hdr *tar.Header) (bool, error) {
switch hdr.Typeflag {
case tar.TypeReg, tar.TypeRegA, tar.TypeDir:
return true, nil
default:
glog.V(6).Infof("Excluded %s because type was not a regular file or directory: %x", hdr.Name, hdr.Typeflag)
return false, nil
}
}
func parseLayerFilter(s string) (LayerFilter, error) {
if strings.HasPrefix(s, "~") {
s = s[1:]
return &prefixLayerFilter{Prefix: s}, nil
}
if strings.Contains(s, ":") {
l := &indexLayerFilter{From: 0, To: math.MaxInt32}
parts := strings.SplitN(s, ":", 2)
if len(parts[0]) > 0 {
i, err := strconv.Atoi(parts[0])
if err != nil {
return nil, fmt.Errorf("[from:to] must have valid numbers: %v", err)
}
l.From = int32(i)
}
if len(parts[1]) > 0 {
i, err := strconv.Atoi(parts[1])
if err != nil {
return nil, fmt.Errorf("[from:to] must have valid numbers: %v", err)
}
l.To = int32(i)
}
if l.To > 0 && l.To < l.From {
return nil, fmt.Errorf("[from:to] to must be larger than from")
}
return l, nil
}
if i, err := strconv.Atoi(s); err == nil {
l := NewPositionLayerFilter(int32(i))
return l, nil
}
return nil, fmt.Errorf("the layer selector [%s] is not valid, must be [from:to], [index], or [~digest]", s)
}
type prefixLayerFilter struct {
Prefix string
}
func (s *prefixLayerFilter) Filter(layers []distribution.Descriptor) ([]distribution.Descriptor, error) {
var filtered []distribution.Descriptor
for _, d := range layers {
if strings.HasPrefix(d.Digest.String(), s.Prefix) {
filtered = append(filtered, d)
}
}
if len(filtered) == 0 {
return nil, fmt.Errorf("no layers start with '%s'", s.Prefix)
}
if len(filtered) > 1 {
return nil, fmt.Errorf("multiple layers start with '%s', you must be more specific", s.Prefix)
}
return filtered, nil
}
type indexLayerFilter struct {
From int32
To int32
}
func (s *indexLayerFilter) Filter(layers []distribution.Descriptor) ([]distribution.Descriptor, error) {
l := int32(len(layers))
from := s.From
to := s.To
if from < 0 {
from = l + from
}
if to < 0 {
to = l + to
}
if to > l {
to = l
}
if from < 0 || to < 0 || from >= l {
if s.To == math.MaxInt32 {
return nil, fmt.Errorf("tried to select [%d:], but image only has %d layers", s.From, l)
}
return nil, fmt.Errorf("tried to select [%d:%d], but image only has %d layers", s.From, s.To, l)
}
if to < from {
to, from = from, to
}
return layers[from:to], nil
}
type positionLayerFilter struct {
At int32
}
func NewPositionLayerFilter(at int32) LayerFilter {
return &positionLayerFilter{at}
}
func (s *positionLayerFilter) Filter(layers []distribution.Descriptor) ([]distribution.Descriptor, error) {
l := int32(len(layers))
at := s.At
if at < 0 {
at = l + s.At
}
if at < 0 || at >= l {
return nil, fmt.Errorf("tried to select layer %d, but image only has %d layers", s.At, l)
}
return []distribution.Descriptor{layers[at]}, nil
}