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: 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.8.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

n0s1-1.0.8-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: n0s1-1.0.8.tar.gz
  • Upload date:
  • Size: 21.2 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.8.tar.gz
Algorithm Hash digest
SHA256 b86f3347fbe7c5f2e7d6b5aeb3709033d37a36f1c780beeffff74fba5075e9f1
MD5 ccfd10ea4f3451c52e4963e63fc12382
BLAKE2b-256 57f477aad5313e5bf8b691ba5833c80954d09b06ceaa41f483dc325f678e813c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: n0s1-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 37.8 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 8a25c477f2e4c20007c3d64d29130b9798dd98d48a8c145fa9c91dd979286912
MD5 5b5fd14a1c808b810b19008b31cacd9f
BLAKE2b-256 55587c7c759fdca3bae1203bb2ad5dad2cd08c8f1425a61186d4f274f5b92e51

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