/src/openssl/crypto/evp/bio_enc.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved. |
3 | | * |
4 | | * Licensed under the Apache License 2.0 (the "License"). You may not use |
5 | | * this file except in compliance with the License. You can obtain a copy |
6 | | * in the file LICENSE in the source distribution or at |
7 | | * https://www.openssl.org/source/license.html |
8 | | */ |
9 | | |
10 | | #define OPENSSL_SUPPRESS_DEPRECATED /* for BIO_get_callback */ |
11 | | |
12 | | #include <stdio.h> |
13 | | #include <errno.h> |
14 | | #include "internal/cryptlib.h" |
15 | | #include <openssl/buffer.h> |
16 | | #include <openssl/evp.h> |
17 | | #include "internal/bio.h" |
18 | | |
19 | | static int enc_write(BIO *h, const char *buf, int num); |
20 | | static int enc_read(BIO *h, char *buf, int size); |
21 | | static long enc_ctrl(BIO *h, int cmd, long arg1, void *arg2); |
22 | | static int enc_new(BIO *h); |
23 | | static int enc_free(BIO *data); |
24 | | static long enc_callback_ctrl(BIO *h, int cmd, BIO_info_cb *fps); |
25 | 0 | #define ENC_BLOCK_SIZE (1024*4) |
26 | 0 | #define ENC_MIN_CHUNK (256) |
27 | 0 | #define BUF_OFFSET (ENC_MIN_CHUNK + EVP_MAX_BLOCK_LENGTH) |
28 | | |
29 | | typedef struct enc_struct { |
30 | | int buf_len; |
31 | | int buf_off; |
32 | | int cont; /* <= 0 when finished */ |
33 | | int finished; |
34 | | int ok; /* bad decrypt */ |
35 | | EVP_CIPHER_CTX *cipher; |
36 | | unsigned char *read_start, *read_end; |
37 | | /* |
38 | | * buf is larger than ENC_BLOCK_SIZE because EVP_DecryptUpdate can return |
39 | | * up to a block more data than is presented to it |
40 | | */ |
41 | | unsigned char buf[BUF_OFFSET + ENC_BLOCK_SIZE]; |
42 | | } BIO_ENC_CTX; |
43 | | |
44 | | static const BIO_METHOD methods_enc = { |
45 | | BIO_TYPE_CIPHER, |
46 | | "cipher", |
47 | | bwrite_conv, |
48 | | enc_write, |
49 | | bread_conv, |
50 | | enc_read, |
51 | | NULL, /* enc_puts, */ |
52 | | NULL, /* enc_gets, */ |
53 | | enc_ctrl, |
54 | | enc_new, |
55 | | enc_free, |
56 | | enc_callback_ctrl, |
57 | | }; |
58 | | |
59 | | const BIO_METHOD *BIO_f_cipher(void) |
60 | 0 | { |
61 | 0 | return &methods_enc; |
62 | 0 | } |
63 | | |
64 | | static int enc_new(BIO *bi) |
65 | 0 | { |
66 | 0 | BIO_ENC_CTX *ctx; |
67 | |
|
68 | 0 | if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL) |
69 | 0 | return 0; |
70 | | |
71 | 0 | ctx->cipher = EVP_CIPHER_CTX_new(); |
72 | 0 | if (ctx->cipher == NULL) { |
73 | 0 | OPENSSL_free(ctx); |
74 | 0 | return 0; |
75 | 0 | } |
76 | 0 | ctx->cont = 1; |
77 | 0 | ctx->ok = 1; |
78 | 0 | ctx->read_end = ctx->read_start = &(ctx->buf[BUF_OFFSET]); |
79 | 0 | BIO_set_data(bi, ctx); |
80 | 0 | BIO_set_init(bi, 1); |
81 | |
|
82 | 0 | return 1; |
83 | 0 | } |
84 | | |
85 | | static int enc_free(BIO *a) |
86 | 0 | { |
87 | 0 | BIO_ENC_CTX *b; |
88 | |
|
89 | 0 | if (a == NULL) |
90 | 0 | return 0; |
91 | | |
92 | 0 | b = BIO_get_data(a); |
93 | 0 | if (b == NULL) |
94 | 0 | return 0; |
95 | | |
96 | 0 | EVP_CIPHER_CTX_free(b->cipher); |
97 | 0 | OPENSSL_clear_free(b, sizeof(BIO_ENC_CTX)); |
98 | 0 | BIO_set_data(a, NULL); |
99 | 0 | BIO_set_init(a, 0); |
100 | |
|
101 | 0 | return 1; |
102 | 0 | } |
103 | | |
104 | | static int enc_read(BIO *b, char *out, int outl) |
105 | 0 | { |
106 | 0 | int ret = 0, i, blocksize; |
107 | 0 | BIO_ENC_CTX *ctx; |
108 | 0 | BIO *next; |
109 | |
|
110 | 0 | if (out == NULL) |
111 | 0 | return 0; |
112 | 0 | ctx = BIO_get_data(b); |
113 | |
|
114 | 0 | next = BIO_next(b); |
115 | 0 | if ((ctx == NULL) || (next == NULL)) |
116 | 0 | return 0; |
117 | | |
118 | | /* First check if there are bytes decoded/encoded */ |
119 | 0 | if (ctx->buf_len > 0) { |
120 | 0 | i = ctx->buf_len - ctx->buf_off; |
121 | 0 | if (i > outl) |
122 | 0 | i = outl; |
123 | 0 | memcpy(out, &(ctx->buf[ctx->buf_off]), i); |
124 | 0 | ret = i; |
125 | 0 | out += i; |
126 | 0 | outl -= i; |
127 | 0 | ctx->buf_off += i; |
128 | 0 | if (ctx->buf_len == ctx->buf_off) { |
129 | 0 | ctx->buf_len = 0; |
130 | 0 | ctx->buf_off = 0; |
131 | 0 | } |
132 | 0 | } |
133 | |
|
134 | 0 | blocksize = EVP_CIPHER_CTX_get_block_size(ctx->cipher); |
135 | 0 | if (blocksize == 1) |
136 | 0 | blocksize = 0; |
137 | | |
138 | | /* |
139 | | * At this point, we have room of outl bytes and an empty buffer, so we |
140 | | * should read in some more. |
141 | | */ |
142 | |
|
143 | 0 | while (outl > 0) { |
144 | 0 | if (ctx->cont <= 0) |
145 | 0 | break; |
146 | | |
147 | 0 | if (ctx->read_start == ctx->read_end) { /* time to read more data */ |
148 | 0 | ctx->read_end = ctx->read_start = &(ctx->buf[BUF_OFFSET]); |
149 | 0 | i = BIO_read(next, ctx->read_start, ENC_BLOCK_SIZE); |
150 | 0 | if (i > 0) |
151 | 0 | ctx->read_end += i; |
152 | 0 | } else { |
153 | 0 | i = ctx->read_end - ctx->read_start; |
154 | 0 | } |
155 | |
|
156 | 0 | if (i <= 0) { |
157 | | /* Should be continue next time we are called? */ |
158 | 0 | if (!BIO_should_retry(next)) { |
159 | 0 | ctx->cont = i; |
160 | 0 | i = EVP_CipherFinal_ex(ctx->cipher, |
161 | 0 | ctx->buf, &(ctx->buf_len)); |
162 | 0 | ctx->ok = i; |
163 | 0 | ctx->buf_off = 0; |
164 | 0 | } else { |
165 | 0 | ret = (ret == 0) ? i : ret; |
166 | 0 | break; |
167 | 0 | } |
168 | 0 | } else { |
169 | 0 | if (outl > ENC_MIN_CHUNK) { |
170 | | /* |
171 | | * Depending on flags block cipher decrypt can write |
172 | | * one extra block and then back off, i.e. output buffer |
173 | | * has to accommodate extra block... |
174 | | */ |
175 | 0 | int j = outl - blocksize, buf_len; |
176 | |
|
177 | 0 | if (!EVP_CipherUpdate(ctx->cipher, |
178 | 0 | (unsigned char *)out, &buf_len, |
179 | 0 | ctx->read_start, i > j ? j : i)) { |
180 | 0 | BIO_clear_retry_flags(b); |
181 | 0 | return 0; |
182 | 0 | } |
183 | 0 | ret += buf_len; |
184 | 0 | out += buf_len; |
185 | 0 | outl -= buf_len; |
186 | |
|
187 | 0 | if ((i -= j) <= 0) { |
188 | 0 | ctx->read_start = ctx->read_end; |
189 | 0 | continue; |
190 | 0 | } |
191 | 0 | ctx->read_start += j; |
192 | 0 | } |
193 | 0 | if (i > ENC_MIN_CHUNK) |
194 | 0 | i = ENC_MIN_CHUNK; |
195 | 0 | if (!EVP_CipherUpdate(ctx->cipher, |
196 | 0 | ctx->buf, &ctx->buf_len, |
197 | 0 | ctx->read_start, i)) { |
198 | 0 | BIO_clear_retry_flags(b); |
199 | 0 | ctx->ok = 0; |
200 | 0 | return 0; |
201 | 0 | } |
202 | 0 | ctx->read_start += i; |
203 | 0 | ctx->cont = 1; |
204 | | /* |
205 | | * Note: it is possible for EVP_CipherUpdate to decrypt zero |
206 | | * bytes because this is or looks like the final block: if this |
207 | | * happens we should retry and either read more data or decrypt |
208 | | * the final block |
209 | | */ |
210 | 0 | if (ctx->buf_len == 0) |
211 | 0 | continue; |
212 | 0 | } |
213 | | |
214 | 0 | if (ctx->buf_len <= outl) |
215 | 0 | i = ctx->buf_len; |
216 | 0 | else |
217 | 0 | i = outl; |
218 | 0 | if (i <= 0) |
219 | 0 | break; |
220 | 0 | memcpy(out, ctx->buf, i); |
221 | 0 | ret += i; |
222 | 0 | ctx->buf_off = i; |
223 | 0 | outl -= i; |
224 | 0 | out += i; |
225 | 0 | } |
226 | | |
227 | 0 | BIO_clear_retry_flags(b); |
228 | 0 | BIO_copy_next_retry(b); |
229 | 0 | return ((ret == 0) ? ctx->cont : ret); |
230 | 0 | } |
231 | | |
232 | | static int enc_write(BIO *b, const char *in, int inl) |
233 | 0 | { |
234 | 0 | int ret = 0, n, i; |
235 | 0 | BIO_ENC_CTX *ctx; |
236 | 0 | BIO *next; |
237 | |
|
238 | 0 | ctx = BIO_get_data(b); |
239 | 0 | next = BIO_next(b); |
240 | 0 | if ((ctx == NULL) || (next == NULL)) |
241 | 0 | return 0; |
242 | | |
243 | 0 | ret = inl; |
244 | |
|
245 | 0 | BIO_clear_retry_flags(b); |
246 | 0 | n = ctx->buf_len - ctx->buf_off; |
247 | 0 | while (n > 0) { |
248 | 0 | i = BIO_write(next, &(ctx->buf[ctx->buf_off]), n); |
249 | 0 | if (i <= 0) { |
250 | 0 | BIO_copy_next_retry(b); |
251 | 0 | return i; |
252 | 0 | } |
253 | 0 | ctx->buf_off += i; |
254 | 0 | n -= i; |
255 | 0 | } |
256 | | /* at this point all pending data has been written */ |
257 | | |
258 | 0 | if ((in == NULL) || (inl <= 0)) |
259 | 0 | return 0; |
260 | | |
261 | 0 | ctx->buf_off = 0; |
262 | 0 | while (inl > 0) { |
263 | 0 | n = (inl > ENC_BLOCK_SIZE) ? ENC_BLOCK_SIZE : inl; |
264 | 0 | if (!EVP_CipherUpdate(ctx->cipher, |
265 | 0 | ctx->buf, &ctx->buf_len, |
266 | 0 | (const unsigned char *)in, n)) { |
267 | 0 | BIO_clear_retry_flags(b); |
268 | 0 | ctx->ok = 0; |
269 | 0 | return 0; |
270 | 0 | } |
271 | 0 | inl -= n; |
272 | 0 | in += n; |
273 | |
|
274 | 0 | ctx->buf_off = 0; |
275 | 0 | n = ctx->buf_len; |
276 | 0 | while (n > 0) { |
277 | 0 | i = BIO_write(next, &(ctx->buf[ctx->buf_off]), n); |
278 | 0 | if (i <= 0) { |
279 | 0 | BIO_copy_next_retry(b); |
280 | 0 | return (ret == inl) ? i : ret - inl; |
281 | 0 | } |
282 | 0 | n -= i; |
283 | 0 | ctx->buf_off += i; |
284 | 0 | } |
285 | 0 | ctx->buf_len = 0; |
286 | 0 | ctx->buf_off = 0; |
287 | 0 | } |
288 | 0 | BIO_copy_next_retry(b); |
289 | 0 | return ret; |
290 | 0 | } |
291 | | |
292 | | static long enc_ctrl(BIO *b, int cmd, long num, void *ptr) |
293 | 0 | { |
294 | 0 | BIO *dbio; |
295 | 0 | BIO_ENC_CTX *ctx, *dctx; |
296 | 0 | long ret = 1; |
297 | 0 | int i; |
298 | 0 | EVP_CIPHER_CTX **c_ctx; |
299 | 0 | BIO *next; |
300 | 0 | int pend; |
301 | |
|
302 | 0 | ctx = BIO_get_data(b); |
303 | 0 | next = BIO_next(b); |
304 | 0 | if (ctx == NULL) |
305 | 0 | return 0; |
306 | | |
307 | 0 | switch (cmd) { |
308 | 0 | case BIO_CTRL_RESET: |
309 | 0 | ctx->ok = 1; |
310 | 0 | ctx->finished = 0; |
311 | 0 | if (!EVP_CipherInit_ex(ctx->cipher, NULL, NULL, NULL, NULL, |
312 | 0 | EVP_CIPHER_CTX_is_encrypting(ctx->cipher))) |
313 | 0 | return 0; |
314 | 0 | ret = BIO_ctrl(next, cmd, num, ptr); |
315 | 0 | break; |
316 | 0 | case BIO_CTRL_EOF: /* More to read */ |
317 | 0 | if (ctx->cont <= 0) |
318 | 0 | ret = 1; |
319 | 0 | else |
320 | 0 | ret = BIO_ctrl(next, cmd, num, ptr); |
321 | 0 | break; |
322 | 0 | case BIO_CTRL_WPENDING: |
323 | 0 | ret = ctx->buf_len - ctx->buf_off; |
324 | 0 | if (ret <= 0) |
325 | 0 | ret = BIO_ctrl(next, cmd, num, ptr); |
326 | 0 | break; |
327 | 0 | case BIO_CTRL_PENDING: /* More to read in buffer */ |
328 | 0 | ret = ctx->buf_len - ctx->buf_off; |
329 | 0 | if (ret <= 0) |
330 | 0 | ret = BIO_ctrl(next, cmd, num, ptr); |
331 | 0 | break; |
332 | 0 | case BIO_CTRL_FLUSH: |
333 | | /* do a final write */ |
334 | 0 | again: |
335 | 0 | while (ctx->buf_len != ctx->buf_off) { |
336 | 0 | pend = ctx->buf_len - ctx->buf_off; |
337 | 0 | i = enc_write(b, NULL, 0); |
338 | | /* |
339 | | * i should never be > 0 here because we didn't ask to write any |
340 | | * new data. We stop if we get an error or we failed to make any |
341 | | * progress writing pending data. |
342 | | */ |
343 | 0 | if (i < 0 || (ctx->buf_len - ctx->buf_off) == pend) |
344 | 0 | return i; |
345 | 0 | } |
346 | | |
347 | 0 | if (!ctx->finished) { |
348 | 0 | ctx->finished = 1; |
349 | 0 | ctx->buf_off = 0; |
350 | 0 | ret = EVP_CipherFinal_ex(ctx->cipher, |
351 | 0 | (unsigned char *)ctx->buf, |
352 | 0 | &(ctx->buf_len)); |
353 | 0 | ctx->ok = (int)ret; |
354 | 0 | if (ret <= 0) |
355 | 0 | break; |
356 | | |
357 | | /* push out the bytes */ |
358 | 0 | goto again; |
359 | 0 | } |
360 | | |
361 | | /* Finally flush the underlying BIO */ |
362 | 0 | ret = BIO_ctrl(next, cmd, num, ptr); |
363 | 0 | break; |
364 | 0 | case BIO_C_GET_CIPHER_STATUS: |
365 | 0 | ret = (long)ctx->ok; |
366 | 0 | break; |
367 | 0 | case BIO_C_DO_STATE_MACHINE: |
368 | 0 | BIO_clear_retry_flags(b); |
369 | 0 | ret = BIO_ctrl(next, cmd, num, ptr); |
370 | 0 | BIO_copy_next_retry(b); |
371 | 0 | break; |
372 | 0 | case BIO_C_GET_CIPHER_CTX: |
373 | 0 | c_ctx = (EVP_CIPHER_CTX **)ptr; |
374 | 0 | *c_ctx = ctx->cipher; |
375 | 0 | BIO_set_init(b, 1); |
376 | 0 | break; |
377 | 0 | case BIO_CTRL_DUP: |
378 | 0 | dbio = (BIO *)ptr; |
379 | 0 | dctx = BIO_get_data(dbio); |
380 | 0 | dctx->cipher = EVP_CIPHER_CTX_new(); |
381 | 0 | if (dctx->cipher == NULL) |
382 | 0 | return 0; |
383 | 0 | ret = EVP_CIPHER_CTX_copy(dctx->cipher, ctx->cipher); |
384 | 0 | if (ret) |
385 | 0 | BIO_set_init(dbio, 1); |
386 | 0 | break; |
387 | 0 | default: |
388 | 0 | ret = BIO_ctrl(next, cmd, num, ptr); |
389 | 0 | break; |
390 | 0 | } |
391 | 0 | return ret; |
392 | 0 | } |
393 | | |
394 | | static long enc_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp) |
395 | 0 | { |
396 | 0 | BIO *next = BIO_next(b); |
397 | |
|
398 | 0 | if (next == NULL) |
399 | 0 | return 0; |
400 | | |
401 | 0 | return BIO_callback_ctrl(next, cmd, fp); |
402 | 0 | } |
403 | | |
404 | | int BIO_set_cipher(BIO *b, const EVP_CIPHER *c, const unsigned char *k, |
405 | | const unsigned char *i, int e) |
406 | 0 | { |
407 | 0 | BIO_ENC_CTX *ctx; |
408 | 0 | BIO_callback_fn_ex callback_ex; |
409 | 0 | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
410 | 0 | long (*callback) (struct bio_st *, int, const char *, int, long, long) = NULL; |
411 | 0 | #endif |
412 | |
|
413 | 0 | ctx = BIO_get_data(b); |
414 | 0 | if (ctx == NULL) |
415 | 0 | return 0; |
416 | | |
417 | 0 | if ((callback_ex = BIO_get_callback_ex(b)) != NULL) { |
418 | 0 | if (callback_ex(b, BIO_CB_CTRL, (const char *)c, 0, BIO_CTRL_SET, |
419 | 0 | e, 1, NULL) <= 0) |
420 | 0 | return 0; |
421 | 0 | } |
422 | 0 | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
423 | 0 | else { |
424 | 0 | callback = BIO_get_callback(b); |
425 | |
|
426 | 0 | if ((callback != NULL) && |
427 | 0 | (callback(b, BIO_CB_CTRL, (const char *)c, BIO_CTRL_SET, e, |
428 | 0 | 0L) <= 0)) |
429 | 0 | return 0; |
430 | 0 | } |
431 | 0 | #endif |
432 | | |
433 | 0 | BIO_set_init(b, 1); |
434 | |
|
435 | 0 | if (!EVP_CipherInit_ex(ctx->cipher, c, NULL, k, i, e)) |
436 | 0 | return 0; |
437 | | |
438 | 0 | if (callback_ex != NULL) |
439 | 0 | return callback_ex(b, BIO_CB_CTRL | BIO_CB_RETURN, (const char *)c, 0, |
440 | 0 | BIO_CTRL_SET, e, 1, NULL); |
441 | 0 | #ifndef OPENSSL_NO_DEPRECATED_3_0 |
442 | 0 | else if (callback != NULL) |
443 | 0 | return callback(b, BIO_CB_CTRL, (const char *)c, BIO_CTRL_SET, e, 1L); |
444 | 0 | #endif |
445 | 0 | return 1; |
446 | 0 | } |