Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify authentication and token management #74

Merged
merged 3 commits into from
Mar 29, 2024
Merged

Clarify authentication and token management #74

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb0db88
Clarify authentication and token management
nflaig Mar 8, 2024
2dc07ed
Update description to more closely follow jwt-secret spec
nflaig Mar 28, 2024
bad1ade
Consistent spelling of key manager
nflaig Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions keymanager-oapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,12 @@ info:
All requests by default send and receive JSON, and as such should have either or both of the "Content-Type: application/json"
and "Accept: application/json" headers.

All sensitive routes are to be authenticated with a token. This token should be provided by the user via a secure channel:
- Log the token to stdout when running the binary with the key manager API enabled
- Read the token from a file available to the binary
All sensitive routes MUST be authenticated with a token.

The key manager binary SHOULD accept a configuration parameter: `token-file`, which designates a file containing the hex-encoded token
of at least 256 bits. If such a parameter is not given, the client SHOULD generate such a token and write it to a file, to be reused
across multiple restarts of the binary. If such a parameter is given, but the file or token cannot be read, the client SHOULD treat this
as an error: either abort the startup, or show the error and continue without exposing the key manager routes.
version: "v1.0.0"
contact:
name: Ethereum Github
Expand Down Expand Up @@ -63,7 +66,7 @@ components:
bearerAuth:
type: http
scheme: bearer
bearerFormat: URL safe token, optionally JWT
bearerFormat: URL safe, opaque token

schemas:
Pubkey:
Expand Down
Loading