This tool provides notification ability via Slack, the popular messaging application.
Installation
Installation of this tool has two steps.
Create the app and webhook in Slack. See documentation for steps.
Install peach2slack
pip install peachapisec-slack
Start using the tool
Syntax
- peach2slack
–api http://192.168.1.100 –api_token=xxxx –slack_webhook https://hooks.slack.com/services/xxxxx
All parameters can also be provided via environment variables. This is especially usefull for the Slack webhook url, which can then be stored in your CI secrets store.
Parameters
- api:
Peach API Security API URL. Defaults to PEACH_API environ.
- api_token:
Peach API Security API Token. Defaults to PEACH_API_TOKEN environ.
- slack_webhook:
Slack webhook URL. Defaults to PEACH_SLACK_WEBHOOK environ.
- msg:
[optional] Message template to post when no issues are found. Defaults to PEACH_MSG environ.
Defaults to: Security testing completed succesfully, no issues found after {{tests_count}} tests.
- failmsg:
[optional] Message template to post when issues are found. Defaults to PEACH_FAILMSG environ.
Defaults to: A total of {{failure_count}} failures from {{tests_count}} tests were found.
- errormsg:
[optional] Error message template to post when job did’t complete. Defaults to PEACH_ERRORMSG environ.
Defaults to: Error: {{reason}}
Message Template
A message template is provided using any of the following placeholders:
- {{failure_count}}:
Count of failured identified during job
- {{job_id}}:
Job Identifier (GUID)
- {{job_url}}:
Url to job details. Requires ‘baseurl’ be provided.
- {{job_tags}}:
Tags set on job
- {{project}}:
Project name
- {{reason}}:
Job completion reason. Succes or error message.
- {{tests_count}}:
Count of security tests performed during testing
1 maintainer
Metadata
1 maintainer
Release files for peachapisec-slack 1.5.41
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| peachapisec-slack-1.5.41.tar.gz | 3.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| peachapisec_slack-1.5.41-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 8.4 kB
Release files / peachapisec-slack-1.5.41.tar.gz
| Download URL | peachapisec-slack-1.5.41.tar.gz |
|---|---|
| Size | 3.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
89df1417a9fea1a42e80c7b0c0a49afd81bf2e511d9b5cb14661ad6762ea3ecb
|
|
BLAKE2b-256 checksum How to use checksums |
6a1fc261727abe707727a2ee0ac336030179eb87a71b7d0ea56143e65c25d00e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.15
|
Release files / peachapisec_slack-1.5.41-py2-none-any.whl
| Download URL | peachapisec_slack-1.5.41-py2-none-any.whl |
|---|---|
| Size | 4.5 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
f83fa91e67419eef575ecef21aa3dc724061bdd8b45456f91eaa03b0eb27f534
|
|
BLAKE2b-256 checksum How to use checksums |
a729f0a09bdcadf2b73d91e0092ed391ff698b2eae291ebc3d857cfc9024381a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.15
|
Security for peachapisec-slack 1.5.41
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.
