ws-bulk-report-generator


Namews-bulk-report-generator JSON
Version 24.1.1 PyPI version JSON
download
home_pagehttps://github.com/whitesource-ps/ws-bulk-report-generator
SummaryWS Bulk Report Generator
upload_time2024-01-09 21:31:43
maintainer
docs_urlNone
authorWhiteSource Professional Services
requires_python>=3.7
licenseLICENSE.txt
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![Logo](https://resources.mend.io/mend-sig/logo/mend-dark-logo-horizontal.png)](https://www.mend.io/)
[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://opensource.org/licenses/Apache-2.0)
[![CI](https://github.com/whitesource-ps/ws-bulk-report-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/whitesource-ps/ws-bulk-report-generator/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/ws-bulk-report-generator?style=plastic)](https://pypi.org/project/ws-bulk-report-generator/)
# [Mend Bulk Report Generator](https://github.com/whitesource-ps/ws-bulk-report-generator)
CLI Tool to generate reports on multiple products or projects.
* The tool allows including and excluding scopes by stating their tokens.
* Report scope (`-s, --ReportScope`) determines whether reports run on projects or products.
* If included scopes (via `-i, --includedTokens`) are not specified, the tool runs reports on **all** scopes.
* Report data exported by default in binary format (i.e., Excel or PDF) or JSON.
* Recommended using -o parameter for specifying output-dir. Otherwise, the output stored in the running dir (which is pip install cmd work with, and it depends on your OS)

## Supported Operating Systems
- **Linux (Bash):**	CentOS, Debian, Ubuntu, RedHat
- **Windows (PowerShell):**	10, 2012, 2016

## Prerequisites
* Python 3.6+

## Installation and Execution by pulling package from PyPi:
1. Execute `pip install ws-bulk-report-generator`
2. Run report: `ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -r <REPORT_NAME> -o <OUTPUT_PATH>`
>* *Note:  If installing packages as a non-root user, insure to include the path to the executables within the Operating System paths.*

## Examples:
Generate Due Diligence Reports (file per product) on all products within an organization in JSON format:  
`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r due_diligence -t json`

---

Generate Due Diligence Reports (file per project) on all projects within an organization in JSON format:  
`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -s project -r due_diligence -t json`

---

Generate Risk Reports (PDF format) on all products (file per product) within an organization:  
`ws_bulk_report_generator -a app-eu -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r risk`

---

Search for log4j 3 recent vulnerabilities in the entire organization and get output in a single unified JSON:  
`ws_bulk_report_generator -a di.whitesourcesoftware.com -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t unified_json -x vulnerability_names="CVE-2021-45046,CVE-2021-44228,CVE-2021-4104"`  
* *Note: The output produces only if the specified CVEs were discovered.*

---

Generate Inventory report filtered by 'libwebp-dev_0.6.1-2_amd64.deb' and get a unified JSON for the entire organization:  
`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r inventory -t unified_json -x lib_name=libwebp-dev_0.6.1-2_amd64.deb`

---

Generate Security Alerts report and get a unified JSON for all organizations within a Global organization (Note: user must be defined in each organization):  
`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r inventory -t unified_json -y globalOrganization`

---

Generate Vulnerability report and get a unified Excel report on 2 specific products in the organization (-s project means the API calls run on the project level behind the scenes, used when timeouts in the API response):  
`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t unified_xlsx -i "<PRODCUCT_TOKEN_1> , <PRODCUCT_TOKEN_2> -s project"`

---


>**NEW!** USING ASYNCHRONOUS API for large organizations.  
Supported reports: `inventory`, `vulnerability`, `alerts`, `plugin request history`

The TIMEOUT is 6 minutes, meaning it's checking for the report status READY for 6 min before moving to the next one. If it's not ready in 6 minutes, the tool logs the reportStatusId for manually checking the status (and downloading), and moves along. The timeout will be configurable in the following releases.

Generate Vulnerability report using asynchronous API calls in Excel format:  
`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t binary -c True`

---

Search for log4j 3 recent vulnerabilities in the entire organization using asynchronous API call and get output per each Product in JSON format:  
`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t json -x vulnerability_names="CVE-2021-45046,CVE-2021-44228,CVE-2021-4104" -c True`  
* *Note: The output produces only if the specified CVEs were discovered.* 

---

Generate Security Alerts report using asynchronous API calls in Excel format:  
`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r alerts -t binary -c True`

---

Generate Plugin Request history report using asynchronous API calls in Excel format (unlimited results):  
`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r request_history -t binary -c True -x plugin=True`

---

Generate Inventory report using asynchronous API calls in Excel format:  
`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r inventory -t binary -c True`

<br/>  

# Full Usage:
```shell
usage: ws_bulk_report_generator [-h] -u WS_USER_KEY -k WS_TOKEN [-y {organization,globalOrganization}] -r
                                {alerts,ignored_alerts,resolved_alerts,inventory,lib_dependencies,vulnerability,container_vulnerability,source_files,source_file_inventory,in_house_libraries,in_house,risk,library_location,license_compatibility,due_diligence,attributes,attribution,effective_licenses,bugs,request_history(-x plugin=true)}
                                [-t {unified_json,unified_xlsx,binary,json}] [-s {project,product}] [-a WS_URL] [-o DIR] [-x EXTRA_REPORT_ARGS] [-i INC_TOKENS] [-e EXC_TOKENS] [-c {True,False}]

Mend Bulk Reports Generator

optional arguments:
  -h, --help            show this help message and exit
  -u WS_USER_KEY, --userKey WS_USER_KEY
                        WS User Key
  -k WS_TOKEN, --token WS_TOKEN
                        WS Token
  -y {organization,globalOrganization}, --token_type 
                        WS Token Type
  -r {alerts,ignored_alerts,resolved_alerts,inventory,lib_dependencies,vulnerability,container_vulnerability,source_files,source_file_inventory,in_house_libraries,in_house,risk,library_location,license_compatibility,due_diligence,at
               tributes,attribution,effective_licenses,bugs,request_history}, --report 
                        Report Type to produce
  -t {unified_json,unified_xlsx,binary(i.e., Excel or PDF),json}, --outputType 
                        Type of output
  -s {project,product}, --ReportScope 
                        Scope of report
  -a WS_URL, --wsUrl WS_URL
                        WS URL
  -o DIR, --reportDir DIR
                        Report Dir
  -x EXTRA_REPORT_ARGS, --extraReportArguments EXTRA_REPORT_ARGS
                        Extra arguments (key=value) to pass the report
  -i INC_TOKENS, --includedTokens INC_TOKENS
                        Included token (Default: All)
  -e EXC_TOKENS, --excludedTokens EXC_TOKENS
                        Excluded token (Default: None)
  -c ASYNCR, --asynchronousCalls ASYNCR
                        Asynchronous API (Default: False)
```

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/whitesource-ps/ws-bulk-report-generator",
    "name": "ws-bulk-report-generator",
    "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": "[![Logo](https://resources.mend.io/mend-sig/logo/mend-dark-logo-horizontal.png)](https://www.mend.io/)\n[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg)](https://opensource.org/licenses/Apache-2.0)\n[![CI](https://github.com/whitesource-ps/ws-bulk-report-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/whitesource-ps/ws-bulk-report-generator/actions/workflows/ci.yml)\n[![PyPI](https://img.shields.io/pypi/v/ws-bulk-report-generator?style=plastic)](https://pypi.org/project/ws-bulk-report-generator/)\n# [Mend Bulk Report Generator](https://github.com/whitesource-ps/ws-bulk-report-generator)\nCLI Tool to generate reports on multiple products or projects.\n* The tool allows including and excluding scopes by stating their tokens.\n* Report scope (`-s, --ReportScope`) determines whether reports run on projects or products.\n* If included scopes (via `-i, --includedTokens`) are not specified, the tool runs reports on **all** scopes.\n* Report data exported by default in binary format (i.e., Excel or PDF) or JSON.\n* Recommended using -o parameter for specifying output-dir. Otherwise, the output stored in the running dir (which is pip install cmd work with, and it depends on your OS)\n\n## Supported Operating Systems\n- **Linux (Bash):**\tCentOS, Debian, Ubuntu, RedHat\n- **Windows (PowerShell):**\t10, 2012, 2016\n\n## Prerequisites\n* Python 3.6+\n\n## Installation and Execution by pulling package from PyPi:\n1. Execute `pip install ws-bulk-report-generator`\n2. Run report: `ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -r <REPORT_NAME> -o <OUTPUT_PATH>`\n>* *Note:  If installing packages as a non-root user, insure to include the path to the executables within the Operating System paths.*\n\n## Examples:\nGenerate Due Diligence Reports (file per product) on all products within an organization in JSON format:  \n`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r due_diligence -t json`\n\n---\n\nGenerate Due Diligence Reports (file per project) on all projects within an organization in JSON format:  \n`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -s project -r due_diligence -t json`\n\n---\n\nGenerate Risk Reports (PDF format) on all products (file per product) within an organization:  \n`ws_bulk_report_generator -a app-eu -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r risk`\n\n---\n\nSearch for log4j 3 recent vulnerabilities in the entire organization and get output in a single unified JSON:  \n`ws_bulk_report_generator -a di.whitesourcesoftware.com -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t unified_json -x vulnerability_names=\"CVE-2021-45046,CVE-2021-44228,CVE-2021-4104\"`  \n* *Note: The output produces only if the specified CVEs were discovered.*\n\n---\n\nGenerate Inventory report filtered by 'libwebp-dev_0.6.1-2_amd64.deb' and get a unified JSON for the entire organization:  \n`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r inventory -t unified_json -x lib_name=libwebp-dev_0.6.1-2_amd64.deb`\n\n---\n\nGenerate Security Alerts report and get a unified JSON for all organizations within a Global organization (Note: user must be defined in each organization):  \n`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r inventory -t unified_json -y globalOrganization`\n\n---\n\nGenerate Vulnerability report and get a unified Excel report on 2 specific products in the organization (-s project means the API calls run on the project level behind the scenes, used when timeouts in the API response):  \n`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t unified_xlsx -i \"<PRODCUCT_TOKEN_1> , <PRODCUCT_TOKEN_2> -s project\"`\n\n---\n\n\n>**NEW!** USING ASYNCHRONOUS API for large organizations.  \nSupported reports: `inventory`, `vulnerability`, `alerts`, `plugin request history`\n\nThe TIMEOUT is 6 minutes, meaning it's checking for the report status READY for 6 min before moving to the next one. If it's not ready in 6 minutes, the tool logs the reportStatusId for manually checking the status (and downloading), and moves along. The timeout will be configurable in the following releases.\n\nGenerate Vulnerability report using asynchronous API calls in Excel format:  \n`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t binary -c True`\n\n---\n\nSearch for log4j 3 recent vulnerabilities in the entire organization using asynchronous API call and get output per each Product in JSON format:  \n`ws_bulk_report_generator -u <USER_KEY> -k <ORG_TOKEN> -o <OUTPUT_PATH> -r vulnerability -t json -x vulnerability_names=\"CVE-2021-45046,CVE-2021-44228,CVE-2021-4104\" -c True`  \n* *Note: The output produces only if the specified CVEs were discovered.* \n\n---\n\nGenerate Security Alerts report using asynchronous API calls in Excel format:  \n`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r alerts -t binary -c True`\n\n---\n\nGenerate Plugin Request history report using asynchronous API calls in Excel format (unlimited results):  \n`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r request_history -t binary -c True -x plugin=True`\n\n---\n\nGenerate Inventory report using asynchronous API calls in Excel format:  \n`ws_bulk_report_generator -u <USER_KEY>  -k <ORG_TOKEN> -o <OUTPUT_PATH> -r inventory -t binary -c True`\n\n<br/>  \n\n# Full Usage:\n```shell\nusage: ws_bulk_report_generator [-h] -u WS_USER_KEY -k WS_TOKEN [-y {organization,globalOrganization}] -r\n                                {alerts,ignored_alerts,resolved_alerts,inventory,lib_dependencies,vulnerability,container_vulnerability,source_files,source_file_inventory,in_house_libraries,in_house,risk,library_location,license_compatibility,due_diligence,attributes,attribution,effective_licenses,bugs,request_history(-x plugin=true)}\n                                [-t {unified_json,unified_xlsx,binary,json}] [-s {project,product}] [-a WS_URL] [-o DIR] [-x EXTRA_REPORT_ARGS] [-i INC_TOKENS] [-e EXC_TOKENS] [-c {True,False}]\n\nMend Bulk Reports Generator\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -u WS_USER_KEY, --userKey WS_USER_KEY\n                        WS User Key\n  -k WS_TOKEN, --token WS_TOKEN\n                        WS Token\n  -y {organization,globalOrganization}, --token_type \n                        WS Token Type\n  -r {alerts,ignored_alerts,resolved_alerts,inventory,lib_dependencies,vulnerability,container_vulnerability,source_files,source_file_inventory,in_house_libraries,in_house,risk,library_location,license_compatibility,due_diligence,at\n               tributes,attribution,effective_licenses,bugs,request_history}, --report \n                        Report Type to produce\n  -t {unified_json,unified_xlsx,binary(i.e., Excel or PDF),json}, --outputType \n                        Type of output\n  -s {project,product}, --ReportScope \n                        Scope of report\n  -a WS_URL, --wsUrl WS_URL\n                        WS URL\n  -o DIR, --reportDir DIR\n                        Report Dir\n  -x EXTRA_REPORT_ARGS, --extraReportArguments EXTRA_REPORT_ARGS\n                        Extra arguments (key=value) to pass the report\n  -i INC_TOKENS, --includedTokens INC_TOKENS\n                        Included token (Default: All)\n  -e EXC_TOKENS, --excludedTokens EXC_TOKENS\n                        Excluded token (Default: None)\n  -c ASYNCR, --asynchronousCalls ASYNCR\n                        Asynchronous API (Default: False)\n```\n\n\n",
    "bugtrack_url": null,
    "license": "LICENSE.txt",
    "summary": "WS Bulk Report Generator",
    "version": "24.1.1",
    "project_urls": {
        "Homepage": "https://github.com/whitesource-ps/ws-bulk-report-generator"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d38de9c4800c3e8ac275d16b7cf90c17523daa3e57079d5c56e4caf8016fcfb",
                "md5": "a139b1e2644ebb789ecfea156df74b7e",
                "sha256": "da8d632c9f6cb3adf093eea13c808b0f98eb03730788867eca39b11b8ed6ace6"
            },
            "downloads": -1,
            "filename": "ws_bulk_report_generator-24.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a139b1e2644ebb789ecfea156df74b7e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 13180,
            "upload_time": "2024-01-09T21:31:43",
            "upload_time_iso_8601": "2024-01-09T21:31:43.281314Z",
            "url": "https://files.pythonhosted.org/packages/0d/38/de9c4800c3e8ac275d16b7cf90c17523daa3e57079d5c56e4caf8016fcfb/ws_bulk_report_generator-24.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-09 21:31:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "whitesource-ps",
    "github_project": "ws-bulk-report-generator",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ws-bulk-report-generator"
}
WhiteSource Professional Services
Elapsed time: 0.16569s