如何在 Golang 代码里面解析容器镜像

一 背景

容器镜像在我们日常的开发工作中占据着极其重要的位置。通常情况下我们是将应用程序打包到容器镜像并上传到镜像仓库中，在生产环境将其拉取下来。然后用 docker/containerd 等容器运行时将镜像启动，开始执行应用。但是对于一些运维平台来说，对于一个镜像制品本身的扫描和分析才是真正的关注点。本文简单介绍下如何在代码中解析一个容器镜像。

二 go-containerregistry

go-containerregistry 是 google 公司的一个开源项目，它提供了一个对镜像的操作接口，这个接口背后的资源可以是 镜像仓库的远程资源，镜像的tar包，甚至是 docker daemon 进程。下面我们就简单介绍下如何使用这个项目来完成我们的目标—— 在代码中解析镜像。

除了对外提供了三方包，该项目里面还提供了 crane (与远端镜像交互的客户端)gcrane (与 gcr 交互的客户端)。

三 基本接口

1 镜像基本概念

在介绍具体接口之间先介绍几个简单概念

• ImageIndex， 根据 OCI 规范，是为了兼容多架构(amd64, arm64)镜像而创造出来的数据结构, 我们可以在一个ImageIndex 里面关联多个镜像，使用同一个镜像tag，客户端(docker，ctr)会根据客户端所在的操作系统的基础架构拉取对应架构的镜像下来
• Image Manifest 基本上对应了一个镜像，里面包含了一个镜像的所有layers digest，客户端拉取镜像的时候一般都是先获取manifest 文件，在根据 manifest 文件里面的内容拉取镜像各个层(tar+gzip)
• Image Config 跟 ImageManifest 是一一对应的关系，Image Config 主要包含一些 镜像的基本配置，例如 创建时间，作者，该镜像的基础架构，镜像层的 diffID(未压缩的 ChangeSet)，ChainID 之类的信息。一般在宿主机上执行 docker image 看到的ImageID就是 ImageConfig 的hash值。
• layer 就是镜像层，镜像层信息不包含任何的运行时信息(环境变量等)只包含文件系统的信息。镜像是通过最底层 rootfs 加上各层的 changeset(对上一层的 add, update, delete 操作)组合而成的。
  • layer diffid 是未压缩的层的hash值，常见于 本地环境，使用 看到的便是diffid。因为客户端一般下载 ImageConfig, ImageConfig 里面是引用的diffid。
  • layer digest 是压缩后的层的hash值，常见于镜像仓库 使用 看到的layers 一般都是 digest. 因为 manifest 引用都是 layer digest。
  • 两者没有可以直接转换的方式，目前的唯一方式就是按照顺序来对应。
  • 用一张图来总结一下。

1. // ImageIndex 定义与 OCI ImageIndex 交互的接口
2. type ImageIndex interface {
3. // 返回当前 imageIndex 的 MediaType
4. MediaType() (types.MediaType, error)
6. // 返回这个 ImageIndex manifest 的 sha256值。
7. Digest() (Hash, error)
9. // 返回这个 ImageIndex manifest 的大小
10. Size() (int64, error)
12. // 返回这个 ImageIndex 的 manifest 结构
13. IndexManifest() (*IndexManifest, error)
15. // 返回这个 ImageIndex 的 manifest 字节数组
16. RawManifest() ([]byte, error)
18. // 返回这个 ImageIndex 引用的 Image
19. Image(Hash) (Image, error)
21. // 返回这个 ImageIndex 引用的 ImageIndex
22. ImageIndex(Hash) (ImageIndex, error)
23. }
25. // Image 定义了与 OCI Image 交互的接口
26. type Image interface {
27. // 返回了当前镜像的所有层级， 最老/最基础的层在数组的前面，最上面/最新的层在数组的后面
28. Layers() ([]Layer, error)
30. // 返回当前 image 的 MediaType
31. MediaType() (types.MediaType, error)
33. // 返回这个 Image manifest 的大小
34. Size() (int64, error)
36. // 返回这个镜像 ConfigFile 的hash值，也是这个镜像的 ImageID
37. ConfigName() (Hash, error)
39. // 返回这个镜像的 ConfigFile
40. ConfigFile() (*ConfigFile, error)
42. // 返回这个镜像的 ConfigFile 的字节数组
43. RawConfigFile() ([]byte, error)
45. // 返回这个Image Manifest 的sha256 值
46. Digest() (Hash, error)
48. // 返回这个Image Manifest
49. Manifest() (*Manifest, error)
51. // 返回 ImageManifest 的bytes数组
52. RawManifest() ([]byte, error)
54. // 返回这个镜像中的某一层layer， 根据 digest（压缩后的hash值） 来查找
55. LayerByDigest(Hash) (Layer, error)
57. // 返回这个镜像中的某一层layer， 根据 diffid （未压缩的hash值） 来查找
58. LayerByDiffID(Hash) (Layer, error)
59. }
61. // Layer 定义了访问 OCI Image 特定 Layer 的接口
62. type Layer interface {
63. // 返回了压缩后的layer的sha256 值
64. Digest() (Hash, error)
66. // 返回了 未压缩的layer 的sha256值.
67. DiffID() (Hash, error)
69. // 返回了压缩后的镜像层
70. Compressed() (io.ReadCloser, error)
72. // 返回了未压缩的镜像层
73. Uncompressed() (io.ReadCloser, error)
75. // 返回了压缩后镜像层的大小
76. Size() (int64, error)
78. // 返回当前 layer 的 MediaType
79. MediaType() (types.MediaType, error)
80. }

相关接口功能已在注释中说明，不再赘述。

四 获取镜像相关元信息

我们以 remote 方式(拉取远程镜像) 举例说明下如何使用。

1. package main
3. import (
4. "github.com/google/go-containerregistry/pkg/authn"
5. "github.com/google/go-containerregistry/pkg/name"
6. "github.com/google/go-containerregistry/pkg/v1/remote"
7. )
9. func main() {
10. ref, err := name.ParseReference("xxx")
11. if err != nil {
12. panic(err)
13. }
14. tryRemote(context.TODO(), ref, GetDockerOption())
15. if err != nil {
16. panic(err)
17. }
19. // do stuff with img
20. }
22. type DockerOption struct {
23. // Auth
24. UserName string
25. Password string
27. // RegistryToken is a bearer token to be sent to a registry
28. RegistryToken string
30. // ECR
31. AwsAccessKey string
32. AwsSecretKey string
33. AwsSessionToken string
34. AwsRegion string
36. // GCP
37. GcpCredPath string
39. InsecureSkipTLSVerify bool
40. NonSSL bool
41. SkipPing bool // this is ignored now
42. Timeout time.Duration
43. }
45. func GetDockerOption() (types.DockerOption, error) {
46. cfg := DockerConfig{}
47. if err := env.Parse(&cfg); err != nil {
48. return types.DockerOption{}, fmt.Errorf("unable to parse environment variables: %w", err)
49. }
51. return types.DockerOption{
52. UserName: cfg.UserName,
53. Password: cfg.Password,
54. RegistryToken: cfg.RegistryToken,
55. InsecureSkipTLSVerify: cfg.Insecure,
56. NonSSL: cfg.NonSSL,
57. }, nil
58. }
60. func tryRemote(ctx context.Context, ref name.Reference, option types.DockerOption) (v1.Image, extender, error) {
61. var remoteOpts []remote.Option
62. if option.InsecureSkipTLSVerify {
63. t := &http.Transport{
64. TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
65. }
66. remoteOpts = append(remoteOpts, remote.WithTransport(t))
67. }
69. domain := ref.Context().RegistryStr()
70. auth := token.GetToken(ctx, domain, option)
72. if auth.Username != "" && auth.Password != "" {
73. remoteOpts = append(remoteOpts, remote.WithAuth(&auth))
74. } else if option.RegistryToken != "" {
75. bearer := authn.Bearer{Token: option.RegistryToken}
76. remoteOpts = append(remoteOpts, remote.WithAuth(&bearer))
77. } else {
78. remoteOpts = append(remoteOpts, remote.WithAuthFromKeychain(authn.DefaultKeychain))
79. }
81. desc, err := remote.Get(ref, remoteOpts...)
82. if err != nil {
83. return nil, nil, err
84. }
86. img, err := desc.Image()
87. if err != nil {
88. return nil, nil, err
89. }
91. // Return v1.Image if the image is found in Docker Registry
92. return img, remoteExtender{
93. ref: implicitReference{ref: ref},
94. descriptor: desc,
95. }, nil
96. }

执行完 tryRemote 代码之后就可以获取 Image 对象的实例，进而对这个实例进行操作。明确以下几个关键点

• remote.Get() 方法只会实际拉取镜像的manifestList/manifest，并不会拉取整个镜像。
• desc.Image() 方法会判断 remote.Get() 返回的媒体类型。如果是镜像的话直接返回一个 Image interface, 如果是 manifest list 的情况会解析当前宿主机的架构，并且返回指定架构对应的镜像。 同样这里并不会拉取镜像。
• 所有的数据都是lazy load。只有需要的时候才会去获取。

五 读取镜像中系统软件的信息

通过上面的接口定义可知，我们可以通过 Image.LayerByDiffID(Hash) (Layer, error) 获取一个 layer 对象， 获取了layer对象之后我们可以调用 layer.Uncompressed() 方法获取一个未被压缩的层的 io.Reader , 也就是一个 tar file。

1. // tarOnceOpener 读取文件一次并共享内容，以便分析器可以共享数据
2. func tarOnceOpener(r io.Reader) func() ([]byte, error) {
3. var once sync.Once
4. var b []byte
5. var err error
7. return func() ([]byte, error) {
8. once.Do(func() {
9. b, err = ioutil.ReadAll(r)
10. })
11. if err != nil {
12. return nil, xerrors.Errorf("unable to read tar file: %w", err)
13. }
14. return b, nil
15. }
16. }
18. // 该方法主要是遍历整个 io stream，首先解析出文件的元信息 （path, prefix,suffix）, 然后调用 analyzeFn 方法解析文件内容
19. func WalkLayerTar(layer io.Reader, analyzeFn WalkFunc) ([]string, []string, error) {
20. var opqDirs, whFiles []string
21. var result *AnalysisResult
22. tr := tar.NewReader(layer)
23. opq := ".wh..wh..opq"
24. wh := ".wh."
25. for {
26. hdr, err := tr.Next()
27. if err == io.EOF {
28. break
29. }
30. if err != nil {
31. return nil, nil, xerrors.Errorf("failed to extract the archive: %w", err)
32. }
34. filePath := hdr.Name
35. filePath = strings.TrimLeft(filepath.Clean(filePath), "/")
36. fileDir, fileName := filepath.Split(filePath)
38. // e.g. etc/.wh..wh..opq
39. if opq == fileName {
40. opqDirs = append(opqDirs, fileDir)
41. continue
42. }
43. // etc/.wh.hostname
44. if strings.HasPrefix(fileName, wh) {
45. name := strings.TrimPrefix(fileName, wh)
46. fpath := filepath.Join(fileDir, name)
47. whFiles = append(whFiles, fpath)
48. continue
49. }
51. if hdr.Typeflag == tar.TypeSymlink || hdr.Typeflag == tar.TypeLink || hdr.Typeflag == tar.TypeReg {
52. analyzeFn(filePath, hdr.FileInfo(), tarOnceOpener(tr), result)
53. if err != nil {
54. return nil, nil, xerrors.Errorf("failed to analyze file: %w", err)
55. }
56. }
57. }
59. return opqDirs, whFiles, nil
60. }
62. // 调用不同的driver 对同一个文件进行解析
63. func analyzeFn(filePath string, info os.FileInfo, opener analyzer.Opener,result *AnalysisResult) error {
64. if info.IsDir() {
65. return nil, nil
66. }
68. var wg sync.WaitGroup
69. for _, d := range drivers {
70. // filepath extracted from tar file doesn't have the prefix "/"
71. if !d.Required(strings.TrimLeft(filePath, "/"), info) {
72. continue
73. }
74. b, err := opener()
75. if err != nil {
76. return nil, xerrors.Errorf("unable to open a file (%s): %w", filePath, err)
77. }
79. if err = limit.Acquire(ctx, 1); err != nil {
80. return nil, xerrors.Errorf("semaphore acquire: %w", err)
81. }
82. wg.Add(1)
84. go func(a analyzer, target AnalysisTarget) {
85. defer limit.Release(1)
86. defer wg.Done()
88. ret, err := a.Analyze(target)
89. if err != nil && !xerrors.Is(err, aos.AnalyzeOSError) {
90. log.Logger.Debugf("Analysis error: %s", err)
91. return nil, err
92. }
93. result.Merge(ret)
94. }(d, AnalysisTarget{Dir: dir, FilePath: filePath, Content: b})
95. }
98. return result, nil
99. }
101. // drivers: 用于解析tar包中的文件
102. func (a alpinePkgAnalyzer) Analyze(target analyzer.AnalysisTarget) (*analyzer.AnalysisResult, error) {
103. scanner := bufio.NewScanner(bytes.NewBuffer(target.Content))
104. var pkg types.Package
105. var version string
106. for scanner.Scan() {
107. line := scanner.Text()
109. // check package if paragraph end
110. if len(line) < 2 {
111. if analyzer.CheckPackage(&pkg) {
112. pkgs = append(pkgs, pkg)
113. }
114. pkg = types.Package{}
115. continue
116. }
118. switch line[:2] {
119. case "P:":
120. pkg.Name = line[2:]
121. case "V:":
122. version = string(line[2:])
123. if !apkVersion.Valid(version) {
124. log.Printf("Invalid Version Found : OS %s, Package %s, Version %s", "alpine", pkg.Name, version)
125. continue
126. }
127. pkg.Version = version
128. case "o:":
129. origin := line[2:]
130. pkg.SrcName = origin
131. pkg.SrcVersion = version
132. }
133. }
134. // in case of last paragraph
135. if analyzer.CheckPackage(&pkg) {
136. pkgs = append(pkgs, pkg)
137. }
139. parsedPkgs := a.uniquePkgs(pkgs)
141. return &analyzer.AnalysisResult{
142. PackageInfos: []types.PackageInfo{
143. {
144. FilePath: target.FilePath,
145. Packages: parsedPkgs,
146. },
147. },
148. }, nil
149. }

以上代码的重点在于 Analyze(target analyzer.AnalysisTarget) 方法，在介绍这个方法之前，有两个特殊文件需要稍微介绍下。众所周知，镜像是分层的，并且所有层都是只读的。当容器是以镜像为基础起来的时候，它会将所有镜像层包含的文件组合成为 rootfs 对容器暂时，当我们将容器 commit 成一个新的镜像的时候，容器内对文件修改会以新的layer 的方式覆盖到原有的镜像中。其中有如下两种特殊文件：

• .wh..wh..opq: 代表这个文件所在的目录被删除了
• .wh.：以这个词缀开头的文件说明这个文件在当前层已经被删除

所以综上所述，所有容器内的文件删除均不是真正的删除。所以我们在 WalkLayerTar 方法中将两个文件记录下来，跳过解析。

1 Analyze(target analyzer.AnalysisTarget)

• 首先我们调用 bufio.scanner.Scan() 方法， 他会不断扫描文件中的信息，当返回false 的时候代表扫描到文件结尾，如果这时在扫描过程中没有错误，则 scanner 的 Err 字段为 nil
• 我们通过 scanner.Text() 获取扫描文件的每一行，截取每一行的前两个字符，得出 apk package 的 package name & package version。

六 读取镜像中的java 应用信息

下面我们实际来看下如何读取java 应用中的依赖信息，包括 应用依赖 & jar包依赖， 首先我们使用上面的方式读取某一层的文件信息。

• 如果发现 文件是jar包
• 初始化 zip reader， 开始读取 jar 包内容
• 开始通过 jar包名称进行解析 artifact的名称和版本， 例如: spring-core-5.3.4-SNAPSHOT.jar => sprint-core, 5.3.4-SNAPSHOT
• 从 zip reader 读取被压缩的文件
• 判断文件类型
  • 调用parseArtifact进行递归解析
  • 将返回的innerLibs放到 libs对象中
  • 从 MANIFEST.MF 文件中解析出manifest返回
  • 从 properties 文件中解析 groupid, artifactid, version 并返回
  • 将上述信息放到 libs 对象中
  • 如果是 pom.properties
  • 如果是 MANIFEST.MF
  • 如果是 jar/war/ear 等文件
• 如果 找不到 artifactid or groupid
  • 根据jar sha256查询对应的包信息
  • 找到直接返回
• 返回解析出来的libs

1. func parseArtifact(c conf, fileName string, r io.ReadCloser) ([]types.Library, error) {
2. defer r.Close()
3. b, err := ioutil.ReadAll(r)
4. if err != nil {
5. return nil, xerrors.Errorf("unable to read the jar file: %w", err)
6. }
7. zr, err := zip.NewReader(bytes.NewReader(b), int64(len(b)))
8. if err != nil {
9. return nil, xerrors.Errorf("zip error: %w", err)
10. }
12. fileName = filepath.Base(fileName)
13. fileProps := parseFileName(fileName)
15. var libs []types.Library
16. var m manifest
17. var foundPomProps bool
19. for _, fileInJar := range zr.File {
20. switch {
21. case filepath.Base(fileInJar.Name) == "pom.properties":
22. props, err := parsePomProperties(fileInJar)
23. if err != nil {
24. return nil, xerrors.Errorf("failed to parse %s: %w", fileInJar.Name, err)
25. }
26. libs = append(libs, props.library())
27. if fileProps.artifactID == props.artifactID && fileProps.version == props.version {
28. foundPomProps = true
29. }
30. case filepath.Base(fileInJar.Name) == "MANIFEST.MF":
31. m, err = parseManifest(fileInJar)
32. if err != nil {
33. return nil, xerrors.Errorf("failed to parse MANIFEST.MF: %w", err)
34. }
35. case isArtifact(fileInJar.Name):
36. fr, err := fileInJar.Open()
37. if err != nil {
38. return nil, xerrors.Errorf("unable to open %s: %w", fileInJar.Name, err)
39. }
41. // 递归解析 jar/war/ear
42. innerLibs, err := parseArtifact(c, fileInJar.Name, fr)
43. if err != nil {
44. return nil, xerrors.Errorf("failed to parse %s: %w", fileInJar.Name, err)
45. }
46. libs = append(libs, innerLibs...)
47. }
48. }
50. // 如果找到了 pom.properties 文件，则直接返回libs对象
51. if foundPomProps {
52. return libs, nil
53. }
54. // 如果没有找到 pom.properties 文件，则解析MANIFEST.MF 文件
55. manifestProps := m.properties()
56. if manifestProps.valid() {
57. // 这里即使找到了 artifactid or groupid 也有可能是非法的。这里会访问 maven等仓库确认 jar包是否真正存在
58. if ok, _ := exists(c, manifestProps); ok {
59. return append(libs, manifestProps.library()), nil
60. }
61. }
62. p, err := searchBySHA1(c, b)
63. if err == nil {
64. return append(libs, p.library()), nil
65. } else if !xerrors.Is(err, ArtifactNotFoundErr) {
66. return nil, xerrors.Errorf("failed to search by SHA1: %w", err)
67. }
68. return libs, nil
69. }

以上我们便完成了从容器镜像中读取信息的功能。

参考：

https://github.com/google/go-containerregistry

https://github.com/aquasecurity/fanal

项目地址： https://github.com/google/go-containerregistry

原文链接：https://zhuanlan.51cto.com/art/202201/697935.htm