docs: adds an expires field to the bearer token response #676
Conversation
This file contains hidden or 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
Where a bearer token is returned to the client for future use, optionally include an `expires` field which indicates the latest time that it will be treated as valid. The server is free to expire tokens at any time so this field is purely advisory. Fixes #674
achingbrain
commented
Apr 30, 2025
achingbrain
commented
Apr 30, 2025
MarcoPolo
reviewed
May 1, 2025
http/peer-id-auth.md
Outdated
| @@ -172,6 +172,17 @@ protocol operates as follows: | |||
| Authentication-Info: libp2p-PeerID sig="<base64-signature-bytes>" bearer="<base64-encoded-opaque-blob>" | |||
| ``` | |||
|
|
|||
| The server MAY include an `expires` field which contains the expiry time of | |||
| the bearer token in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) | |||
There was a problem hiding this comment.
I think we should use RFC 3339 instead. It's a subset of ISO 8601 with a focus on simplicity and use over the internet.
In JS, I believe toISOString() is RFC 3339 compliant.
There was a problem hiding this comment.
I think that's what I meant. I'm all in favour of simplicity.
achingbrain
commented
May 1, 2025
achingbrain
commented
May 1, 2025
achingbrain
commented
May 1, 2025
achingbrain
commented
May 1, 2025
achingbrain
commented
May 16, 2025
achingbrain
commented
May 16, 2025
MarcoPolo
approved these changes
May 19, 2025
p-shahi
reviewed
May 27, 2025
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.
Where a bearer token is returned to the client for future use, optionally include an
expiresfield which indicates the latest time that it will be treated as valid.The server is free to expire tokens at any time so this field is purely advisory.
Fixes #674