feat(c): add license support for conan lock files #6329
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,152 @@ | ||
| package conan | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "context" | ||
| "io" | ||
| "io/fs" | ||
| "os" | ||
| "path" | ||
| "path/filepath" | ||
| "sort" | ||
| "strings" | ||
|
|
||
| "golang.org/x/xerrors" | ||
|
|
||
| "github.com/aquasecurity/trivy/pkg/dependency/parser/c/conan" | ||
| godeptypes "github.com/aquasecurity/trivy/pkg/dependency/types" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/analyzer/language" | ||
| "github.com/aquasecurity/trivy/pkg/fanal/types" | ||
| "github.com/aquasecurity/trivy/pkg/log" | ||
| "github.com/aquasecurity/trivy/pkg/utils/fsutils" | ||
| ) | ||
|
|
||
| func init() { | ||
| analyzer.RegisterPostAnalyzer(analyzer.TypeConanLock, newConanLockAnalyzer) | ||
| } | ||
|
|
||
| const ( | ||
| version = 2 | ||
| ) | ||
|
|
||
| // conanLockAnalyzer analyzes conan.lock | ||
| type conanLockAnalyzer struct { | ||
| logger *log.Logger | ||
| parser godeptypes.Parser | ||
| } | ||
|
|
||
| func newConanLockAnalyzer(_ analyzer.AnalyzerOptions) (analyzer.PostAnalyzer, error) { | ||
| return conanLockAnalyzer{ | ||
| logger: log.WithPrefix("conan"), | ||
| parser: conan.NewParser(), | ||
| }, nil | ||
| } | ||
|
|
||
| func (a conanLockAnalyzer) PostAnalyze(_ context.Context, input analyzer.PostAnalysisInput) (*analyzer.AnalysisResult, error) { | ||
| required := func(filePath string, d fs.DirEntry) bool { | ||
| return a.Required(filePath, nil) | ||
| } | ||
|
|
||
| licenses, err := licensesFromCache() | ||
| if err != nil { | ||
| a.logger.Debug("Unable to parse cache directory to obtain licenses", log.Err(err)) | ||
| } | ||
|
|
||
| var apps []types.Application | ||
| if err = fsutils.WalkDir(input.FS, ".", required, func(filePath string, _ fs.DirEntry, r io.Reader) error { | ||
| app, err := language.Parse(types.Conan, filePath, r, a.parser) | ||
| if err != nil { | ||
| return xerrors.Errorf("%s parse error: %w", filePath, err) | ||
| } | ||
|
|
||
| if app == nil { | ||
| return nil | ||
| } | ||
|
|
||
| // Fill licenses | ||
| for i, lib := range app.Libraries { | ||
| if license, ok := licenses[lib.Name]; ok { | ||
| app.Libraries[i].Licenses = []string{ | ||
| license, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| sort.Sort(app.Libraries) | ||
| apps = append(apps, *app) | ||
| return nil | ||
| }); err != nil { | ||
| return nil, xerrors.Errorf("unable to parse conan lock file: %w", err) | ||
| } | ||
|
|
||
| return &analyzer.AnalysisResult{ | ||
| Applications: apps, | ||
| }, nil | ||
| } | ||
|
|
||
| func licensesFromCache() (map[string]string, error) { | ||
| required := func(filePath string, d fs.DirEntry) bool { | ||
| return filepath.Base(filePath) == "conanfile.py" | ||
| } | ||
|
|
||
| // cf. https://docs.conan.io/1/mastering/custom_cache.html | ||
| cacheDir := os.Getenv("CONAN_USER_HOME") | ||
| if cacheDir == "" { | ||
| cacheDir, _ = os.UserHomeDir() | ||
| } | ||
| cacheDir = path.Join(cacheDir, ".conan", "data") | ||
|
|
||
| if !fsutils.DirExists(cacheDir) { | ||
| return nil, xerrors.Errorf("the Conan cache directory (%s) was not found.", cacheDir) | ||
| } | ||
|
|
||
| licenses := make(map[string]string) | ||
| if err := fsutils.WalkDir(os.DirFS(cacheDir), ".", required, func(filePath string, _ fs.DirEntry, r io.Reader) error { | ||
| scanner := bufio.NewScanner(r) | ||
| var name, license string | ||
| for scanner.Scan() { | ||
| line := strings.TrimSpace(scanner.Text()) | ||
|
|
||
| if strings.HasPrefix(line, "name") { // cf. https://docs.conan.io/1/reference/conanfile/attributes.html#name | ||
|
|
||
| // remove spaces before and after `=` (if used). e.g. `name = "openssl"` -> `name="openssl"` | ||
| name = strings.ReplaceAll(line, " ", "") | ||
| // trim extra characters - e.g. `name="openssl"` -> `openssl` | ||
| name = strings.TrimSuffix(strings.TrimPrefix(name, `name="`), `"`) | ||
| // Check that the license is already found | ||
| if license != "" { | ||
| break | ||
| } | ||
| } else if strings.HasPrefix(line, "license") { // cf. https://docs.conan.io/1/reference/conanfile/attributes.html#license | ||
|
There was a problem hiding this comment. It should be more strict. Otherwise, it matches other than the license line. That's why I suggested regexp this time. There was a problem hiding this comment. it looks like we can't avoid using regexp... There was a problem hiding this comment. If possible, I don't want to use regexp. I'm still considering a way to parse the license line without regexp, but... There was a problem hiding this comment. take a look this -https://go.dev/play/p/yWIioLCblQ9 |
||
| // remove spaces before and after `=` (if used). e.g. `license = "Apache-2.0"` -> `license="Apache-2.0"` | ||
| license = strings.ReplaceAll(line, " ", "") | ||
|
There was a problem hiding this comment. It introduces another bug with `license = "Apache or MIT". |
||
| // trim extra characters - e.g. `license = "Apache-2.0"` -> `Apache-2.0` | ||
| license = strings.TrimSuffix(strings.TrimPrefix(license, `license="`), `"`) | ||
| // Check that the name is already found | ||
| if name != "" { | ||
| break | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Skip files without name/license | ||
| if name == "" || license == "" { | ||
| return nil | ||
| } | ||
knqyf263 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| licenses[name] = license | ||
| return nil | ||
| }); err != nil { | ||
| return nil, xerrors.Errorf("the Conan cache dir (%s) walk error: %w", cacheDir, err) | ||
| } | ||
| return licenses, nil | ||
| } | ||
|
|
||
| func (a conanLockAnalyzer) Required(filePath string, _ os.FileInfo) bool { | ||
| // Lock file name can be anything | ||
| // cf. https://docs.conan.io/1/versioning/lockfiles/introduction.html#locking-dependencies | ||
| // By default, we only check the default filename - `conan.lock`. | ||
| return filepath.Base(filePath) == types.ConanLock | ||
| } | ||
|
|
||
| func (a conanLockAnalyzer) Type() analyzer.Type { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't
conanfile.txtused?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cache dir contains only
conanfile.pyfiles:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is
conanfile.pyrequired? I'm wondering if we just don't find a project usingconanfile.txtas most projects useconanfile.py. But we can handleconanfile.txtif we find such a case.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIUC only
conanfile.pycontains attributes - https://docs.conan.io/2/reference/conanfile_txt.html#conanfile-txtTherefore, we can't detect package name/license from
conanfile.txtfiles.Then we don't need to parse the conanfile.txt files.