Skip to content

development.md

Latest commit

 

History

History
129 lines (87 loc) · 3.32 KB

development.md

File metadata and controls

129 lines (87 loc) · 3.32 KB
Raw

Development Guide

Rust

If you haven't already, get started with Rust.

See CONVENTIONS.md for coding standards, linting, and pre-commit workflow.

macOS: Shared Memory Limits

Concurrent Postgres instances during testing can exhaust shared memory on macOS. Adjusting shared memory is not straightforward — use this guide.

PostgreSQL

Unit tests and "PM mode" use an embedded Postgres instance installed automatically on the local filesystem. You can also use an external database.

Starting a containerized instance

podman-compose -f etc/deploy/compose/compose.yaml up

Connecting via psql

env PGPASSWORD=trustify psql -U postgres -d trustify -h localhost -p 5432

If psql is not available locally:

podman-compose -f etc/deploy/compose/compose.yaml exec postgres psql -U postgres -d trustify

Pointing the app at an external database

RUST_LOG=info cargo run --bin trustd api --db-password trustify --devmode --auth-disabled

Run cargo run --bin trustd api --help for all database options.

Authentication

By default, authentication is enabled. For development, you have two options:

  • Disable auth: --auth-disabled flag or AUTH_DISABLED=true env var
  • Dev mode: --devmode uses the Keycloak instance from the compose deployment

For full OIDC setup, see oidc.md.

Using bearer tokens

HTTP requests must provide a bearer token via the Authorization header. You can use the oidc-cli tool:

cargo install oidc-cli

Set up the client (re-run when Keycloak is re-created):

oidc create confidential trusty \
  --issuer http://localhost:8090/realms/trustify \
  --client-id walker \
  --client-secret ZVzq9AMOVUdMY1lSohpx1jI3aW56QDPS

Make authenticated requests:

curl -H "Authorization: Bearer $(oidc token trusty -b)" \
  http://localhost:8080/purl/asdf/dependencies

Repository Organization

Sources

Directory Purpose
common Shared model types used across modules
entity Database entity models (SeaORM)
migration SeaORM DDL migrations
modules Primary application behavior
server REST API server
trustd Server CLI binary

Supporting files

Directory Purpose
etc/test-data Test data for unit tests
etc/datasets Integrated data bundles for demos
etc/deploy Deployment files (compose, etc.)

Data Loading

Datasets

Bundled datasets are available in etc/datasets:

cd etc/datasets && make
curl -X POST http://localhost:8080/api/v3/dataset \
  --data-binary @ds1.zip -H "Content-Type: application/zip"

Upload via UI

Use the upload page at http://localhost:8080/upload

Upload via API

curl -X POST http://localhost:8080/api/v3/sbom \
  --data-binary @some-sbom.json -H "Content-Type: application/json"
curl -X POST http://localhost:8080/api/v3/advisory \
  --data-binary @some-advisory.json -H "Content-Type: application/json"

Importers

Configure importers to regularly fetch from remote sources. See modules/importer/README.md.