eng_devcrypto: add command to dump driver info
[openssl.git] / crypto / engine / eng_devcrypto.c
1 /*
2  * Copyright 2017-2018 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 #include "e_os.h"
11 #include <string.h>
12 #include <sys/types.h>
13 #include <sys/stat.h>
14 #include <fcntl.h>
15 #include <sys/ioctl.h>
16 #include <unistd.h>
17 #include <assert.h>
18
19 #include <openssl/conf.h>
20 #include <openssl/evp.h>
21 #include <openssl/err.h>
22 #include <openssl/engine.h>
23 #include <openssl/objects.h>
24 #include <crypto/cryptodev.h>
25
26 #include "internal/engine.h"
27
28 #ifdef CRYPTO_ALGORITHM_MIN
29 # define CHECK_BSD_STYLE_MACROS
30 #endif
31
32 /*
33  * ONE global file descriptor for all sessions.  This allows operations
34  * such as digest session data copying (see digest_copy()), but is also
35  * saner...  why re-open /dev/crypto for every session?
36  */
37 static int cfd;
38 #define DEVCRYPTO_REQUIRE_ACCELERATED 0 /* require confirmation of acceleration */
39 #define DEVCRYPTO_USE_SOFTWARE        1 /* allow software drivers */
40 #define DEVCRYPTO_REJECT_SOFTWARE     2 /* only disallow confirmed software drivers */
41
42 #define DEVCRYPTO_DEFAULT_USE_SOFDTRIVERS DEVCRYPTO_REJECT_SOFTWARE
43 static int use_softdrivers = DEVCRYPTO_DEFAULT_USE_SOFDTRIVERS;
44
45 /*
46  * cipher/digest status & acceleration definitions
47  * Make sure the defaults are set to 0
48  */
49 struct driver_info_st {
50     enum devcrypto_status_t {
51         DEVCRYPTO_STATUS_FAILURE         = -3, /* unusable for other reason */
52         DEVCRYPTO_STATUS_NO_CIOCCPHASH   = -2, /* hash state copy not supported */
53         DEVCRYPTO_STATUS_NO_CIOCGSESSION = -1, /* session open failed */
54         DEVCRYPTO_STATUS_UNKNOWN         =  0, /* not tested yet */
55         DEVCRYPTO_STATUS_USABLE          =  1  /* algo can be used */
56     } status;
57
58     enum devcrypto_accelerated_t {
59         DEVCRYPTO_NOT_ACCELERATED        = -1, /* software implemented */
60         DEVCRYPTO_ACCELERATION_UNKNOWN   =  0, /* acceleration support unkown */
61         DEVCRYPTO_ACCELERATED            =  1  /* hardware accelerated */
62     } accelerated;
63
64     char *driver_name;
65 };
66
67 /******************************************************************************
68  *
69  * Ciphers
70  *
71  * Because they all do the same basic operation, we have only one set of
72  * method functions for them all to share, and a mapping table between
73  * NIDs and cryptodev IDs, with all the necessary size data.
74  *
75  *****/
76
77 struct cipher_ctx {
78     struct session_op sess;
79     int op;                      /* COP_ENCRYPT or COP_DECRYPT */
80     unsigned long mode;          /* EVP_CIPH_*_MODE */
81
82     /* to handle ctr mode being a stream cipher */
83     unsigned char partial[EVP_MAX_BLOCK_LENGTH];
84     unsigned int blocksize, num;
85 };
86
87 static const struct cipher_data_st {
88     int nid;
89     int blocksize;
90     int keylen;
91     int ivlen;
92     int flags;
93     int devcryptoid;
94 } cipher_data[] = {
95 #ifndef OPENSSL_NO_DES
96     { NID_des_cbc, 8, 8, 8, EVP_CIPH_CBC_MODE, CRYPTO_DES_CBC },
97     { NID_des_ede3_cbc, 8, 24, 8, EVP_CIPH_CBC_MODE, CRYPTO_3DES_CBC },
98 #endif
99 #ifndef OPENSSL_NO_BF
100     { NID_bf_cbc, 8, 16, 8, EVP_CIPH_CBC_MODE, CRYPTO_BLF_CBC },
101 #endif
102 #ifndef OPENSSL_NO_CAST
103     { NID_cast5_cbc, 8, 16, 8, EVP_CIPH_CBC_MODE, CRYPTO_CAST_CBC },
104 #endif
105     { NID_aes_128_cbc, 16, 128 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
106     { NID_aes_192_cbc, 16, 192 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
107     { NID_aes_256_cbc, 16, 256 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
108 #ifndef OPENSSL_NO_RC4
109     { NID_rc4, 1, 16, 0, EVP_CIPH_STREAM_CIPHER, CRYPTO_ARC4 },
110 #endif
111 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_AES_CTR)
112     { NID_aes_128_ctr, 16, 128 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
113     { NID_aes_192_ctr, 16, 192 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
114     { NID_aes_256_ctr, 16, 256 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
115 #endif
116 #if 0                            /* Not yet supported */
117     { NID_aes_128_xts, 16, 128 / 8 * 2, 16, EVP_CIPH_XTS_MODE, CRYPTO_AES_XTS },
118     { NID_aes_256_xts, 16, 256 / 8 * 2, 16, EVP_CIPH_XTS_MODE, CRYPTO_AES_XTS },
119 #endif
120 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_AES_ECB)
121     { NID_aes_128_ecb, 16, 128 / 8, 0, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
122     { NID_aes_192_ecb, 16, 192 / 8, 0, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
123     { NID_aes_256_ecb, 16, 256 / 8, 0, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
124 #endif
125 #if 0                            /* Not yet supported */
126     { NID_aes_128_gcm, 16, 128 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
127     { NID_aes_192_gcm, 16, 192 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
128     { NID_aes_256_gcm, 16, 256 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
129 #endif
130 #ifndef OPENSSL_NO_CAMELLIA
131     { NID_camellia_128_cbc, 16, 128 / 8, 16, EVP_CIPH_CBC_MODE,
132       CRYPTO_CAMELLIA_CBC },
133     { NID_camellia_192_cbc, 16, 192 / 8, 16, EVP_CIPH_CBC_MODE,
134       CRYPTO_CAMELLIA_CBC },
135     { NID_camellia_256_cbc, 16, 256 / 8, 16, EVP_CIPH_CBC_MODE,
136       CRYPTO_CAMELLIA_CBC },
137 #endif
138 };
139
140 static size_t find_cipher_data_index(int nid)
141 {
142     size_t i;
143
144     for (i = 0; i < OSSL_NELEM(cipher_data); i++)
145         if (nid == cipher_data[i].nid)
146             return i;
147     return (size_t)-1;
148 }
149
150 static size_t get_cipher_data_index(int nid)
151 {
152     size_t i = find_cipher_data_index(nid);
153
154     if (i != (size_t)-1)
155         return i;
156
157     /*
158      * Code further down must make sure that only NIDs in the table above
159      * are used.  If any other NID reaches this function, there's a grave
160      * coding error further down.
161      */
162     assert("Code that never should be reached" == NULL);
163     return -1;
164 }
165
166 static const struct cipher_data_st *get_cipher_data(int nid)
167 {
168     return &cipher_data[get_cipher_data_index(nid)];
169 }
170
171 /*
172  * Following are the three necessary functions to map OpenSSL functionality
173  * with cryptodev.
174  */
175
176 static int cipher_init(EVP_CIPHER_CTX *ctx, const unsigned char *key,
177                        const unsigned char *iv, int enc)
178 {
179     struct cipher_ctx *cipher_ctx =
180         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
181     const struct cipher_data_st *cipher_d =
182         get_cipher_data(EVP_CIPHER_CTX_nid(ctx));
183
184     memset(&cipher_ctx->sess, 0, sizeof(cipher_ctx->sess));
185     cipher_ctx->sess.cipher = cipher_d->devcryptoid;
186     cipher_ctx->sess.keylen = cipher_d->keylen;
187     cipher_ctx->sess.key = (void *)key;
188     cipher_ctx->op = enc ? COP_ENCRYPT : COP_DECRYPT;
189     cipher_ctx->mode = cipher_d->flags & EVP_CIPH_MODE;
190     cipher_ctx->blocksize = cipher_d->blocksize;
191     if (ioctl(cfd, CIOCGSESSION, &cipher_ctx->sess) < 0) {
192         SYSerr(SYS_F_IOCTL, errno);
193         return 0;
194     }
195
196     return 1;
197 }
198
199 static int cipher_do_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
200                             const unsigned char *in, size_t inl)
201 {
202     struct cipher_ctx *cipher_ctx =
203         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
204     struct crypt_op cryp;
205     unsigned char *iv = EVP_CIPHER_CTX_iv_noconst(ctx);
206 #if !defined(COP_FLAG_WRITE_IV)
207     unsigned char saved_iv[EVP_MAX_IV_LENGTH];
208     const unsigned char *ivptr;
209     size_t nblocks, ivlen;
210 #endif
211
212     memset(&cryp, 0, sizeof(cryp));
213     cryp.ses = cipher_ctx->sess.ses;
214     cryp.len = inl;
215     cryp.src = (void *)in;
216     cryp.dst = (void *)out;
217     cryp.iv = (void *)iv;
218     cryp.op = cipher_ctx->op;
219 #if !defined(COP_FLAG_WRITE_IV)
220     cryp.flags = 0;
221
222     ivlen = EVP_CIPHER_CTX_iv_length(ctx);
223     if (ivlen > 0)
224         switch (cipher_ctx->mode) {
225         case EVP_CIPH_CBC_MODE:
226             assert(inl >= ivlen);
227             if (!EVP_CIPHER_CTX_encrypting(ctx)) {
228                 ivptr = in + inl - ivlen;
229                 memcpy(saved_iv, ivptr, ivlen);
230             }
231             break;
232
233         case EVP_CIPH_CTR_MODE:
234             break;
235
236         default: /* should not happen */
237             return 0;
238         }
239 #else
240     cryp.flags = COP_FLAG_WRITE_IV;
241 #endif
242
243     if (ioctl(cfd, CIOCCRYPT, &cryp) < 0) {
244         SYSerr(SYS_F_IOCTL, errno);
245         return 0;
246     }
247
248 #if !defined(COP_FLAG_WRITE_IV)
249     if (ivlen > 0)
250         switch (cipher_ctx->mode) {
251         case EVP_CIPH_CBC_MODE:
252             assert(inl >= ivlen);
253             if (EVP_CIPHER_CTX_encrypting(ctx))
254                 ivptr = out + inl - ivlen;
255             else
256                 ivptr = saved_iv;
257
258             memcpy(iv, ivptr, ivlen);
259             break;
260
261         case EVP_CIPH_CTR_MODE:
262             nblocks = (inl + cipher_ctx->blocksize - 1)
263                       / cipher_ctx->blocksize;
264             do {
265                 ivlen--;
266                 nblocks += iv[ivlen];
267                 iv[ivlen] = (uint8_t) nblocks;
268                 nblocks >>= 8;
269             } while (ivlen);
270             break;
271
272         default: /* should not happen */
273             return 0;
274         }
275 #endif
276
277     return 1;
278 }
279
280 static int ctr_do_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
281                          const unsigned char *in, size_t inl)
282 {
283     struct cipher_ctx *cipher_ctx =
284         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
285     size_t nblocks, len;
286
287     /* initial partial block */
288     while (cipher_ctx->num && inl) {
289         (*out++) = *(in++) ^ cipher_ctx->partial[cipher_ctx->num];
290         --inl;
291         cipher_ctx->num = (cipher_ctx->num + 1) % cipher_ctx->blocksize;
292     }
293
294     /* full blocks */
295     if (inl > (unsigned int) cipher_ctx->blocksize) {
296         nblocks = inl/cipher_ctx->blocksize;
297         len = nblocks * cipher_ctx->blocksize;
298         if (cipher_do_cipher(ctx, out, in, len) < 1)
299             return 0;
300         inl -= len;
301         out += len;
302         in += len;
303     }
304
305     /* final partial block */
306     if (inl) {
307         memset(cipher_ctx->partial, 0, cipher_ctx->blocksize);
308         if (cipher_do_cipher(ctx, cipher_ctx->partial, cipher_ctx->partial,
309             cipher_ctx->blocksize) < 1)
310             return 0;
311         while (inl--) {
312             out[cipher_ctx->num] = in[cipher_ctx->num]
313                                    ^ cipher_ctx->partial[cipher_ctx->num];
314             cipher_ctx->num++;
315         }
316     }
317
318     return 1;
319 }
320
321 static int cipher_ctrl(EVP_CIPHER_CTX *ctx, int type, int p1, void* p2)
322 {
323     EVP_CIPHER_CTX *to_ctx = (EVP_CIPHER_CTX *)p2;
324     struct cipher_ctx *cipher_ctx;
325
326     if (type == EVP_CTRL_COPY) {
327         /* when copying the context, a new session needs to be initialized */
328         cipher_ctx = (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
329         return (cipher_ctx == NULL)
330             || cipher_init(to_ctx, cipher_ctx->sess.key, EVP_CIPHER_CTX_iv(ctx),
331                            (cipher_ctx->op == COP_ENCRYPT));
332     }
333
334     return -1;
335 }
336
337 static int cipher_cleanup(EVP_CIPHER_CTX *ctx)
338 {
339     struct cipher_ctx *cipher_ctx =
340         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
341
342     if (ioctl(cfd, CIOCFSESSION, &cipher_ctx->sess.ses) < 0) {
343         SYSerr(SYS_F_IOCTL, errno);
344         return 0;
345     }
346
347     return 1;
348 }
349
350 /*
351  * Keep tables of known nids, associated methods, selected ciphers, and driver
352  * info.
353  * Note that known_cipher_nids[] isn't necessarily indexed the same way as
354  * cipher_data[] above, which the other tables are.
355  */
356 static int known_cipher_nids[OSSL_NELEM(cipher_data)];
357 static int known_cipher_nids_amount = -1; /* -1 indicates not yet initialised */
358 static EVP_CIPHER *known_cipher_methods[OSSL_NELEM(cipher_data)] = { NULL, };
359 static int selected_ciphers[OSSL_NELEM(cipher_data)];
360 static struct driver_info_st cipher_driver_info[OSSL_NELEM(cipher_data)];
361
362
363 static int devcrypto_test_cipher(size_t cipher_data_index)
364 {
365     return (cipher_driver_info[cipher_data_index].status == DEVCRYPTO_STATUS_USABLE
366             && selected_ciphers[cipher_data_index] == 1
367             && (cipher_driver_info[cipher_data_index].accelerated
368                     == DEVCRYPTO_ACCELERATED
369                 || use_softdrivers == DEVCRYPTO_USE_SOFTWARE
370                 || (cipher_driver_info[cipher_data_index].accelerated
371                         != DEVCRYPTO_NOT_ACCELERATED
372                     && use_softdrivers == DEVCRYPTO_REJECT_SOFTWARE)));
373 }
374
375 static void prepare_cipher_methods(void)
376 {
377     size_t i;
378     struct session_op sess;
379     unsigned long cipher_mode;
380 #ifdef CIOCGSESSINFO
381     struct session_info_op siop;
382 #endif
383
384     memset(&cipher_driver_info, 0, sizeof(cipher_driver_info));
385
386     memset(&sess, 0, sizeof(sess));
387     sess.key = (void *)"01234567890123456789012345678901234567890123456789";
388
389     for (i = 0, known_cipher_nids_amount = 0;
390          i < OSSL_NELEM(cipher_data); i++) {
391
392         selected_ciphers[i] = 1;
393         /*
394          * Check that the cipher is usable
395          */
396         sess.cipher = cipher_data[i].devcryptoid;
397         sess.keylen = cipher_data[i].keylen;
398         if (ioctl(cfd, CIOCGSESSION, &sess) < 0) {
399             cipher_driver_info[i].status = DEVCRYPTO_STATUS_NO_CIOCGSESSION;
400             continue;
401         }
402
403         cipher_mode = cipher_data[i].flags & EVP_CIPH_MODE;
404
405         if ((known_cipher_methods[i] =
406                  EVP_CIPHER_meth_new(cipher_data[i].nid,
407                                      cipher_mode == EVP_CIPH_CTR_MODE ? 1 :
408                                                     cipher_data[i].blocksize,
409                                      cipher_data[i].keylen)) == NULL
410             || !EVP_CIPHER_meth_set_iv_length(known_cipher_methods[i],
411                                               cipher_data[i].ivlen)
412             || !EVP_CIPHER_meth_set_flags(known_cipher_methods[i],
413                                           cipher_data[i].flags
414                                           | EVP_CIPH_CUSTOM_COPY
415                                           | EVP_CIPH_FLAG_DEFAULT_ASN1)
416             || !EVP_CIPHER_meth_set_init(known_cipher_methods[i], cipher_init)
417             || !EVP_CIPHER_meth_set_do_cipher(known_cipher_methods[i],
418                                      cipher_mode == EVP_CIPH_CTR_MODE ?
419                                               ctr_do_cipher :
420                                               cipher_do_cipher)
421             || !EVP_CIPHER_meth_set_ctrl(known_cipher_methods[i], cipher_ctrl)
422             || !EVP_CIPHER_meth_set_cleanup(known_cipher_methods[i],
423                                             cipher_cleanup)
424             || !EVP_CIPHER_meth_set_impl_ctx_size(known_cipher_methods[i],
425                                                   sizeof(struct cipher_ctx))) {
426             cipher_driver_info[i].status = DEVCRYPTO_STATUS_FAILURE;
427             EVP_CIPHER_meth_free(known_cipher_methods[i]);
428             known_cipher_methods[i] = NULL;
429         } else {
430             cipher_driver_info[i].status = DEVCRYPTO_STATUS_USABLE;
431 #ifdef CIOCGSESSINFO
432             siop.ses = sess.ses;
433             if (ioctl(cfd, CIOCGSESSINFO, &siop) < 0) {
434                 cipher_driver_info[i].accelerated = DEVCRYPTO_ACCELERATION_UNKNOWN;
435             } else {
436                 cipher_driver_info[i].driver_name =
437                     OPENSSL_strndup(siop.cipher_info.cra_driver_name,
438                                     CRYPTODEV_MAX_ALG_NAME);
439                 if (!(siop.flags & SIOP_FLAG_KERNEL_DRIVER_ONLY))
440                     cipher_driver_info[i].accelerated = DEVCRYPTO_NOT_ACCELERATED;
441                 else
442                     cipher_driver_info[i].accelerated = DEVCRYPTO_ACCELERATED;
443             }
444 #endif /* CIOCGSESSINFO */
445         }
446         ioctl(cfd, CIOCFSESSION, &sess.ses);
447         if (devcrypto_test_cipher(i)) {
448             known_cipher_nids[known_cipher_nids_amount++] =
449                 cipher_data[i].nid;
450         }
451     }
452 }
453
454 static void rebuild_known_cipher_nids(ENGINE *e)
455 {
456     size_t i;
457
458     for (i = 0, known_cipher_nids_amount = 0; i < OSSL_NELEM(cipher_data); i++) {
459         if (devcrypto_test_cipher(i))
460             known_cipher_nids[known_cipher_nids_amount++] = cipher_data[i].nid;
461     }
462     ENGINE_unregister_ciphers(e);
463     ENGINE_register_ciphers(e);
464 }
465
466 static const EVP_CIPHER *get_cipher_method(int nid)
467 {
468     size_t i = get_cipher_data_index(nid);
469
470     if (i == (size_t)-1)
471         return NULL;
472     return known_cipher_methods[i];
473 }
474
475 static int get_cipher_nids(const int **nids)
476 {
477     *nids = known_cipher_nids;
478     return known_cipher_nids_amount;
479 }
480
481 static void destroy_cipher_method(int nid)
482 {
483     size_t i = get_cipher_data_index(nid);
484
485     EVP_CIPHER_meth_free(known_cipher_methods[i]);
486     known_cipher_methods[i] = NULL;
487 }
488
489 static void destroy_all_cipher_methods(void)
490 {
491     size_t i;
492
493     for (i = 0; i < OSSL_NELEM(cipher_data); i++) {
494         destroy_cipher_method(cipher_data[i].nid);
495         OPENSSL_free(cipher_driver_info[i].driver_name);
496         cipher_driver_info[i].driver_name = NULL;
497     }
498 }
499
500 static int devcrypto_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
501                              const int **nids, int nid)
502 {
503     if (cipher == NULL)
504         return get_cipher_nids(nids);
505
506     *cipher = get_cipher_method(nid);
507
508     return *cipher != NULL;
509 }
510
511 static void devcrypto_select_all_ciphers(int *cipher_list)
512 {
513     size_t i;
514
515     for (i = 0; i < OSSL_NELEM(cipher_data); i++)
516         cipher_list[i] = 1;
517 }
518
519 static int cryptodev_select_cipher_cb(const char *str, int len, void *usr)
520 {
521     int *cipher_list = (int *)usr;
522     char *name;
523     const EVP_CIPHER *EVP;
524     size_t i;
525
526     if (len == 0)
527         return 1;
528     if (usr == NULL || (name = OPENSSL_strndup(str, len)) == NULL)
529         return 0;
530     EVP = EVP_get_cipherbyname(name);
531     if (EVP == NULL)
532         fprintf(stderr, "devcrypto: unknown cipher %s\n", name);
533     else if ((i = find_cipher_data_index(EVP_CIPHER_nid(EVP))) != (size_t)-1)
534         cipher_list[i] = 1;
535     else
536         fprintf(stderr, "devcrypto: cipher %s not available\n", name);
537     OPENSSL_free(name);
538     return 1;
539 }
540
541 static void dump_cipher_info(void)
542 {
543     size_t i;
544     const char *name;
545
546     fprintf (stderr, "Information about ciphers supported by the /dev/crypto"
547              " engine:\n");
548 #ifndef CIOCGSESSINFO
549     fprintf(stderr, "CIOCGSESSINFO (session info call) unavailable\n");
550 #endif
551     for (i = 0; i < OSSL_NELEM(cipher_data); i++) {
552         name = OBJ_nid2sn(cipher_data[i].nid);
553         fprintf (stderr, "Cipher %s, NID=%d, /dev/crypto info: id=%d, ",
554                  name ? name : "unknown", cipher_data[i].nid,
555                  cipher_data[i].devcryptoid);
556         if (cipher_driver_info[i].status == DEVCRYPTO_STATUS_NO_CIOCGSESSION ) {
557             fprintf (stderr, "CIOCGSESSION (session open call) failed\n");
558             continue;
559         }
560         fprintf (stderr, "driver=%s ", cipher_driver_info[i].driver_name ?
561                  cipher_driver_info[i].driver_name : "unknown");
562         if (cipher_driver_info[i].accelerated == DEVCRYPTO_ACCELERATED)
563             fprintf(stderr, "(hw accelerated)");
564         else if (cipher_driver_info[i].accelerated == DEVCRYPTO_NOT_ACCELERATED)
565             fprintf(stderr, "(software)");
566         else
567             fprintf(stderr, "(acceleration status unknown)");
568         if (cipher_driver_info[i].status == DEVCRYPTO_STATUS_FAILURE)
569             fprintf (stderr, ". Cipher setup failed");
570         fprintf(stderr, "\n");
571     }
572     fprintf(stderr, "\n");
573 }
574
575 /*
576  * We only support digests if the cryptodev implementation supports multiple
577  * data updates and session copying.  Otherwise, we would be forced to maintain
578  * a cache, which is perilous if there's a lot of data coming in (if someone
579  * wants to checksum an OpenSSL tarball, for example).
580  */
581 #if defined(CIOCCPHASH) && defined(COP_FLAG_UPDATE) && defined(COP_FLAG_FINAL)
582 #define IMPLEMENT_DIGEST
583
584 /******************************************************************************
585  *
586  * Digests
587  *
588  * Because they all do the same basic operation, we have only one set of
589  * method functions for them all to share, and a mapping table between
590  * NIDs and cryptodev IDs, with all the necessary size data.
591  *
592  *****/
593
594 struct digest_ctx {
595     struct session_op sess;
596     /* This signals that the init function was called, not that it succeeded. */
597     int init_called;
598     unsigned char digest_res[HASH_MAX_LEN];
599 };
600
601 static const struct digest_data_st {
602     int nid;
603     int digestlen;
604     int devcryptoid;
605 } digest_data[] = {
606 #ifndef OPENSSL_NO_MD5
607     { NID_md5, 16, CRYPTO_MD5 },
608 #endif
609     { NID_sha1, 20, CRYPTO_SHA1 },
610 #ifndef OPENSSL_NO_RMD160
611 # if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_RIPEMD160)
612     { NID_ripemd160, 20, CRYPTO_RIPEMD160 },
613 # endif
614 #endif
615 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_224)
616     { NID_sha224, 224 / 8, CRYPTO_SHA2_224 },
617 #endif
618 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_256)
619     { NID_sha256, 256 / 8, CRYPTO_SHA2_256 },
620 #endif
621 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_384)
622     { NID_sha384, 384 / 8, CRYPTO_SHA2_384 },
623 #endif
624 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_512)
625     { NID_sha512, 512 / 8, CRYPTO_SHA2_512 },
626 #endif
627 };
628
629 static size_t find_digest_data_index(int nid)
630 {
631     size_t i;
632
633     for (i = 0; i < OSSL_NELEM(digest_data); i++)
634         if (nid == digest_data[i].nid)
635             return i;
636     return (size_t)-1;
637 }
638
639 static size_t get_digest_data_index(int nid)
640 {
641     size_t i = find_digest_data_index(nid);
642
643     if (i != (size_t)-1)
644         return i;
645
646     /*
647      * Code further down must make sure that only NIDs in the table above
648      * are used.  If any other NID reaches this function, there's a grave
649      * coding error further down.
650      */
651     assert("Code that never should be reached" == NULL);
652     return -1;
653 }
654
655 static const struct digest_data_st *get_digest_data(int nid)
656 {
657     return &digest_data[get_digest_data_index(nid)];
658 }
659
660 /*
661  * Following are the five necessary functions to map OpenSSL functionality
662  * with cryptodev: init, update, final, cleanup, and copy.
663  */
664
665 static int digest_init(EVP_MD_CTX *ctx)
666 {
667     struct digest_ctx *digest_ctx =
668         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
669     const struct digest_data_st *digest_d =
670         get_digest_data(EVP_MD_CTX_type(ctx));
671
672     digest_ctx->init_called = 1;
673
674     memset(&digest_ctx->sess, 0, sizeof(digest_ctx->sess));
675     digest_ctx->sess.mac = digest_d->devcryptoid;
676     if (ioctl(cfd, CIOCGSESSION, &digest_ctx->sess) < 0) {
677         SYSerr(SYS_F_IOCTL, errno);
678         return 0;
679     }
680
681     return 1;
682 }
683
684 static int digest_op(struct digest_ctx *ctx, const void *src, size_t srclen,
685                      void *res, unsigned int flags)
686 {
687     struct crypt_op cryp;
688
689     memset(&cryp, 0, sizeof(cryp));
690     cryp.ses = ctx->sess.ses;
691     cryp.len = srclen;
692     cryp.src = (void *)src;
693     cryp.dst = NULL;
694     cryp.mac = res;
695     cryp.flags = flags;
696     return ioctl(cfd, CIOCCRYPT, &cryp);
697 }
698
699 static int digest_update(EVP_MD_CTX *ctx, const void *data, size_t count)
700 {
701     struct digest_ctx *digest_ctx =
702         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
703
704     if (count == 0)
705         return 1;
706
707     if (digest_ctx == NULL)
708         return 0;
709
710     if (EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_ONESHOT)) {
711         if (digest_op(digest_ctx, data, count, digest_ctx->digest_res, 0) >= 0)
712             return 1;
713     } else if (digest_op(digest_ctx, data, count, NULL, COP_FLAG_UPDATE) >= 0) {
714         return 1;
715     }
716
717     SYSerr(SYS_F_IOCTL, errno);
718     return 0;
719 }
720
721 static int digest_final(EVP_MD_CTX *ctx, unsigned char *md)
722 {
723     struct digest_ctx *digest_ctx =
724         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
725
726     if (md == NULL || digest_ctx == NULL)
727         return 0;
728
729     if (EVP_MD_CTX_test_flags(ctx, EVP_MD_CTX_FLAG_ONESHOT)) {
730         memcpy(md, digest_ctx->digest_res, EVP_MD_CTX_size(ctx));
731     } else if (digest_op(digest_ctx, NULL, 0, md, COP_FLAG_FINAL) < 0) {
732         SYSerr(SYS_F_IOCTL, errno);
733         return 0;
734     }
735
736     return 1;
737 }
738
739 static int digest_copy(EVP_MD_CTX *to, const EVP_MD_CTX *from)
740 {
741     struct digest_ctx *digest_from =
742         (struct digest_ctx *)EVP_MD_CTX_md_data(from);
743     struct digest_ctx *digest_to =
744         (struct digest_ctx *)EVP_MD_CTX_md_data(to);
745     struct cphash_op cphash;
746
747     if (digest_from == NULL || digest_from->init_called != 1)
748         return 1;
749
750     if (!digest_init(to)) {
751         SYSerr(SYS_F_IOCTL, errno);
752         return 0;
753     }
754
755     cphash.src_ses = digest_from->sess.ses;
756     cphash.dst_ses = digest_to->sess.ses;
757     if (ioctl(cfd, CIOCCPHASH, &cphash) < 0) {
758         SYSerr(SYS_F_IOCTL, errno);
759         return 0;
760     }
761     return 1;
762 }
763
764 static int digest_cleanup(EVP_MD_CTX *ctx)
765 {
766     struct digest_ctx *digest_ctx =
767         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
768
769     if (digest_ctx == NULL)
770         return 1;
771     if (ioctl(cfd, CIOCFSESSION, &digest_ctx->sess.ses) < 0) {
772         SYSerr(SYS_F_IOCTL, errno);
773         return 0;
774     }
775     return 1;
776 }
777
778 /*
779  * Keep tables of known nids, associated methods, selected digests, and
780  * driver info.
781  * Note that known_digest_nids[] isn't necessarily indexed the same way as
782  * digest_data[] above, which the other tables are.
783  */
784 static int known_digest_nids[OSSL_NELEM(digest_data)];
785 static int known_digest_nids_amount = -1; /* -1 indicates not yet initialised */
786 static EVP_MD *known_digest_methods[OSSL_NELEM(digest_data)] = { NULL, };
787 static int selected_digests[OSSL_NELEM(digest_data)];
788 static struct driver_info_st digest_driver_info[OSSL_NELEM(digest_data)];
789
790 static int devcrypto_test_digest(size_t digest_data_index)
791 {
792     return (digest_driver_info[digest_data_index].status == DEVCRYPTO_STATUS_USABLE
793             && selected_digests[digest_data_index] == 1
794             && (digest_driver_info[digest_data_index].accelerated
795                     == DEVCRYPTO_ACCELERATED
796                 || use_softdrivers == DEVCRYPTO_USE_SOFTWARE
797                 || (digest_driver_info[digest_data_index].accelerated
798                         != DEVCRYPTO_NOT_ACCELERATED
799                     && use_softdrivers == DEVCRYPTO_REJECT_SOFTWARE)));
800 }
801
802 static void rebuild_known_digest_nids(ENGINE *e)
803 {
804     size_t i;
805
806     for (i = 0, known_digest_nids_amount = 0; i < OSSL_NELEM(digest_data); i++) {
807         if (devcrypto_test_digest(i))
808             known_digest_nids[known_digest_nids_amount++] = digest_data[i].nid;
809     }
810     ENGINE_unregister_digests(e);
811     ENGINE_register_digests(e);
812 }
813
814 static void prepare_digest_methods(void)
815 {
816     size_t i;
817     struct session_op sess1, sess2;
818 #ifdef CIOCGSESSINFO
819     struct session_info_op siop;
820 #endif
821     struct cphash_op cphash;
822
823     memset(&digest_driver_info, 0, sizeof(digest_driver_info));
824
825     memset(&sess1, 0, sizeof(sess1));
826     memset(&sess2, 0, sizeof(sess2));
827
828     for (i = 0, known_digest_nids_amount = 0; i < OSSL_NELEM(digest_data);
829          i++) {
830
831         selected_digests[i] = 1;
832
833         /*
834          * Check that the digest is usable
835          */
836         sess1.mac = digest_data[i].devcryptoid;
837         sess2.ses = 0;
838         if (ioctl(cfd, CIOCGSESSION, &sess1) < 0) {
839             digest_driver_info[i].status = DEVCRYPTO_STATUS_NO_CIOCGSESSION;
840             goto finish;
841         }
842
843 #ifdef CIOCGSESSINFO
844         /* gather hardware acceleration info from the driver */
845         siop.ses = sess1.ses;
846         if (ioctl(cfd, CIOCGSESSINFO, &siop) < 0) {
847             digest_driver_info[i].accelerated = DEVCRYPTO_ACCELERATION_UNKNOWN;
848         } else {
849             digest_driver_info[i].driver_name =
850                 OPENSSL_strndup(siop.hash_info.cra_driver_name,
851                                 CRYPTODEV_MAX_ALG_NAME);
852             if (siop.flags & SIOP_FLAG_KERNEL_DRIVER_ONLY)
853                 digest_driver_info[i].accelerated = DEVCRYPTO_ACCELERATED;
854             else
855                 digest_driver_info[i].accelerated = DEVCRYPTO_NOT_ACCELERATED;
856         }
857 #endif
858
859         /* digest must be capable of hash state copy */
860         sess2.mac = sess1.mac;
861         if (ioctl(cfd, CIOCGSESSION, &sess2) < 0) {
862             digest_driver_info[i].status = DEVCRYPTO_STATUS_FAILURE;
863             goto finish;
864         }
865         cphash.src_ses = sess1.ses;
866         cphash.dst_ses = sess2.ses;
867         if (ioctl(cfd, CIOCCPHASH, &cphash) < 0) {
868             digest_driver_info[i].status = DEVCRYPTO_STATUS_NO_CIOCCPHASH;
869             goto finish;
870         }
871         if ((known_digest_methods[i] = EVP_MD_meth_new(digest_data[i].nid,
872                                                        NID_undef)) == NULL
873             || !EVP_MD_meth_set_result_size(known_digest_methods[i],
874                                             digest_data[i].digestlen)
875             || !EVP_MD_meth_set_init(known_digest_methods[i], digest_init)
876             || !EVP_MD_meth_set_update(known_digest_methods[i], digest_update)
877             || !EVP_MD_meth_set_final(known_digest_methods[i], digest_final)
878             || !EVP_MD_meth_set_copy(known_digest_methods[i], digest_copy)
879             || !EVP_MD_meth_set_cleanup(known_digest_methods[i], digest_cleanup)
880             || !EVP_MD_meth_set_app_datasize(known_digest_methods[i],
881                                              sizeof(struct digest_ctx))) {
882             digest_driver_info[i].status = DEVCRYPTO_STATUS_FAILURE;
883             EVP_MD_meth_free(known_digest_methods[i]);
884             known_digest_methods[i] = NULL;
885             goto finish;
886         }
887         digest_driver_info[i].status = DEVCRYPTO_STATUS_USABLE;
888 finish:
889         ioctl(cfd, CIOCFSESSION, &sess1.ses);
890         if (sess2.ses != 0)
891             ioctl(cfd, CIOCFSESSION, &sess2.ses);
892         if (devcrypto_test_digest(i))
893             known_digest_nids[known_digest_nids_amount++] = digest_data[i].nid;
894     }
895 }
896
897 static const EVP_MD *get_digest_method(int nid)
898 {
899     size_t i = get_digest_data_index(nid);
900
901     if (i == (size_t)-1)
902         return NULL;
903     return known_digest_methods[i];
904 }
905
906 static int get_digest_nids(const int **nids)
907 {
908     *nids = known_digest_nids;
909     return known_digest_nids_amount;
910 }
911
912 static void destroy_digest_method(int nid)
913 {
914     size_t i = get_digest_data_index(nid);
915
916     EVP_MD_meth_free(known_digest_methods[i]);
917     known_digest_methods[i] = NULL;
918 }
919
920 static void destroy_all_digest_methods(void)
921 {
922     size_t i;
923
924     for (i = 0; i < OSSL_NELEM(digest_data); i++) {
925         destroy_digest_method(digest_data[i].nid);
926         OPENSSL_free(digest_driver_info[i].driver_name);
927         digest_driver_info[i].driver_name = NULL;
928     }
929 }
930
931 static int devcrypto_digests(ENGINE *e, const EVP_MD **digest,
932                              const int **nids, int nid)
933 {
934     if (digest == NULL)
935         return get_digest_nids(nids);
936
937     *digest = get_digest_method(nid);
938
939     return *digest != NULL;
940 }
941
942 static void devcrypto_select_all_digests(int *digest_list)
943 {
944     size_t i;
945
946     for (i = 0; i < OSSL_NELEM(digest_data); i++)
947         digest_list[i] = 1;
948 }
949
950 static int cryptodev_select_digest_cb(const char *str, int len, void *usr)
951 {
952     int *digest_list = (int *)usr;
953     char *name;
954     const EVP_MD *EVP;
955     size_t i;
956
957     if (len == 0)
958         return 1;
959     if (usr == NULL || (name = OPENSSL_strndup(str, len)) == NULL)
960         return 0;
961     EVP = EVP_get_digestbyname(name);
962     if (EVP == NULL)
963         fprintf(stderr, "devcrypto: unknown digest %s\n", name);
964     else if ((i = find_digest_data_index(EVP_MD_type(EVP))) != (size_t)-1)
965         digest_list[i] = 1;
966     else
967         fprintf(stderr, "devcrypto: digest %s not available\n", name);
968     OPENSSL_free(name);
969     return 1;
970 }
971
972 static void dump_digest_info(void)
973 {
974     size_t i;
975     const char *name;
976
977     fprintf (stderr, "Information about digests supported by the /dev/crypto"
978              " engine:\n");
979 #ifndef CIOCGSESSINFO
980     fprintf(stderr, "CIOCGSESSINFO (session info call) unavailable\n");
981 #endif
982
983     for (i = 0; i < OSSL_NELEM(digest_data); i++) {
984         name = OBJ_nid2sn(digest_data[i].nid);
985         fprintf (stderr, "Digest %s, NID=%d, /dev/crypto info: id=%d, driver=%s",
986                  name ? name : "unknown", digest_data[i].nid,
987                  digest_data[i].devcryptoid,
988                  digest_driver_info[i].driver_name ? digest_driver_info[i].driver_name : "unknown");
989         if (digest_driver_info[i].status == DEVCRYPTO_STATUS_NO_CIOCGSESSION) {
990             fprintf (stderr, ". CIOCGSESSION (session open) failed\n");
991             continue;
992         }
993         if (digest_driver_info[i].accelerated == DEVCRYPTO_ACCELERATED)
994             fprintf(stderr, " (hw accelerated)");
995         else if (digest_driver_info[i].accelerated == DEVCRYPTO_NOT_ACCELERATED)
996             fprintf(stderr, " (software)");
997         else
998             fprintf(stderr, " (acceleration status unknown)");
999         if (cipher_driver_info[i].status == DEVCRYPTO_STATUS_FAILURE)
1000             fprintf (stderr, ". Cipher setup failed\n");
1001         else if (digest_driver_info[i].status == DEVCRYPTO_STATUS_NO_CIOCCPHASH)
1002             fprintf(stderr, ", CIOCCPHASH failed\n");
1003         else
1004             fprintf(stderr, ", CIOCCPHASH capable\n");
1005     }
1006     fprintf(stderr, "\n");
1007 }
1008
1009 #endif
1010
1011 /******************************************************************************
1012  *
1013  * CONTROL COMMANDS
1014  *
1015  *****/
1016
1017 #define DEVCRYPTO_CMD_USE_SOFTDRIVERS ENGINE_CMD_BASE
1018 #define DEVCRYPTO_CMD_CIPHERS (ENGINE_CMD_BASE + 1)
1019 #define DEVCRYPTO_CMD_DIGESTS (ENGINE_CMD_BASE + 2)
1020 #define DEVCRYPTO_CMD_DUMP_INFO (ENGINE_CMD_BASE + 3)
1021
1022 static const ENGINE_CMD_DEFN devcrypto_cmds[] = {
1023 #ifdef CIOCGSESSINFO
1024    {DEVCRYPTO_CMD_USE_SOFTDRIVERS,
1025     "USE_SOFTDRIVERS",
1026     "specifies whether to use software (not accelerated) drivers ("
1027         OPENSSL_MSTR(DEVCRYPTO_REQUIRE_ACCELERATED) "=use only accelerated drivers, "
1028         OPENSSL_MSTR(DEVCRYPTO_USE_SOFTWARE) "=allow all drivers, "
1029         OPENSSL_MSTR(DEVCRYPTO_REJECT_SOFTWARE)
1030         "=use if acceleration can't be determined) [default="
1031         OPENSSL_MSTR(DEVCRYPTO_DEFAULT_USE_SOFDTRIVERS) "]",
1032     ENGINE_CMD_FLAG_NUMERIC},
1033 #endif
1034
1035    {DEVCRYPTO_CMD_CIPHERS,
1036     "CIPHERS",
1037     "either ALL, NONE, or a comma-separated list of ciphers to enable [default=ALL]",
1038     ENGINE_CMD_FLAG_STRING},
1039
1040 #ifdef IMPLEMENT_DIGEST
1041    {DEVCRYPTO_CMD_DIGESTS,
1042     "DIGESTS",
1043     "either ALL, NONE, or a comma-separated list of digests to enable [default=ALL]",
1044     ENGINE_CMD_FLAG_STRING},
1045 #endif
1046
1047    {DEVCRYPTO_CMD_DUMP_INFO,
1048     "DUMP_INFO",
1049     "dump info about each algorithm to stderr; use 'openssl engine -pre DUMP_INFO devcrypto'",
1050     ENGINE_CMD_FLAG_NO_INPUT},
1051
1052    {0, NULL, NULL, 0}
1053 };
1054
1055 static int devcrypto_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f) (void))
1056 {
1057     int *new_list;
1058     switch (cmd) {
1059 #ifdef CIOCGSESSINFO
1060     case DEVCRYPTO_CMD_USE_SOFTDRIVERS:
1061         switch (i) {
1062         case DEVCRYPTO_REQUIRE_ACCELERATED:
1063         case DEVCRYPTO_USE_SOFTWARE:
1064         case DEVCRYPTO_REJECT_SOFTWARE:
1065             break;
1066         default:
1067             fprintf(stderr, "devcrypto: invalid value (%ld) for USE_SOFTDRIVERS\n", i);
1068             return 0;
1069         }
1070         if (use_softdrivers == i)
1071             return 1;
1072         use_softdrivers = i;
1073 #ifdef IMPLEMENT_DIGEST
1074         rebuild_known_digest_nids(e);
1075 #endif
1076         rebuild_known_cipher_nids(e);
1077         return 1;
1078 #endif /* CIOCGSESSINFO */
1079
1080     case DEVCRYPTO_CMD_CIPHERS:
1081         if (p == NULL)
1082             return 1;
1083         if (strcasecmp((const char *)p, "ALL") == 0) {
1084             devcrypto_select_all_ciphers(selected_ciphers);
1085         } else if (strcasecmp((const char*)p, "NONE") == 0) {
1086             memset(selected_ciphers, 0, sizeof(selected_ciphers));
1087         } else {
1088             new_list=OPENSSL_zalloc(sizeof(selected_ciphers));
1089             if (!CONF_parse_list(p, ',', 1, cryptodev_select_cipher_cb, new_list)) {
1090                 OPENSSL_free(new_list);
1091                 return 0;
1092             }
1093             memcpy(selected_ciphers, new_list, sizeof(selected_ciphers));
1094             OPENSSL_free(new_list);
1095         }
1096         rebuild_known_cipher_nids(e);
1097         return 1;
1098
1099 #ifdef IMPLEMENT_DIGEST
1100     case DEVCRYPTO_CMD_DIGESTS:
1101         if (p == NULL)
1102             return 1;
1103         if (strcasecmp((const char *)p, "ALL") == 0) {
1104             devcrypto_select_all_digests(selected_digests);
1105         } else if (strcasecmp((const char*)p, "NONE") == 0) {
1106             memset(selected_digests, 0, sizeof(selected_digests));
1107         } else {
1108             new_list=OPENSSL_zalloc(sizeof(selected_digests));
1109             if (!CONF_parse_list(p, ',', 1, cryptodev_select_digest_cb, new_list)) {
1110                 OPENSSL_free(new_list);
1111                 return 0;
1112             }
1113             memcpy(selected_digests, new_list, sizeof(selected_digests));
1114             OPENSSL_free(new_list);
1115         }
1116         rebuild_known_digest_nids(e);
1117         return 1;
1118 #endif /* IMPLEMENT_DIGEST */
1119
1120     case DEVCRYPTO_CMD_DUMP_INFO:
1121         dump_cipher_info();
1122 #ifdef IMPLEMENT_DIGEST
1123         dump_digest_info();
1124 #endif
1125         return 1;
1126
1127     default:
1128         break;
1129     }
1130     return 0;
1131 }
1132
1133 /******************************************************************************
1134  *
1135  * LOAD / UNLOAD
1136  *
1137  *****/
1138
1139 static int devcrypto_unload(ENGINE *e)
1140 {
1141     destroy_all_cipher_methods();
1142 #ifdef IMPLEMENT_DIGEST
1143     destroy_all_digest_methods();
1144 #endif
1145
1146     close(cfd);
1147
1148     return 1;
1149 }
1150 /*
1151  * This engine is always built into libcrypto, so it doesn't offer any
1152  * ability to be dynamically loadable.
1153  */
1154 void engine_load_devcrypto_int()
1155 {
1156     ENGINE *e = NULL;
1157
1158     if ((cfd = open("/dev/crypto", O_RDWR, 0)) < 0) {
1159         fprintf(stderr, "Could not open /dev/crypto: %s\n", strerror(errno));
1160         return;
1161     }
1162
1163     if ((e = ENGINE_new()) == NULL
1164         || !ENGINE_set_destroy_function(e, devcrypto_unload)) {
1165         ENGINE_free(e);
1166         /*
1167          * We know that devcrypto_unload() won't be called when one of the
1168          * above two calls have failed, so we close cfd explicitly here to
1169          * avoid leaking resources.
1170          */
1171         close(cfd);
1172         return;
1173     }
1174
1175     prepare_cipher_methods();
1176 #ifdef IMPLEMENT_DIGEST
1177     prepare_digest_methods();
1178 #endif
1179
1180     if (!ENGINE_set_id(e, "devcrypto")
1181         || !ENGINE_set_name(e, "/dev/crypto engine")
1182         || !ENGINE_set_cmd_defns(e, devcrypto_cmds)
1183         || !ENGINE_set_ctrl_function(e, devcrypto_ctrl)
1184
1185 /*
1186  * Asymmetric ciphers aren't well supported with /dev/crypto.  Among the BSD
1187  * implementations, it seems to only exist in FreeBSD, and regarding the
1188  * parameters in its crypt_kop, the manual crypto(4) has this to say:
1189  *
1190  *    The semantics of these arguments are currently undocumented.
1191  *
1192  * Reading through the FreeBSD source code doesn't give much more than
1193  * their CRK_MOD_EXP implementation for ubsec.
1194  *
1195  * It doesn't look much better with cryptodev-linux.  They have the crypt_kop
1196  * structure as well as the command (CRK_*) in cryptodev.h, but no support
1197  * seems to be implemented at all for the moment.
1198  *
1199  * At the time of writing, it seems impossible to write proper support for
1200  * FreeBSD's asym features without some very deep knowledge and access to
1201  * specific kernel modules.
1202  *
1203  * /Richard Levitte, 2017-05-11
1204  */
1205 #if 0
1206 # ifndef OPENSSL_NO_RSA
1207         || !ENGINE_set_RSA(e, devcrypto_rsa)
1208 # endif
1209 # ifndef OPENSSL_NO_DSA
1210         || !ENGINE_set_DSA(e, devcrypto_dsa)
1211 # endif
1212 # ifndef OPENSSL_NO_DH
1213         || !ENGINE_set_DH(e, devcrypto_dh)
1214 # endif
1215 # ifndef OPENSSL_NO_EC
1216         || !ENGINE_set_EC(e, devcrypto_ec)
1217 # endif
1218 #endif
1219         || !ENGINE_set_ciphers(e, devcrypto_ciphers)
1220 #ifdef IMPLEMENT_DIGEST
1221         || !ENGINE_set_digests(e, devcrypto_digests)
1222 #endif
1223         ) {
1224         ENGINE_free(e);
1225         return;
1226     }
1227
1228     ENGINE_add(e);
1229     ENGINE_free(e);          /* Loose our local reference */
1230     ERR_clear_error();
1231 }