Skip to content

Commit

Permalink
Adr for public and private keys (#583)
Browse files Browse the repository at this point in the history
* Pushing draft adr for public and private keys

* Updating key names

* Updating ADR file
  • Loading branch information
jcrichlake authored Oct 23, 2023
1 parent 7f3bbe2 commit cbb05f9
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ repos:
- id: check-symlinks
- id: check-yaml
- id: detect-private-key
exclude: (mock_credentials|.+\/JjwtEngine.java|.+\/resources\/(organization-report-stream-public-key.pem|trusted-intermediary-private-key-local.pem))
exclude: (mock_credentials|.+\/JjwtEngine.java|.+\/resources\/(organization-report-stream-public-key-local.pem|trusted-intermediary-private-key-local.pem))
- id: end-of-file-fixer
- id: no-commit-to-branch
- id: trailing-whitespace
Expand Down
33 changes: 33 additions & 0 deletions adr/014-keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 14. Keys

Date: 2023-10-23

## Decision

### Internal Keys

These keys are used for the intermediary's internal use. These keys will follow the following naming paradigm...

`trusted-intermediary-<key type>-key-<environment>`.

For example, `trusted-intermediary-private-key-staging` or `trusted-intermediary-public-key-prod`.

### Organization Keys

These are keys for external orgs to authenticate with us. Currently, report stream is the only organization we have. The pattern for the name of these keys is

`organization-<org name>-<key type>-key-<environment>`.

For example, `organization-report-stream-public-key-staging`

## Status

Accepted.

## Context

This naming convention applies to all locations where our keys are stored. Previously, we didn't have a consistent naming convention across all our locations which caused confusion on which key was to be used in which context and environment.

### Related Issues

- #584

0 comments on commit cbb05f9

Please sign in to comment.