1 | /**
|
---|
2 | * \file blowfish.h
|
---|
3 | *
|
---|
4 | * \brief Blowfish block cipher
|
---|
5 | */
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
|
---|
8 | * SPDX-License-Identifier: Apache-2.0
|
---|
9 | *
|
---|
10 | * Licensed under the Apache License, Version 2.0 (the "License"); you may
|
---|
11 | * not use this file except in compliance with the License.
|
---|
12 | * You may obtain a copy of the License at
|
---|
13 | *
|
---|
14 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
15 | *
|
---|
16 | * Unless required by applicable law or agreed to in writing, software
|
---|
17 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
18 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
19 | * See the License for the specific language governing permissions and
|
---|
20 | * limitations under the License.
|
---|
21 | *
|
---|
22 | * This file is part of mbed TLS (https://tls.mbed.org)
|
---|
23 | */
|
---|
24 | #ifndef MBEDTLS_BLOWFISH_H
|
---|
25 | #define MBEDTLS_BLOWFISH_H
|
---|
26 |
|
---|
27 | #if !defined(MBEDTLS_CONFIG_FILE)
|
---|
28 | #include "config.h"
|
---|
29 | #else
|
---|
30 | #include MBEDTLS_CONFIG_FILE
|
---|
31 | #endif
|
---|
32 |
|
---|
33 | #include <stddef.h>
|
---|
34 | #include <stdint.h>
|
---|
35 |
|
---|
36 | #include "platform_util.h"
|
---|
37 |
|
---|
38 | #define MBEDTLS_BLOWFISH_ENCRYPT 1
|
---|
39 | #define MBEDTLS_BLOWFISH_DECRYPT 0
|
---|
40 | #define MBEDTLS_BLOWFISH_MAX_KEY_BITS 448
|
---|
41 | #define MBEDTLS_BLOWFISH_MIN_KEY_BITS 32
|
---|
42 | #define MBEDTLS_BLOWFISH_ROUNDS 16 /**< Rounds to use. When increasing this value, make sure to extend the initialisation vectors */
|
---|
43 | #define MBEDTLS_BLOWFISH_BLOCKSIZE 8 /* Blowfish uses 64 bit blocks */
|
---|
44 |
|
---|
45 | #if !defined(MBEDTLS_DEPRECATED_REMOVED)
|
---|
46 | #define MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH MBEDTLS_DEPRECATED_NUMERIC_CONSTANT( -0x0016 )
|
---|
47 | #endif /* !MBEDTLS_DEPRECATED_REMOVED */
|
---|
48 | #define MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA -0x0016 /**< Bad input data. */
|
---|
49 |
|
---|
50 | #define MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH -0x0018 /**< Invalid data input length. */
|
---|
51 |
|
---|
52 | /* MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED is deprecated and should not be used.
|
---|
53 | */
|
---|
54 | #define MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED -0x0017 /**< Blowfish hardware accelerator failed. */
|
---|
55 |
|
---|
56 | #ifdef __cplusplus
|
---|
57 | extern "C" {
|
---|
58 | #endif
|
---|
59 |
|
---|
60 | #if !defined(MBEDTLS_BLOWFISH_ALT)
|
---|
61 | // Regular implementation
|
---|
62 | //
|
---|
63 |
|
---|
64 | /**
|
---|
65 | * \brief Blowfish context structure
|
---|
66 | */
|
---|
67 | typedef struct mbedtls_blowfish_context
|
---|
68 | {
|
---|
69 | uint32_t P[MBEDTLS_BLOWFISH_ROUNDS + 2]; /*!< Blowfish round keys */
|
---|
70 | uint32_t S[4][256]; /*!< key dependent S-boxes */
|
---|
71 | }
|
---|
72 | mbedtls_blowfish_context;
|
---|
73 |
|
---|
74 | #else /* MBEDTLS_BLOWFISH_ALT */
|
---|
75 | #include "blowfish_alt.h"
|
---|
76 | #endif /* MBEDTLS_BLOWFISH_ALT */
|
---|
77 |
|
---|
78 | /**
|
---|
79 | * \brief Initialize a Blowfish context.
|
---|
80 | *
|
---|
81 | * \param ctx The Blowfish context to be initialized.
|
---|
82 | * This must not be \c NULL.
|
---|
83 | */
|
---|
84 | void mbedtls_blowfish_init( mbedtls_blowfish_context *ctx );
|
---|
85 |
|
---|
86 | /**
|
---|
87 | * \brief Clear a Blowfish context.
|
---|
88 | *
|
---|
89 | * \param ctx The Blowfish context to be cleared.
|
---|
90 | * This may be \c NULL, in which case this function
|
---|
91 | * returns immediately. If it is not \c NULL, it must
|
---|
92 | * point to an initialized Blowfish context.
|
---|
93 | */
|
---|
94 | void mbedtls_blowfish_free( mbedtls_blowfish_context *ctx );
|
---|
95 |
|
---|
96 | /**
|
---|
97 | * \brief Perform a Blowfish key schedule operation.
|
---|
98 | *
|
---|
99 | * \param ctx The Blowfish context to perform the key schedule on.
|
---|
100 | * \param key The encryption key. This must be a readable buffer of
|
---|
101 | * length \p keybits Bits.
|
---|
102 | * \param keybits The length of \p key in Bits. This must be between
|
---|
103 | * \c 32 and \c 448 and a multiple of \c 8.
|
---|
104 | *
|
---|
105 | * \return \c 0 if successful.
|
---|
106 | * \return A negative error code on failure.
|
---|
107 | */
|
---|
108 | int mbedtls_blowfish_setkey( mbedtls_blowfish_context *ctx, const unsigned char *key,
|
---|
109 | unsigned int keybits );
|
---|
110 |
|
---|
111 | /**
|
---|
112 | * \brief Perform a Blowfish-ECB block encryption/decryption operation.
|
---|
113 | *
|
---|
114 | * \param ctx The Blowfish context to use. This must be initialized
|
---|
115 | * and bound to a key.
|
---|
116 | * \param mode The mode of operation. Possible values are
|
---|
117 | * #MBEDTLS_BLOWFISH_ENCRYPT for encryption, or
|
---|
118 | * #MBEDTLS_BLOWFISH_DECRYPT for decryption.
|
---|
119 | * \param input The input block. This must be a readable buffer
|
---|
120 | * of size \c 8 Bytes.
|
---|
121 | * \param output The output block. This must be a writable buffer
|
---|
122 | * of size \c 8 Bytes.
|
---|
123 | *
|
---|
124 | * \return \c 0 if successful.
|
---|
125 | * \return A negative error code on failure.
|
---|
126 | */
|
---|
127 | int mbedtls_blowfish_crypt_ecb( mbedtls_blowfish_context *ctx,
|
---|
128 | int mode,
|
---|
129 | const unsigned char input[MBEDTLS_BLOWFISH_BLOCKSIZE],
|
---|
130 | unsigned char output[MBEDTLS_BLOWFISH_BLOCKSIZE] );
|
---|
131 |
|
---|
132 | #if defined(MBEDTLS_CIPHER_MODE_CBC)
|
---|
133 | /**
|
---|
134 | * \brief Perform a Blowfish-CBC buffer encryption/decryption operation.
|
---|
135 | *
|
---|
136 | * \note Upon exit, the content of the IV is updated so that you can
|
---|
137 | * call the function same function again on the following
|
---|
138 | * block(s) of data and get the same result as if it was
|
---|
139 | * encrypted in one call. This allows a "streaming" usage.
|
---|
140 | * If on the other hand you need to retain the contents of the
|
---|
141 | * IV, you should either save it manually or use the cipher
|
---|
142 | * module instead.
|
---|
143 | *
|
---|
144 | * \param ctx The Blowfish context to use. This must be initialized
|
---|
145 | * and bound to a key.
|
---|
146 | * \param mode The mode of operation. Possible values are
|
---|
147 | * #MBEDTLS_BLOWFISH_ENCRYPT for encryption, or
|
---|
148 | * #MBEDTLS_BLOWFISH_DECRYPT for decryption.
|
---|
149 | * \param length The length of the input data in Bytes. This must be
|
---|
150 | * multiple of \c 8.
|
---|
151 | * \param iv The initialization vector. This must be a read/write buffer
|
---|
152 | * of length \c 8 Bytes. It is updated by this function.
|
---|
153 | * \param input The input data. This must be a readable buffer of length
|
---|
154 | * \p length Bytes.
|
---|
155 | * \param output The output data. This must be a writable buffer of length
|
---|
156 | * \p length Bytes.
|
---|
157 | *
|
---|
158 | * \return \c 0 if successful.
|
---|
159 | * \return A negative error code on failure.
|
---|
160 | */
|
---|
161 | int mbedtls_blowfish_crypt_cbc( mbedtls_blowfish_context *ctx,
|
---|
162 | int mode,
|
---|
163 | size_t length,
|
---|
164 | unsigned char iv[MBEDTLS_BLOWFISH_BLOCKSIZE],
|
---|
165 | const unsigned char *input,
|
---|
166 | unsigned char *output );
|
---|
167 | #endif /* MBEDTLS_CIPHER_MODE_CBC */
|
---|
168 |
|
---|
169 | #if defined(MBEDTLS_CIPHER_MODE_CFB)
|
---|
170 | /**
|
---|
171 | * \brief Perform a Blowfish CFB buffer encryption/decryption operation.
|
---|
172 | *
|
---|
173 | * \note Upon exit, the content of the IV is updated so that you can
|
---|
174 | * call the function same function again on the following
|
---|
175 | * block(s) of data and get the same result as if it was
|
---|
176 | * encrypted in one call. This allows a "streaming" usage.
|
---|
177 | * If on the other hand you need to retain the contents of the
|
---|
178 | * IV, you should either save it manually or use the cipher
|
---|
179 | * module instead.
|
---|
180 | *
|
---|
181 | * \param ctx The Blowfish context to use. This must be initialized
|
---|
182 | * and bound to a key.
|
---|
183 | * \param mode The mode of operation. Possible values are
|
---|
184 | * #MBEDTLS_BLOWFISH_ENCRYPT for encryption, or
|
---|
185 | * #MBEDTLS_BLOWFISH_DECRYPT for decryption.
|
---|
186 | * \param length The length of the input data in Bytes.
|
---|
187 | * \param iv_off The offset in the initialiation vector.
|
---|
188 | * The value pointed to must be smaller than \c 8 Bytes.
|
---|
189 | * It is updated by this function to support the aforementioned
|
---|
190 | * streaming usage.
|
---|
191 | * \param iv The initialization vector. This must be a read/write buffer
|
---|
192 | * of size \c 8 Bytes. It is updated after use.
|
---|
193 | * \param input The input data. This must be a readable buffer of length
|
---|
194 | * \p length Bytes.
|
---|
195 | * \param output The output data. This must be a writable buffer of length
|
---|
196 | * \p length Bytes.
|
---|
197 | *
|
---|
198 | * \return \c 0 if successful.
|
---|
199 | * \return A negative error code on failure.
|
---|
200 | */
|
---|
201 | int mbedtls_blowfish_crypt_cfb64( mbedtls_blowfish_context *ctx,
|
---|
202 | int mode,
|
---|
203 | size_t length,
|
---|
204 | size_t *iv_off,
|
---|
205 | unsigned char iv[MBEDTLS_BLOWFISH_BLOCKSIZE],
|
---|
206 | const unsigned char *input,
|
---|
207 | unsigned char *output );
|
---|
208 | #endif /*MBEDTLS_CIPHER_MODE_CFB */
|
---|
209 |
|
---|
210 | #if defined(MBEDTLS_CIPHER_MODE_CTR)
|
---|
211 | /**
|
---|
212 | * \brief Perform a Blowfish-CTR buffer encryption/decryption operation.
|
---|
213 | *
|
---|
214 | * \warning You must never reuse a nonce value with the same key. Doing so
|
---|
215 | * would void the encryption for the two messages encrypted with
|
---|
216 | * the same nonce and key.
|
---|
217 | *
|
---|
218 | * There are two common strategies for managing nonces with CTR:
|
---|
219 | *
|
---|
220 | * 1. You can handle everything as a single message processed over
|
---|
221 | * successive calls to this function. In that case, you want to
|
---|
222 | * set \p nonce_counter and \p nc_off to 0 for the first call, and
|
---|
223 | * then preserve the values of \p nonce_counter, \p nc_off and \p
|
---|
224 | * stream_block across calls to this function as they will be
|
---|
225 | * updated by this function.
|
---|
226 | *
|
---|
227 | * With this strategy, you must not encrypt more than 2**64
|
---|
228 | * blocks of data with the same key.
|
---|
229 | *
|
---|
230 | * 2. You can encrypt separate messages by dividing the \p
|
---|
231 | * nonce_counter buffer in two areas: the first one used for a
|
---|
232 | * per-message nonce, handled by yourself, and the second one
|
---|
233 | * updated by this function internally.
|
---|
234 | *
|
---|
235 | * For example, you might reserve the first 4 bytes for the
|
---|
236 | * per-message nonce, and the last 4 bytes for internal use. In that
|
---|
237 | * case, before calling this function on a new message you need to
|
---|
238 | * set the first 4 bytes of \p nonce_counter to your chosen nonce
|
---|
239 | * value, the last 4 to 0, and \p nc_off to 0 (which will cause \p
|
---|
240 | * stream_block to be ignored). That way, you can encrypt at most
|
---|
241 | * 2**32 messages of up to 2**32 blocks each with the same key.
|
---|
242 | *
|
---|
243 | * The per-message nonce (or information sufficient to reconstruct
|
---|
244 | * it) needs to be communicated with the ciphertext and must be unique.
|
---|
245 | * The recommended way to ensure uniqueness is to use a message
|
---|
246 | * counter.
|
---|
247 | *
|
---|
248 | * Note that for both stategies, sizes are measured in blocks and
|
---|
249 | * that a Blowfish block is 8 bytes.
|
---|
250 | *
|
---|
251 | * \warning Upon return, \p stream_block contains sensitive data. Its
|
---|
252 | * content must not be written to insecure storage and should be
|
---|
253 | * securely discarded as soon as it's no longer needed.
|
---|
254 | *
|
---|
255 | * \param ctx The Blowfish context to use. This must be initialized
|
---|
256 | * and bound to a key.
|
---|
257 | * \param length The length of the input data in Bytes.
|
---|
258 | * \param nc_off The offset in the current stream_block (for resuming
|
---|
259 | * within current cipher stream). The offset pointer
|
---|
260 | * should be \c 0 at the start of a stream and must be
|
---|
261 | * smaller than \c 8. It is updated by this function.
|
---|
262 | * \param nonce_counter The 64-bit nonce and counter. This must point to a
|
---|
263 | * read/write buffer of length \c 8 Bytes.
|
---|
264 | * \param stream_block The saved stream-block for resuming. This must point to
|
---|
265 | * a read/write buffer of length \c 8 Bytes.
|
---|
266 | * \param input The input data. This must be a readable buffer of
|
---|
267 | * length \p length Bytes.
|
---|
268 | * \param output The output data. This must be a writable buffer of
|
---|
269 | * length \p length Bytes.
|
---|
270 | *
|
---|
271 | * \return \c 0 if successful.
|
---|
272 | * \return A negative error code on failure.
|
---|
273 | */
|
---|
274 | int mbedtls_blowfish_crypt_ctr( mbedtls_blowfish_context *ctx,
|
---|
275 | size_t length,
|
---|
276 | size_t *nc_off,
|
---|
277 | unsigned char nonce_counter[MBEDTLS_BLOWFISH_BLOCKSIZE],
|
---|
278 | unsigned char stream_block[MBEDTLS_BLOWFISH_BLOCKSIZE],
|
---|
279 | const unsigned char *input,
|
---|
280 | unsigned char *output );
|
---|
281 | #endif /* MBEDTLS_CIPHER_MODE_CTR */
|
---|
282 |
|
---|
283 | #ifdef __cplusplus
|
---|
284 | }
|
---|
285 | #endif
|
---|
286 |
|
---|
287 | #endif /* blowfish.h */
|
---|