eng_devcrypto: add cipher CTX copy function
[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/evp.h>
20 #include <openssl/err.h>
21 #include <openssl/engine.h>
22 #include <openssl/objects.h>
23 #include <crypto/cryptodev.h>
24
25 #include "internal/engine.h"
26
27 #ifdef CRYPTO_ALGORITHM_MIN
28 # define CHECK_BSD_STYLE_MACROS
29 #endif
30
31 /*
32  * ONE global file descriptor for all sessions.  This allows operations
33  * such as digest session data copying (see digest_copy()), but is also
34  * saner...  why re-open /dev/crypto for every session?
35  */
36 static int cfd;
37
38 /******************************************************************************
39  *
40  * Ciphers
41  *
42  * Because they all do the same basic operation, we have only one set of
43  * method functions for them all to share, and a mapping table between
44  * NIDs and cryptodev IDs, with all the necessary size data.
45  *
46  *****/
47
48 struct cipher_ctx {
49     struct session_op sess;
50
51     /* to pass from init to do_cipher */
52     const unsigned char *iv;
53     int op;                      /* COP_ENCRYPT or COP_DECRYPT */
54 };
55
56 static const struct cipher_data_st {
57     int nid;
58     int blocksize;
59     int keylen;
60     int ivlen;
61     int flags;
62     int devcryptoid;
63 } cipher_data[] = {
64 #ifndef OPENSSL_NO_DES
65     { NID_des_cbc, 8, 8, 8, EVP_CIPH_CBC_MODE, CRYPTO_DES_CBC },
66     { NID_des_ede3_cbc, 8, 24, 8, EVP_CIPH_CBC_MODE, CRYPTO_3DES_CBC },
67 #endif
68 #ifndef OPENSSL_NO_BF
69     { NID_bf_cbc, 8, 16, 8, EVP_CIPH_CBC_MODE, CRYPTO_BLF_CBC },
70 #endif
71 #ifndef OPENSSL_NO_CAST
72     { NID_cast5_cbc, 8, 16, 8, EVP_CIPH_CBC_MODE, CRYPTO_CAST_CBC },
73 #endif
74     { NID_aes_128_cbc, 16, 128 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
75     { NID_aes_192_cbc, 16, 192 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
76     { NID_aes_256_cbc, 16, 256 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
77 #ifndef OPENSSL_NO_RC4
78     { NID_rc4, 1, 16, 0, EVP_CIPH_STREAM_CIPHER, CRYPTO_ARC4 },
79 #endif
80 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_AES_CTR)
81     { NID_aes_128_ctr, 16, 128 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
82     { NID_aes_192_ctr, 16, 192 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
83     { NID_aes_256_ctr, 16, 256 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
84 #endif
85 #if 0                            /* Not yet supported */
86     { NID_aes_128_xts, 16, 128 / 8 * 2, 16, EVP_CIPH_XTS_MODE, CRYPTO_AES_XTS },
87     { NID_aes_256_xts, 16, 256 / 8 * 2, 16, EVP_CIPH_XTS_MODE, CRYPTO_AES_XTS },
88 #endif
89 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_AES_ECB)
90     { NID_aes_128_ecb, 16, 128 / 8, 16, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
91     { NID_aes_192_ecb, 16, 192 / 8, 16, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
92     { NID_aes_256_ecb, 16, 256 / 8, 16, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
93 #endif
94 #if 0                            /* Not yet supported */
95     { NID_aes_128_gcm, 16, 128 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
96     { NID_aes_192_gcm, 16, 192 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
97     { NID_aes_256_gcm, 16, 256 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
98 #endif
99 #ifndef OPENSSL_NO_CAMELLIA
100     { NID_camellia_128_cbc, 16, 128 / 8, 16, EVP_CIPH_CBC_MODE,
101       CRYPTO_CAMELLIA_CBC },
102     { NID_camellia_192_cbc, 16, 192 / 8, 16, EVP_CIPH_CBC_MODE,
103       CRYPTO_CAMELLIA_CBC },
104     { NID_camellia_256_cbc, 16, 256 / 8, 16, EVP_CIPH_CBC_MODE,
105       CRYPTO_CAMELLIA_CBC },
106 #endif
107 };
108
109 static size_t get_cipher_data_index(int nid)
110 {
111     size_t i;
112
113     for (i = 0; i < OSSL_NELEM(cipher_data); i++)
114         if (nid == cipher_data[i].nid)
115             return i;
116
117     /*
118      * Code further down must make sure that only NIDs in the table above
119      * are used.  If any other NID reaches this function, there's a grave
120      * coding error further down.
121      */
122     assert("Code that never should be reached" == NULL);
123     return -1;
124 }
125
126 static const struct cipher_data_st *get_cipher_data(int nid)
127 {
128     return &cipher_data[get_cipher_data_index(nid)];
129 }
130
131 /*
132  * Following are the three necessary functions to map OpenSSL functionality
133  * with cryptodev.
134  */
135
136 static int cipher_init(EVP_CIPHER_CTX *ctx, const unsigned char *key,
137                        const unsigned char *iv, int enc)
138 {
139     struct cipher_ctx *cipher_ctx =
140         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
141     const struct cipher_data_st *cipher_d =
142         get_cipher_data(EVP_CIPHER_CTX_nid(ctx));
143
144     memset(&cipher_ctx->sess, 0, sizeof(cipher_ctx->sess));
145     cipher_ctx->sess.cipher = cipher_d->devcryptoid;
146     cipher_ctx->sess.keylen = cipher_d->keylen;
147     cipher_ctx->sess.key = (void *)key;
148     cipher_ctx->op = enc ? COP_ENCRYPT : COP_DECRYPT;
149     if (ioctl(cfd, CIOCGSESSION, &cipher_ctx->sess) < 0) {
150         SYSerr(SYS_F_IOCTL, errno);
151         return 0;
152     }
153
154     return 1;
155 }
156
157 static int cipher_do_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
158                             const unsigned char *in, size_t inl)
159 {
160     struct cipher_ctx *cipher_ctx =
161         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
162     struct crypt_op cryp;
163 #if !defined(COP_FLAG_WRITE_IV)
164     unsigned char saved_iv[EVP_MAX_IV_LENGTH];
165 #endif
166
167     memset(&cryp, 0, sizeof(cryp));
168     cryp.ses = cipher_ctx->sess.ses;
169     cryp.len = inl;
170     cryp.src = (void *)in;
171     cryp.dst = (void *)out;
172     cryp.iv = (void *)EVP_CIPHER_CTX_iv_noconst(ctx);
173     cryp.op = cipher_ctx->op;
174 #if !defined(COP_FLAG_WRITE_IV)
175     cryp.flags = 0;
176
177     if (EVP_CIPHER_CTX_iv_length(ctx) > 0) {
178         assert(inl >= EVP_CIPHER_CTX_iv_length(ctx));
179         if (!EVP_CIPHER_CTX_encrypting(ctx)) {
180             unsigned char *ivptr = in + inl - EVP_CIPHER_CTX_iv_length(ctx);
181
182             memcpy(saved_iv, ivptr, EVP_CIPHER_CTX_iv_length(ctx));
183         }
184     }
185 #else
186     cryp.flags = COP_FLAG_WRITE_IV;
187 #endif
188
189     if (ioctl(cfd, CIOCCRYPT, &cryp) < 0) {
190         SYSerr(SYS_F_IOCTL, errno);
191         return 0;
192     }
193
194 #if !defined(COP_FLAG_WRITE_IV)
195     if (EVP_CIPHER_CTX_iv_length(ctx) > 0) {
196         unsigned char *ivptr = saved_iv;
197
198         assert(inl >= EVP_CIPHER_CTX_iv_length(ctx));
199         if (!EVP_CIPHER_CTX_encrypting(ctx))
200             ivptr = out + inl - EVP_CIPHER_CTX_iv_length(ctx);
201
202         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), ivptr,
203                EVP_CIPHER_CTX_iv_length(ctx));
204     }
205 #endif
206
207     return 1;
208 }
209
210 static int cipher_ctrl(EVP_CIPHER_CTX *ctx, int type, int p1, void* p2)
211 {
212     EVP_CIPHER_CTX *to_ctx = (EVP_CIPHER_CTX *)p2;
213     struct cipher_ctx *cipher_ctx;
214
215     if (type == EVP_CTRL_COPY) {
216         /* when copying the context, a new session needs to be initialized */
217         cipher_ctx = (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
218         return (cipher_ctx == NULL)
219             || cipher_init(to_ctx, cipher_ctx->sess.key, EVP_CIPHER_CTX_iv(ctx),
220                            (cipher_ctx->op == COP_ENCRYPT));
221     }
222
223     return -1;
224 }
225
226 static int cipher_cleanup(EVP_CIPHER_CTX *ctx)
227 {
228     struct cipher_ctx *cipher_ctx =
229         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
230
231     if (ioctl(cfd, CIOCFSESSION, &cipher_ctx->sess.ses) < 0) {
232         SYSerr(SYS_F_IOCTL, errno);
233         return 0;
234     }
235
236     return 1;
237 }
238
239 /*
240  * Keep a table of known nids and associated methods.
241  * Note that known_cipher_nids[] isn't necessarily indexed the same way as
242  * cipher_data[] above, which known_cipher_methods[] is.
243  */
244 static int known_cipher_nids[OSSL_NELEM(cipher_data)];
245 static int known_cipher_nids_amount = -1; /* -1 indicates not yet initialised */
246 static EVP_CIPHER *known_cipher_methods[OSSL_NELEM(cipher_data)] = { NULL, };
247
248 static void prepare_cipher_methods(void)
249 {
250     size_t i;
251     struct session_op sess;
252
253     memset(&sess, 0, sizeof(sess));
254     sess.key = (void *)"01234567890123456789012345678901234567890123456789";
255
256     for (i = 0, known_cipher_nids_amount = 0;
257          i < OSSL_NELEM(cipher_data); i++) {
258
259         /*
260          * Check that the algo is really availably by trying to open and close
261          * a session.
262          */
263         sess.cipher = cipher_data[i].devcryptoid;
264         sess.keylen = cipher_data[i].keylen;
265         if (ioctl(cfd, CIOCGSESSION, &sess) < 0
266             || ioctl(cfd, CIOCFSESSION, &sess.ses) < 0)
267             continue;
268
269         if ((known_cipher_methods[i] =
270                  EVP_CIPHER_meth_new(cipher_data[i].nid,
271                                      cipher_data[i].blocksize,
272                                      cipher_data[i].keylen)) == NULL
273             || !EVP_CIPHER_meth_set_iv_length(known_cipher_methods[i],
274                                               cipher_data[i].ivlen)
275             || !EVP_CIPHER_meth_set_flags(known_cipher_methods[i],
276                                           cipher_data[i].flags
277                                           | EVP_CIPH_CUSTOM_COPY
278                                           | EVP_CIPH_FLAG_DEFAULT_ASN1)
279             || !EVP_CIPHER_meth_set_init(known_cipher_methods[i], cipher_init)
280             || !EVP_CIPHER_meth_set_do_cipher(known_cipher_methods[i],
281                                               cipher_do_cipher)
282             || !EVP_CIPHER_meth_set_ctrl(known_cipher_methods[i], cipher_ctrl)
283             || !EVP_CIPHER_meth_set_cleanup(known_cipher_methods[i],
284                                             cipher_cleanup)
285             || !EVP_CIPHER_meth_set_impl_ctx_size(known_cipher_methods[i],
286                                                   sizeof(struct cipher_ctx))) {
287             EVP_CIPHER_meth_free(known_cipher_methods[i]);
288             known_cipher_methods[i] = NULL;
289         } else {
290             known_cipher_nids[known_cipher_nids_amount++] =
291                 cipher_data[i].nid;
292         }
293     }
294 }
295
296 static const EVP_CIPHER *get_cipher_method(int nid)
297 {
298     size_t i = get_cipher_data_index(nid);
299
300     if (i == (size_t)-1)
301         return NULL;
302     return known_cipher_methods[i];
303 }
304
305 static int get_cipher_nids(const int **nids)
306 {
307     *nids = known_cipher_nids;
308     return known_cipher_nids_amount;
309 }
310
311 static void destroy_cipher_method(int nid)
312 {
313     size_t i = get_cipher_data_index(nid);
314
315     EVP_CIPHER_meth_free(known_cipher_methods[i]);
316     known_cipher_methods[i] = NULL;
317 }
318
319 static void destroy_all_cipher_methods(void)
320 {
321     size_t i;
322
323     for (i = 0; i < OSSL_NELEM(cipher_data); i++)
324         destroy_cipher_method(cipher_data[i].nid);
325 }
326
327 static int devcrypto_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
328                              const int **nids, int nid)
329 {
330     if (cipher == NULL)
331         return get_cipher_nids(nids);
332
333     *cipher = get_cipher_method(nid);
334
335     return *cipher != NULL;
336 }
337
338 /*
339  * We only support digests if the cryptodev implementation supports multiple
340  * data updates and session copying.  Otherwise, we would be forced to maintain
341  * a cache, which is perilous if there's a lot of data coming in (if someone
342  * wants to checksum an OpenSSL tarball, for example).
343  */
344 #if defined(CIOCCPHASH) && defined(COP_FLAG_UPDATE) && defined(COP_FLAG_FINAL)
345 #define IMPLEMENT_DIGEST
346
347 /******************************************************************************
348  *
349  * Digests
350  *
351  * Because they all do the same basic operation, we have only one set of
352  * method functions for them all to share, and a mapping table between
353  * NIDs and cryptodev IDs, with all the necessary size data.
354  *
355  *****/
356
357 struct digest_ctx {
358     struct session_op sess;
359     /* This signals that the init function was called, not that it succeeded. */
360     int init_called;
361 };
362
363 static const struct digest_data_st {
364     int nid;
365     int digestlen;
366     int devcryptoid;
367 } digest_data[] = {
368 #ifndef OPENSSL_NO_MD5
369     { NID_md5, 16, CRYPTO_MD5 },
370 #endif
371     { NID_sha1, 20, CRYPTO_SHA1 },
372 #ifndef OPENSSL_NO_RMD160
373 # if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_RIPEMD160)
374     { NID_ripemd160, 20, CRYPTO_RIPEMD160 },
375 # endif
376 #endif
377 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_224)
378     { NID_sha224, 224 / 8, CRYPTO_SHA2_224 },
379 #endif
380 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_256)
381     { NID_sha256, 256 / 8, CRYPTO_SHA2_256 },
382 #endif
383 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_384)
384     { NID_sha384, 384 / 8, CRYPTO_SHA2_384 },
385 #endif
386 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_SHA2_512)
387     { NID_sha512, 512 / 8, CRYPTO_SHA2_512 },
388 #endif
389 };
390
391 static size_t get_digest_data_index(int nid)
392 {
393     size_t i;
394
395     for (i = 0; i < OSSL_NELEM(digest_data); i++)
396         if (nid == digest_data[i].nid)
397             return i;
398
399     /*
400      * Code further down must make sure that only NIDs in the table above
401      * are used.  If any other NID reaches this function, there's a grave
402      * coding error further down.
403      */
404     assert("Code that never should be reached" == NULL);
405     return -1;
406 }
407
408 static const struct digest_data_st *get_digest_data(int nid)
409 {
410     return &digest_data[get_digest_data_index(nid)];
411 }
412
413 /*
414  * Following are the four necessary functions to map OpenSSL functionality
415  * with cryptodev.
416  */
417
418 static int digest_init(EVP_MD_CTX *ctx)
419 {
420     struct digest_ctx *digest_ctx =
421         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
422     const struct digest_data_st *digest_d =
423         get_digest_data(EVP_MD_CTX_type(ctx));
424
425     digest_ctx->init_called = 1;
426
427     memset(&digest_ctx->sess, 0, sizeof(digest_ctx->sess));
428     digest_ctx->sess.mac = digest_d->devcryptoid;
429     if (ioctl(cfd, CIOCGSESSION, &digest_ctx->sess) < 0) {
430         SYSerr(SYS_F_IOCTL, errno);
431         return 0;
432     }
433
434     return 1;
435 }
436
437 static int digest_op(struct digest_ctx *ctx, const void *src, size_t srclen,
438                      void *res, unsigned int flags)
439 {
440     struct crypt_op cryp;
441
442     memset(&cryp, 0, sizeof(cryp));
443     cryp.ses = ctx->sess.ses;
444     cryp.len = srclen;
445     cryp.src = (void *)src;
446     cryp.dst = NULL;
447     cryp.mac = res;
448     cryp.flags = flags;
449     return ioctl(cfd, CIOCCRYPT, &cryp);
450 }
451
452 static int digest_update(EVP_MD_CTX *ctx, const void *data, size_t count)
453 {
454     struct digest_ctx *digest_ctx =
455         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
456
457     if (count == 0)
458         return 1;
459
460     if (digest_ctx == NULL)
461         return 0;
462
463     if (digest_op(digest_ctx, data, count, NULL, COP_FLAG_UPDATE) < 0) {
464         SYSerr(SYS_F_IOCTL, errno);
465         return 0;
466     }
467
468     return 1;
469 }
470
471 static int digest_final(EVP_MD_CTX *ctx, unsigned char *md)
472 {
473     struct digest_ctx *digest_ctx =
474         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
475
476     if (md == NULL || digest_ctx == NULL)
477         return 0;
478     if (digest_op(digest_ctx, NULL, 0, md, COP_FLAG_FINAL) < 0) {
479         SYSerr(SYS_F_IOCTL, errno);
480         return 0;
481     }
482
483     return 1;
484 }
485
486 static int digest_copy(EVP_MD_CTX *to, const EVP_MD_CTX *from)
487 {
488     struct digest_ctx *digest_from =
489         (struct digest_ctx *)EVP_MD_CTX_md_data(from);
490     struct digest_ctx *digest_to =
491         (struct digest_ctx *)EVP_MD_CTX_md_data(to);
492     struct cphash_op cphash;
493
494     if (digest_from == NULL || digest_from->init_called != 1)
495         return 1;
496
497     if (!digest_init(to)) {
498         SYSerr(SYS_F_IOCTL, errno);
499         return 0;
500     }
501
502     cphash.src_ses = digest_from->sess.ses;
503     cphash.dst_ses = digest_to->sess.ses;
504     if (ioctl(cfd, CIOCCPHASH, &cphash) < 0) {
505         SYSerr(SYS_F_IOCTL, errno);
506         return 0;
507     }
508     return 1;
509 }
510
511 static int digest_cleanup(EVP_MD_CTX *ctx)
512 {
513     struct digest_ctx *digest_ctx =
514         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
515
516     if (digest_ctx == NULL)
517         return 1;
518     if (ioctl(cfd, CIOCFSESSION, &digest_ctx->sess.ses) < 0) {
519         SYSerr(SYS_F_IOCTL, errno);
520         return 0;
521     }
522     return 1;
523 }
524
525 /*
526  * Keep a table of known nids and associated methods.
527  * Note that known_digest_nids[] isn't necessarily indexed the same way as
528  * digest_data[] above, which known_digest_methods[] is.
529  */
530 static int known_digest_nids[OSSL_NELEM(digest_data)];
531 static int known_digest_nids_amount = -1; /* -1 indicates not yet initialised */
532 static EVP_MD *known_digest_methods[OSSL_NELEM(digest_data)] = { NULL, };
533
534 static void prepare_digest_methods(void)
535 {
536     size_t i;
537     struct session_op sess;
538
539     memset(&sess, 0, sizeof(sess));
540
541     for (i = 0, known_digest_nids_amount = 0; i < OSSL_NELEM(digest_data);
542          i++) {
543
544         /*
545          * Check that the algo is really availably by trying to open and close
546          * a session.
547          */
548         sess.mac = digest_data[i].devcryptoid;
549         if (ioctl(cfd, CIOCGSESSION, &sess) < 0
550             || ioctl(cfd, CIOCFSESSION, &sess.ses) < 0)
551             continue;
552
553         if ((known_digest_methods[i] = EVP_MD_meth_new(digest_data[i].nid,
554                                                        NID_undef)) == NULL
555             || !EVP_MD_meth_set_result_size(known_digest_methods[i],
556                                             digest_data[i].digestlen)
557             || !EVP_MD_meth_set_init(known_digest_methods[i], digest_init)
558             || !EVP_MD_meth_set_update(known_digest_methods[i], digest_update)
559             || !EVP_MD_meth_set_final(known_digest_methods[i], digest_final)
560             || !EVP_MD_meth_set_copy(known_digest_methods[i], digest_copy)
561             || !EVP_MD_meth_set_cleanup(known_digest_methods[i], digest_cleanup)
562             || !EVP_MD_meth_set_app_datasize(known_digest_methods[i],
563                                              sizeof(struct digest_ctx))) {
564             EVP_MD_meth_free(known_digest_methods[i]);
565             known_digest_methods[i] = NULL;
566         } else {
567             known_digest_nids[known_digest_nids_amount++] = digest_data[i].nid;
568         }
569     }
570 }
571
572 static const EVP_MD *get_digest_method(int nid)
573 {
574     size_t i = get_digest_data_index(nid);
575
576     if (i == (size_t)-1)
577         return NULL;
578     return known_digest_methods[i];
579 }
580
581 static int get_digest_nids(const int **nids)
582 {
583     *nids = known_digest_nids;
584     return known_digest_nids_amount;
585 }
586
587 static void destroy_digest_method(int nid)
588 {
589     size_t i = get_digest_data_index(nid);
590
591     EVP_MD_meth_free(known_digest_methods[i]);
592     known_digest_methods[i] = NULL;
593 }
594
595 static void destroy_all_digest_methods(void)
596 {
597     size_t i;
598
599     for (i = 0; i < OSSL_NELEM(digest_data); i++)
600         destroy_digest_method(digest_data[i].nid);
601 }
602
603 static int devcrypto_digests(ENGINE *e, const EVP_MD **digest,
604                              const int **nids, int nid)
605 {
606     if (digest == NULL)
607         return get_digest_nids(nids);
608
609     *digest = get_digest_method(nid);
610
611     return *digest != NULL;
612 }
613
614 #endif
615
616 /******************************************************************************
617  *
618  * LOAD / UNLOAD
619  *
620  *****/
621
622 static int devcrypto_unload(ENGINE *e)
623 {
624     destroy_all_cipher_methods();
625 #ifdef IMPLEMENT_DIGEST
626     destroy_all_digest_methods();
627 #endif
628
629     close(cfd);
630
631     return 1;
632 }
633 /*
634  * This engine is always built into libcrypto, so it doesn't offer any
635  * ability to be dynamically loadable.
636  */
637 void engine_load_devcrypto_int()
638 {
639     ENGINE *e = NULL;
640
641     if ((cfd = open("/dev/crypto", O_RDWR, 0)) < 0) {
642         fprintf(stderr, "Could not open /dev/crypto: %s\n", strerror(errno));
643         return;
644     }
645
646     if ((e = ENGINE_new()) == NULL
647         || !ENGINE_set_destroy_function(e, devcrypto_unload)) {
648         ENGINE_free(e);
649         /*
650          * We know that devcrypto_unload() won't be called when one of the
651          * above two calls have failed, so we close cfd explicitly here to
652          * avoid leaking resources.
653          */
654         close(cfd);
655         return;
656     }
657
658     prepare_cipher_methods();
659 #ifdef IMPLEMENT_DIGEST
660     prepare_digest_methods();
661 #endif
662
663     if (!ENGINE_set_id(e, "devcrypto")
664         || !ENGINE_set_name(e, "/dev/crypto engine")
665
666 /*
667  * Asymmetric ciphers aren't well supported with /dev/crypto.  Among the BSD
668  * implementations, it seems to only exist in FreeBSD, and regarding the
669  * parameters in its crypt_kop, the manual crypto(4) has this to say:
670  *
671  *    The semantics of these arguments are currently undocumented.
672  *
673  * Reading through the FreeBSD source code doesn't give much more than
674  * their CRK_MOD_EXP implementation for ubsec.
675  *
676  * It doesn't look much better with cryptodev-linux.  They have the crypt_kop
677  * structure as well as the command (CRK_*) in cryptodev.h, but no support
678  * seems to be implemented at all for the moment.
679  *
680  * At the time of writing, it seems impossible to write proper support for
681  * FreeBSD's asym features without some very deep knowledge and access to
682  * specific kernel modules.
683  *
684  * /Richard Levitte, 2017-05-11
685  */
686 #if 0
687 # ifndef OPENSSL_NO_RSA
688         || !ENGINE_set_RSA(e, devcrypto_rsa)
689 # endif
690 # ifndef OPENSSL_NO_DSA
691         || !ENGINE_set_DSA(e, devcrypto_dsa)
692 # endif
693 # ifndef OPENSSL_NO_DH
694         || !ENGINE_set_DH(e, devcrypto_dh)
695 # endif
696 # ifndef OPENSSL_NO_EC
697         || !ENGINE_set_EC(e, devcrypto_ec)
698 # endif
699 #endif
700         || !ENGINE_set_ciphers(e, devcrypto_ciphers)
701 #ifdef IMPLEMENT_DIGEST
702         || !ENGINE_set_digests(e, devcrypto_digests)
703 #endif
704         ) {
705         ENGINE_free(e);
706         return;
707     }
708
709     ENGINE_add(e);
710     ENGINE_free(e);          /* Loose our local reference */
711     ERR_clear_error();
712 }