1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay@cryptsoft.com). 6 * The implementation was written so as to conform with Netscapes SSL. 7 * 8 * This library is free for commercial and non-commercial use as long as 9 * the following conditions are aheared to. The following conditions 10 * apply to all code found in this distribution, be it the RC4, RSA, 11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 12 * included with this distribution is covered by the same copyright terms 13 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 14 * 15 * Copyright remains Eric Young's, and as such any Copyright notices in 16 * the code are not to be removed. 17 * If this package is used in a product, Eric Young should be given attribution 18 * as the author of the parts of the library used. 19 * This can be in the form of a textual message at program startup or 20 * in documentation (online or textual) provided with the package. 21 * 22 * Redistribution and use in source and binary forms, with or without 23 * modification, are permitted provided that the following conditions 24 * are met: 25 * 1. Redistributions of source code must retain the copyright 26 * notice, this list of conditions and the following disclaimer. 27 * 2. Redistributions in binary form must reproduce the above copyright 28 * notice, this list of conditions and the following disclaimer in the 29 * documentation and/or other materials provided with the distribution. 30 * 3. All advertising materials mentioning features or use of this software 31 * must display the following acknowledgement: 32 * "This product includes cryptographic software written by 33 * Eric Young (eay@cryptsoft.com)" 34 * The word 'cryptographic' can be left out if the rouines from the library 35 * being used are not cryptographic related :-). 36 * 4. If you include any Windows specific code (or a derivative thereof) from 37 * the apps directory (application code) you must include an acknowledgement: 38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 39 * 40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 50 * SUCH DAMAGE. 51 * 52 * The licence and distribution terms for any publically available version or 53 * derivative of this code cannot be changed. i.e. this code cannot simply be 54 * copied and put under another distribution licence 55 * [including the GNU Public Licence.] */ 56 57 #ifndef OPENSSL_HEADER_CIPHER_H 58 #define OPENSSL_HEADER_CIPHER_H 59 60 #include <openssl/base.h> 61 62 #if defined(__cplusplus) 63 extern "C" { 64 #endif 65 66 67 // Ciphers. 68 69 70 // Cipher primitives. 71 // 72 // The following functions return |EVP_CIPHER| objects that implement the named 73 // cipher algorithm. 74 75 OPENSSL_EXPORT const EVP_CIPHER *EVP_rc4(void); 76 77 OPENSSL_EXPORT const EVP_CIPHER *EVP_des_cbc(void); 78 OPENSSL_EXPORT const EVP_CIPHER *EVP_des_ecb(void); 79 OPENSSL_EXPORT const EVP_CIPHER *EVP_des_ede(void); 80 OPENSSL_EXPORT const EVP_CIPHER *EVP_des_ede3(void); 81 OPENSSL_EXPORT const EVP_CIPHER *EVP_des_ede_cbc(void); 82 OPENSSL_EXPORT const EVP_CIPHER *EVP_des_ede3_cbc(void); 83 84 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_ecb(void); 85 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_cbc(void); 86 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_ctr(void); 87 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_ofb(void); 88 89 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_ecb(void); 90 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_cbc(void); 91 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_ctr(void); 92 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_ofb(void); 93 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_xts(void); 94 95 // EVP_enc_null returns a 'cipher' that passes plaintext through as 96 // ciphertext. 97 OPENSSL_EXPORT const EVP_CIPHER *EVP_enc_null(void); 98 99 // EVP_rc2_cbc returns a cipher that implements 128-bit RC2 in CBC mode. 100 OPENSSL_EXPORT const EVP_CIPHER *EVP_rc2_cbc(void); 101 102 // EVP_rc2_40_cbc returns a cipher that implements 40-bit RC2 in CBC mode. This 103 // is obviously very, very weak and is included only in order to read PKCS#12 104 // files, which often encrypt the certificate chain using this cipher. It is 105 // deliberately not exported. 106 const EVP_CIPHER *EVP_rc2_40_cbc(void); 107 108 // EVP_get_cipherbynid returns the cipher corresponding to the given NID, or 109 // NULL if no such cipher is known. Note using this function links almost every 110 // cipher implemented by BoringSSL into the binary, whether the caller uses them 111 // or not. Size-conscious callers, such as client software, should not use this 112 // function. 113 OPENSSL_EXPORT const EVP_CIPHER *EVP_get_cipherbynid(int nid); 114 115 116 // Cipher context allocation. 117 // 118 // An |EVP_CIPHER_CTX| represents the state of an encryption or decryption in 119 // progress. 120 121 // EVP_CIPHER_CTX_init initialises an, already allocated, |EVP_CIPHER_CTX|. 122 OPENSSL_EXPORT void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *ctx); 123 124 // EVP_CIPHER_CTX_new allocates a fresh |EVP_CIPHER_CTX|, calls 125 // |EVP_CIPHER_CTX_init| and returns it, or NULL on allocation failure. 126 OPENSSL_EXPORT EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void); 127 128 // EVP_CIPHER_CTX_cleanup frees any memory referenced by |ctx|. It returns 129 // one. 130 OPENSSL_EXPORT int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *ctx); 131 132 // EVP_CIPHER_CTX_free calls |EVP_CIPHER_CTX_cleanup| on |ctx| and then frees 133 // |ctx| itself. 134 OPENSSL_EXPORT void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx); 135 136 // EVP_CIPHER_CTX_copy sets |out| to be a duplicate of the current state of 137 // |in|. The |out| argument must have been previously initialised. 138 OPENSSL_EXPORT int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, 139 const EVP_CIPHER_CTX *in); 140 141 // EVP_CIPHER_CTX_reset calls |EVP_CIPHER_CTX_cleanup| followed by 142 // |EVP_CIPHER_CTX_init| and returns one. 143 OPENSSL_EXPORT int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx); 144 145 146 // Cipher context configuration. 147 148 // EVP_CipherInit_ex configures |ctx| for a fresh encryption (or decryption, if 149 // |enc| is zero) operation using |cipher|. If |ctx| has been previously 150 // configured with a cipher then |cipher|, |key| and |iv| may be |NULL| and 151 // |enc| may be -1 to reuse the previous values. The operation will use |key| 152 // as the key and |iv| as the IV (if any). These should have the correct 153 // lengths given by |EVP_CIPHER_key_length| and |EVP_CIPHER_iv_length|. It 154 // returns one on success and zero on error. 155 OPENSSL_EXPORT int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, 156 const EVP_CIPHER *cipher, ENGINE *engine, 157 const uint8_t *key, const uint8_t *iv, 158 int enc); 159 160 // EVP_EncryptInit_ex calls |EVP_CipherInit_ex| with |enc| equal to one. 161 OPENSSL_EXPORT int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, 162 const EVP_CIPHER *cipher, ENGINE *impl, 163 const uint8_t *key, const uint8_t *iv); 164 165 // EVP_DecryptInit_ex calls |EVP_CipherInit_ex| with |enc| equal to zero. 166 OPENSSL_EXPORT int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, 167 const EVP_CIPHER *cipher, ENGINE *impl, 168 const uint8_t *key, const uint8_t *iv); 169 170 171 // Cipher operations. 172 173 // EVP_EncryptUpdate encrypts |in_len| bytes from |in| to |out|. The number 174 // of output bytes may be up to |in_len| plus the block length minus one and 175 // |out| must have sufficient space. The number of bytes actually output is 176 // written to |*out_len|. It returns one on success and zero otherwise. 177 OPENSSL_EXPORT int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out, 178 int *out_len, const uint8_t *in, 179 int in_len); 180 181 // EVP_EncryptFinal_ex writes at most a block of ciphertext to |out| and sets 182 // |*out_len| to the number of bytes written. If padding is enabled (the 183 // default) then standard padding is applied to create the final block. If 184 // padding is disabled (with |EVP_CIPHER_CTX_set_padding|) then any partial 185 // block remaining will cause an error. The function returns one on success and 186 // zero otherwise. 187 OPENSSL_EXPORT int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, uint8_t *out, 188 int *out_len); 189 190 // EVP_DecryptUpdate decrypts |in_len| bytes from |in| to |out|. The number of 191 // output bytes may be up to |in_len| plus the block length minus one and |out| 192 // must have sufficient space. The number of bytes actually output is written 193 // to |*out_len|. It returns one on success and zero otherwise. 194 OPENSSL_EXPORT int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out, 195 int *out_len, const uint8_t *in, 196 int in_len); 197 198 // EVP_DecryptFinal_ex writes at most a block of ciphertext to |out| and sets 199 // |*out_len| to the number of bytes written. If padding is enabled (the 200 // default) then padding is removed from the final block. 201 // 202 // WARNING: it is unsafe to call this function with unauthenticated 203 // ciphertext if padding is enabled. 204 OPENSSL_EXPORT int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, uint8_t *out, 205 int *out_len); 206 207 // EVP_Cipher performs a one-shot encryption/decryption operation. No partial 208 // blocks are maintained between calls. However, any internal cipher state is 209 // still updated. For CBC-mode ciphers, the IV is updated to the final 210 // ciphertext block. For stream ciphers, the stream is advanced past the bytes 211 // used. It returns one on success and zero otherwise, unless |EVP_CIPHER_flags| 212 // has |EVP_CIPH_FLAG_CUSTOM_CIPHER| set. Then it returns the number of bytes 213 // written or -1 on error. 214 // 215 // WARNING: this differs from the usual return value convention when using 216 // |EVP_CIPH_FLAG_CUSTOM_CIPHER|. 217 // 218 // TODO(davidben): The normal ciphers currently never fail, even if, e.g., 219 // |in_len| is not a multiple of the block size for CBC-mode decryption. The 220 // input just gets rounded up while the output gets truncated. This should 221 // either be officially documented or fail. 222 OPENSSL_EXPORT int EVP_Cipher(EVP_CIPHER_CTX *ctx, uint8_t *out, 223 const uint8_t *in, size_t in_len); 224 225 // EVP_CipherUpdate calls either |EVP_EncryptUpdate| or |EVP_DecryptUpdate| 226 // depending on how |ctx| has been setup. 227 OPENSSL_EXPORT int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, uint8_t *out, 228 int *out_len, const uint8_t *in, 229 int in_len); 230 231 // EVP_CipherFinal_ex calls either |EVP_EncryptFinal_ex| or 232 // |EVP_DecryptFinal_ex| depending on how |ctx| has been setup. 233 OPENSSL_EXPORT int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, uint8_t *out, 234 int *out_len); 235 236 237 // Cipher context accessors. 238 239 // EVP_CIPHER_CTX_cipher returns the |EVP_CIPHER| underlying |ctx|, or NULL if 240 // none has been set. 241 OPENSSL_EXPORT const EVP_CIPHER *EVP_CIPHER_CTX_cipher( 242 const EVP_CIPHER_CTX *ctx); 243 244 // EVP_CIPHER_CTX_nid returns a NID identifying the |EVP_CIPHER| underlying 245 // |ctx| (e.g. |NID_aes_128_gcm|). It will crash if no cipher has been 246 // configured. 247 OPENSSL_EXPORT int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx); 248 249 // EVP_CIPHER_CTX_encrypting returns one if |ctx| is configured for encryption 250 // and zero otherwise. 251 OPENSSL_EXPORT int EVP_CIPHER_CTX_encrypting(const EVP_CIPHER_CTX *ctx); 252 253 // EVP_CIPHER_CTX_block_size returns the block size, in bytes, of the cipher 254 // underlying |ctx|, or one if the cipher is a stream cipher. It will crash if 255 // no cipher has been configured. 256 OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx); 257 258 // EVP_CIPHER_CTX_key_length returns the key size, in bytes, of the cipher 259 // underlying |ctx| or zero if no cipher has been configured. 260 OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx); 261 262 // EVP_CIPHER_CTX_iv_length returns the IV size, in bytes, of the cipher 263 // underlying |ctx|. It will crash if no cipher has been configured. 264 OPENSSL_EXPORT unsigned EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx); 265 266 // EVP_CIPHER_CTX_get_app_data returns the opaque, application data pointer for 267 // |ctx|, or NULL if none has been set. 268 OPENSSL_EXPORT void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx); 269 270 // EVP_CIPHER_CTX_set_app_data sets the opaque, application data pointer for 271 // |ctx| to |data|. 272 OPENSSL_EXPORT void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, 273 void *data); 274 275 // EVP_CIPHER_CTX_flags returns a value which is the OR of zero or more 276 // |EVP_CIPH_*| flags. It will crash if no cipher has been configured. 277 OPENSSL_EXPORT uint32_t EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *ctx); 278 279 // EVP_CIPHER_CTX_mode returns one of the |EVP_CIPH_*| cipher mode values 280 // enumerated below. It will crash if no cipher has been configured. 281 OPENSSL_EXPORT uint32_t EVP_CIPHER_CTX_mode(const EVP_CIPHER_CTX *ctx); 282 283 // EVP_CIPHER_CTX_ctrl is an |ioctl| like function. The |command| argument 284 // should be one of the |EVP_CTRL_*| values. The |arg| and |ptr| arguments are 285 // specific to the command in question. 286 OPENSSL_EXPORT int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int command, 287 int arg, void *ptr); 288 289 // EVP_CIPHER_CTX_set_padding sets whether padding is enabled for |ctx| and 290 // returns one. Pass a non-zero |pad| to enable padding (the default) or zero 291 // to disable. 292 OPENSSL_EXPORT int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *ctx, int pad); 293 294 // EVP_CIPHER_CTX_set_key_length sets the key length for |ctx|. This is only 295 // valid for ciphers that can take a variable length key. It returns one on 296 // success and zero on error. 297 OPENSSL_EXPORT int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *ctx, 298 unsigned key_len); 299 300 301 // Cipher accessors. 302 303 // EVP_CIPHER_nid returns a NID identifying |cipher|. (For example, 304 // |NID_aes_128_gcm|.) 305 OPENSSL_EXPORT int EVP_CIPHER_nid(const EVP_CIPHER *cipher); 306 307 // EVP_CIPHER_block_size returns the block size, in bytes, for |cipher|, or one 308 // if |cipher| is a stream cipher. 309 OPENSSL_EXPORT unsigned EVP_CIPHER_block_size(const EVP_CIPHER *cipher); 310 311 // EVP_CIPHER_key_length returns the key size, in bytes, for |cipher|. If 312 // |cipher| can take a variable key length then this function returns the 313 // default key length and |EVP_CIPHER_flags| will return a value with 314 // |EVP_CIPH_VARIABLE_LENGTH| set. 315 OPENSSL_EXPORT unsigned EVP_CIPHER_key_length(const EVP_CIPHER *cipher); 316 317 // EVP_CIPHER_iv_length returns the IV size, in bytes, of |cipher|, or zero if 318 // |cipher| doesn't take an IV. 319 OPENSSL_EXPORT unsigned EVP_CIPHER_iv_length(const EVP_CIPHER *cipher); 320 321 // EVP_CIPHER_flags returns a value which is the OR of zero or more 322 // |EVP_CIPH_*| flags. 323 OPENSSL_EXPORT uint32_t EVP_CIPHER_flags(const EVP_CIPHER *cipher); 324 325 // EVP_CIPHER_mode returns one of the cipher mode values enumerated below. 326 OPENSSL_EXPORT uint32_t EVP_CIPHER_mode(const EVP_CIPHER *cipher); 327 328 329 // Key derivation. 330 331 // EVP_BytesToKey generates a key and IV for the cipher |type| by iterating 332 // |md| |count| times using |data| and |salt|. On entry, the |key| and |iv| 333 // buffers must have enough space to hold a key and IV for |type|. It returns 334 // the length of the key on success or zero on error. 335 OPENSSL_EXPORT int EVP_BytesToKey(const EVP_CIPHER *type, const EVP_MD *md, 336 const uint8_t *salt, const uint8_t *data, 337 size_t data_len, unsigned count, uint8_t *key, 338 uint8_t *iv); 339 340 341 // Cipher modes (for |EVP_CIPHER_mode|). 342 343 #define EVP_CIPH_STREAM_CIPHER 0x0 344 #define EVP_CIPH_ECB_MODE 0x1 345 #define EVP_CIPH_CBC_MODE 0x2 346 #define EVP_CIPH_CFB_MODE 0x3 347 #define EVP_CIPH_OFB_MODE 0x4 348 #define EVP_CIPH_CTR_MODE 0x5 349 #define EVP_CIPH_GCM_MODE 0x6 350 #define EVP_CIPH_XTS_MODE 0x7 351 352 353 // Cipher flags (for |EVP_CIPHER_flags|). 354 355 // EVP_CIPH_VARIABLE_LENGTH indicates that the cipher takes a variable length 356 // key. 357 #define EVP_CIPH_VARIABLE_LENGTH 0x40 358 359 // EVP_CIPH_ALWAYS_CALL_INIT indicates that the |init| function for the cipher 360 // should always be called when initialising a new operation, even if the key 361 // is NULL to indicate that the same key is being used. 362 #define EVP_CIPH_ALWAYS_CALL_INIT 0x80 363 364 // EVP_CIPH_CUSTOM_IV indicates that the cipher manages the IV itself rather 365 // than keeping it in the |iv| member of |EVP_CIPHER_CTX|. 366 #define EVP_CIPH_CUSTOM_IV 0x100 367 368 // EVP_CIPH_CTRL_INIT indicates that EVP_CTRL_INIT should be used when 369 // initialising an |EVP_CIPHER_CTX|. 370 #define EVP_CIPH_CTRL_INIT 0x200 371 372 // EVP_CIPH_FLAG_CUSTOM_CIPHER indicates that the cipher manages blocking 373 // itself. This causes EVP_(En|De)crypt_ex to be simple wrapper functions. 374 #define EVP_CIPH_FLAG_CUSTOM_CIPHER 0x400 375 376 // EVP_CIPH_FLAG_AEAD_CIPHER specifies that the cipher is an AEAD. This is an 377 // older version of the proper AEAD interface. See aead.h for the current 378 // one. 379 #define EVP_CIPH_FLAG_AEAD_CIPHER 0x800 380 381 // EVP_CIPH_CUSTOM_COPY indicates that the |ctrl| callback should be called 382 // with |EVP_CTRL_COPY| at the end of normal |EVP_CIPHER_CTX_copy| 383 // processing. 384 #define EVP_CIPH_CUSTOM_COPY 0x1000 385 386 // EVP_CIPH_FLAG_NON_FIPS_ALLOW is meaningless. In OpenSSL it permits non-FIPS 387 // algorithms in FIPS mode. But BoringSSL FIPS mode doesn't prohibit algorithms 388 // (it's up the the caller to use the FIPS module in a fashion compliant with 389 // their needs). Thus this exists only to allow code to compile. 390 #define EVP_CIPH_FLAG_NON_FIPS_ALLOW 0 391 392 393 // Deprecated functions 394 395 // EVP_CipherInit acts like EVP_CipherInit_ex except that |EVP_CIPHER_CTX_init| 396 // is called on |cipher| first, if |cipher| is not NULL. 397 OPENSSL_EXPORT int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, 398 const uint8_t *key, const uint8_t *iv, 399 int enc); 400 401 // EVP_EncryptInit calls |EVP_CipherInit| with |enc| equal to one. 402 OPENSSL_EXPORT int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, 403 const EVP_CIPHER *cipher, const uint8_t *key, 404 const uint8_t *iv); 405 406 // EVP_DecryptInit calls |EVP_CipherInit| with |enc| equal to zero. 407 OPENSSL_EXPORT int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, 408 const EVP_CIPHER *cipher, const uint8_t *key, 409 const uint8_t *iv); 410 411 // EVP_CipherFinal calls |EVP_CipherFinal_ex|. 412 OPENSSL_EXPORT int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, uint8_t *out, 413 int *out_len); 414 415 // EVP_EncryptFinal calls |EVP_EncryptFinal_ex|. 416 OPENSSL_EXPORT int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, uint8_t *out, 417 int *out_len); 418 419 // EVP_DecryptFinal calls |EVP_DecryptFinal_ex|. 420 OPENSSL_EXPORT int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, uint8_t *out, 421 int *out_len); 422 423 // EVP_add_cipher_alias does nothing and returns one. 424 OPENSSL_EXPORT int EVP_add_cipher_alias(const char *a, const char *b); 425 426 // EVP_get_cipherbyname returns an |EVP_CIPHER| given a human readable name in 427 // |name|, or NULL if the name is unknown. Note using this function links almost 428 // every cipher implemented by BoringSSL into the binary, not just the ones the 429 // caller requests. Size-conscious callers, such as client software, should not 430 // use this function. 431 OPENSSL_EXPORT const EVP_CIPHER *EVP_get_cipherbyname(const char *name); 432 433 // These AEADs are deprecated AES-GCM implementations that set 434 // |EVP_CIPH_FLAG_CUSTOM_CIPHER|. Use |EVP_aead_aes_128_gcm| and 435 // |EVP_aead_aes_256_gcm| instead. 436 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_gcm(void); 437 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_gcm(void); 438 439 // These are deprecated, 192-bit version of AES. 440 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_192_ecb(void); 441 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_192_cbc(void); 442 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_192_ctr(void); 443 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_192_gcm(void); 444 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_192_ofb(void); 445 446 // EVP_des_ede3_ecb is an alias for |EVP_des_ede3|. Use the former instead. 447 OPENSSL_EXPORT const EVP_CIPHER *EVP_des_ede3_ecb(void); 448 449 // EVP_aes_128_cfb128 is only available in decrepit. 450 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_cfb128(void); 451 452 // EVP_aes_128_cfb is an alias for |EVP_aes_128_cfb128| and is only available in 453 // decrepit. 454 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_128_cfb(void); 455 456 // EVP_aes_192_cfb128 is only available in decrepit. 457 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_192_cfb128(void); 458 459 // EVP_aes_192_cfb is an alias for |EVP_aes_192_cfb128| and is only available in 460 // decrepit. 461 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_192_cfb(void); 462 463 // EVP_aes_256_cfb128 is only available in decrepit. 464 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_cfb128(void); 465 466 // EVP_aes_256_cfb is an alias for |EVP_aes_256_cfb128| and is only available in 467 // decrepit. 468 OPENSSL_EXPORT const EVP_CIPHER *EVP_aes_256_cfb(void); 469 470 // EVP_bf_ecb is Blowfish in ECB mode and is only available in decrepit. 471 OPENSSL_EXPORT const EVP_CIPHER *EVP_bf_ecb(void); 472 473 // EVP_bf_cbc is Blowfish in CBC mode and is only available in decrepit. 474 OPENSSL_EXPORT const EVP_CIPHER *EVP_bf_cbc(void); 475 476 // EVP_bf_cfb is Blowfish in 64-bit CFB mode and is only available in decrepit. 477 OPENSSL_EXPORT const EVP_CIPHER *EVP_bf_cfb(void); 478 479 // EVP_cast5_ecb is CAST5 in ECB mode and is only available in decrepit. 480 OPENSSL_EXPORT const EVP_CIPHER *EVP_cast5_ecb(void); 481 482 // EVP_cast5_cbc is CAST5 in CBC mode and is only available in decrepit. 483 OPENSSL_EXPORT const EVP_CIPHER *EVP_cast5_cbc(void); 484 485 // The following flags do nothing and are included only to make it easier to 486 // compile code with BoringSSL. 487 #define EVP_CIPH_CCM_MODE (-1) 488 #define EVP_CIPH_OCB_MODE (-2) 489 #define EVP_CIPH_WRAP_MODE (-3) 490 #define EVP_CIPHER_CTX_FLAG_WRAP_ALLOW 0 491 492 // EVP_CIPHER_CTX_set_flags does nothing. 493 OPENSSL_EXPORT void EVP_CIPHER_CTX_set_flags(const EVP_CIPHER_CTX *ctx, 494 uint32_t flags); 495 496 497 // Private functions. 498 499 // EVP_CIPH_NO_PADDING disables padding in block ciphers. 500 #define EVP_CIPH_NO_PADDING 0x800 501 502 // The following are |EVP_CIPHER_CTX_ctrl| commands. 503 #define EVP_CTRL_INIT 0x0 504 #define EVP_CTRL_SET_KEY_LENGTH 0x1 505 #define EVP_CTRL_GET_RC2_KEY_BITS 0x2 506 #define EVP_CTRL_SET_RC2_KEY_BITS 0x3 507 #define EVP_CTRL_GET_RC5_ROUNDS 0x4 508 #define EVP_CTRL_SET_RC5_ROUNDS 0x5 509 #define EVP_CTRL_RAND_KEY 0x6 510 #define EVP_CTRL_PBE_PRF_NID 0x7 511 #define EVP_CTRL_COPY 0x8 512 #define EVP_CTRL_AEAD_SET_IVLEN 0x9 513 #define EVP_CTRL_AEAD_GET_TAG 0x10 514 #define EVP_CTRL_AEAD_SET_TAG 0x11 515 #define EVP_CTRL_AEAD_SET_IV_FIXED 0x12 516 #define EVP_CTRL_GCM_IV_GEN 0x13 517 #define EVP_CTRL_AEAD_SET_MAC_KEY 0x17 518 // EVP_CTRL_GCM_SET_IV_INV sets the GCM invocation field, decrypt only 519 #define EVP_CTRL_GCM_SET_IV_INV 0x18 520 521 // The following constants are unused. 522 #define EVP_GCM_TLS_FIXED_IV_LEN 4 523 #define EVP_GCM_TLS_EXPLICIT_IV_LEN 8 524 #define EVP_GCM_TLS_TAG_LEN 16 525 526 // The following are legacy aliases for AEAD |EVP_CIPHER_CTX_ctrl| values. 527 #define EVP_CTRL_GCM_SET_IVLEN EVP_CTRL_AEAD_SET_IVLEN 528 #define EVP_CTRL_GCM_GET_TAG EVP_CTRL_AEAD_GET_TAG 529 #define EVP_CTRL_GCM_SET_TAG EVP_CTRL_AEAD_SET_TAG 530 #define EVP_CTRL_GCM_SET_IV_FIXED EVP_CTRL_AEAD_SET_IV_FIXED 531 532 #define EVP_MAX_KEY_LENGTH 64 533 #define EVP_MAX_IV_LENGTH 16 534 #define EVP_MAX_BLOCK_LENGTH 32 535 536 struct evp_cipher_ctx_st { 537 // cipher contains the underlying cipher for this context. 538 const EVP_CIPHER *cipher; 539 540 // app_data is a pointer to opaque, user data. 541 void *app_data; // application stuff 542 543 // cipher_data points to the |cipher| specific state. 544 void *cipher_data; 545 546 // key_len contains the length of the key, which may differ from 547 // |cipher->key_len| if the cipher can take a variable key length. 548 unsigned key_len; 549 550 // encrypt is one if encrypting and zero if decrypting. 551 int encrypt; 552 553 // flags contains the OR of zero or more |EVP_CIPH_*| flags, above. 554 uint32_t flags; 555 556 // oiv contains the original IV value. 557 uint8_t oiv[EVP_MAX_IV_LENGTH]; 558 559 // iv contains the current IV value, which may have been updated. 560 uint8_t iv[EVP_MAX_IV_LENGTH]; 561 562 // buf contains a partial block which is used by, for example, CTR mode to 563 // store unused keystream bytes. 564 uint8_t buf[EVP_MAX_BLOCK_LENGTH]; 565 566 // buf_len contains the number of bytes of a partial block contained in 567 // |buf|. 568 int buf_len; 569 570 // num contains the number of bytes of |iv| which are valid for modes that 571 // manage partial blocks themselves. 572 unsigned num; 573 574 // final_used is non-zero if the |final| buffer contains plaintext. 575 int final_used; 576 577 uint8_t final[EVP_MAX_BLOCK_LENGTH]; // possible final block 578 } /* EVP_CIPHER_CTX */; 579 580 typedef struct evp_cipher_info_st { 581 const EVP_CIPHER *cipher; 582 unsigned char iv[EVP_MAX_IV_LENGTH]; 583 } EVP_CIPHER_INFO; 584 585 struct evp_cipher_st { 586 // type contains a NID identifing the cipher. (e.g. NID_aes_128_gcm.) 587 int nid; 588 589 // block_size contains the block size, in bytes, of the cipher, or 1 for a 590 // stream cipher. 591 unsigned block_size; 592 593 // key_len contains the key size, in bytes, for the cipher. If the cipher 594 // takes a variable key size then this contains the default size. 595 unsigned key_len; 596 597 // iv_len contains the IV size, in bytes, or zero if inapplicable. 598 unsigned iv_len; 599 600 // ctx_size contains the size, in bytes, of the per-key context for this 601 // cipher. 602 unsigned ctx_size; 603 604 // flags contains the OR of a number of flags. See |EVP_CIPH_*|. 605 uint32_t flags; 606 607 // app_data is a pointer to opaque, user data. 608 void *app_data; 609 610 int (*init)(EVP_CIPHER_CTX *ctx, const uint8_t *key, const uint8_t *iv, 611 int enc); 612 613 int (*cipher)(EVP_CIPHER_CTX *ctx, uint8_t *out, const uint8_t *in, 614 size_t inl); 615 616 // cleanup, if non-NULL, releases memory associated with the context. It is 617 // called if |EVP_CTRL_INIT| succeeds. Note that |init| may not have been 618 // called at this point. 619 void (*cleanup)(EVP_CIPHER_CTX *); 620 621 int (*ctrl)(EVP_CIPHER_CTX *, int type, int arg, void *ptr); 622 }; 623 624 625 #if defined(__cplusplus) 626 } // extern C 627 628 #if !defined(BORINGSSL_NO_CXX) 629 extern "C++" { 630 631 BSSL_NAMESPACE_BEGIN 632 633 BORINGSSL_MAKE_DELETER(EVP_CIPHER_CTX, EVP_CIPHER_CTX_free) 634 635 using ScopedEVP_CIPHER_CTX = 636 internal::StackAllocated<EVP_CIPHER_CTX, int, EVP_CIPHER_CTX_init, 637 EVP_CIPHER_CTX_cleanup>; 638 639 BSSL_NAMESPACE_END 640 641 } // extern C++ 642 #endif 643 644 #endif 645 646 #define CIPHER_R_AES_KEY_SETUP_FAILED 100 647 #define CIPHER_R_BAD_DECRYPT 101 648 #define CIPHER_R_BAD_KEY_LENGTH 102 649 #define CIPHER_R_BUFFER_TOO_SMALL 103 650 #define CIPHER_R_CTRL_NOT_IMPLEMENTED 104 651 #define CIPHER_R_CTRL_OPERATION_NOT_IMPLEMENTED 105 652 #define CIPHER_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH 106 653 #define CIPHER_R_INITIALIZATION_ERROR 107 654 #define CIPHER_R_INPUT_NOT_INITIALIZED 108 655 #define CIPHER_R_INVALID_AD_SIZE 109 656 #define CIPHER_R_INVALID_KEY_LENGTH 110 657 #define CIPHER_R_INVALID_NONCE_SIZE 111 658 #define CIPHER_R_INVALID_OPERATION 112 659 #define CIPHER_R_IV_TOO_LARGE 113 660 #define CIPHER_R_NO_CIPHER_SET 114 661 #define CIPHER_R_OUTPUT_ALIASES_INPUT 115 662 #define CIPHER_R_TAG_TOO_LARGE 116 663 #define CIPHER_R_TOO_LARGE 117 664 #define CIPHER_R_UNSUPPORTED_AD_SIZE 118 665 #define CIPHER_R_UNSUPPORTED_INPUT_SIZE 119 666 #define CIPHER_R_UNSUPPORTED_KEY_SIZE 120 667 #define CIPHER_R_UNSUPPORTED_NONCE_SIZE 121 668 #define CIPHER_R_UNSUPPORTED_TAG_SIZE 122 669 #define CIPHER_R_WRONG_FINAL_BLOCK_LENGTH 123 670 #define CIPHER_R_NO_DIRECTION_SET 124 671 #define CIPHER_R_INVALID_NONCE 125 672 673 #endif // OPENSSL_HEADER_CIPHER_H 674