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.

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

Document JWK keys export/import with examples #1523

Merged
merged 3 commits into from Mar 20, 2024
Merged

Conversation

olegbespalov
Copy link
Contributor

@olegbespalov olegbespalov commented Mar 15, 2024

What?

This change documents the newly added support of jwk format for the webcrypto's keys export/import, which was done in grafana/xk6-webcrypto#61

It also adds examples that showcase the data tackling (static and base64 encoded) since we learned that it could not always be straightforward for our customers.

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the make docs command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/next folder of the documentation.

Related PR(s)/Issue(s)

@olegbespalov olegbespalov requested review from a team, mstoykov and oleiade and removed request for a team March 15, 2024 12:55
Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions, overall it looks great! 🤓


export default async function () {
// transmitted data is the base64 of the initialization vector + encrypted data
// that unusually transmitted over the network
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I understand the meaning here, could you expand a little bit on what you are trying to say here? 🤓 Is it that this data would not usually be transmitted?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was trying to point out that in this example, transmittedData is the data that you got from somewhere, let's say in a response body, etc

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh I see. In that case, maybe we could reword it to: "this is data usually transmitted over the network".

Or include response body there as well as an example: "this is data usually transmitted over the network, such as a response body"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now, I'm wondering if we should drop that part 😅

Actually, doesn't matter how data is received, essential details (in this example) that transmitted data is a concatenation of an initialization vector and encrypted data; some people could use this approach, that's why I used it to bring examples more real-world close

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a fair point! Actually, what if we added this context on line 81? Something along the lines of:

"This example demonstrates how to import a static raw key and decrypt some transmitted data in base64. The transmitted data in this example represents an initialization vector and encoded data, and in a real-world scenario, it can be a response body or other data received from a request."

It would keep the code sample concise but still give context to users.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjusted ✔️

@olegbespalov olegbespalov mentioned this pull request Mar 15, 2024
28 tasks
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a comment to highlight the change we talked about in the other thread, everything else looks good! 🚢

…tlecrypto/importkey.md

Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@oleiade oleiade merged commit d223977 into main Mar 20, 2024
5 checks passed
@oleiade oleiade deleted the feat/webcrypto-jwk branch March 20, 2024 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants