docs: Small doc changes for KTLS#5521
Conversation
api/unstable/ktls.h
Outdated
| * Additionally, an application must not use kTLS to attempt to send more than 35GB | ||
| * of data and must not call s2n_send more than 23 million times. If either of these | ||
| * limits is exceeded, it will report an S2N_ERR_KTLS_KEY_LIMIT S2N_ERR_T_PROTO error. | ||
| * @note Calling this API will force a limit of 388 GB per s2n_send/sendfile call. |
There was a problem hiding this comment.
Maybe mention that exceeding this limit will cause an INVALID_ARGUMENT error?
I'm also curious how the 388 GB is calculated 🤔 Could you add a note in the PR description?
There was a problem hiding this comment.
Oh we might also want to mention that the limit isn't permanent / unavoidable. Like, if a customer reaches out, we could get rid of the limit. Maybe create a tracking issue and link that?
There was a problem hiding this comment.
I think the calculation isn't something that users need to know about, so I didn't put it in our public docs. But yes, I amended an internal code comment to describe where this limit comes from.
Also yeah I created a tracking issue. If someone wants this, they can complain there.
fc09e26 to
9a76afb
Compare
Co-authored-by: Lindsay Stewart <stewart.r.lindsay@gmail.com>
Co-authored-by: Lindsay Stewart <stewart.r.lindsay@gmail.com>
Release Summary:
Resolved issues:
Description of changes:
We now support key updates with our ktls feature(after this is merged), so the docs should reflect that.
Call-outs:
Ended up being a smaller change than I expected, but I'm not sure more edits are needed.
Testing:
doc change.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.