diff options
| author | Paul Yang <yang.yang@baishancloud.com> | 2017-08-07 22:05:46 +0800 |
|---|---|---|
| committer | Benjamin Kaduk <kaduk@mit.edu> | 2017-08-30 13:54:28 -0500 |
| commit | 22d1a340b644d5d833157de1c0c2d1f0d7690529 (patch) | |
| tree | ec2105ea280a90490235b994f935ab93cff8b8f3 /doc | |
| parent | e44d37618018eb5dc8ba2d776b215abdaca6090a (diff) | |
Add two missing SSL_CIPHER_* functions
This is yet another 'code health' commit to respond to this round of code health
Tuesday
[skip ci]
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Ben Kaduk <kaduk@mit.edu>
(Merged from https://github.com/openssl/openssl/pull/4107)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/SSL_CIPHER_get_name.pod | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/man3/SSL_CIPHER_get_name.pod b/doc/man3/SSL_CIPHER_get_name.pod index 89f53d685d..2f8dcae9f7 100644 --- a/doc/man3/SSL_CIPHER_get_name.pod +++ b/doc/man3/SSL_CIPHER_get_name.pod @@ -13,7 +13,9 @@ SSL_CIPHER_get_digest_nid, SSL_CIPHER_get_handshake_digest, SSL_CIPHER_get_kx_nid, SSL_CIPHER_get_auth_nid, -SSL_CIPHER_is_aead +SSL_CIPHER_is_aead, +SSL_CIPHER_find, +SSL_CIPHER_get_id - get SSL_CIPHER properties =head1 SYNOPSIS @@ -32,6 +34,8 @@ SSL_CIPHER_is_aead int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c); int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c); int SSL_CIPHER_is_aead(const SSL_CIPHER *c); + const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr); + uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c); =head1 DESCRIPTION @@ -88,6 +92,18 @@ TLS 1.3 cipher suites) B<NID_auth_any> is returned. Examples (not comprehensive) SSL_CIPHER_is_aead() returns 1 if the cipher B<c> is AEAD (e.g. GCM or ChaCha20/Poly1305), and 0 if it is not AEAD. +SSL_CIPHER_find() returns a B<SSL_CIPHER> structure which has the cipher ID stored +in B<ptr>. The B<ptr> parameter is a two element array of B<char>, which stores the +two-byte TLS cipher ID (as allocated by IANA) in network byte order. This parameter +is usually retrieved from a TLS packet by using functions like L<SSL_early_get0_ciphers(3)>. +SSL_CIPHER_find() returns NULL if an error occurs or the indicated cipher is not found. + +SSL_CIPHER_get_id() returns the ID of the given cipher B<c>. The ID here is an +OpenSSL-specific concept, which stores a prefix of 0x0300 in the higher two bytes, +and the IANA-specified chipher suite ID in the lower two bytes. For instance, +TLS_RSA_WITH_NULL_MD5 has IANA ID "0x00, 0x01", but the SSL_CIPHER_get_id() +function will return an ID with value 0x03000001. + SSL_CIPHER_description() returns a textual description of the cipher used into the buffer B<buf> of length B<len> provided. If B<buf> is provided, it must be at least 128 bytes, otherwise a buffer will be allocated using |