-
Notifications
You must be signed in to change notification settings - Fork 218
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
Conversation
1d5d690
to
d09d98c
Compare
There was a problem hiding this 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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adjusted ✔️
docs/sources/next/javascript-api/k6-experimental/webcrypto/subtlecrypto/importkey.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/webcrypto/subtlecrypto/importkey.md
Outdated
Show resolved
Hide resolved
docs/sources/next/javascript-api/k6-experimental/webcrypto/subtlecrypto/importkey.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
d1660b3
to
c5cef5e
Compare
There was a problem hiding this 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! 🚢
docs/sources/next/javascript-api/k6-experimental/webcrypto/subtlecrypto/importkey.md
Outdated
Show resolved
Hide resolved
…tlecrypto/importkey.md Co-authored-by: Heitor Tashiro Sergent <[email protected]>
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#61It 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
make docs
command locally and verified that the changes look good.docs/sources/next
folder of the documentation.Related PR(s)/Issue(s)