Directories
¶
| Path | Synopsis |
|---|---|
|
Package api_key_cruder reads and writes the keys an account registers, and records what they mint with.
|
Package api_key_cruder reads and writes the keys an account registers, and records what they mint with. |
|
Package assertion verifies what a client signs to mint a token: a short-lived JWT, signed by the private half of a key the account registered, saying which key is asking and what it is asking of.
|
Package assertion verifies what a client signs to mint a token: a short-lived JWT, signed by the private half of a key the account registered, saying which key is asking and what it is asking of. |
|
Package client is the holder's side of an API key: the assertion it signs with the private half of a key its account registered, wherever that half is kept -- a file, a key manager, a TPM, anything a crypto.Signer reaches -- and the exchange of the assertion for a session token at the login service's token endpoint.
|
Package client is the holder's side of an API key: the assertion it signs with the private half of a key its account registered, wherever that half is kept -- a file, a key manager, a TPM, anything a crypto.Signer reaches -- and the exchange of the assertion for a session token at the login service's token endpoint. |
|
endpoint
|
|
|
create_api_key_endpoint
Package create_api_key_endpoint registers a public key for the signed-in account.
|
Package create_api_key_endpoint registers a public key for the signed-in account. |
|
mint_token_endpoint
Package mint_token_endpoint mints an access token for a client that can sign for a registered key.
|
Package mint_token_endpoint mints an access token for a client that can sign for a registered key. |
|
read_own_api_keys_endpoint
Package read_own_api_keys_endpoint lists the keys the signed-in account registered.
|
Package read_own_api_keys_endpoint lists the keys the signed-in account registered. |
|
revoke_api_key_endpoint
Package revoke_api_key_endpoint takes one of the account's keys out of use.
|
Package revoke_api_key_endpoint takes one of the account's keys out of use. |
|
Package public_key reads the public keys accounts register for API access.
|
Package public_key reads the public keys accounts register for API access. |
|
Package testing is what the API key packages' tests share: a database of a test package's own, on the server TEST_DATABASE_URL names, with the library's tables in it; accounts in it; and session tokens for them, signed by a key the tests hold, as a browser or a minted token would carry them.
|
Package testing is what the API key packages' tests share: a database of a test package's own, on the server TEST_DATABASE_URL names, with the library's tables in it; accounts in it; and session tokens for them, signed by a key the tests hold, as a browser or a minted token would carry them. |
|
Package types holds what the API key endpoints take and answer with.
|
Package types holds what the API key endpoints take and answer with. |
Click to show internal directories.
Click to hide internal directories.