feat: introduce bridge generate-tokens command
#175
Merged
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
In service of the UCAN bridge implementation in storacha/w3infra#325 this PR proposes a new `bridge generate-tokens` command that will generate values for the `Authorization` header and `proof` field of the HTTP request users make to the bridge. This PR is currently intended as a stake-in-the-ground and is expected to change significantly. TODO - [ ] clean up and refactor bridge - [ ] finalize command names - [ ] decouple from coupon code (?)
6 tasks
send all auth info in headers and base64url multibase encode both values
travis
changed the title
bridge generate-tokens commandbridge generate-tokens command
alanshaw
approved these changes
Mar 5, 2024
|
|
||
| Generate tokens that can be used as the `X-Auth-Secret` and `Authorization` headers required to use the UCAN-HTTP bridge. | ||
|
|
||
| TODO: link to UCAN-HTTP bridge specification once it lands |
There was a problem hiding this comment.
You can probably link to where it will land and not block :)
| ) | ||
| .option( | ||
| '-o, --output', | ||
| 'Path of file to write the exported delegation data to.' |
| .option('-c, --can', 'One or more abilities to delegate.') | ||
| .option( | ||
| '-e, --expiration', | ||
| 'Unix timestamp when the delegation is no longer valid. Zero indicates no expiration.', |
There was a problem hiding this comment.
Suggested change
| 'Unix timestamp when the delegation is no longer valid. Zero indicates no expiration.', | |
| 'Unix timestamp (in seconds) when the delegation is no longer valid. Zero indicates no expiration.', |
There was a problem hiding this comment.
whoops - when I scanned this PR I somehow missed these comments - will address and submit a followup PR right now!
travis
added a commit
that referenced
this pull request
Mar 5, 2024
A few followups from feedback to #175 : - remove unused --output option - add --json option - clarify documentation
travis
added a commit
that referenced
this pull request
Mar 5, 2024
A few followups from feedback to #175 : - remove unused --output option - add --json option - clarify documentation
travis
added a commit
that referenced
this pull request
Mar 5, 2024
A few followups from feedback to #175 : - remove unused --output option - add --json option - clarify documentation
travis
added a commit
to storacha/w3infra
that referenced
this pull request
Mar 5, 2024
To support users in languages that do not have existing UCAN invocation implementations, we are going to launch a bridge that allows them to make simple HTTP requests with JSON bodies that we transform into proper UCAN invocations. This follows the specification here: storacha/specs#112 Values for authorization headers can be generated using the `bridge generate-tokens` w3cli command proposed here: storacha/w3cli#175 - [x] factor core bridge logic out to a separate library (filed as #338) - [x] factor HTTP input wrangling out to a separate function - [x] rename `UPLOAD_API_DID` and `ACCESS_SERVICE_URL` environment variables to `W3UP_SERVICE_DID` and `W3UP_SERVICE_URL` (filed as #337) - [x] add tests - [x] expand and formalize bridge specification, move it to the specs repo (done - storacha/specs#112) - [x] document response format
travis
pushed a commit
that referenced
this pull request
Mar 5, 2024
🤖 I have created a release *beep* *boop* --- ## [7.6.0](v7.5.0...v7.6.0) (2024-03-05) ### Features * introduce `bridge generate-tokens` command ([#175](#175)) ([5de8579](5de8579)) * updates from PR feedback ([#179](#179)) ([75f2195](75f2195)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
In service of the UCAN bridge implementation in storacha/w3infra#325 this PR introduces a new
bridge generate-tokenscommand that will generate values for theX-Auth-SecretandAuthorizationheaders of the HTTP request users make to the bridge.