chore: Improve document about certificate #1715
Conversation
tottoto
changed the title
tonic/src/request.rs
Outdated
| @@ -256,6 +256,12 @@ impl<T> Request<T> { | |||
| /// and is mostly used for mTLS. This currently only returns | |||
| /// `Some` on the server side of the `transport` server with | |||
| /// TLS enabled connections. | |||
| /// | |||
| /// ## NOTE | |||
| /// Alghouth the returned ['Certificate'] is supposed to contain PEM | |||
tonic/src/transport/tls.rs
Outdated
| /// `pem` must contain valid PEM encoded certificate. It is undefined | ||
| /// behavior to call this with `pem` that is not valid PEM encoded |
There was a problem hiding this comment.
Is this really undefined behavior? When I hear "UB" I think things like "the compiler is free to do whatever it wants", but in this case it seems like the behavior is pretty clear: You get a valid (in the rust sense) Certificate object containing invalid data (in the business logic sense). Am I missing something?
There was a problem hiding this comment.
Thanks! Makes sense. The "UB" should be in the meaning of Rust. I updated it just a detailed document. By the way, now that I think about it, the constructor name is from_pem so it might not as confusing as I thought it would be. If this note section seems unnecessary, I will remove it.
tottoto
force-pushed
the
improve-document-about-certificate
branch
from
442dcdf
to
abdb5db
Compare
|
I don't think we'll want to merge this, we should merge (something like) #1707 instead. |
|
I understand. I will close this. |
Motivation
Adds documents related to #1707 separated from its breaking changes.
Solution
Adds some documents of certificates for that users may be confused about.