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 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: dast
  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.4.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

n0s1-1.0.4-py3-none-any.whl (35.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: n0s1-1.0.4.tar.gz
  • Upload date:
  • Size: 19.6 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.4.tar.gz
Algorithm Hash digest
SHA256 54e74640f7d4b9e244428d9a855d608400068be818e2b983ae9615a3e92c9b40
MD5 01c1fb06e3f3d9dbc9dd5b061c188056
BLAKE2b-256 e4fa038c994e0f9567bf755603927a7beeabbd44bfe944369d4c8edeccd5b001

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: n0s1-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 35.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 545b1cfd7e057ceceb25a1b591d7da15e3d7639dc0c0660fe6d3a3ef74077976
MD5 3ea1632201a9c2f1dfe11433d931e426
BLAKE2b-256 59f52e94e969d8c9bf83cb027cfcbba13c8b71d94641c3c3c4303f7a1ace4d0a

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