Skip to content

Commit c7d6220

Browse files
committed
librustls: fix typo in server cert verifier builder docs
The removed sentence fragment is incomplete, and is covered by the next paragraph.
1 parent 5c88e9f commit c7d6220

2 files changed

Lines changed: 37 additions & 37 deletions

File tree

librustls/src/rustls.h

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -28,41 +28,6 @@
2828
#endif
2929

3030

31-
/**
32-
* Describes which sort of handshake happened.
33-
*/
34-
typedef enum rustls_handshake_kind {
35-
/**
36-
* The type of handshake could not be determined.
37-
*
38-
* This variant should not be used.
39-
*/
40-
RUSTLS_HANDSHAKE_KIND_UNKNOWN = 0,
41-
/**
42-
* A full TLS handshake.
43-
*
44-
* This is the typical TLS connection initiation process when resumption is
45-
* not yet unavailable, and the initial client hello was accepted by the server.
46-
*/
47-
RUSTLS_HANDSHAKE_KIND_FULL = 1,
48-
/**
49-
* A full TLS handshake, with an extra round-trip for a hello retry request.
50-
*
51-
* The server can respond with a hello retry request (HRR) if the initial client
52-
* hello is unacceptable for several reasons, the most likely if no supported key
53-
* shares were offered by the client.
54-
*/
55-
RUSTLS_HANDSHAKE_KIND_FULL_WITH_HELLO_RETRY_REQUEST = 2,
56-
/**
57-
* A resumed TLS handshake.
58-
*
59-
* Resumed handshakes involve fewer round trips and less cryptography than
60-
* full ones, but can only happen when the peers have previously done a full
61-
* handshake together, and then remember data about it.
62-
*/
63-
RUSTLS_HANDSHAKE_KIND_RESUMED = 3,
64-
} rustls_handshake_kind;
65-
6631
/**
6732
* Numeric error codes returned from rustls-ffi API functions.
6833
*/
@@ -208,6 +173,41 @@ typedef enum rustls_tls_version {
208173
RUSTLS_TLS_VERSION_TLSV1_3 = 772,
209174
} rustls_tls_version;
210175

176+
/**
177+
* Describes which sort of handshake happened.
178+
*/
179+
typedef enum rustls_handshake_kind {
180+
/**
181+
* The type of handshake could not be determined.
182+
*
183+
* This variant should not be used.
184+
*/
185+
RUSTLS_HANDSHAKE_KIND_UNKNOWN = 0,
186+
/**
187+
* A full TLS handshake.
188+
*
189+
* This is the typical TLS connection initiation process when resumption is
190+
* not yet unavailable, and the initial client hello was accepted by the server.
191+
*/
192+
RUSTLS_HANDSHAKE_KIND_FULL = 1,
193+
/**
194+
* A full TLS handshake, with an extra round-trip for a hello retry request.
195+
*
196+
* The server can respond with a hello retry request (HRR) if the initial client
197+
* hello is unacceptable for several reasons, the most likely if no supported key
198+
* shares were offered by the client.
199+
*/
200+
RUSTLS_HANDSHAKE_KIND_FULL_WITH_HELLO_RETRY_REQUEST = 2,
201+
/**
202+
* A resumed TLS handshake.
203+
*
204+
* Resumed handshakes involve fewer round trips and less cryptography than
205+
* full ones, but can only happen when the peers have previously done a full
206+
* handshake together, and then remember data about it.
207+
*/
208+
RUSTLS_HANDSHAKE_KIND_RESUMED = 3,
209+
} rustls_handshake_kind;
210+
211211
/**
212212
* A parsed ClientHello produced by a rustls_acceptor.
213213
*
@@ -2689,7 +2689,7 @@ void rustls_web_pki_client_cert_verifier_builder_free(struct rustls_web_pki_clie
26892689

26902690
/**
26912691
* Create a `rustls_web_pki_server_cert_verifier_builder` using the process-wide default
2692-
* crypto provider. Caller owns the memory and may free it with
2692+
* crypto provider.
26932693
*
26942694
* Caller owns the memory and may free it with `rustls_web_pki_server_cert_verifier_builder_free`,
26952695
* regardless of whether `rustls_web_pki_server_cert_verifier_builder_build` was called.

librustls/src/verifier.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ pub(crate) struct ServerCertVerifierBuilder {
409409

410410
impl ServerCertVerifierBuilder {
411411
/// Create a `rustls_web_pki_server_cert_verifier_builder` using the process-wide default
412-
/// crypto provider. Caller owns the memory and may free it with
412+
/// crypto provider.
413413
///
414414
/// Caller owns the memory and may free it with `rustls_web_pki_server_cert_verifier_builder_free`,
415415
/// regardless of whether `rustls_web_pki_server_cert_verifier_builder_build` was called.

0 commit comments

Comments
 (0)