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
|
package pom
import (
"encoding/xml"
"fmt"
"io"
"net/http"
"net/url"
"os"
"path"
"path/filepath"
"strings"
multierror "github.com/hashicorp/go-multierror"
"golang.org/x/net/html/charset"
"golang.org/x/xerrors"
"github.com/aquasecurity/go-dep-parser/pkg/log"
"github.com/aquasecurity/go-dep-parser/pkg/types"
"github.com/aquasecurity/go-dep-parser/pkg/utils"
)
const (
centralURL = "https://repo.maven.apache.org/maven2/"
)
type options struct {
offline bool
remoteRepos []string
}
type option func(*options)
func WithOffline(offline bool) option {
return func(opts *options) {
opts.offline = offline
}
}
func WithRemoteRepos(repos []string) option {
return func(opts *options) {
opts.remoteRepos = repos
}
}
type parser struct {
rootPath string
cache pomCache
localRepository string
remoteRepositories []string
offline bool
}
func NewParser(filePath string, opts ...option) *parser {
o := &options{
offline: false,
remoteRepos: []string{centralURL},
}
for _, opt := range opts {
opt(o)
}
s := readSettings()
localRepository := s.LocalRepository
if localRepository == "" {
homeDir, _ := os.UserHomeDir()
localRepository = filepath.Join(homeDir, ".m2", "repository")
}
return &parser{
rootPath: filepath.Clean(filePath),
cache: newPOMCache(),
localRepository: localRepository,
remoteRepositories: o.remoteRepos,
offline: o.offline,
}
}
func (p *parser) Parse(r io.Reader) ([]types.Library, error) {
content, err := parsePom(r)
if err != nil {
return nil, xerrors.Errorf("failed to parse POM: %w", err)
}
root := &pom{
filePath: p.rootPath,
content: content,
}
// Analyze root POM
result, err := p.analyze(root, nil)
if err != nil {
return nil, xerrors.Errorf("analyze error (%s): %w", p.rootPath, err)
}
// Cache root POM
p.cache.put(result.artifact, result)
return p.parseRoot(root.artifact())
}
func (p *parser) parseRoot(root artifact) ([]types.Library, error) {
// Prepare a queue for dependencies
queue := newArtifactQueue()
// Enqueue root POM
root.Module = false
queue.enqueue(root)
var libs []types.Library
uniqArtifacts := map[string]version{}
// Iterate direct and transitive dependencies
for !queue.IsEmpty() {
art := queue.dequeue()
// Modules should be handled separately so that they can have independent dependencies.
// It means multi-module allows for duplicate dependencies.
if art.Module {
moduleLibs, err := p.parseRoot(art)
if err != nil {
return nil, err
}
libs = append(libs, moduleLibs...)
continue
}
// For soft requirements, skip dependency resolution that has already been resolved.
if v, ok := uniqArtifacts[art.Name()]; ok {
if !v.shouldOverride(art.Version) {
continue
}
}
result, err := p.resolve(art)
if err != nil {
return nil, xerrors.Errorf("resolve error (%s): %w", art, err)
}
// Parse, cache, and enqueue modules.
for _, relativePath := range result.modules {
moduleArtifact, err := p.parseModule(result.filePath, relativePath)
if err != nil {
return nil, xerrors.Errorf("module error (%s): %w", relativePath, err)
}
queue.enqueue(moduleArtifact)
}
// Resolve transitive dependencies later
queue.enqueue(result.dependencies...)
// Offline mode may be missing some fields.
if !art.IsEmpty() {
// Override the version
uniqArtifacts[art.Name()] = art.Version
}
}
// Convert to []types.Library
for name, ver := range uniqArtifacts {
libs = append(libs, types.Library{
Name: name,
Version: ver.String(),
})
}
return libs, nil
}
func (p *parser) parseModule(currentPath, relativePath string) (artifact, error) {
// modulePath: "root/" + "module/" => "root/module"
module, err := p.openRelativePom(currentPath, relativePath)
if err != nil {
return artifact{}, xerrors.Errorf("unable to open the relative path: %w", err)
}
result, err := p.analyze(module, nil)
if err != nil {
return artifact{}, xerrors.Errorf("analyze error: %w", err)
}
moduleArtifact := module.artifact()
moduleArtifact.Module = true
p.cache.put(moduleArtifact, result)
return moduleArtifact, nil
}
func (p *parser) resolve(art artifact) (analysisResult, error) {
// If the artifact is found in cache, it is returned.
if result := p.cache.get(art); result != nil {
return *result, nil
}
log.Logger.Debugf("Resolving %s:%s:%s...", art.GroupID, art.ArtifactID, art.Version)
pomContent, err := p.tryRepository(art.GroupID, art.ArtifactID, art.Version.String())
if err != nil {
log.Logger.Debug(err)
}
result, err := p.analyze(pomContent, art.Exclusions)
if err != nil {
return analysisResult{}, xerrors.Errorf("analyze error: %w", err)
}
p.cache.put(art, result)
return result, nil
}
type analysisResult struct {
filePath string
artifact artifact
dependencies []artifact
dependencyManagement map[string]pomDependency
properties map[string]string
modules []string
}
func (p *parser) analyze(pom *pom, exclusions map[string]struct{}) (analysisResult, error) {
if pom == nil || pom.content == nil {
return analysisResult{}, nil
}
// Update remoteRepositories
p.remoteRepositories = utils.UniqueStrings(append(p.remoteRepositories, pom.repositories()...))
// Parent
parent, err := p.parseParent(pom.filePath, pom.content.Parent)
if err != nil {
return analysisResult{}, xerrors.Errorf("parent error: %w", err)
}
// Inherit values/properties from parent
pom.inherit(parent)
// Generate properties
props := pom.properties()
// Extract and merge dependencies under "dependencyManagement"
depManagement := p.dependencyManagement(pom.content.DependencyManagement.Dependencies.Dependency, props)
depManagement = p.mergeDependencyManagement(parent.dependencyManagement, depManagement)
// Merge dependencies. Child dependencies must be preferred than parent dependencies.
deps := p.parseDependencies(pom.content.Dependencies.Dependency, props, depManagement, exclusions)
deps = p.mergeDependencies(parent.dependencies, deps, exclusions)
return analysisResult{
filePath: pom.filePath,
artifact: pom.artifact(),
dependencies: deps,
dependencyManagement: depManagement,
properties: props,
modules: pom.content.Modules.Module,
}, nil
}
func (p parser) dependencyManagement(deps []pomDependency, props properties) map[string]pomDependency {
depManagement := map[string]pomDependency{}
for _, d := range deps {
// Evaluate variables
d = d.Resolve(props, nil)
// https://howtodoinjava.com/maven/maven-dependency-scopes/#import
if d.Scope == "import" {
art := newArtifact(d.GroupID, d.ArtifactID, d.Version, props)
result, err := p.resolve(art)
if err == nil {
depManagement = p.mergeDependencyManagement(depManagement, result.dependencyManagement)
}
continue
}
depManagement[d.Name()] = d
}
return depManagement
}
func (p parser) mergeDependencyManagement(a, b map[string]pomDependency) map[string]pomDependency {
if a == nil {
return b
}
for key, value := range b {
a[key] = value
}
return a
}
func (p parser) parseDependencies(deps []pomDependency, props map[string]string, depManagement map[string]pomDependency,
exclusions map[string]struct{}) []artifact {
var dependencies []artifact
for _, d := range deps {
// Resolve dependencies
d = d.Resolve(props, depManagement)
if (d.Scope != "" && d.Scope != "compile") || d.Optional {
continue
}
dependencies = append(dependencies, d.ToArtifact(exclusions))
}
return dependencies
}
func (p parser) mergeDependencies(parent, child []artifact, exclusions map[string]struct{}) []artifact {
unique := map[string]artifact{}
for _, d := range child {
if _, ok := exclusions[d.Name()]; ok {
continue
}
unique[d.Name()] = d
}
for _, d := range parent {
if _, ok := exclusions[d.Name()]; ok {
continue
}
if _, ok := unique[d.Name()]; !ok {
unique[d.Name()] = d
}
}
var deps []artifact
for _, d := range unique {
deps = append(deps, d)
}
return deps
}
func (p parser) parseParent(currentPath string, parent pomParent) (analysisResult, error) {
// Pass nil properties so that variables in <parent> are not evaluated.
target := newArtifact(parent.GroupId, parent.ArtifactId, parent.Version, nil)
if target.IsEmpty() {
return analysisResult{}, nil
}
// If the artifact is found in cache, it is returned.
if result := p.cache.get(target); result != nil {
return *result, nil
}
parentPOM, err := p.retrieveParent(currentPath, parent.RelativePath, target)
if err != nil {
log.Logger.Debugf("parent POM not found: %s", err)
}
result, err := p.analyze(parentPOM, nil)
if err != nil {
return analysisResult{}, xerrors.Errorf("analyze error: %w", err)
}
p.cache.put(target, result)
return result, nil
}
func (p parser) retrieveParent(currentPath, relativePath string, target artifact) (*pom, error) {
var errs error
// Try relativePath
if relativePath != "" {
pom, err := p.tryRelativePath(target, currentPath, relativePath)
if err != nil {
errs = multierror.Append(errs, err)
} else {
return pom, nil
}
}
// If not found, search the parent director
pom, err := p.tryRelativePath(target, currentPath, "../pom.xml")
if err != nil {
errs = multierror.Append(errs, err)
} else {
return pom, nil
}
// If not found, search local/remote remoteRepositories
pom, err = p.tryRepository(target.GroupID, target.ArtifactID, target.Version.String())
if err != nil {
errs = multierror.Append(errs, err)
} else {
return pom, nil
}
// Reaching here means the POM wasn't found
return nil, errs
}
func (p parser) tryRelativePath(parentArtifact artifact, currentPath, relativePath string) (*pom, error) {
pom, err := p.openRelativePom(currentPath, relativePath)
if err != nil {
return nil, err
}
result, err := p.analyze(pom, nil)
if err != nil {
return nil, xerrors.Errorf("analyze error: %w", err)
}
if !parentArtifact.Equal(result.artifact) {
return nil, xerrors.New("'parent.relativePath' points at wrong local POM")
}
return pom, nil
}
func (p parser) openRelativePom(currentPath, relativePath string) (*pom, error) {
// e.g. child/pom.xml => child/
dir := filepath.Dir(currentPath)
// e.g. child + ../parent => parent/
filePath := filepath.Join(dir, relativePath)
isDir, err := isDirectory(filePath)
if err != nil {
return nil, err
} else if isDir {
// e.g. parent/ => parent/pom.xml
filePath = filepath.Join(filePath, "pom.xml")
}
pom, err := p.openPom(filePath)
if err != nil {
return nil, xerrors.Errorf("failed to open %s: %w", filePath, err)
}
return pom, nil
}
func (p parser) openPom(filePath string) (*pom, error) {
f, err := os.Open(filePath)
if err != nil {
return nil, xerrors.Errorf("file open error (%s): %w", filePath, err)
}
content, err := parsePom(f)
if err != nil {
return nil, xerrors.Errorf("failed to parse the local POM: %w", err)
}
return &pom{
filePath: filePath,
content: content,
}, nil
}
func (p parser) tryRepository(groupID, artifactID, version string) (*pom, error) {
// Generate a proper path to the pom.xml
// e.g. com.fasterxml.jackson.core, jackson-annotations, 2.10.0
// => com/fasterxml/jackson/core/jackson-annotations/2.10.0/jackson-annotations-2.10.0.pom
paths := strings.Split(groupID, ".")
paths = append(paths, artifactID, version)
paths = append(paths, fmt.Sprintf("%s-%s.pom", artifactID, version))
// Search local remoteRepositories
loaded, err := p.loadPOMFromLocalRepository(paths)
if err == nil {
return loaded, nil
}
// Search remote remoteRepositories
loaded, err = p.fetchPOMFromRemoteRepository(paths)
if err == nil {
return loaded, nil
}
return nil, xerrors.Errorf("%s:%s:%s was not found in local/remote repositories", groupID, artifactID, version)
}
func (p parser) loadPOMFromLocalRepository(paths []string) (*pom, error) {
paths = append([]string{p.localRepository}, paths...)
localPath := filepath.Join(paths...)
return p.openPom(localPath)
}
func (p parser) fetchPOMFromRemoteRepository(paths []string) (*pom, error) {
// Do not try fetching pom.xml from remote repositories in offline mode
if p.offline {
log.Logger.Debug("Fetching the remote pom.xml is skipped")
return nil, xerrors.New("offline mode")
}
// try all remoteRepositories
for _, repo := range p.remoteRepositories {
repoURL, err := url.Parse(repo)
if err != nil {
continue
}
paths = append([]string{repoURL.Path}, paths...)
repoURL.Path = path.Join(paths...)
resp, err := http.Get(repoURL.String())
if err != nil || resp.StatusCode != http.StatusOK {
continue
}
content, err := parsePom(resp.Body)
if err != nil {
return nil, xerrors.Errorf("failed to parse the remote POM: %w", err)
}
return &pom{
filePath: "", // from remote repositories
content: content,
}, nil
}
return nil, xerrors.Errorf("the POM was not found in remote remoteRepositories")
}
func parsePom(r io.Reader) (*pomXML, error) {
parsed := &pomXML{}
decoder := xml.NewDecoder(r)
decoder.CharsetReader = charset.NewReaderLabel
if err := decoder.Decode(parsed); err != nil {
return nil, xerrors.Errorf("xml decode error: %w", err)
}
return parsed, nil
}
|