Skip to content

feat: #7482 offer ossindex credentials for maven #7631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

nhumblot
Copy link
Collaborator

@nhumblot nhumblot commented May 5, 2025

Description of Change

This PR is a draft. Identified things that must be checked before marking it as ready:

This PR aims to implement #7482 as expressed into the initial comment of the discussion.

Added change to the documentation as is:

Capture d’écran du 2025-05-05 20-33-33

Related issues

Have test cases been added to cover the new functionality?

yes/no: no as of now, but has to be implemented before marking the PR as ready.

@boring-cyborg boring-cyborg bot added documentation site documentation maven changes to the maven plugin labels May 5, 2025
@aikebah
Copy link
Collaborator

aikebah commented May 7, 2025

@nhumblot Your feature implemenation should include the environmentvariable option similar to how its done for the NVD API (which was unfortunately not added to the maven doc markdown (we should fix that) but is being documented in the standard maven plugin docs at https://dependency-check.github.io/DependencyCheck/dependency-check-maven/check-mojo.html#nvdApiKeyEnvironmentVariable

Specifying the environment variable name is a safer way to pass them than directly in the command-line (typically the env variable itself would be provided by setting it as a CI secret) given that maven will always log unmasked plaintexts on the mvn -X executions.

Configuring the ossIndexPassword property as an env variable reference would not help, as it would get interpolated by the shell and by the time maven logs it (in the -X-case) it would already be a plaintext password.

Wording for the ossIndexPassword should be similar to that of the ApiKey setting nudging the users to prefer either the settings.xml or the env variablename configuration option over specifying a password directly that is guaranteed to be exposed by mvn -X https://dependency-check.github.io/DependencyCheck/dependency-check-maven/check-mojo.html#nvdApiKey

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation site documentation maven changes to the maven plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Offer OSS Index user/pw for Maven
2 participants