feat: add crypto explanation for the stream gateway #123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
morphis
force-pushed
the
add-stream-gateway-crypto
branch
from
e7af0a7 to
5412f53
Compare
morphis
force-pushed
the
add-stream-gateway-crypto
branch
from
5412f53 to
f17feed
Compare
keirthana
requested changes
Aug 28, 2024
|
Everyone contributing to this PR have now signed the CLA. Thanks! |
morphis
force-pushed
the
add-stream-gateway-crypto
branch
from
d55e349 to
19ab117
Compare
jat-canonical
approved these changes
Aug 29, 2024
|
|
||
| ## Token based authentication | ||
|
|
||
| Users can generate API tokens to authenticate with the HTTP API provided by the Anbox Stream Gateway. For the API tokens, a scope-limited [Macaroon](http://theory.stanford.edu/~ataly/Papers/macaroons.pdf) is used. The token is signed with a [HMAC](https://www.okta.com/identity-101/hmac/) using SHA-256 (HS256) and a 64 byte secret key. The [`macaroon.New`](https://pkg.go.dev/gopkg.in/[email protected]#New) method is used internally to generate the [JWT](https://jwt.io/) token. |
There was a problem hiding this comment.
The macaroon.New method is used internally to generate the JWT token.
I wonder if this is necessary to include as this leaks internal implementation detail which might not be suitable for the nature of our product ?
There was a problem hiding this comment.
That's fine. We reference the package we use already and drawing a conclusion to what method is used from it is straightforward.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.