diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-checkmarxpythonsdk.spec | 571 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 573 insertions, 0 deletions
@@ -0,0 +1 @@ +/CheckmarxPythonSDK-0.7.3.tar.gz diff --git a/python-checkmarxpythonsdk.spec b/python-checkmarxpythonsdk.spec new file mode 100644 index 0000000..f74dabb --- /dev/null +++ b/python-checkmarxpythonsdk.spec @@ -0,0 +1,571 @@ +%global _empty_manifest_terminate_build 0 +Name: python-CheckmarxPythonSDK +Version: 0.7.3 +Release: 1 +Summary: Checkmarx Python SDK +License: GNU General Public License v3 (GPLv3) +URL: https://github.com/checkmarx-ts/checkmarx-python-sdk +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/df/72/1932128683ac103f108116cf910bb93f0e6ddd6adf7e270266ba4baa9187/CheckmarxPythonSDK-0.7.3.tar.gz +BuildArch: noarch + +Requires: python3-urllib3 +Requires: python3-requests +Requires: python3-requests-toolbelt +Requires: python3-zeep +Requires: python3-dateutil +Requires: python3-keyring +Requires: python3-Deprecated +Requires: python3-pytest +Requires: python3-coverage +Requires: python3-dotenv + +%description +# Checkmarx Python SDK + +This is wrapper using Python for CxSAST and CxOSA REST API, Portal SOAP API, CxSAST ODATA API, CxSCA REST API. + +By using this SDK, Checkmarx users will be able to do automatic scanning with CxSAST, CxOSA, and CxSCA. + +[](https://static.pepy.tech/badge/CheckmarxPythonSDK/month) +[](https://pypi.org/project/CheckmarxPythonSDK) +[](https://github.com/checkmarx-ts/checkmarx-python-sdk/graphs/contributors) + +# Checkmarx API Official Documents + +For more information about Checkmarx API, please refer to Checkmarx knowledge Center： + +- [CxSAST API Document](https://checkmarx.com/resource/documents/en/34965-46552-sast-api-guide.html) +- [CxOSA API Document](https://checkmarx.com/resource/documents/en/34965-46909-cxosa-api-guide.html) +- [Access Control API Document](https://checkmarx.com/resource/documents/en/34965-46622-access-control--rest--api--v1-5-and-up-.html) +- [CxSCA API Document](https://checkmarx.com/resource/documents/en/34965-19221-checkmarx-sca--rest--api-documentation.html) +- [CxOne API Document](https://checkmarx.com/resource/documents/en/34965-68772-checkmarx-one-api-documentation.html) +- [CxReporting API Document](https://checkmarx.com/resource/documents/en/34965-93162-apis.html) + +# Notice + +Please use Python3 + +# Quick Start + +## Install the library + +The easiest way to begin using the SDK is to install it using the **pip** command. + +``` +$ pip install CheckmarxPythonSDK +``` + +Alternatively, either download and unzip this repository, or clone it to your local drive, and install using the `setup.py` script. + +``` +$ git clone https://github.com/checkmarx-ts/checkmarx-python-sdk.git +$ python setup.py install +``` + +Even if you install the SDK using **pip**, you might still want to download or clone this repository for the sample scripts. + +## Set up configuration + +### Option 1, using config.ini file: +```buildoutcfg +[checkmarx] +base_url = http://localhost:80 +username = ****** +password = ****** +grant_type = password +scope = sast_rest_api +client_id = resource_owner_client +client_secret = 014DF517-39D1-4453-B7B3-9930C563627C +url = %(base_url)s/cxrestapi +scan_preset = Checkmarx Default +configuration = Default Configuration +team_full_name = /CxServer +max_try = 3 + +[CxSCA] +access_control_url = https://platform.checkmarx.net +server = https://api-sca.checkmarx.net +account = *** +username = *** +password = *** + +[CxOne] +access_control_url = https://iam.checkmarx.net +server = https://ast.checkmarx.net +tenant_name = *** +grant_type = refresh_token +client_id = ast-app +client_secret = *** +username = *** +password = *** +refresh_token = *** + +[CxReporting] +base_url = http://localhost +reporting_client_url = http://localhost:5001 +username = *** +password = *** +grant_type = password +scope = reporting_api +client_id = reporting_service_api +client_secret = 014DF517-39D1-4453-B7B3-9930C563627C +``` + +configuration file path: + +By default, Checkmarx Python SDK looks for `config.ini` or `config.json` file in a `.Checkmarx` folder in your home directory. +- For windows, it should be like `C:\\Users\\<UserName>\\.Checkmarx\\config.ini` +- For linux and MacOS, it should be like `/home/<UserName>/.Checkmarx/config.ini` + +You can also use `checkmarx_config_path` as environment variable or command line argument to set up configuration file path. + +For CxOne configuration, if you are going to use refresh_token grant type, you must use client id "ast-app", +refresh_token, ignore client_secret, username, password. If you are going to use client_credentials grant type, +you must create a client with roles such as ast-scanner, manage-webhook, queries-editor, ast-viewer, manage-application, +manage-project, then fill in your own client_id, client secret, username, password, ignore the refresh_token. + +### Option 2, using environment variables or command line arguments + +For CxSAST: + + - cxsast_base_url + - cxsast_username + - cxsast_password + - cxsast_grant_type + - cxsast_scope + - cxsast_client_id + - cxsast_client_secret + +For CxSCA: + + - cxsca_access_control_url + - cxsca_server + - cxsca_account + - cxsca_username + - cxsca_password + +For CxOne: + + - cxone_access_control_url + - cxone_server + - cxone_tenant_name + - cxone_grant_type + - cxone_client_id + - cxone_client_secret + - cxone_username + - cxone_password + - cxone_refresh_token + + For CxReporting + + - cxreporting_base_url + - cxreporting_reporting_client_url + - cxreporting_username + - cxreporting_password + - cxreporting_grant_type + - cxreporting_scope + - cxreporting_client_id + - cxreporting_client_secret + +# Debug Mode +You can use command line option `--cx_debug true` to enable debug mode. In debug mode, it will print out how to load the +configuration file and print every http request send out. + +# Examples + Please find example scripts from [examples folder](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/examples). + + +# API List + +- [CxOne_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxOne_REST_API_List.md) +- [CxSAST_and_CxOSA_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_and_CxOSA_REST_API_List.md) +- [CxSAST_ODATA_API](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_ODATA_API.md) +- [CxSAST_Portal_SOAP_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_Portal_SOAP_API_List.md) +- [CxSCA_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSCA_REST_API_List.md) +- [CxReporting_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/blob/master/docs/CxReporting_REST_API_List.md) + + +%package -n python3-CheckmarxPythonSDK +Summary: Checkmarx Python SDK +Provides: python-CheckmarxPythonSDK +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-CheckmarxPythonSDK +# Checkmarx Python SDK + +This is wrapper using Python for CxSAST and CxOSA REST API, Portal SOAP API, CxSAST ODATA API, CxSCA REST API. + +By using this SDK, Checkmarx users will be able to do automatic scanning with CxSAST, CxOSA, and CxSCA. + +[](https://static.pepy.tech/badge/CheckmarxPythonSDK/month) +[](https://pypi.org/project/CheckmarxPythonSDK) +[](https://github.com/checkmarx-ts/checkmarx-python-sdk/graphs/contributors) + +# Checkmarx API Official Documents + +For more information about Checkmarx API, please refer to Checkmarx knowledge Center： + +- [CxSAST API Document](https://checkmarx.com/resource/documents/en/34965-46552-sast-api-guide.html) +- [CxOSA API Document](https://checkmarx.com/resource/documents/en/34965-46909-cxosa-api-guide.html) +- [Access Control API Document](https://checkmarx.com/resource/documents/en/34965-46622-access-control--rest--api--v1-5-and-up-.html) +- [CxSCA API Document](https://checkmarx.com/resource/documents/en/34965-19221-checkmarx-sca--rest--api-documentation.html) +- [CxOne API Document](https://checkmarx.com/resource/documents/en/34965-68772-checkmarx-one-api-documentation.html) +- [CxReporting API Document](https://checkmarx.com/resource/documents/en/34965-93162-apis.html) + +# Notice + +Please use Python3 + +# Quick Start + +## Install the library + +The easiest way to begin using the SDK is to install it using the **pip** command. + +``` +$ pip install CheckmarxPythonSDK +``` + +Alternatively, either download and unzip this repository, or clone it to your local drive, and install using the `setup.py` script. + +``` +$ git clone https://github.com/checkmarx-ts/checkmarx-python-sdk.git +$ python setup.py install +``` + +Even if you install the SDK using **pip**, you might still want to download or clone this repository for the sample scripts. + +## Set up configuration + +### Option 1, using config.ini file: +```buildoutcfg +[checkmarx] +base_url = http://localhost:80 +username = ****** +password = ****** +grant_type = password +scope = sast_rest_api +client_id = resource_owner_client +client_secret = 014DF517-39D1-4453-B7B3-9930C563627C +url = %(base_url)s/cxrestapi +scan_preset = Checkmarx Default +configuration = Default Configuration +team_full_name = /CxServer +max_try = 3 + +[CxSCA] +access_control_url = https://platform.checkmarx.net +server = https://api-sca.checkmarx.net +account = *** +username = *** +password = *** + +[CxOne] +access_control_url = https://iam.checkmarx.net +server = https://ast.checkmarx.net +tenant_name = *** +grant_type = refresh_token +client_id = ast-app +client_secret = *** +username = *** +password = *** +refresh_token = *** + +[CxReporting] +base_url = http://localhost +reporting_client_url = http://localhost:5001 +username = *** +password = *** +grant_type = password +scope = reporting_api +client_id = reporting_service_api +client_secret = 014DF517-39D1-4453-B7B3-9930C563627C +``` + +configuration file path: + +By default, Checkmarx Python SDK looks for `config.ini` or `config.json` file in a `.Checkmarx` folder in your home directory. +- For windows, it should be like `C:\\Users\\<UserName>\\.Checkmarx\\config.ini` +- For linux and MacOS, it should be like `/home/<UserName>/.Checkmarx/config.ini` + +You can also use `checkmarx_config_path` as environment variable or command line argument to set up configuration file path. + +For CxOne configuration, if you are going to use refresh_token grant type, you must use client id "ast-app", +refresh_token, ignore client_secret, username, password. If you are going to use client_credentials grant type, +you must create a client with roles such as ast-scanner, manage-webhook, queries-editor, ast-viewer, manage-application, +manage-project, then fill in your own client_id, client secret, username, password, ignore the refresh_token. + +### Option 2, using environment variables or command line arguments + +For CxSAST: + + - cxsast_base_url + - cxsast_username + - cxsast_password + - cxsast_grant_type + - cxsast_scope + - cxsast_client_id + - cxsast_client_secret + +For CxSCA: + + - cxsca_access_control_url + - cxsca_server + - cxsca_account + - cxsca_username + - cxsca_password + +For CxOne: + + - cxone_access_control_url + - cxone_server + - cxone_tenant_name + - cxone_grant_type + - cxone_client_id + - cxone_client_secret + - cxone_username + - cxone_password + - cxone_refresh_token + + For CxReporting + + - cxreporting_base_url + - cxreporting_reporting_client_url + - cxreporting_username + - cxreporting_password + - cxreporting_grant_type + - cxreporting_scope + - cxreporting_client_id + - cxreporting_client_secret + +# Debug Mode +You can use command line option `--cx_debug true` to enable debug mode. In debug mode, it will print out how to load the +configuration file and print every http request send out. + +# Examples + Please find example scripts from [examples folder](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/examples). + + +# API List + +- [CxOne_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxOne_REST_API_List.md) +- [CxSAST_and_CxOSA_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_and_CxOSA_REST_API_List.md) +- [CxSAST_ODATA_API](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_ODATA_API.md) +- [CxSAST_Portal_SOAP_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_Portal_SOAP_API_List.md) +- [CxSCA_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSCA_REST_API_List.md) +- [CxReporting_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/blob/master/docs/CxReporting_REST_API_List.md) + + +%package help +Summary: Development documents and examples for CheckmarxPythonSDK +Provides: python3-CheckmarxPythonSDK-doc +%description help +# Checkmarx Python SDK + +This is wrapper using Python for CxSAST and CxOSA REST API, Portal SOAP API, CxSAST ODATA API, CxSCA REST API. + +By using this SDK, Checkmarx users will be able to do automatic scanning with CxSAST, CxOSA, and CxSCA. + +[](https://static.pepy.tech/badge/CheckmarxPythonSDK/month) +[](https://pypi.org/project/CheckmarxPythonSDK) +[](https://github.com/checkmarx-ts/checkmarx-python-sdk/graphs/contributors) + +# Checkmarx API Official Documents + +For more information about Checkmarx API, please refer to Checkmarx knowledge Center： + +- [CxSAST API Document](https://checkmarx.com/resource/documents/en/34965-46552-sast-api-guide.html) +- [CxOSA API Document](https://checkmarx.com/resource/documents/en/34965-46909-cxosa-api-guide.html) +- [Access Control API Document](https://checkmarx.com/resource/documents/en/34965-46622-access-control--rest--api--v1-5-and-up-.html) +- [CxSCA API Document](https://checkmarx.com/resource/documents/en/34965-19221-checkmarx-sca--rest--api-documentation.html) +- [CxOne API Document](https://checkmarx.com/resource/documents/en/34965-68772-checkmarx-one-api-documentation.html) +- [CxReporting API Document](https://checkmarx.com/resource/documents/en/34965-93162-apis.html) + +# Notice + +Please use Python3 + +# Quick Start + +## Install the library + +The easiest way to begin using the SDK is to install it using the **pip** command. + +``` +$ pip install CheckmarxPythonSDK +``` + +Alternatively, either download and unzip this repository, or clone it to your local drive, and install using the `setup.py` script. + +``` +$ git clone https://github.com/checkmarx-ts/checkmarx-python-sdk.git +$ python setup.py install +``` + +Even if you install the SDK using **pip**, you might still want to download or clone this repository for the sample scripts. + +## Set up configuration + +### Option 1, using config.ini file: +```buildoutcfg +[checkmarx] +base_url = http://localhost:80 +username = ****** +password = ****** +grant_type = password +scope = sast_rest_api +client_id = resource_owner_client +client_secret = 014DF517-39D1-4453-B7B3-9930C563627C +url = %(base_url)s/cxrestapi +scan_preset = Checkmarx Default +configuration = Default Configuration +team_full_name = /CxServer +max_try = 3 + +[CxSCA] +access_control_url = https://platform.checkmarx.net +server = https://api-sca.checkmarx.net +account = *** +username = *** +password = *** + +[CxOne] +access_control_url = https://iam.checkmarx.net +server = https://ast.checkmarx.net +tenant_name = *** +grant_type = refresh_token +client_id = ast-app +client_secret = *** +username = *** +password = *** +refresh_token = *** + +[CxReporting] +base_url = http://localhost +reporting_client_url = http://localhost:5001 +username = *** +password = *** +grant_type = password +scope = reporting_api +client_id = reporting_service_api +client_secret = 014DF517-39D1-4453-B7B3-9930C563627C +``` + +configuration file path: + +By default, Checkmarx Python SDK looks for `config.ini` or `config.json` file in a `.Checkmarx` folder in your home directory. +- For windows, it should be like `C:\\Users\\<UserName>\\.Checkmarx\\config.ini` +- For linux and MacOS, it should be like `/home/<UserName>/.Checkmarx/config.ini` + +You can also use `checkmarx_config_path` as environment variable or command line argument to set up configuration file path. + +For CxOne configuration, if you are going to use refresh_token grant type, you must use client id "ast-app", +refresh_token, ignore client_secret, username, password. If you are going to use client_credentials grant type, +you must create a client with roles such as ast-scanner, manage-webhook, queries-editor, ast-viewer, manage-application, +manage-project, then fill in your own client_id, client secret, username, password, ignore the refresh_token. + +### Option 2, using environment variables or command line arguments + +For CxSAST: + + - cxsast_base_url + - cxsast_username + - cxsast_password + - cxsast_grant_type + - cxsast_scope + - cxsast_client_id + - cxsast_client_secret + +For CxSCA: + + - cxsca_access_control_url + - cxsca_server + - cxsca_account + - cxsca_username + - cxsca_password + +For CxOne: + + - cxone_access_control_url + - cxone_server + - cxone_tenant_name + - cxone_grant_type + - cxone_client_id + - cxone_client_secret + - cxone_username + - cxone_password + - cxone_refresh_token + + For CxReporting + + - cxreporting_base_url + - cxreporting_reporting_client_url + - cxreporting_username + - cxreporting_password + - cxreporting_grant_type + - cxreporting_scope + - cxreporting_client_id + - cxreporting_client_secret + +# Debug Mode +You can use command line option `--cx_debug true` to enable debug mode. In debug mode, it will print out how to load the +configuration file and print every http request send out. + +# Examples + Please find example scripts from [examples folder](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/examples). + + +# API List + +- [CxOne_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxOne_REST_API_List.md) +- [CxSAST_and_CxOSA_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_and_CxOSA_REST_API_List.md) +- [CxSAST_ODATA_API](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_ODATA_API.md) +- [CxSAST_Portal_SOAP_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSAST_Portal_SOAP_API_List.md) +- [CxSCA_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/tree/master/docs/CxSCA_REST_API_List.md) +- [CxReporting_REST_API_List](https://github.com/checkmarx-ts/checkmarx-python-sdk/blob/master/docs/CxReporting_REST_API_List.md) + + +%prep +%autosetup -n CheckmarxPythonSDK-0.7.3 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-CheckmarxPythonSDK -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.3-1 +- Package Spec generated @@ -0,0 +1 @@ +b07da59a957a2dab3ddf97028a76b4f4 CheckmarxPythonSDK-0.7.3.tar.gz |