diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_CIPHER_get_name.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_CIPHER_get_name.3 | 196 |
1 files changed, 0 insertions, 196 deletions
diff --git a/src/lib/libssl/doc/SSL_CIPHER_get_name.3 b/src/lib/libssl/doc/SSL_CIPHER_get_name.3 deleted file mode 100644 index ebc478f9c6..0000000000 --- a/src/lib/libssl/doc/SSL_CIPHER_get_name.3 +++ /dev/null | |||
| @@ -1,196 +0,0 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_CIPHER_get_name.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: December 2 2014 $ | ||
| 5 | .Dt SSL_CIPHER_GET_NAME 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_CIPHER_get_name , | ||
| 9 | .Nm SSL_CIPHER_get_bits , | ||
| 10 | .Nm SSL_CIPHER_get_version , | ||
| 11 | .Nm SSL_CIPHER_description | ||
| 12 | .Nd get SSL_CIPHER properties | ||
| 13 | .Sh SYNOPSIS | ||
| 14 | .In openssl/ssl.h | ||
| 15 | .Ft const char * | ||
| 16 | .Fn SSL_CIPHER_get_name "const SSL_CIPHER *cipher" | ||
| 17 | .Ft int | ||
| 18 | .Fn SSL_CIPHER_get_bits "const SSL_CIPHER *cipher" "int *alg_bits" | ||
| 19 | .Ft char * | ||
| 20 | .Fn SSL_CIPHER_get_version "const SSL_CIPHER *cipher" | ||
| 21 | .Ft char * | ||
| 22 | .Fn SSL_CIPHER_description "const SSL_CIPHER *cipher" "char *buf" "int size" | ||
| 23 | .Sh DESCRIPTION | ||
| 24 | .Fn SSL_CIPHER_get_name | ||
| 25 | returns a pointer to the name of | ||
| 26 | .Fa cipher . | ||
| 27 | If the | ||
| 28 | argument is the | ||
| 29 | .Dv NULL | ||
| 30 | pointer, a pointer to the constant value | ||
| 31 | .Qq NONE | ||
| 32 | is returned. | ||
| 33 | .Pp | ||
| 34 | .Fn SSL_CIPHER_get_bits | ||
| 35 | returns the number of secret bits used for | ||
| 36 | .Fa cipher . | ||
| 37 | If | ||
| 38 | .Fa alg_bits | ||
| 39 | is not | ||
| 40 | .Dv NULL , | ||
| 41 | it contains the number of bits processed by the | ||
| 42 | chosen algorithm. | ||
| 43 | If | ||
| 44 | .Fa cipher | ||
| 45 | is | ||
| 46 | .Dv NULL , | ||
| 47 | 0 is returned. | ||
| 48 | .Pp | ||
| 49 | .Fn SSL_CIPHER_get_version | ||
| 50 | returns a string which indicates the SSL/TLS protocol version that first | ||
| 51 | defined the cipher. | ||
| 52 | This is currently | ||
| 53 | .Qq SSLv2 | ||
| 54 | or | ||
| 55 | .Qq TLSv1/SSLv3 . | ||
| 56 | In some cases it should possibly return | ||
| 57 | .Qq TLSv1.2 | ||
| 58 | but the function does not; use | ||
| 59 | .Xr SSL_CIPHER_description 3 | ||
| 60 | instead. | ||
| 61 | If | ||
| 62 | .Fa cipher | ||
| 63 | is | ||
| 64 | .Dv NULL , | ||
| 65 | .Qq (NONE) | ||
| 66 | is returned. | ||
| 67 | .Pp | ||
| 68 | .Fn SSL_CIPHER_description | ||
| 69 | returns a textual description of the cipher used into the buffer | ||
| 70 | .Fa buf | ||
| 71 | of length | ||
| 72 | .Fa len | ||
| 73 | provided. | ||
| 74 | If | ||
| 75 | .Fa buf | ||
| 76 | is | ||
| 77 | .Dv NULL , | ||
| 78 | a buffer is allocated using | ||
| 79 | .Xr asprintf 3 ; | ||
| 80 | that buffer should be freed using the | ||
| 81 | .Xr free 3 | ||
| 82 | function. | ||
| 83 | If | ||
| 84 | .Fa len | ||
| 85 | is too small, or if | ||
| 86 | .Fa buf | ||
| 87 | is | ||
| 88 | .Dv NULL | ||
| 89 | and the allocation fails, a pointer to the string | ||
| 90 | .Qq Buffer too small | ||
| 91 | is returned. | ||
| 92 | .Sh NOTES | ||
| 93 | The number of bits processed can be different from the secret bits. | ||
| 94 | For example, an export cipher like EXP-RC4-MD5 has only 40 secret bits. | ||
| 95 | The algorithm does use the full 128 bits (which would be returned for | ||
| 96 | .Fa alg_bits ) , | ||
| 97 | but 88 bits are fixed. | ||
| 98 | The search space is hence only 40 bits. | ||
| 99 | .Pp | ||
| 100 | The string returned by | ||
| 101 | .Fn SSL_CIPHER_description | ||
| 102 | in case of success consists | ||
| 103 | of cleartext information separated by one or more blanks in the following | ||
| 104 | sequence: | ||
| 105 | .Bl -tag -width Ds | ||
| 106 | .It Aq Ar ciphername | ||
| 107 | Textual representation of the cipher name. | ||
| 108 | .It Aq Ar protocol version | ||
| 109 | Protocol version: | ||
| 110 | .Em SSLv2 , | ||
| 111 | .Em SSLv3 , | ||
| 112 | .Em TLSv1.2 . | ||
| 113 | The TLSv1.0 ciphers are flagged with SSLv3. | ||
| 114 | No new ciphers were added by TLSv1.1. | ||
| 115 | .It Kx= Ns Aq Ar key exchange | ||
| 116 | Key exchange method: | ||
| 117 | .Em RSA | ||
| 118 | (for export ciphers as | ||
| 119 | .Em RSA(512) | ||
| 120 | or | ||
| 121 | .Em RSA(1024) ) , | ||
| 122 | .Em DH | ||
| 123 | (for export ciphers as | ||
| 124 | .Em DH(512) | ||
| 125 | or | ||
| 126 | .Em DH(1024) ) , | ||
| 127 | .Em DH/RSA , | ||
| 128 | .Em DH/DSS , | ||
| 129 | .Em Fortezza . | ||
| 130 | .It Au= Ns Aq Ar authentication | ||
| 131 | Authentication method: | ||
| 132 | .Em RSA , | ||
| 133 | .Em DSS , | ||
| 134 | .Em DH , | ||
| 135 | .Em None . | ||
| 136 | .Em None | ||
| 137 | is the representation of anonymous ciphers. | ||
| 138 | .It Enc= Ns Aq Ar symmetric encryption method | ||
| 139 | Encryption method with number of secret bits: | ||
| 140 | .Em DES(40) , | ||
| 141 | .Em DES(56) , | ||
| 142 | .Em 3DES(168) , | ||
| 143 | .Em RC4(40) , | ||
| 144 | .Em RC4(56) , | ||
| 145 | .Em RC4(64) , | ||
| 146 | .Em RC4(128) , | ||
| 147 | .Em RC2(40) , | ||
| 148 | .Em RC2(56) , | ||
| 149 | .Em RC2(128) , | ||
| 150 | .Em IDEA(128) , | ||
| 151 | .Em Fortezza , | ||
| 152 | .Em None . | ||
| 153 | .It Mac= Ns Aq Ar message authentication code | ||
| 154 | Message digest: | ||
| 155 | .Em MD5 , | ||
| 156 | .Em SHA1 . | ||
| 157 | .It Aq Ar export flag | ||
| 158 | If the cipher is flagged exportable with respect to old US crypto | ||
| 159 | regulations, the word | ||
| 160 | .Dq export | ||
| 161 | is printed. | ||
| 162 | .El | ||
| 163 | .Sh RETURN VALUES | ||
| 164 | See | ||
| 165 | .Sx DESCRIPTION | ||
| 166 | .Sh EXAMPLES | ||
| 167 | Some examples for the output of | ||
| 168 | .Fn SSL_CIPHER_description : | ||
| 169 | .D1 "EDH-RSA-DES-CBC3-SHA SSLv3 Kx=DH Au=RSA Enc=3DES(168) Mac=SHA1" | ||
| 170 | .D1 "EDH-DSS-DES-CBC3-SHA SSLv3 Kx=DH Au=DSS Enc=3DES(168) Mac=SHA1" | ||
| 171 | .D1 "RC4-MD5 SSLv3 Kx=RSA Au=RSA Enc=RC4(128) Mac=MD5" | ||
| 172 | .D1 "EXP-RC4-MD5 SSLv3 Kx=RSA(512) Au=RSA Enc=RC4(40) Mac=MD5 export" | ||
| 173 | .Pp | ||
| 174 | A complete list can be retrieved by invoking the following command: | ||
| 175 | .Pp | ||
| 176 | .Dl $ openssl ciphers -v ALL | ||
| 177 | .Sh SEE ALSO | ||
| 178 | .Xr openssl 1 , | ||
| 179 | .Xr ssl 3 , | ||
| 180 | .Xr SSL_get_ciphers 3 , | ||
| 181 | .Xr SSL_get_current_cipher 3 | ||
| 182 | .Sh BUGS | ||
| 183 | If | ||
| 184 | .Fn SSL_CIPHER_description | ||
| 185 | is called with | ||
| 186 | .Fa cipher | ||
| 187 | being | ||
| 188 | .Dv NULL , | ||
| 189 | the library crashes. | ||
| 190 | .Pp | ||
| 191 | If | ||
| 192 | .Fn SSL_CIPHER_description | ||
| 193 | cannot handle a built-in cipher, | ||
| 194 | the according description of the cipher property is | ||
| 195 | .Qq unknown . | ||
| 196 | This case should not occur. | ||
