Skip to main content

n0s1 is a secret scanner for Project Management and Issue Tracker tools such as Jira and Linear.

Project description

n0s1 - Secret Scanner

n0s1 (pronunciation) is an open-source secret scanner designed for Project Management and Issue Tracker tools such as Jira, Confluence and Linear.app. It scans all tickets/items/issues within the chosen platform in search of any leaked secrets in the titles, bodies, and comments.

These secrets are identified by comparing them against an adaptable configuration file named regex.toml. The scanner specifically looks for sensitive information, which includes:

  • Github Personal Access Tokens
  • GitLab Personal Access Tokens
  • AWS Access Tokens
  • PKCS8 private keys
  • RSA private keys
  • SSH private keys
  • npm access tokens

Currently supported target platforms:

Quick Start

CLI:

python3 -m pip install n0s1
n0s1 jira_scan --server "https://<YOUR_JIRA_SERVER>.atlassian.net" --api-key "<YOUR_JIRA_API_TOKEN>"

Docker:

docker run spark1security/n0s1 jira_scan --server "https://<YOUR_JIRA_SERVER>.atlassian.net" --api-key "<YOUR_JIRA_API_TOKEN>"

From source:

git clone https://github.com/spark1security/n0s1.git
cd n0s1/src/n0s1
python3 -m venv n0s1_python
source n0s1_python/bin/activate
python3 -m pip install -r ../../requirements.txt
python3 n0s1.py jira_scan --server "https://<YOUR_JIRA_SERVER>.atlassian.net" --api-key "<YOUR_JIRA_API_TOKEN>"
deactivate

GitHub Actions:

jobs:
  jira_secret_scanning:
    steps:
      - uses: spark1security/n0s1-action@main
        env:
          JIRA_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
        with:
          scan-target: 'jira_scan'
          user-email: 'service_account@<YOUR_COMPANY>.atlassian.net'
          platform-url: 'https://<YOUR_COMPANY>.atlassian.net'

GitLab CI - Add the following job to your .gitlab-ci.yml file:

jira-scan:
  stage: test
  image:
    name: spark1security/n0s1
    entrypoint: [""]
  script:
    - n0s1 jira_scan --email "service_account@<YOUR_COMPANY>.atlassian.net" --api-key $JIRA_TOKEN --server "https://<YOUR_COMPANY>.atlassian.net" --report-file gl-dast-report.json --report-format gitlab
    - apt-get update
    - apt-get -y install jq
    - cat gl-dast-report.json | jq
  artifacts:
    reports:
      dast:
        - gl-dast-report.json

Want more? Check out Spark 1

If you liked n0s1, you will love Spark 1 which builds on top of n0s1 to provide even more enhanced capabilities for a complete security management offering.

Don't forget to check out the https://spark1.us website for more information about our products and services.

If you'd like to contact Spark 1 or request a demo, please use the free consultation form.

Community

n0s1 is a Spark 1 open source project.
Learn about our open source work and portfolio here.
Contact us about any matter by opening a GitHub Discussion here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

n0s1-1.0.9.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

n0s1-1.0.9-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

Details for the file n0s1-1.0.9.tar.gz.

File metadata

  • Download URL: n0s1-1.0.9.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.4

File hashes

Hashes for n0s1-1.0.9.tar.gz
Algorithm Hash digest
SHA256 2514346122e2a64cda67c751383a34275bfe3f76242224f6770bbb1b123bcbee
MD5 aaa7751462034cd1c1d914194c4f3e37
BLAKE2b-256 d1a29ab0343a8df66daba5f81b9760f5bfbc700facaec892f79a4d1ace8fb184

See more details on using hashes here.

Provenance

File details

Details for the file n0s1-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: n0s1-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 40.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.4

File hashes

Hashes for n0s1-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 193211f6402c13cf3c368649c62b07a084170128931d00ed3028abd8fb7aa91c
MD5 fa6104e14c0a9a4a6551521fa3cd2cac
BLAKE2b-256 860ebedd809fa2a2523a37cf3cefe56d99d91740648f607683705daa3cba37cc

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page