Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame^] | 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_INTERNAL_H |
| 58 | #define OPENSSL_HEADER_CIPHER_INTERNAL_H |
| 59 | |
| 60 | #include <openssl/base.h> |
| 61 | |
| 62 | #include <openssl/asn1t.h> |
| 63 | |
| 64 | #if defined(__cplusplus) |
| 65 | extern "C" { |
| 66 | #endif |
| 67 | |
| 68 | |
| 69 | struct evp_cipher_st { |
| 70 | /* type contains a NID identifing the cipher. (For example, NID_rc4.) */ |
| 71 | int nid; |
| 72 | |
| 73 | /* block_size contains the block size, in bytes, of the cipher, or 1 for a |
| 74 | * stream cipher. */ |
| 75 | unsigned block_size; |
| 76 | |
| 77 | /* key_len contains the key size, in bytes, for the cipher. If the cipher |
| 78 | * takes a variable key size then this contains the default size. */ |
| 79 | unsigned key_len; |
| 80 | |
| 81 | /* iv_len contains the IV size, in bytes, or zero if inapplicable. */ |
| 82 | unsigned iv_len; |
| 83 | |
| 84 | /* ctx_size contains the size, in bytes, of the per-key context for this |
| 85 | * cipher. */ |
| 86 | unsigned ctx_size; |
| 87 | |
| 88 | /* flags contains the OR of a number of flags. See |EVP_CIPH_*|. */ |
| 89 | uint32_t flags; |
| 90 | |
| 91 | /* app_data is a pointer to opaque, user data. */ |
| 92 | void *app_data; |
| 93 | |
| 94 | int (*init)(EVP_CIPHER_CTX *ctx, const uint8_t *key, const uint8_t *iv, |
| 95 | int enc); |
| 96 | |
| 97 | int (*cipher)(EVP_CIPHER_CTX *ctx, uint8_t *out, const uint8_t *in, |
| 98 | size_t inl); |
| 99 | |
| 100 | int (*cleanup)(EVP_CIPHER_CTX *); |
| 101 | |
| 102 | int (*ctrl)(EVP_CIPHER_CTX *, int type, int arg, void *ptr); |
| 103 | }; |
| 104 | |
| 105 | /* EVP_CIPH_MODE_MASK contains the bits of |flags| that represent the mode. */ |
| 106 | #define EVP_CIPH_MODE_MASK 0x3f |
| 107 | |
| 108 | |
| 109 | struct evp_aead_ctx_st; |
| 110 | |
| 111 | /* EVP_AEAD represents a specific AEAD algorithm. */ |
| 112 | struct evp_aead_st { |
| 113 | uint8_t key_len; |
| 114 | uint8_t nonce_len; |
| 115 | uint8_t overhead; |
| 116 | uint8_t max_tag_len; |
| 117 | |
| 118 | int (*init)(struct evp_aead_ctx_st *, const uint8_t *key, |
| 119 | size_t key_len, size_t tag_len); |
| 120 | void (*cleanup)(struct evp_aead_ctx_st *); |
| 121 | |
| 122 | int (*seal)(const struct evp_aead_ctx_st *ctx, uint8_t *out, |
| 123 | size_t *out_len, size_t max_out_len, const uint8_t *nonce, |
| 124 | size_t nonce_len, const uint8_t *in, size_t in_len, |
| 125 | const uint8_t *ad, size_t ad_len); |
| 126 | |
| 127 | int (*open)(const struct evp_aead_ctx_st *ctx, uint8_t *out, |
| 128 | size_t *out_len, size_t max_out_len, const uint8_t *nonce, |
| 129 | size_t nonce_len, const uint8_t *in, size_t in_len, |
| 130 | const uint8_t *ad, size_t ad_len); |
| 131 | }; |
| 132 | |
| 133 | |
| 134 | /* EVP_tls_cbc_get_padding determines the padding from the decrypted, TLS, CBC |
| 135 | * record in |in|. This decrypted record should not include any "decrypted" |
| 136 | * explicit IV. It sets |*out_len| to the length with the padding removed or |
| 137 | * |in_len| if invalid. |
| 138 | * |
| 139 | * block_size: the block size of the cipher used to encrypt the record. |
| 140 | * returns: |
| 141 | * 0: (in non-constant time) if the record is publicly invalid. |
| 142 | * 1: if the padding was valid |
| 143 | * -1: otherwise. */ |
| 144 | int EVP_tls_cbc_remove_padding(unsigned *out_len, |
| 145 | const uint8_t *in, unsigned in_len, |
| 146 | unsigned block_size, unsigned mac_size); |
| 147 | |
| 148 | /* EVP_tls_cbc_copy_mac copies |md_size| bytes from the end of the first |
| 149 | * |in_len| bytes of |in| to |out| in constant time (independent of the concrete |
| 150 | * value of |in_len|, which may vary within a 256-byte window). |in| must point |
| 151 | * to a buffer of |orig_len| bytes. |
| 152 | * |
| 153 | * On entry: |
| 154 | * orig_len >= in_len >= md_size |
| 155 | * md_size <= EVP_MAX_MD_SIZE */ |
| 156 | void EVP_tls_cbc_copy_mac(uint8_t *out, unsigned md_size, |
| 157 | const uint8_t *in, unsigned in_len, |
| 158 | unsigned orig_len); |
| 159 | |
| 160 | /* EVP_tls_cbc_record_digest_supported returns 1 iff |md| is a hash function |
| 161 | * which EVP_tls_cbc_digest_record supports. */ |
| 162 | int EVP_tls_cbc_record_digest_supported(const EVP_MD *md); |
| 163 | |
| 164 | /* EVP_tls_cbc_digest_record computes the MAC of a decrypted, padded TLS |
| 165 | * record. |
| 166 | * |
| 167 | * md: the hash function used in the HMAC. |
| 168 | * EVP_tls_cbc_record_digest_supported must return true for this hash. |
| 169 | * md_out: the digest output. At most EVP_MAX_MD_SIZE bytes will be written. |
| 170 | * md_out_size: the number of output bytes is written here. |
| 171 | * header: the 13-byte, TLS record header. |
| 172 | * data: the record data itself |
| 173 | * data_plus_mac_size: the secret, reported length of the data and MAC |
| 174 | * once the padding has been removed. |
| 175 | * data_plus_mac_plus_padding_size: the public length of the whole |
| 176 | * record, including padding. |
| 177 | * |
| 178 | * On entry: by virtue of having been through one of the remove_padding |
| 179 | * functions, above, we know that data_plus_mac_size is large enough to contain |
| 180 | * a padding byte and MAC. (If the padding was invalid, it might contain the |
| 181 | * padding too. ) */ |
| 182 | int EVP_tls_cbc_digest_record(const EVP_MD *md, uint8_t *md_out, |
| 183 | size_t *md_out_size, const uint8_t header[13], |
| 184 | const uint8_t *data, size_t data_plus_mac_size, |
| 185 | size_t data_plus_mac_plus_padding_size, |
| 186 | const uint8_t *mac_secret, |
| 187 | unsigned mac_secret_length); |
| 188 | |
| 189 | #if defined(__cplusplus) |
| 190 | } /* extern C */ |
| 191 | #endif |
| 192 | |
| 193 | #endif /* OPENSSL_HEADER_CIPHER_INTERNAL_H */ |