[](https://www.mend.io/)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/whitesource-ps/whitesource-nexus-integration/releases/latest)
[](https://github.com/whitesource-ps/whitesource-nexus-integration/actions/workflows/ci.yml)
[](https://www.python.org/downloads/release/python-360/)
[](https://pypi.org/project/ws-nexus-integration/)
# [Mend for Nexus](https://github.com/whitesource-ps/ws-nexus-integration)
**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)
1. Install ws-nexus-integration: `pip install ws-nexus-integration`
2. Download and edit [_params.config_](https://github.com/whitesource-ps/ws-nexus-integration/blob/master/config/params.config)
3. 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 |
=================================================================================================
```
Raw data
{
"_id": null,
"home_page": "https://github.com/whitesource-ps/ws-nexus-integration",
"name": "ws-nexus-integration",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "WhiteSource Professional Services",
"author_email": "ps@whitesourcesoftware.com",
"download_url": "",
"platform": null,
"description": "[](https://www.mend.io/)\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://github.com/whitesource-ps/whitesource-nexus-integration/releases/latest)\n[](https://github.com/whitesource-ps/whitesource-nexus-integration/actions/workflows/ci.yml)\n[](https://www.python.org/downloads/release/python-360/)\n[](https://pypi.org/project/ws-nexus-integration/)\n\n# [Mend for Nexus](https://github.com/whitesource-ps/ws-nexus-integration)\n**ws-nexus-integration** is a command line tool to scan Nexus repositories. \nThis tool can be deployed either on the Nexus host or on a separate machine that has access to the Nexus instance.\nSupported formats: `maven2`, `npm`, `pypi`, `rubygems`, `nuget`, `docker` and `raw`.\n\n### Prerequisites\n- Nexus Repository Manager 3.x (any edition)\n- Java VM > 8\n- Docker\n- Python 3.8 or above\n\n## Install and utilization from PyPi (simplest)\n1. Install ws-nexus-integration: `pip install ws-nexus-integration`\n2. Download and edit [_params.config_](https://github.com/whitesource-ps/ws-nexus-integration/blob/master/config/params.config)\n3. Execute `ws_nexus_integration <path/to/params.config>`\n\n### Configuration Parameters\n```\n===================================================================================================================\n| Group | Parameter | Description |\n===================================================================================================================\n| Nexus Settings | NexusBaseUrl | Nexus instance base URL (Default: http://localhost:8081) |\n-------------------------------------------------------------------------------------------------------------------\n| Nexus Settings | NexusAuthToken | Nexus auth token (base64 encoded) |\n-------------------------------------------------------------------------------------------------------------------\n| Nexus Settings | NexusUser | Nexus username. Required if NexusAuthToken is not specified |\n-------------------------------------------------------------------------------------------------------------------\n| Nexus Settings | NexusPassword | Nexus password. Required if NexusAuthToken is not specified |\n-------------------------------------------------------------------------------------------------------------------\n| Nexus Settings | NexusRepositories | Comma-separated list of repository names to scan. |\n-------------------------------------------------------------------------------------------------------------------\n| General Settings | NexusExcludedRepos| Comma-separated list of repository names to excluded from scan. |\n| | itories | |\n-------------------------------------------------------------------------------------------------------------------\n| General Settings | NexusDockerRepos | In case of docker repository , |\n| | ImagesIncludes | Comma-separated regex list of images expressions to be included |\n-------------------------------------------------------------------------------------------------------------------\n| Nexus Settings | NexusAltDocker | Allow specifying specific registry URL (host:port) to download docker|\n| | RegistryAddress | images (i.e, when registry is under NAT due to Nexus K8S deployment).|\n===================================================================================================================\n| Mend Settings | WSApiKey | Mend API Key, can be found under the 'Integrate' tab in your |\n| | | Mend organization. |\n-------------------------------------------------------------------------------------------------------------------\n| Mend Settings | WSUserKey | Mend User Key, can be found under the 'user profile' tab in |\n| | | your Mend organization. |\n-------------------------------------------------------------------------------------------------------------------\n| Mend Settings | WSProductName | The Mend product that will aggregate all scanned repositories. |\n-------------------------------------------------------------------------------------------------------------------\n| Mend Settings | WSCheckPolicies | Whether to enable Mend policy check for scanned repositories. |\n-------------------------------------------------------------------------------------------------------------------\n| Mend Settings | WSLang | (Optional) allow passing a comma seperated list of suffices of |\n| | | artifacts to scan in Docker (default: empty). |\n-------------------------------------------------------------------------------------------------------------------\n| Mend Settings | WSUrl | Mend server URL, can be found under the 'Integrate' tab in |\n| | | your Mend organization. |\n===================================================================================================================\n-------------------------------------------------------------------------------------------------------------------\n| General Settings | ThreadCount | Multi-threading speeds up the scan preperation phase, but it depends |\n| | | on your environment capabilities (default: 5). |\n===================================================================================================================\n```\n\n### Exit Codes\n```\n=================================================================================================\n| Code | Message | Description |\n=================================================================================================\n| 0 | SUCCESS | |\n-------------------------------------------------------------------------------------------------\n| 1 | FAILED | Prerequisites, configuration or general errors |\n-------------------------------------------------------------------------------------------------\n| -1 | ERROR | Mend scan general error |\n-------------------------------------------------------------------------------------------------\n| -2 | POLICY_VIOLATION | Mend policy violation |\n-------------------------------------------------------------------------------------------------\n| -3 | CLIENT_FAILURE | Mend scan client side error |\n-------------------------------------------------------------------------------------------------\n| -4 | CONNECTION_FAILURE | Mend agent failed to connect to the application server. |\n-------------------------------------------------------------------------------------------------\n| -5 | SERVER_FAILURE | Mend scan server side error |\n=================================================================================================\n```\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "WS Nexus Integration",
"version": "24.2.1",
"project_urls": {
"Homepage": "https://github.com/whitesource-ps/ws-nexus-integration"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "692cdada580ce14b0f8a4a8aab4a3fe6e36fc489eef41028e0b350c16fcceea0",
"md5": "b4ca939dfc45037241767bffd764bdba",
"sha256": "866ee8f1e128e0a8ef44610f4b8bcdc92d235219b72357e7985306d5329c4640"
},
"downloads": -1,
"filename": "ws_nexus_integration-24.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4ca939dfc45037241767bffd764bdba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16837,
"upload_time": "2024-02-05T19:35:56",
"upload_time_iso_8601": "2024-02-05T19:35:56.759054Z",
"url": "https://files.pythonhosted.org/packages/69/2c/dada580ce14b0f8a4a8aab4a3fe6e36fc489eef41028e0b350c16fcceea0/ws_nexus_integration-24.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 19:35:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whitesource-ps",
"github_project": "ws-nexus-integration",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ws-nexus-integration"
}
JSON
