// Package common ... package common import ( "encoding/json" goerrors "errors" "fmt" "path" "strconv" "strings" "time" v1 "github.com/google/go-containerregistry/pkg/v1" notreg "github.com/notaryproject/notation-go/registry" godigest "github.com/opencontainers/go-digest" ispec "github.com/opencontainers/image-spec/specs-go/v1" "zotregistry.io/zot/errors" "zotregistry.io/zot/pkg/log" "zotregistry.io/zot/pkg/storage" ) type OciLayoutUtils interface { GetImageManifests(image string) ([]ispec.Descriptor, error) GetImageBlobManifest(imageDir string, digest godigest.Digest) (v1.Manifest, error) GetImageInfo(imageDir string, hash v1.Hash) (ispec.Image, error) GetImageTagsWithTimestamp(repo string) ([]TagInfo, error) GetImageLastUpdated(imageInfo ispec.Image) time.Time GetImagePlatform(imageInfo ispec.Image) (string, string) GetImageManifestSize(repo string, manifestDigest godigest.Digest) int64 GetRepoLastUpdated(repo string) (TagInfo, error) GetExpandedRepoInfo(name string) (RepoInfo, error) GetImageConfigInfo(repo string, manifestDigest godigest.Digest) (ispec.Image, error) CheckManifestSignature(name string, digest godigest.Digest) bool GetRepositories() ([]string, error) } // OciLayoutInfo ... type BaseOciLayoutUtils struct { Log log.Logger StoreController storage.StoreController } type RepoInfo struct { Summary RepoSummary ImageSummaries []ImageSummary `json:"images"` } type RepoSummary struct { Name string `json:"name"` LastUpdated time.Time `json:"lastUpdated"` Size string `json:"size"` Platforms []OsArch `json:"platforms"` Vendors []string `json:"vendors"` Score int `json:"score"` NewestImage ImageSummary `json:"newestImage"` } type ImageSummary struct { RepoName string `json:"repoName"` Tag string `json:"tag"` Digest string `json:"digest"` ConfigDigest string `json:"configDigest"` LastUpdated time.Time `json:"lastUpdated"` IsSigned bool `json:"isSigned"` Size string `json:"size"` Platform OsArch `json:"platform"` Vendor string `json:"vendor"` Score int `json:"score"` DownloadCount int `json:"downloadCount"` Description string `json:"description"` Licenses string `json:"licenses"` Labels string `json:"labels"` Title string `json:"title"` Source string `json:"source"` Documentation string `json:"documentation"` Layers []Layer `json:"layers"` } type OsArch struct { Os string `json:"os"` Arch string `json:"arch"` } type Layer struct { Size string `json:"size"` Digest string `json:"digest"` } // NewBaseOciLayoutUtils initializes a new OciLayoutUtils object. func NewBaseOciLayoutUtils(storeController storage.StoreController, log log.Logger) *BaseOciLayoutUtils { return &BaseOciLayoutUtils{Log: log, StoreController: storeController} } func (olu BaseOciLayoutUtils) GetImageManifest(repo string, reference string) (ispec.Manifest, error) { imageStore := olu.StoreController.GetImageStore(repo) if reference == "" { reference = "latest" } buf, _, _, err := imageStore.GetImageManifest(repo, reference) if err != nil { return ispec.Manifest{}, err } var manifest ispec.Manifest err = json.Unmarshal(buf, &manifest) if err != nil { return ispec.Manifest{}, err } return manifest, nil } // Provide a list of repositories from all the available image stores. func (olu BaseOciLayoutUtils) GetRepositories() ([]string, error) { defaultStore := olu.StoreController.DefaultStore substores := olu.StoreController.SubStore repoList, err := defaultStore.GetRepositories() if err != nil { return []string{}, err } for _, sub := range substores { repoListForSubstore, err := sub.GetRepositories() if err != nil { return []string{}, err } repoList = append(repoList, repoListForSubstore...) } return repoList, nil } // Below method will return image path including root dir, root dir is determined by splitting. func (olu BaseOciLayoutUtils) GetImageManifests(image string) ([]ispec.Descriptor, error) { imageStore := olu.StoreController.GetImageStore(image) buf, err := imageStore.GetIndexContent(image) if err != nil { if goerrors.Is(errors.ErrRepoNotFound, err) { olu.Log.Error().Err(err).Msg("index.json doesn't exist") return nil, errors.ErrRepoNotFound } olu.Log.Error().Err(err).Msg("unable to open index.json") return nil, errors.ErrRepoNotFound } var index ispec.Index if err := json.Unmarshal(buf, &index); err != nil { olu.Log.Error().Err(err).Str("dir", path.Join(imageStore.RootDir(), image)).Msg("invalid JSON") return nil, errors.ErrRepoNotFound } return index.Manifests, nil } //nolint: interfacer func (olu BaseOciLayoutUtils) GetImageBlobManifest(imageDir string, digest godigest.Digest) (v1.Manifest, error) { var blobIndex v1.Manifest imageStore := olu.StoreController.GetImageStore(imageDir) blobBuf, err := imageStore.GetBlobContent(imageDir, digest.String()) if err != nil { olu.Log.Error().Err(err).Msg("unable to open image metadata file") return blobIndex, err } if err := json.Unmarshal(blobBuf, &blobIndex); err != nil { olu.Log.Error().Err(err).Msg("unable to marshal blob index") return blobIndex, err } return blobIndex, nil } //nolint: interfacer func (olu BaseOciLayoutUtils) GetImageInfo(imageDir string, hash v1.Hash) (ispec.Image, error) { var imageInfo ispec.Image imageStore := olu.StoreController.GetImageStore(imageDir) blobBuf, err := imageStore.GetBlobContent(imageDir, hash.String()) if err != nil { olu.Log.Error().Err(err).Msg("unable to open image layers file") return imageInfo, err } if err := json.Unmarshal(blobBuf, &imageInfo); err != nil { olu.Log.Error().Err(err).Msg("unable to marshal blob index") return imageInfo, err } return imageInfo, err } // GetImageTagsWithTimestamp returns a list of image tags with timestamp available in the specified repository. func (olu BaseOciLayoutUtils) GetImageTagsWithTimestamp(repo string) ([]TagInfo, error) { tagsInfo := make([]TagInfo, 0) manifests, err := olu.GetImageManifests(repo) if err != nil { olu.Log.Error().Err(err).Msg("unable to read image manifests") return tagsInfo, err } for _, manifest := range manifests { digest := manifest.Digest val, ok := manifest.Annotations[ispec.AnnotationRefName] if ok { imageBlobManifest, err := olu.GetImageBlobManifest(repo, digest) if err != nil { olu.Log.Error().Err(err).Msg("unable to read image blob manifest") return tagsInfo, err } imageInfo, err := olu.GetImageInfo(repo, imageBlobManifest.Config.Digest) if err != nil { olu.Log.Error().Err(err).Msg("unable to read image info") return tagsInfo, err } var timeStamp time.Time if len(imageInfo.History) != 0 { timeStamp = *imageInfo.History[0].Created } else { timeStamp = time.Time{} } tagsInfo = append(tagsInfo, TagInfo{Name: val, Timestamp: timeStamp, Digest: digest.String()}) } } return tagsInfo, nil } // check notary signature corresponding to repo name, manifest digest and mediatype. func (olu BaseOciLayoutUtils) checkNotarySignature(name string, digest godigest.Digest) bool { imageStore := olu.StoreController.GetImageStore(name) mediaType := notreg.ArtifactTypeNotation _, err := imageStore.GetReferrers(name, digest.String(), mediaType) if err != nil { olu.Log.Info().Err(err).Str("repo", name).Str("digest", digest.String()).Str("mediatype", mediaType).Msg("invalid notary signature") return false } return true } // check cosign signature corresponding to manifest. func (olu BaseOciLayoutUtils) checkCosignSignature(name string, digest godigest.Digest) bool { imageStore := olu.StoreController.GetImageStore(name) // if manifest is signed using cosign mechanism, cosign adds a new manifest. // new manifest is tagged as sha256-.sig. reference := fmt.Sprintf("sha256-%s.sig", digest.Encoded()) _, _, _, err := imageStore.GetImageManifest(name, reference) // nolint: dogsled if err != nil { olu.Log.Info().Err(err).Str("repo", name).Str("digest", digest.String()).Msg("invalid cosign signature") return false } return true } // checks if manifest is signed or not // checks for notary or cosign signature // if cosign signature found it does not looks for notary signature. func (olu BaseOciLayoutUtils) CheckManifestSignature(name string, digest godigest.Digest) bool { if !olu.checkCosignSignature(name, digest) { return olu.checkNotarySignature(name, digest) } return true } func (olu BaseOciLayoutUtils) GetImageLastUpdated(imageInfo ispec.Image) time.Time { var timeStamp time.Time if len(imageInfo.History) != 0 { timeStamp = *imageInfo.History[0].Created } else { timeStamp = time.Time{} } return timeStamp } func (olu BaseOciLayoutUtils) GetImagePlatform(imageConfig ispec.Image) ( string, string, ) { return imageConfig.OS, imageConfig.Architecture } func (olu BaseOciLayoutUtils) GetImageConfigInfo(repo string, manifestDigest godigest.Digest) (ispec.Image, error) { imageBlobManifest, err := olu.GetImageBlobManifest(repo, manifestDigest) if err != nil { return ispec.Image{}, err } imageInfo, err := olu.GetImageInfo(repo, imageBlobManifest.Config.Digest) if err != nil { return ispec.Image{}, err } return imageInfo, nil } func (olu BaseOciLayoutUtils) GetImageManifestSize(repo string, manifestDigest godigest.Digest) int64 { imageStore := olu.StoreController.GetImageStore(repo) manifestBlob, err := imageStore.GetBlobContent(repo, manifestDigest.String()) if err != nil { olu.Log.Error().Err(err).Msg("error when getting manifest blob content") return int64(len(manifestBlob)) } return int64(len(manifestBlob)) } func (olu BaseOciLayoutUtils) GetImageConfigSize(repo string, manifestDigest godigest.Digest) int64 { imageBlobManifest, err := olu.GetImageBlobManifest(repo, manifestDigest) if err != nil { olu.Log.Error().Err(err).Msg("can't get image blob manifest") return 0 } return imageBlobManifest.Config.Size } func (olu BaseOciLayoutUtils) GetRepoLastUpdated(repo string) (TagInfo, error) { tagsInfo, err := olu.GetImageTagsWithTimestamp(repo) if err != nil || len(tagsInfo) == 0 { return TagInfo{}, err } latestTag := GetLatestTag(tagsInfo) return latestTag, nil } func (olu BaseOciLayoutUtils) GetExpandedRepoInfo(name string) (RepoInfo, error) { repo := RepoInfo{} repoBlob2Size := make(map[string]int64, 10) // made up of all manifests, configs and image layers repoSize := int64(0) imageSummaries := make([]ImageSummary, 0) manifestList, err := olu.GetImageManifests(name) if err != nil { olu.Log.Error().Err(err).Msg("error getting image manifests") return RepoInfo{}, err } lastUpdatedTag, err := olu.GetRepoLastUpdated(name) if err != nil { olu.Log.Error().Err(err).Msgf("can't get last updated manifest for repo: %s", name) return RepoInfo{}, err } repoPlatforms := make([]OsArch, 0) repoVendors := make([]string, 0, len(manifestList)) var lastUpdatedImageSummary ImageSummary for _, man := range manifestList { imageLayersSize := int64(0) tag, ok := man.Annotations[ispec.AnnotationRefName] if !ok { olu.Log.Info().Msgf("skipping manifest with digest %s because it doesn't have a tag", string(man.Digest)) continue } manifest, err := olu.GetImageBlobManifest(name, man.Digest) if err != nil { olu.Log.Error().Err(err).Msg("error getting image manifest blob") return RepoInfo{}, err } isSigned := olu.CheckManifestSignature(name, man.Digest) manifestSize := olu.GetImageManifestSize(name, man.Digest) olu.Log.Debug().Msg(fmt.Sprintf("%v", man.Digest)) configSize := manifest.Config.Size repoBlob2Size[man.Digest.String()] = manifestSize repoBlob2Size[manifest.Config.Digest.Hex] = configSize imageConfigInfo, err := olu.GetImageConfigInfo(name, man.Digest) if err != nil { olu.Log.Error().Err(err).Msgf("can't retrieve config info for the image %s %s", name, man.Digest) continue } os, arch := olu.GetImagePlatform(imageConfigInfo) osArch := OsArch{ Os: os, Arch: arch, } repoPlatforms = append(repoPlatforms, osArch) layers := make([]Layer, 0) for _, layer := range manifest.Layers { layerInfo := Layer{} layerInfo.Digest = layer.Digest.Hex repoBlob2Size[layerInfo.Digest] = layer.Size layerInfo.Size = strconv.FormatInt(layer.Size, 10) imageLayersSize += layer.Size layers = append(layers, layerInfo) } imageSize := imageLayersSize + manifestSize + configSize // get image info from manifest annotation, if not found get from image config labels. annotations := GetAnnotations(manifest.Annotations, imageConfigInfo.Config.Labels) repoVendors = append(repoVendors, annotations.Vendor) size := strconv.Itoa(int(imageSize)) manifestDigest := man.Digest.Hex() configDigest := manifest.Config.Digest.Hex lastUpdated := olu.GetImageLastUpdated(imageConfigInfo) score := 0 imageSummary := ImageSummary{ RepoName: name, Tag: tag, LastUpdated: lastUpdated, Digest: manifestDigest, ConfigDigest: configDigest, IsSigned: isSigned, Size: size, Platform: osArch, Vendor: annotations.Vendor, Score: score, Description: annotations.Description, Title: annotations.Title, Documentation: annotations.Documentation, Licenses: annotations.Licenses, Labels: annotations.Labels, Source: annotations.Source, Layers: layers, } imageSummaries = append(imageSummaries, imageSummary) if man.Digest.String() == lastUpdatedTag.Digest { lastUpdatedImageSummary = imageSummary } } repo.ImageSummaries = imageSummaries for blob := range repoBlob2Size { repoSize += repoBlob2Size[blob] } size := strconv.FormatInt(repoSize, 10) summary := RepoSummary{ Name: name, LastUpdated: lastUpdatedTag.Timestamp, Size: size, Platforms: repoPlatforms, NewestImage: lastUpdatedImageSummary, Vendors: repoVendors, Score: -1, } repo.Summary = summary return repo, nil } func GetImageDirAndTag(imageName string) (string, string) { var imageDir string var imageTag string if strings.Contains(imageName, ":") { imageDir, imageTag, _ = strings.Cut(imageName, ":") } else { imageDir = imageName } return imageDir, imageTag }