Skip to content

.env.markdown

Latest commit

 

History

History
78 lines (52 loc) · 2.96 KB

.env.markdown

File metadata and controls

78 lines (52 loc) · 2.96 KB
Raw

Environment file info

If you're running in production, you should set these securely.

However, if you just want to experiment, set the following values

Django Settings

These are all Django settings, defined in stixify/settings.py

  • DJANGO_SECRET: insecure_django_secret
  • DJANGO_DEBUG: True
  • DJANGO_ALLOWED_HOSTS: BLANK
  • DJANGO_CORS_ALLOW_ALL_ORIGINS: True
  • DJANGO_CORS_ALLOWED_ORIGINS: LEAVE EMPTY

Postgres Settings

These are all Django settings, defined in stixify/settings.py

  • POSTGRES_HOST: pgdb
  • POSTGRES_PORT: BLANK
  • POSTGRES_DB: postgres
  • POSTGRES_USER: postgres
  • POSTGRES_PASSWORD: postgres

Vulmatch API settings

These define how the API behaves.

  • MAX_PAGE_SIZE: 50
    • This is the maximum number of results the API will ever return before pagination
  • DEFAULT_PAGE_SIZE: 50
    • The default page size of result returned by the API
  • DOWNLOAD_TIMEOUT_SECONDS: 300
    • How long the server should wait before giving up downloading data from R2. Vulmatch will try 3 times when a download timeout happens, before giving up.

ArangoDB settings

Note, this code will not install an ArangoDB instance.

If you're new to ArangoDB, you can install the community edition quickly by following the instructions here.

The script will automatically create a database called vulmatch_database when the container is spun up (if it does not exist).

Vulmatch will create the following collections for the CVE data to be stored:

  • NVD CVE:
    • nvd_cve_vertex_collection
    • nvd_cve_edge_collection

The ArangoDB settings you need to configure are:

  • ARANGODB_HOST_URL: 'http://host.docker.internal:8529'
    • If you are running ArangoDB locally, be sure to set ARANGODB_HOST_URL : 'http://host.docker.internal:8529' in the .env file otherwise you will run into networking errors.
  • ARANGODB_USERNAME: root
    • Change this if neeed
  • ARANGODB_PASSWORD: USE PASSWORD OF ARANGODB_USERNAME

arango_cve_processor envs

Arango CTI Processor requires ctibutler to lookup ATT&CK, CAPEC, and CWE relationships.

  • CTIBUTLER_BASE_URL: 'http://api.ctibutler.com' (recommended)
    • If you are running CTI Butler locally, be sure to set 'http://host.docker.internal:8006/api/' in the .env file otherwise you will run into networking errors.
  • CTIBUTLER_API_KEY:
  • VULNCHECK_API_KEY
    • if using cve-vulncheck-kev mode you need to add your API key from VulnCheck. Generated here.

R2 PATHS

All of the knowledgebases are stored on Cloudflare R2. The variables in this part of the config should not be changed.

  • CVE2STIX_BUCKET_ROOT_PATH: https://cve2stix.vulmatch.com/