Mend for Nexus
ws-nexus-integration is a command line tool to scan Nexus repositories.
This tool can be deployed either on the Nexus host or on a separate machine that has access to the Nexus instance.
Supported formats: maven2, npm, pypi, rubygems, nuget, docker and raw.
Prerequisites
- Nexus Repository Manager 3.x (any edition)
- Java VM > 8
- Docker
- Python 3.8 or above
Install and utilization from PyPi (simplest)
- Install ws-nexus-integration:
pip install ws-nexus-integration - Download and edit params.config
- Execute
ws_nexus_integration <path/to/params.config>
Configuration Parameters
===================================================================================================================
| Group | Parameter | Description |
===================================================================================================================
| Nexus Settings | NexusBaseUrl | Nexus instance base URL (Default: http://localhost:8081) |
-------------------------------------------------------------------------------------------------------------------
| Nexus Settings | NexusAuthToken | Nexus auth token (base64 encoded) |
-------------------------------------------------------------------------------------------------------------------
| Nexus Settings | NexusUser | Nexus username. Required if NexusAuthToken is not specified |
-------------------------------------------------------------------------------------------------------------------
| Nexus Settings | NexusPassword | Nexus password. Required if NexusAuthToken is not specified |
-------------------------------------------------------------------------------------------------------------------
| Nexus Settings | NexusRepositories | Comma-separated list of repository names to scan. |
-------------------------------------------------------------------------------------------------------------------
| General Settings | NexusExcludedRepos| Comma-separated list of repository names to excluded from scan. |
| | itories | |
-------------------------------------------------------------------------------------------------------------------
| General Settings | NexusDockerRepos | In case of docker repository , |
| | ImagesIncludes | Comma-separated regex list of images expressions to be included |
-------------------------------------------------------------------------------------------------------------------
| Nexus Settings | NexusAltDocker | Allow specifying specific registry URL (host:port) to download docker|
| | RegistryAddress | images (i.e, when registry is under NAT due to Nexus K8S deployment).|
===================================================================================================================
| Mend Settings | WSApiKey | Mend API Key, can be found under the 'Integrate' tab in your |
| | | Mend organization. |
-------------------------------------------------------------------------------------------------------------------
| Mend Settings | WSUserKey | Mend User Key, can be found under the 'user profile' tab in |
| | | your Mend organization. |
-------------------------------------------------------------------------------------------------------------------
| Mend Settings | WSProductName | The Mend product that will aggregate all scanned repositories. |
-------------------------------------------------------------------------------------------------------------------
| Mend Settings | WSCheckPolicies | Whether to enable Mend policy check for scanned repositories. |
-------------------------------------------------------------------------------------------------------------------
| Mend Settings | WSLang | (Optional) allow passing a comma seperated list of suffices of |
| | | artifacts to scan in Docker (default: empty). |
-------------------------------------------------------------------------------------------------------------------
| Mend Settings | WSUrl | Mend server URL, can be found under the 'Integrate' tab in |
| | | your Mend organization. |
===================================================================================================================
-------------------------------------------------------------------------------------------------------------------
| General Settings | ThreadCount | Multi-threading speeds up the scan preperation phase, but it depends |
| | | on your environment capabilities (default: 5). |
===================================================================================================================
Exit Codes
=================================================================================================
| Code | Message | Description |
=================================================================================================
| 0 | SUCCESS | |
-------------------------------------------------------------------------------------------------
| 1 | FAILED | Prerequisites, configuration or general errors |
-------------------------------------------------------------------------------------------------
| -1 | ERROR | Mend scan general error |
-------------------------------------------------------------------------------------------------
| -2 | POLICY_VIOLATION | Mend policy violation |
-------------------------------------------------------------------------------------------------
| -3 | CLIENT_FAILURE | Mend scan client side error |
-------------------------------------------------------------------------------------------------
| -4 | CONNECTION_FAILURE | Mend agent failed to connect to the application server. |
-------------------------------------------------------------------------------------------------
| -5 | SERVER_FAILURE | Mend scan server side error |
=================================================================================================
2 maintainers
Metadata
2 maintainers
Release files for ws-nexus-integration 24.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ws_nexus_integration-24.2.1-py3-none-any.whl | Python 3 | none | any | Details for ws_nexus_integration-24.2.1-py3-none-any.whl |
Release files / ws_nexus_integration-24.2.1-py3-none-any.whl
| Download URL | ws_nexus_integration-24.2.1-py3-none-any.whl |
|---|---|
| Size | 16.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
866ee8f1e128e0a8ef44610f4b8bcdc92d235219b72357e7985306d5329c4640
|
|
BLAKE2b-256 checksum How to use checksums |
692cdada580ce14b0f8a4a8aab4a3fe6e36fc489eef41028e0b350c16fcceea0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for ws-nexus-integration 24.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
