Skip to content

Latest commit

 

History

History
51 lines (44 loc) · 2.14 KB

README.md

File metadata and controls

51 lines (44 loc) · 2.14 KB
Raw

README

Astral is an api-only application intended to simplify certificate acquisition for other applications/services. Broadly speaking, it will:

  1. Authenticate the request for cerficate using a third party trusted source (JWT, etc)
  2. Authorize the request using a Domain Ownership Registry
  3. If authorized, obtain a certificate from PKI CLM (such as Vault/OpenBao)
  4. Log this transaction in audit infrastructure (ELK, etc).

Running in development

This Rails app is most easily run and developed in its devcontainer.

  1. Open in devcontainer
  2. Launch server using vscode launch config, or in terminal run:
rails s
  1. POST /certificates to acquire cert (need to provide common_name param):
curl -X POST http://localhost:3000/certificates \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsIm5hbWUiOiJKb2huIERvZSIsImlhdCI6MTUxNjIzOTAyMiwiZ3JvdXBzIjpbImdyb3VwMSIsImdyb3VwMiJdLCJhdWQiOiJhc3RyYWwifQ.tfRLXmE_eq-piP88_clwPWrYfMAQbCJAeZQI6OFxZSI" \
-H "Content-type: application/json" \
-d "{ \"cert_issue_request\": { \"common_name\": \"example.com\" } }"
  1. POST and GET /secrets to save and fetch a secret:
curl -X POST http://localhost:3000/secrets \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsIm5hbWUiOiJKb2huIERvZSIsImlhdCI6MTUxNjIzOTAyMiwiZ3JvdXBzIjpbImdyb3VwMSIsImdyb3VwMiJdLCJhdWQiOiJhc3RyYWwifQ.tfRLXmE_eq-piP88_clwPWrYfMAQbCJAeZQI6OFxZSI" \
-H "Content-type: application/json" \
-d "{\"secret\": { \"path\":\"some/path\", \"data\": {\"password\": \"s3crit\"} } }"

curl http://localhost:3000/secrets/some/path \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsIm5hbWUiOiJKb2huIERvZSIsImlhdCI6MTUxNjIzOTAyMiwiZ3JvdXBzIjpbImdyb3VwMSIsImdyb3VwMiJdLCJhdWQiOiJhc3RyYWwifQ.tfRLXmE_eq-piP88_clwPWrYfMAQbCJAeZQI6OFxZSI"
  1. Run the tests from devcontainer terminal:
rails test

Running the prod image (local build):

  1. Build the prod image:
docker build -t astral:latest .
  1. Run the prod image:
docker run -e SECRET_KEY_BASE=mysecrit -p 3000:3000 astral:latest