Coverage Report

Created: 2023-06-08 06:40

/src/openssl111/engines/e_afalg.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
3
 *
4
 * Licensed under the OpenSSL license (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
/* Required for vmsplice */
11
#ifndef _GNU_SOURCE
12
# define _GNU_SOURCE
13
#endif
14
#include <stdio.h>
15
#include <string.h>
16
#include <unistd.h>
17
18
#include <openssl/engine.h>
19
#include <openssl/async.h>
20
#include <openssl/err.h>
21
#include "internal/nelem.h"
22
23
#include <sys/socket.h>
24
#include <linux/version.h>
25
#define K_MAJ   4
26
#define K_MIN1  1
27
#define K_MIN2  0
28
#if LINUX_VERSION_CODE < KERNEL_VERSION(K_MAJ, K_MIN1, K_MIN2) || \
29
    !defined(AF_ALG)
30
# ifndef PEDANTIC
31
#  warning "AFALG ENGINE requires Kernel Headers >= 4.1.0"
32
#  warning "Skipping Compilation of AFALG engine"
33
# endif
34
void engine_load_afalg_int(void);
35
void engine_load_afalg_int(void)
36
{
37
}
38
#else
39
40
# include <linux/if_alg.h>
41
# include <fcntl.h>
42
# include <sys/utsname.h>
43
44
# include <linux/aio_abi.h>
45
# include <sys/syscall.h>
46
# include <errno.h>
47
48
# include "e_afalg.h"
49
# include "e_afalg_err.c"
50
51
# ifndef SOL_ALG
52
#  define SOL_ALG 279
53
# endif
54
55
# ifdef ALG_ZERO_COPY
56
#  ifndef SPLICE_F_GIFT
57
#   define SPLICE_F_GIFT    (0x08)
58
#  endif
59
# endif
60
61
0
# define ALG_AES_IV_LEN 16
62
# define ALG_IV_LEN(len) (sizeof(struct af_alg_iv) + (len))
63
# define ALG_OP_TYPE     unsigned int
64
0
# define ALG_OP_LEN      (sizeof(ALG_OP_TYPE))
65
66
# ifdef OPENSSL_NO_DYNAMIC_ENGINE
67
void engine_load_afalg_int(void);
68
# endif
69
70
/* Local Linkage Functions */
71
static int afalg_init_aio(afalg_aio *aio);
72
static int afalg_fin_cipher_aio(afalg_aio *ptr, int sfd,
73
                                unsigned char *buf, size_t len);
74
static int afalg_create_sk(afalg_ctx *actx, const char *ciphertype,
75
                                const char *ciphername);
76
static int afalg_destroy(ENGINE *e);
77
static int afalg_init(ENGINE *e);
78
static int afalg_finish(ENGINE *e);
79
static const EVP_CIPHER *afalg_aes_cbc(int nid);
80
static cbc_handles *get_cipher_handle(int nid);
81
static int afalg_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
82
                         const int **nids, int nid);
83
static int afalg_cipher_init(EVP_CIPHER_CTX *ctx, const unsigned char *key,
84
                             const unsigned char *iv, int enc);
85
static int afalg_do_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
86
                           const unsigned char *in, size_t inl);
87
static int afalg_cipher_cleanup(EVP_CIPHER_CTX *ctx);
88
static int afalg_chk_platform(void);
89
90
/* Engine Id and Name */
91
static const char *engine_afalg_id = "afalg";
92
static const char *engine_afalg_name = "AFALG engine support";
93
94
static int afalg_cipher_nids[] = {
95
    NID_aes_128_cbc,
96
    NID_aes_192_cbc,
97
    NID_aes_256_cbc,
98
};
99
100
static cbc_handles cbc_handle[] = {{AES_KEY_SIZE_128, NULL},
101
                                    {AES_KEY_SIZE_192, NULL},
102
                                    {AES_KEY_SIZE_256, NULL}};
103
104
static ossl_inline int io_setup(unsigned n, aio_context_t *ctx)
105
0
{
106
0
    return syscall(__NR_io_setup, n, ctx);
107
0
}
108
109
static ossl_inline int eventfd(int n)
110
0
{
111
0
    return syscall(__NR_eventfd2, n, 0);
112
0
}
113
114
static ossl_inline int io_destroy(aio_context_t ctx)
115
0
{
116
0
    return syscall(__NR_io_destroy, ctx);
117
0
}
118
119
static ossl_inline int io_read(aio_context_t ctx, long n, struct iocb **iocb)
120
0
{
121
0
    return syscall(__NR_io_submit, ctx, n, iocb);
122
0
}
123
124
static ossl_inline int io_getevents(aio_context_t ctx, long min, long max,
125
                               struct io_event *events,
126
                               struct timespec *timeout)
127
0
{
128
0
    return syscall(__NR_io_getevents, ctx, min, max, events, timeout);
129
0
}
130
131
static void afalg_waitfd_cleanup(ASYNC_WAIT_CTX *ctx, const void *key,
132
                                 OSSL_ASYNC_FD waitfd, void *custom)
133
0
{
134
0
    close(waitfd);
135
0
}
136
137
static int afalg_setup_async_event_notification(afalg_aio *aio)
138
0
{
139
0
    ASYNC_JOB *job;
140
0
    ASYNC_WAIT_CTX *waitctx;
141
0
    void *custom = NULL;
142
0
    int ret;
143
144
0
    if ((job = ASYNC_get_current_job()) != NULL) {
145
        /* Async mode */
146
0
        waitctx = ASYNC_get_wait_ctx(job);
147
0
        if (waitctx == NULL) {
148
0
            ALG_WARN("%s(%d): ASYNC_get_wait_ctx error", __FILE__, __LINE__);
149
0
            return 0;
150
0
        }
151
        /* Get waitfd from ASYNC_WAIT_CTX if it is already set */
152
0
        ret = ASYNC_WAIT_CTX_get_fd(waitctx, engine_afalg_id,
153
0
                                    &aio->efd, &custom);
154
0
        if (ret == 0) {
155
            /*
156
             * waitfd is not set in ASYNC_WAIT_CTX, create a new one
157
             * and set it. efd will be signaled when AIO operation completes
158
             */
159
0
            aio->efd = eventfd(0);
160
0
            if (aio->efd == -1) {
161
0
                ALG_PERR("%s(%d): Failed to get eventfd : ", __FILE__,
162
0
                         __LINE__);
163
0
                AFALGerr(AFALG_F_AFALG_SETUP_ASYNC_EVENT_NOTIFICATION,
164
0
                         AFALG_R_EVENTFD_FAILED);
165
0
                return 0;
166
0
            }
167
0
            ret = ASYNC_WAIT_CTX_set_wait_fd(waitctx, engine_afalg_id,
168
0
                                             aio->efd, custom,
169
0
                                             afalg_waitfd_cleanup);
170
0
            if (ret == 0) {
171
0
                ALG_WARN("%s(%d): Failed to set wait fd", __FILE__, __LINE__);
172
0
                close(aio->efd);
173
0
                return 0;
174
0
            }
175
            /* make fd non-blocking in async mode */
176
0
            if (fcntl(aio->efd, F_SETFL, O_NONBLOCK) != 0) {
177
0
                ALG_WARN("%s(%d): Failed to set event fd as NONBLOCKING",
178
0
                         __FILE__, __LINE__);
179
0
            }
180
0
        }
181
0
        aio->mode = MODE_ASYNC;
182
0
    } else {
183
        /* Sync mode */
184
0
        aio->efd = eventfd(0);
185
0
        if (aio->efd == -1) {
186
0
            ALG_PERR("%s(%d): Failed to get eventfd : ", __FILE__, __LINE__);
187
0
            AFALGerr(AFALG_F_AFALG_SETUP_ASYNC_EVENT_NOTIFICATION,
188
0
                     AFALG_R_EVENTFD_FAILED);
189
0
            return 0;
190
0
        }
191
0
        aio->mode = MODE_SYNC;
192
0
    }
193
0
    return 1;
194
0
}
195
196
static int afalg_init_aio(afalg_aio *aio)
197
0
{
198
0
    int r = -1;
199
200
    /* Initialise for AIO */
201
0
    aio->aio_ctx = 0;
202
0
    r = io_setup(MAX_INFLIGHTS, &aio->aio_ctx);
203
0
    if (r < 0) {
204
0
        ALG_PERR("%s(%d): io_setup error : ", __FILE__, __LINE__);
205
0
        AFALGerr(AFALG_F_AFALG_INIT_AIO, AFALG_R_IO_SETUP_FAILED);
206
0
        return 0;
207
0
    }
208
209
0
    memset(aio->cbt, 0, sizeof(aio->cbt));
210
0
    aio->efd = -1;
211
0
    aio->mode = MODE_UNINIT;
212
213
0
    return 1;
214
0
}
215
216
static int afalg_fin_cipher_aio(afalg_aio *aio, int sfd, unsigned char *buf,
217
                                size_t len)
218
0
{
219
0
    int r;
220
0
    int retry = 0;
221
0
    unsigned int done = 0;
222
0
    struct iocb *cb;
223
0
    struct timespec timeout;
224
0
    struct io_event events[MAX_INFLIGHTS];
225
0
    u_int64_t eval = 0;
226
227
0
    timeout.tv_sec = 0;
228
0
    timeout.tv_nsec = 0;
229
230
    /* if efd has not been initialised yet do it here */
231
0
    if (aio->mode == MODE_UNINIT) {
232
0
        r = afalg_setup_async_event_notification(aio);
233
0
        if (r == 0)
234
0
            return 0;
235
0
    }
236
237
0
    cb = &(aio->cbt[0 % MAX_INFLIGHTS]);
238
0
    memset(cb, '\0', sizeof(*cb));
239
0
    cb->aio_fildes = sfd;
240
0
    cb->aio_lio_opcode = IOCB_CMD_PREAD;
241
    /*
242
     * The pointer has to be converted to unsigned value first to avoid
243
     * sign extension on cast to 64 bit value in 32-bit builds
244
     */
245
0
    cb->aio_buf = (size_t)buf;
246
0
    cb->aio_offset = 0;
247
0
    cb->aio_data = 0;
248
0
    cb->aio_nbytes = len;
249
0
    cb->aio_flags = IOCB_FLAG_RESFD;
250
0
    cb->aio_resfd = aio->efd;
251
252
    /*
253
     * Perform AIO read on AFALG socket, this in turn performs an async
254
     * crypto operation in kernel space
255
     */
256
0
    r = io_read(aio->aio_ctx, 1, &cb);
257
0
    if (r < 0) {
258
0
        ALG_PWARN("%s(%d): io_read failed : ", __FILE__, __LINE__);
259
0
        return 0;
260
0
    }
261
262
0
    do {
263
        /* While AIO read is being performed pause job */
264
0
        ASYNC_pause_job();
265
266
        /* Check for completion of AIO read */
267
0
        r = read(aio->efd, &eval, sizeof(eval));
268
0
        if (r < 0) {
269
0
            if (errno == EAGAIN || errno == EWOULDBLOCK)
270
0
                continue;
271
0
            ALG_PERR("%s(%d): read failed for event fd : ", __FILE__, __LINE__);
272
0
            return 0;
273
0
        } else if (r == 0 || eval <= 0) {
274
0
            ALG_WARN("%s(%d): eventfd read %d bytes, eval = %lu\n", __FILE__,
275
0
                     __LINE__, r, eval);
276
0
        }
277
0
        if (eval > 0) {
278
279
            /* Get results of AIO read */
280
0
            r = io_getevents(aio->aio_ctx, 1, MAX_INFLIGHTS,
281
0
                             events, &timeout);
282
0
            if (r > 0) {
283
                /*
284
                 * events.res indicates the actual status of the operation.
285
                 * Handle the error condition first.
286
                 */
287
0
                if (events[0].res < 0) {
288
                    /*
289
                     * Underlying operation cannot be completed at the time
290
                     * of previous submission. Resubmit for the operation.
291
                     */
292
0
                    if (events[0].res == -EBUSY && retry++ < 3) {
293
0
                        r = io_read(aio->aio_ctx, 1, &cb);
294
0
                        if (r < 0) {
295
0
                            ALG_PERR("%s(%d): retry %d for io_read failed : ",
296
0
                                     __FILE__, __LINE__, retry);
297
0
                            return 0;
298
0
                        }
299
0
                        continue;
300
0
                    } else {
301
                        /*
302
                         * Retries exceed for -EBUSY or unrecoverable error
303
                         * condition for this instance of operation.
304
                         */
305
0
                        ALG_WARN
306
0
                            ("%s(%d): Crypto Operation failed with code %lld\n",
307
0
                             __FILE__, __LINE__, events[0].res);
308
0
                        return 0;
309
0
                    }
310
0
                }
311
                /* Operation successful. */
312
0
                done = 1;
313
0
            } else if (r < 0) {
314
0
                ALG_PERR("%s(%d): io_getevents failed : ", __FILE__, __LINE__);
315
0
                return 0;
316
0
            } else {
317
0
                ALG_WARN("%s(%d): io_geteventd read 0 bytes\n", __FILE__,
318
0
                         __LINE__);
319
0
            }
320
0
        }
321
0
    } while (!done);
322
323
0
    return 1;
324
0
}
325
326
static ossl_inline void afalg_set_op_sk(struct cmsghdr *cmsg,
327
                                   const ALG_OP_TYPE op)
328
0
{
329
0
    cmsg->cmsg_level = SOL_ALG;
330
0
    cmsg->cmsg_type = ALG_SET_OP;
331
0
    cmsg->cmsg_len = CMSG_LEN(ALG_OP_LEN);
332
0
    memcpy(CMSG_DATA(cmsg), &op, ALG_OP_LEN);
333
0
}
334
335
static void afalg_set_iv_sk(struct cmsghdr *cmsg, const unsigned char *iv,
336
                            const unsigned int len)
337
0
{
338
0
    struct af_alg_iv *aiv;
339
340
0
    cmsg->cmsg_level = SOL_ALG;
341
0
    cmsg->cmsg_type = ALG_SET_IV;
342
0
    cmsg->cmsg_len = CMSG_LEN(ALG_IV_LEN(len));
343
0
    aiv = (struct af_alg_iv *)CMSG_DATA(cmsg);
344
0
    aiv->ivlen = len;
345
0
    memcpy(aiv->iv, iv, len);
346
0
}
347
348
static ossl_inline int afalg_set_key(afalg_ctx *actx, const unsigned char *key,
349
                                const int klen)
350
0
{
351
0
    int ret;
352
0
    ret = setsockopt(actx->bfd, SOL_ALG, ALG_SET_KEY, key, klen);
353
0
    if (ret < 0) {
354
0
        ALG_PERR("%s(%d): Failed to set socket option : ", __FILE__, __LINE__);
355
0
        AFALGerr(AFALG_F_AFALG_SET_KEY, AFALG_R_SOCKET_SET_KEY_FAILED);
356
0
        return 0;
357
0
    }
358
0
    return 1;
359
0
}
360
361
static int afalg_create_sk(afalg_ctx *actx, const char *ciphertype,
362
                                const char *ciphername)
363
0
{
364
0
    struct sockaddr_alg sa;
365
0
    int r = -1;
366
367
0
    actx->bfd = actx->sfd = -1;
368
369
0
    memset(&sa, 0, sizeof(sa));
370
0
    sa.salg_family = AF_ALG;
371
0
    OPENSSL_strlcpy((char *) sa.salg_type, ciphertype, sizeof(sa.salg_type));
372
0
    OPENSSL_strlcpy((char *) sa.salg_name, ciphername, sizeof(sa.salg_name));
373
374
0
    actx->bfd = socket(AF_ALG, SOCK_SEQPACKET, 0);
375
0
    if (actx->bfd == -1) {
376
0
        ALG_PERR("%s(%d): Failed to open socket : ", __FILE__, __LINE__);
377
0
        AFALGerr(AFALG_F_AFALG_CREATE_SK, AFALG_R_SOCKET_CREATE_FAILED);
378
0
        goto err;
379
0
    }
380
381
0
    r = bind(actx->bfd, (struct sockaddr *)&sa, sizeof(sa));
382
0
    if (r < 0) {
383
0
        ALG_PERR("%s(%d): Failed to bind socket : ", __FILE__, __LINE__);
384
0
        AFALGerr(AFALG_F_AFALG_CREATE_SK, AFALG_R_SOCKET_BIND_FAILED);
385
0
        goto err;
386
0
    }
387
388
0
    actx->sfd = accept(actx->bfd, NULL, 0);
389
0
    if (actx->sfd < 0) {
390
0
        ALG_PERR("%s(%d): Socket Accept Failed : ", __FILE__, __LINE__);
391
0
        AFALGerr(AFALG_F_AFALG_CREATE_SK, AFALG_R_SOCKET_ACCEPT_FAILED);
392
0
        goto err;
393
0
    }
394
395
0
    return 1;
396
397
0
 err:
398
0
    if (actx->bfd >= 0)
399
0
        close(actx->bfd);
400
0
    if (actx->sfd >= 0)
401
0
        close(actx->sfd);
402
0
    actx->bfd = actx->sfd = -1;
403
0
    return 0;
404
0
}
405
406
static int afalg_start_cipher_sk(afalg_ctx *actx, const unsigned char *in,
407
                                 size_t inl, const unsigned char *iv,
408
                                 unsigned int enc)
409
0
{
410
0
    struct msghdr msg = { 0 };
411
0
    struct cmsghdr *cmsg;
412
0
    struct iovec iov;
413
0
    ssize_t sbytes;
414
# ifdef ALG_ZERO_COPY
415
    int ret;
416
# endif
417
0
    char cbuf[CMSG_SPACE(ALG_IV_LEN(ALG_AES_IV_LEN)) + CMSG_SPACE(ALG_OP_LEN)];
418
419
0
    memset(cbuf, 0, sizeof(cbuf));
420
0
    msg.msg_control = cbuf;
421
0
    msg.msg_controllen = sizeof(cbuf);
422
423
    /*
424
     * cipher direction (i.e. encrypt or decrypt) and iv are sent to the
425
     * kernel as part of sendmsg()'s ancillary data
426
     */
427
0
    cmsg = CMSG_FIRSTHDR(&msg);
428
0
    afalg_set_op_sk(cmsg, enc);
429
0
    cmsg = CMSG_NXTHDR(&msg, cmsg);
430
0
    afalg_set_iv_sk(cmsg, iv, ALG_AES_IV_LEN);
431
432
    /* iov that describes input data */
433
0
    iov.iov_base = (unsigned char *)in;
434
0
    iov.iov_len = inl;
435
436
0
    msg.msg_flags = MSG_MORE;
437
438
# ifdef ALG_ZERO_COPY
439
    /*
440
     * ZERO_COPY mode
441
     * Works best when buffer is 4k aligned
442
     * OPENS: out of place processing (i.e. out != in)
443
     */
444
445
    /* Input data is not sent as part of call to sendmsg() */
446
    msg.msg_iovlen = 0;
447
    msg.msg_iov = NULL;
448
449
    /* Sendmsg() sends iv and cipher direction to the kernel */
450
    sbytes = sendmsg(actx->sfd, &msg, 0);
451
    if (sbytes < 0) {
452
        ALG_PERR("%s(%d): sendmsg failed for zero copy cipher operation : ",
453
                 __FILE__, __LINE__);
454
        return 0;
455
    }
456
457
    /*
458
     * vmsplice and splice are used to pin the user space input buffer for
459
     * kernel space processing avoiding copies from user to kernel space
460
     */
461
    ret = vmsplice(actx->zc_pipe[1], &iov, 1, SPLICE_F_GIFT);
462
    if (ret < 0) {
463
        ALG_PERR("%s(%d): vmsplice failed : ", __FILE__, __LINE__);
464
        return 0;
465
    }
466
467
    ret = splice(actx->zc_pipe[0], NULL, actx->sfd, NULL, inl, 0);
468
    if (ret < 0) {
469
        ALG_PERR("%s(%d): splice failed : ", __FILE__, __LINE__);
470
        return 0;
471
    }
472
# else
473
0
    msg.msg_iovlen = 1;
474
0
    msg.msg_iov = &iov;
475
476
    /* Sendmsg() sends iv, cipher direction and input data to the kernel */
477
0
    sbytes = sendmsg(actx->sfd, &msg, 0);
478
0
    if (sbytes < 0) {
479
0
        ALG_PERR("%s(%d): sendmsg failed for cipher operation : ", __FILE__,
480
0
                 __LINE__);
481
0
        return 0;
482
0
    }
483
484
0
    if (sbytes != (ssize_t) inl) {
485
0
        ALG_WARN("Cipher operation send bytes %zd != inlen %zd\n", sbytes,
486
0
                inl);
487
0
        return 0;
488
0
    }
489
0
# endif
490
491
0
    return 1;
492
0
}
493
494
static int afalg_cipher_init(EVP_CIPHER_CTX *ctx, const unsigned char *key,
495
                             const unsigned char *iv, int enc)
496
0
{
497
0
    int ciphertype;
498
0
    int ret;
499
0
    afalg_ctx *actx;
500
0
    const char *ciphername;
501
502
0
    if (ctx == NULL || key == NULL) {
503
0
        ALG_WARN("%s(%d): Null Parameter\n", __FILE__, __LINE__);
504
0
        return 0;
505
0
    }
506
507
0
    if (EVP_CIPHER_CTX_cipher(ctx) == NULL) {
508
0
        ALG_WARN("%s(%d): Cipher object NULL\n", __FILE__, __LINE__);
509
0
        return 0;
510
0
    }
511
512
0
    actx = EVP_CIPHER_CTX_get_cipher_data(ctx);
513
0
    if (actx == NULL) {
514
0
        ALG_WARN("%s(%d): Cipher data NULL\n", __FILE__, __LINE__);
515
0
        return 0;
516
0
    }
517
518
0
    ciphertype = EVP_CIPHER_CTX_nid(ctx);
519
0
    switch (ciphertype) {
520
0
    case NID_aes_128_cbc:
521
0
    case NID_aes_192_cbc:
522
0
    case NID_aes_256_cbc:
523
0
        ciphername = "cbc(aes)";
524
0
        break;
525
0
    default:
526
0
        ALG_WARN("%s(%d): Unsupported Cipher type %d\n", __FILE__, __LINE__,
527
0
                 ciphertype);
528
0
        return 0;
529
0
    }
530
531
0
    if (ALG_AES_IV_LEN != EVP_CIPHER_CTX_iv_length(ctx)) {
532
0
        ALG_WARN("%s(%d): Unsupported IV length :%d\n", __FILE__, __LINE__,
533
0
                 EVP_CIPHER_CTX_iv_length(ctx));
534
0
        return 0;
535
0
    }
536
537
    /* Setup AFALG socket for crypto processing */
538
0
    ret = afalg_create_sk(actx, "skcipher", ciphername);
539
0
    if (ret < 1)
540
0
        return 0;
541
542
543
0
    ret = afalg_set_key(actx, key, EVP_CIPHER_CTX_key_length(ctx));
544
0
    if (ret < 1)
545
0
        goto err;
546
547
    /* Setup AIO ctx to allow async AFALG crypto processing */
548
0
    if (afalg_init_aio(&actx->aio) == 0)
549
0
        goto err;
550
551
# ifdef ALG_ZERO_COPY
552
    pipe(actx->zc_pipe);
553
# endif
554
555
0
    actx->init_done = MAGIC_INIT_NUM;
556
557
0
    return 1;
558
559
0
err:
560
0
    close(actx->sfd);
561
0
    close(actx->bfd);
562
0
    return 0;
563
0
}
564
565
static int afalg_do_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
566
                           const unsigned char *in, size_t inl)
567
0
{
568
0
    afalg_ctx *actx;
569
0
    int ret;
570
0
    char nxtiv[ALG_AES_IV_LEN] = { 0 };
571
572
0
    if (ctx == NULL || out == NULL || in == NULL) {
573
0
        ALG_WARN("NULL parameter passed to function %s(%d)\n", __FILE__,
574
0
                 __LINE__);
575
0
        return 0;
576
0
    }
577
578
0
    actx = (afalg_ctx *) EVP_CIPHER_CTX_get_cipher_data(ctx);
579
0
    if (actx == NULL || actx->init_done != MAGIC_INIT_NUM) {
580
0
        ALG_WARN("%s afalg ctx passed\n",
581
0
                 ctx == NULL ? "NULL" : "Uninitialised");
582
0
        return 0;
583
0
    }
584
585
    /*
586
     * set iv now for decrypt operation as the input buffer can be
587
     * overwritten for inplace operation where in = out.
588
     */
589
0
    if (EVP_CIPHER_CTX_encrypting(ctx) == 0) {
590
0
        memcpy(nxtiv, in + (inl - ALG_AES_IV_LEN), ALG_AES_IV_LEN);
591
0
    }
592
593
    /* Send input data to kernel space */
594
0
    ret = afalg_start_cipher_sk(actx, (unsigned char *)in, inl,
595
0
                                EVP_CIPHER_CTX_iv(ctx),
596
0
                                EVP_CIPHER_CTX_encrypting(ctx));
597
0
    if (ret < 1) {
598
0
        return 0;
599
0
    }
600
601
    /* Perform async crypto operation in kernel space */
602
0
    ret = afalg_fin_cipher_aio(&actx->aio, actx->sfd, out, inl);
603
0
    if (ret < 1)
604
0
        return 0;
605
606
0
    if (EVP_CIPHER_CTX_encrypting(ctx)) {
607
0
        memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), out + (inl - ALG_AES_IV_LEN),
608
0
               ALG_AES_IV_LEN);
609
0
    } else {
610
0
        memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), nxtiv, ALG_AES_IV_LEN);
611
0
    }
612
613
0
    return 1;
614
0
}
615
616
static int afalg_cipher_cleanup(EVP_CIPHER_CTX *ctx)
617
0
{
618
0
    afalg_ctx *actx;
619
620
0
    if (ctx == NULL) {
621
0
        ALG_WARN("NULL parameter passed to function %s(%d)\n", __FILE__,
622
0
                 __LINE__);
623
0
        return 0;
624
0
    }
625
626
0
    actx = (afalg_ctx *) EVP_CIPHER_CTX_get_cipher_data(ctx);
627
0
    if (actx == NULL || actx->init_done != MAGIC_INIT_NUM)
628
0
        return 1;
629
630
0
    close(actx->sfd);
631
0
    close(actx->bfd);
632
# ifdef ALG_ZERO_COPY
633
    close(actx->zc_pipe[0]);
634
    close(actx->zc_pipe[1]);
635
# endif
636
    /* close efd in sync mode, async mode is closed in afalg_waitfd_cleanup() */
637
0
    if (actx->aio.mode == MODE_SYNC)
638
0
        close(actx->aio.efd);
639
0
    io_destroy(actx->aio.aio_ctx);
640
641
0
    return 1;
642
0
}
643
644
static cbc_handles *get_cipher_handle(int nid)
645
0
{
646
0
    switch (nid) {
647
0
    case NID_aes_128_cbc:
648
0
        return &cbc_handle[AES_CBC_128];
649
0
    case NID_aes_192_cbc:
650
0
        return &cbc_handle[AES_CBC_192];
651
0
    case NID_aes_256_cbc:
652
0
        return &cbc_handle[AES_CBC_256];
653
0
    default:
654
0
        return NULL;
655
0
    }
656
0
}
657
658
static const EVP_CIPHER *afalg_aes_cbc(int nid)
659
0
{
660
0
    cbc_handles *cipher_handle = get_cipher_handle(nid);
661
0
    if (cipher_handle->_hidden == NULL
662
0
        && ((cipher_handle->_hidden =
663
0
         EVP_CIPHER_meth_new(nid,
664
0
                             AES_BLOCK_SIZE,
665
0
                             cipher_handle->key_size)) == NULL
666
0
        || !EVP_CIPHER_meth_set_iv_length(cipher_handle->_hidden,
667
0
                                          AES_IV_LEN)
668
0
        || !EVP_CIPHER_meth_set_flags(cipher_handle->_hidden,
669
0
                                      EVP_CIPH_CBC_MODE |
670
0
                                      EVP_CIPH_FLAG_DEFAULT_ASN1)
671
0
        || !EVP_CIPHER_meth_set_init(cipher_handle->_hidden,
672
0
                                     afalg_cipher_init)
673
0
        || !EVP_CIPHER_meth_set_do_cipher(cipher_handle->_hidden,
674
0
                                          afalg_do_cipher)
675
0
        || !EVP_CIPHER_meth_set_cleanup(cipher_handle->_hidden,
676
0
                                        afalg_cipher_cleanup)
677
0
        || !EVP_CIPHER_meth_set_impl_ctx_size(cipher_handle->_hidden,
678
0
                                              sizeof(afalg_ctx)))) {
679
0
        EVP_CIPHER_meth_free(cipher_handle->_hidden);
680
0
        cipher_handle->_hidden= NULL;
681
0
    }
682
0
    return cipher_handle->_hidden;
683
0
}
684
685
static int afalg_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
686
                         const int **nids, int nid)
687
0
{
688
0
    int r = 1;
689
690
0
    if (cipher == NULL) {
691
0
        *nids = afalg_cipher_nids;
692
0
        return (sizeof(afalg_cipher_nids) / sizeof(afalg_cipher_nids[0]));
693
0
    }
694
695
0
    switch (nid) {
696
0
    case NID_aes_128_cbc:
697
0
    case NID_aes_192_cbc:
698
0
    case NID_aes_256_cbc:
699
0
        *cipher = afalg_aes_cbc(nid);
700
0
        break;
701
0
    default:
702
0
        *cipher = NULL;
703
0
        r = 0;
704
0
    }
705
0
    return r;
706
0
}
707
708
static int bind_afalg(ENGINE *e)
709
0
{
710
    /* Ensure the afalg error handling is set up */
711
0
    unsigned short i;
712
0
    ERR_load_AFALG_strings();
713
714
0
    if (!ENGINE_set_id(e, engine_afalg_id)
715
0
        || !ENGINE_set_name(e, engine_afalg_name)
716
0
        || !ENGINE_set_destroy_function(e, afalg_destroy)
717
0
        || !ENGINE_set_init_function(e, afalg_init)
718
0
        || !ENGINE_set_finish_function(e, afalg_finish)) {
719
0
        AFALGerr(AFALG_F_BIND_AFALG, AFALG_R_INIT_FAILED);
720
0
        return 0;
721
0
    }
722
723
    /*
724
     * Create _hidden_aes_xxx_cbc by calling afalg_aes_xxx_cbc
725
     * now, as bind_aflag can only be called by one thread at a
726
     * time.
727
     */
728
0
    for(i = 0; i < OSSL_NELEM(afalg_cipher_nids); i++) {
729
0
        if (afalg_aes_cbc(afalg_cipher_nids[i]) == NULL) {
730
0
            AFALGerr(AFALG_F_BIND_AFALG, AFALG_R_INIT_FAILED);
731
0
            return 0;
732
0
        }
733
0
    }
734
735
0
    if (!ENGINE_set_ciphers(e, afalg_ciphers)) {
736
0
        AFALGerr(AFALG_F_BIND_AFALG, AFALG_R_INIT_FAILED);
737
0
        return 0;
738
0
    }
739
740
0
    return 1;
741
0
}
742
743
# ifndef OPENSSL_NO_DYNAMIC_ENGINE
744
static int bind_helper(ENGINE *e, const char *id)
745
{
746
    if (id && (strcmp(id, engine_afalg_id) != 0))
747
        return 0;
748
749
    if (!afalg_chk_platform())
750
        return 0;
751
752
    if (!bind_afalg(e))
753
        return 0;
754
    return 1;
755
}
756
757
IMPLEMENT_DYNAMIC_CHECK_FN()
758
    IMPLEMENT_DYNAMIC_BIND_FN(bind_helper)
759
# endif
760
761
static int afalg_chk_platform(void)
762
0
{
763
0
    int ret;
764
0
    int i;
765
0
    int kver[3] = { -1, -1, -1 };
766
0
    int sock;
767
0
    char *str;
768
0
    struct utsname ut;
769
770
0
    ret = uname(&ut);
771
0
    if (ret != 0) {
772
0
        AFALGerr(AFALG_F_AFALG_CHK_PLATFORM,
773
0
                 AFALG_R_FAILED_TO_GET_PLATFORM_INFO);
774
0
        return 0;
775
0
    }
776
777
0
    str = strtok(ut.release, ".");
778
0
    for (i = 0; i < 3 && str != NULL; i++) {
779
0
        kver[i] = atoi(str);
780
0
        str = strtok(NULL, ".");
781
0
    }
782
783
0
    if (KERNEL_VERSION(kver[0], kver[1], kver[2])
784
0
        < KERNEL_VERSION(K_MAJ, K_MIN1, K_MIN2)) {
785
0
        ALG_ERR("ASYNC AFALG not supported this kernel(%d.%d.%d)\n",
786
0
                 kver[0], kver[1], kver[2]);
787
0
        ALG_ERR("ASYNC AFALG requires kernel version %d.%d.%d or later\n",
788
0
                 K_MAJ, K_MIN1, K_MIN2);
789
0
        AFALGerr(AFALG_F_AFALG_CHK_PLATFORM,
790
0
                 AFALG_R_KERNEL_DOES_NOT_SUPPORT_ASYNC_AFALG);
791
0
        return 0;
792
0
    }
793
794
    /* Test if we can actually create an AF_ALG socket */
795
0
    sock = socket(AF_ALG, SOCK_SEQPACKET, 0);
796
0
    if (sock == -1) {
797
0
        AFALGerr(AFALG_F_AFALG_CHK_PLATFORM, AFALG_R_SOCKET_CREATE_FAILED);
798
0
        return 0;
799
0
    }
800
0
    close(sock);
801
802
0
    return 1;
803
0
}
804
805
# ifdef OPENSSL_NO_DYNAMIC_ENGINE
806
static ENGINE *engine_afalg(void)
807
0
{
808
0
    ENGINE *ret = ENGINE_new();
809
0
    if (ret == NULL)
810
0
        return NULL;
811
0
    if (!bind_afalg(ret)) {
812
0
        ENGINE_free(ret);
813
0
        return NULL;
814
0
    }
815
0
    return ret;
816
0
}
817
818
void engine_load_afalg_int(void)
819
0
{
820
0
    ENGINE *toadd;
821
822
0
    if (!afalg_chk_platform())
823
0
        return;
824
825
0
    toadd = engine_afalg();
826
0
    if (toadd == NULL)
827
0
        return;
828
0
    ENGINE_add(toadd);
829
0
    ENGINE_free(toadd);
830
0
    ERR_clear_error();
831
0
}
832
# endif
833
834
static int afalg_init(ENGINE *e)
835
0
{
836
0
    return 1;
837
0
}
838
839
static int afalg_finish(ENGINE *e)
840
0
{
841
0
    return 1;
842
0
}
843
844
static int free_cbc(void)
845
0
{
846
0
    short unsigned int i;
847
0
    for(i = 0; i < OSSL_NELEM(afalg_cipher_nids); i++) {
848
0
        EVP_CIPHER_meth_free(cbc_handle[i]._hidden);
849
0
        cbc_handle[i]._hidden = NULL;
850
0
    }
851
0
    return 1;
852
0
}
853
854
static int afalg_destroy(ENGINE *e)
855
0
{
856
0
    ERR_unload_AFALG_strings();
857
0
    free_cbc();
858
0
    return 1;
859
0
}
860
861
#endif                          /* KERNEL VERSION */