Add new /dev/crypto engine
[openssl.git] / crypto / engine / eng_devcrypto.c
1 /*
2  * Copyright 2017 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 #include <string.h>
11 #include <sys/types.h>
12 #include <sys/stat.h>
13 #include <fcntl.h>
14 #include <sys/ioctl.h>
15 #include <unistd.h>
16 #include <assert.h>
17
18 #include "e_os.h"
19
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  *
34  * Ciphers
35  *
36  * Because they all do the same basic operation, we have only one set of
37  * method functions for them all to share, and a mapping table between
38  * NIDs and cryptodev IDs, with all the necessary size data.
39  *
40  *****/
41
42 struct cipher_ctx {
43     int cfd;
44     struct session_op sess;
45
46     /* to pass from init to do_cipher */
47     const unsigned char *iv;
48     int op;                      /* COP_ENCRYPT or COP_DECRYPT */
49 };
50
51 static const struct cipher_data_st {
52     int nid;
53     int blocksize;
54     int keylen;
55     int ivlen;
56     int flags;
57     int devcryptoid;
58 } cipher_data[] = {
59 #ifndef OPENSSL_NO_DES
60     { NID_des_cbc, 8, 8, 8, EVP_CIPH_CBC_MODE, CRYPTO_DES_CBC },
61     { NID_des_ede3_cbc, 8, 24, 8, EVP_CIPH_CBC_MODE, CRYPTO_3DES_CBC },
62 #endif
63 #ifndef OPENSSL_NO_BF
64     { NID_bf_cbc, 8, 16, 8, EVP_CIPH_CBC_MODE, CRYPTO_BLF_CBC },
65 #endif
66 #ifndef OPENSSL_NO_CAST
67     { NID_cast5_cbc, 8, 16, 8, EVP_CIPH_CBC_MODE, CRYPTO_CAST_CBC },
68 #endif
69     { NID_aes_128_cbc, 16, 128 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
70     { NID_aes_192_cbc, 16, 192 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
71     { NID_aes_256_cbc, 16, 256 / 8, 16, EVP_CIPH_CBC_MODE, CRYPTO_AES_CBC },
72 #ifndef OPENSSL_NO_RC4
73     { NID_rc4, 1, 16, 0, CRYPTO_ARC4 },
74 #endif
75 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_AES_CTR)
76     { NID_aes_128_ctr, 16, 128 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
77     { NID_aes_192_ctr, 16, 192 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
78     { NID_aes_256_ctr, 16, 256 / 8, 16, EVP_CIPH_CTR_MODE, CRYPTO_AES_CTR },
79 #endif
80 #if 0                            /* Not yet supported */
81     { NID_aes_128_xts, 16, 128 / 8 * 2, 16, EVP_CIPH_XTS_MODE, CRYPTO_AES_XTS },
82     { NID_aes_256_xts, 16, 256 / 8 * 2, 16, EVP_CIPH_XTS_MODE, CRYPTO_AES_XTS },
83 #endif
84 #if !defined(CHECK_BSD_STYLE_MACROS) || defined(CRYPTO_AES_ECB)
85     { NID_aes_128_ecb, 16, 128 / 8, 16, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
86     { NID_aes_192_ecb, 16, 192 / 8, 16, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
87     { NID_aes_256_ecb, 16, 256 / 8, 16, EVP_CIPH_ECB_MODE, CRYPTO_AES_ECB },
88 #endif
89 #if 0                            /* Not yet supported */
90     { NID_aes_128_gcm, 16, 128 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
91     { NID_aes_192_gcm, 16, 192 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
92     { NID_aes_256_gcm, 16, 256 / 8, 16, EVP_CIPH_GCM_MODE, CRYPTO_AES_GCM },
93 #endif
94 #ifndef OPENSSL_NO_CAMELLIA
95     { NID_camellia_128_cbc, 16, 128 / 8, 16, EVP_CIPH_CBC_MODE,
96       CRYPTO_CAMELLIA_CBC },
97     { NID_camellia_192_cbc, 16, 192 / 8, 16, EVP_CIPH_CBC_MODE,
98       CRYPTO_CAMELLIA_CBC },
99     { NID_camellia_256_cbc, 16, 256 / 8, 16, EVP_CIPH_CBC_MODE,
100       CRYPTO_CAMELLIA_CBC },
101 #endif
102 };
103
104 static size_t get_cipher_data_index(int nid)
105 {
106     size_t i;
107
108     for (i = 0; i < OSSL_NELEM(cipher_data); i++)
109         if (nid == cipher_data[i].nid)
110             return i;
111
112     /*
113      * Code further down must make sure that only NIDs in the table above
114      * are used.  If any other NID reaches this function, there's a grave
115      * coding error further down.
116      */
117     assert("Code that never should be reached" == NULL);
118     return -1;
119 }
120
121 static const struct cipher_data_st *get_cipher_data(int nid)
122 {
123     return &cipher_data[get_cipher_data_index(nid)];
124 }
125
126 /*
127  * Following are the three necessary functions to map OpenSSL functionality
128  * with cryptodev.
129  */
130
131 static int cipher_init(EVP_CIPHER_CTX *ctx, const unsigned char *key,
132                        const unsigned char *iv, int enc)
133 {
134     struct cipher_ctx *cipher_ctx =
135         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
136     const struct cipher_data_st *cipher_d =
137         get_cipher_data(EVP_CIPHER_CTX_nid(ctx));
138
139     if ((cipher_ctx->cfd = open("/dev/crypto", O_RDWR, 0)) < 0) {
140         SYSerr(SYS_F_OPEN, errno);
141         return 0;
142     }
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(cipher_ctx->cfd, CIOCGSESSION, &cipher_ctx->sess) < 0) {
150         SYSerr(SYS_F_IOCTL, errno);
151         close(cipher_ctx->cfd);
152         return 0;
153     }
154
155     return 1;
156 }
157
158 static int cipher_do_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
159                             const unsigned char *in, size_t inl)
160 {
161     struct cipher_ctx *cipher_ctx =
162         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
163     struct crypt_op cryp;
164
165     memset(&cryp, 0, sizeof(cryp));
166     cryp.ses = cipher_ctx->sess.ses;
167     cryp.len = inl;
168     cryp.src = (void *)in;
169     cryp.dst = (void *)out;
170     cryp.iv = (void *)EVP_CIPHER_CTX_iv_noconst(ctx);
171     cryp.op = cipher_ctx->op;
172     cryp.flags = COP_FLAG_WRITE_IV;
173     if (ioctl(cipher_ctx->cfd, CIOCCRYPT, &cryp) < 0) {
174         SYSerr(SYS_F_IOCTL, errno);
175         return 0;
176     }
177
178     return 1;
179 }
180
181 static int cipher_cleanup(EVP_CIPHER_CTX *ctx)
182 {
183     struct cipher_ctx *cipher_ctx =
184         (struct cipher_ctx *)EVP_CIPHER_CTX_get_cipher_data(ctx);
185
186     if (ioctl(cipher_ctx->cfd, CIOCFSESSION, &cipher_ctx->sess) < 0) {
187         SYSerr(SYS_F_IOCTL, errno);
188         return 0;
189     }
190     if (close(cipher_ctx->cfd) < 0) {
191         SYSerr(SYS_F_CLOSE, errno);
192         return 0;
193     }
194
195     return 1;
196 }
197
198 /*
199  * Keep a table of known nids and associated methods.
200  * Note that known_cipher_nids[] isn't necessarely indexed the same way as
201  * cipher_data[] above, which known_cipher_methods[] is.
202  */
203 static int known_cipher_nids[OSSL_NELEM(cipher_data)];
204 static int known_cipher_nids_amount = -1; /* -1 indicates not yet initialised */
205 static EVP_CIPHER *known_cipher_methods[OSSL_NELEM(cipher_data)] = { NULL, };
206
207 static void prepare_cipher_methods()
208 {
209     size_t i;
210     struct session_op sess;
211     int cfd;
212
213     if ((cfd = open("/dev/crypto", O_RDWR, 0)) < 0)
214         return;
215
216     memset(&sess, 0, sizeof(sess));
217     sess.key = (void *)"01234567890123456789012345678901234567890123456789";
218
219     for (i = 0, known_cipher_nids_amount = 0;
220          i < OSSL_NELEM(cipher_data); i++) {
221
222         /*
223          * Check that the algo is really availably by trying to open and close
224          * a session.
225          */
226         sess.cipher = cipher_data[i].devcryptoid;
227         sess.keylen = cipher_data[i].keylen;
228         if (ioctl(cfd, CIOCGSESSION, &sess) < 0
229             || ioctl(cfd, CIOCFSESSION, &sess) < 0)
230             continue;
231
232         if ((known_cipher_methods[i] =
233                  EVP_CIPHER_meth_new(cipher_data[i].nid,
234                                      cipher_data[i].blocksize,
235                                      cipher_data[i].keylen)) == NULL
236             || !EVP_CIPHER_meth_set_iv_length(known_cipher_methods[i],
237                                               cipher_data[i].ivlen)
238             || !EVP_CIPHER_meth_set_flags(known_cipher_methods[i],
239                                           cipher_data[i].flags
240                                           | EVP_CIPH_FLAG_DEFAULT_ASN1)
241             || !EVP_CIPHER_meth_set_init(known_cipher_methods[i], cipher_init)
242             || !EVP_CIPHER_meth_set_do_cipher(known_cipher_methods[i],
243                                               cipher_do_cipher)
244             || !EVP_CIPHER_meth_set_cleanup(known_cipher_methods[i],
245                                             cipher_cleanup)
246             || !EVP_CIPHER_meth_set_impl_ctx_size(known_cipher_methods[i],
247                                                   sizeof(struct cipher_ctx))) {
248             EVP_CIPHER_meth_free(known_cipher_methods[i]);
249             known_cipher_methods[i] = NULL;
250         } else {
251             known_cipher_nids[known_cipher_nids_amount++] =
252                 cipher_data[i].nid;
253         }
254     }
255
256     close(cfd);
257 }
258
259 static const EVP_CIPHER *get_cipher_method(int nid)
260 {
261     size_t i = get_cipher_data_index(nid);
262
263     if (i == (size_t)-1)
264         return NULL;
265     return known_cipher_methods[i];
266 }
267
268 static int get_cipher_nids(const int **nids)
269 {
270     *nids = known_cipher_nids;
271     return known_cipher_nids_amount;
272 }
273
274 static void destroy_cipher_method(int nid)
275 {
276     size_t i = get_cipher_data_index(nid);
277
278     EVP_CIPHER_meth_free(known_cipher_methods[i]);
279     known_cipher_methods[i] = NULL;
280 }
281
282 static void destroy_all_cipher_methods()
283 {
284     size_t i;
285
286     for (i = 0; i < OSSL_NELEM(cipher_data); i++)
287         destroy_cipher_method(cipher_data[i].nid);
288 }
289
290 static int devcrypto_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
291                              const int **nids, int nid)
292 {
293     if (cipher == NULL)
294         return get_cipher_nids(nids);
295
296     *cipher = get_cipher_method(nid);
297
298     return *cipher != NULL;
299 }
300
301 /******************************************************************************
302  *
303  * Digests
304  *
305  * Because they all do the same basic operation, we have only one set of
306  * method functions for them all to share, and a mapping table between
307  * NIDs and cryptodev IDs, with all the necessary size data.
308  *
309  *****/
310
311 struct digest_ctx {
312     int cfd;
313     struct session_op sess;
314     int init;
315 };
316
317 static const struct digest_data_st {
318     int nid;
319     int digestlen;
320     int devcryptoid;
321 } digest_data[] = {
322 #ifndef OPENSSL_NO_MD5
323     { NID_md5, 16, CRYPTO_MD5 },
324 #endif
325     { NID_sha1, 20, CRYPTO_SHA1 },
326 #ifndef OPENSSL_NO_RMD160
327 # if !defined(CHECK_BSD_STYLE_MACROS) && defined(CRYPTO_RIPEMD160)
328     { NID_ripemd160, 20, CRYPTO_RIPEMD160 },
329 # endif
330 #endif
331 #if !defined(CHECK_BSD_STYLE_MACROS) && defined(CRYPTO_SHA2_224)
332     { NID_sha224, 224 / 8, CRYPTO_SHA2_224 },
333 #endif
334 #if !defined(CHECK_BSD_STYLE_MACROS) && defined(CRYPTO_SHA2_256)
335     { NID_sha256, 256 / 8, CRYPTO_SHA2_256 },
336 #endif
337 #if !defined(CHECK_BSD_STYLE_MACROS) && defined(CRYPTO_SHA2_384)
338     { NID_sha384, 384 / 8, CRYPTO_SHA2_384 },
339 #endif
340 #if !defined(CHECK_BSD_STYLE_MACROS) && defined(CRYPTO_SHA2_512)
341     { NID_sha512, 512 / 8, CRYPTO_SHA2_512 },
342 #endif
343 };
344
345 static size_t get_digest_data_index(int nid)
346 {
347     size_t i;
348
349     for (i = 0; i < OSSL_NELEM(digest_data); i++)
350         if (nid == digest_data[i].nid)
351             return i;
352
353     /*
354      * Code further down must make sure that only NIDs in the table above
355      * are used.  If any other NID reaches this function, there's a grave
356      * coding error further down.
357      */
358     assert("Code that never should be reached" == NULL);
359     return -1;
360 }
361
362 static const struct digest_data_st *get_digest_data(int nid)
363 {
364     return &digest_data[get_digest_data_index(nid)];
365 }
366
367 /*
368  * Following are the four necessary functions to map OpenSSL functionality
369  * with cryptodev.
370  */
371
372 static int digest_init(EVP_MD_CTX *ctx)
373 {
374     struct digest_ctx *digest_ctx =
375         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
376     const struct digest_data_st *digest_d =
377         get_digest_data(EVP_MD_CTX_type(ctx));
378
379     if (digest_ctx->init == 0
380         && (digest_ctx->cfd = open("/dev/crypto", O_RDWR, 0)) < 0) {
381         SYSerr(SYS_F_OPEN, errno);
382         return 0;
383     }
384
385     digest_ctx->init = 1;
386
387     memset(&digest_ctx->sess, 0, sizeof(digest_ctx->sess));
388     digest_ctx->sess.mac = digest_d->devcryptoid;
389     if (ioctl(digest_ctx->cfd, CIOCGSESSION, &digest_ctx->sess) < 0) {
390         SYSerr(SYS_F_IOCTL, errno);
391         close(digest_ctx->cfd);
392         return 0;
393     }
394
395     return 1;
396 }
397
398 static int digest_update(EVP_MD_CTX *ctx, const void *data, size_t count)
399 {
400     struct digest_ctx *digest_ctx =
401         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
402     struct crypt_op cryp;
403
404     memset(&cryp, 0, sizeof(cryp));
405     cryp.ses = digest_ctx->sess.ses;
406     cryp.len = count;
407     cryp.src = (void *)data;
408     cryp.flags = COP_FLAG_UPDATE;
409     if (ioctl(digest_ctx->cfd, CIOCCRYPT, &cryp) < 0) {
410         SYSerr(SYS_F_IOCTL, errno);
411         return 0;
412     }
413
414     return 1;
415 }
416
417 static int digest_final(EVP_MD_CTX *ctx, unsigned char *md)
418 {
419     struct digest_ctx *digest_ctx =
420         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
421     struct crypt_op cryp;
422
423     memset(&cryp, 0, sizeof(cryp));
424     cryp.ses = digest_ctx->sess.ses;
425     cryp.len = 0;
426     cryp.src = NULL;
427     cryp.mac = (void *)md;
428     cryp.flags = COP_FLAG_FINAL;
429     if (ioctl(digest_ctx->cfd, CIOCCRYPT, &cryp) < 0) {
430         SYSerr(SYS_F_IOCTL, errno);
431         return 0;
432     }
433     if (ioctl(digest_ctx->cfd, CIOCFSESSION, &digest_ctx->sess) < 0) {
434         SYSerr(SYS_F_IOCTL, errno);
435         return 0;
436     }
437
438     return 1;
439 }
440
441 static int digest_cleanup(EVP_MD_CTX *ctx)
442 {
443     struct digest_ctx *digest_ctx =
444         (struct digest_ctx *)EVP_MD_CTX_md_data(ctx);
445
446     if (close(digest_ctx->cfd) < 0) {
447         SYSerr(SYS_F_CLOSE, errno);
448         return 0;
449     }
450
451     return 1;
452 }
453
454 /*
455  * Keep a table of known nids and associated methods.
456  * Note that known_digest_nids[] isn't necessarely indexed the same way as
457  * digest_data[] above, which known_digest_methods[] is.
458  */
459 static int known_digest_nids[OSSL_NELEM(digest_data)];
460 static int known_digest_nids_amount = -1; /* -1 indicates not yet initialised */
461 static EVP_MD *known_digest_methods[OSSL_NELEM(digest_data)] = { NULL, };
462
463 static void prepare_digest_methods()
464 {
465     size_t i;
466     struct session_op sess;
467     int cfd;
468
469     if ((cfd = open("/dev/crypto", O_RDWR, 0)) < 0)
470         return;
471
472     memset(&sess, 0, sizeof(sess));
473
474     for (i = 0, known_digest_nids_amount = 0; i < OSSL_NELEM(digest_data);
475          i++) {
476
477         /*
478          * Check that the algo is really availably by trying to open and close
479          * a session.
480          */
481         sess.mac = digest_data[i].devcryptoid;
482         if (ioctl(cfd, CIOCGSESSION, &sess) < 0
483             || ioctl(cfd, CIOCFSESSION, &sess) < 0)
484             continue;
485
486         if ((known_digest_methods[i] = EVP_MD_meth_new(digest_data[i].nid,
487                                                        NID_undef)) == NULL
488             || !EVP_MD_meth_set_result_size(known_digest_methods[i],
489                                             digest_data[i].digestlen)
490             || !EVP_MD_meth_set_init(known_digest_methods[i], digest_init)
491             || !EVP_MD_meth_set_update(known_digest_methods[i], digest_update)
492             || !EVP_MD_meth_set_final(known_digest_methods[i], digest_final)
493             || !EVP_MD_meth_set_cleanup(known_digest_methods[i], digest_cleanup)
494             || !EVP_MD_meth_set_app_datasize(known_digest_methods[i],
495                                              sizeof(struct digest_ctx))) {
496             EVP_MD_meth_free(known_digest_methods[i]);
497             known_digest_methods[i] = NULL;
498         } else {
499             known_digest_nids[known_digest_nids_amount++] = digest_data[i].nid;
500         }
501     }
502
503     close(cfd);
504 }
505
506 static const EVP_MD *get_digest_method(int nid)
507 {
508     size_t i = get_digest_data_index(nid);
509
510     if (i == (size_t)-1)
511         return NULL;
512     return known_digest_methods[i];
513 }
514
515 static int get_digest_nids(const int **nids)
516 {
517     *nids = known_digest_nids;
518     return known_digest_nids_amount;
519 }
520
521 static void destroy_digest_method(int nid)
522 {
523     size_t i = get_digest_data_index(nid);
524
525     EVP_MD_meth_free(known_digest_methods[i]);
526     known_digest_methods[i] = NULL;
527 }
528
529 static void destroy_all_digest_methods()
530 {
531     size_t i;
532
533     for (i = 0; i < OSSL_NELEM(digest_data); i++)
534         destroy_digest_method(digest_data[i].nid);
535 }
536
537 static int devcrypto_digests(ENGINE *e, const EVP_MD **digest,
538                              const int **nids, int nid)
539 {
540     if (digest == NULL)
541         return get_digest_nids(nids);
542
543     *digest = get_digest_method(nid);
544
545     return *digest != NULL;
546 }
547
548 /******************************************************************************
549  *
550  * LOAD / UNLOAD
551  *
552  *****/
553
554 static int devcrypto_unload(ENGINE *e)
555 {
556     destroy_all_cipher_methods();
557     destroy_all_digest_methods();
558     return 1;
559 }
560 /*
561  * This engine is always built into libcrypto, so it doesn't offer any
562  * ability to be dynamically loadable.
563  */
564 void engine_load_devcrypto_int()
565 {
566     ENGINE *e = NULL;
567
568     if (access("/dev/crypto", R_OK | W_OK) < 0) {
569         fprintf(stderr,
570                 "/dev/crypto not present, not enabling devcrypto engine\n");
571         return;
572     }
573
574     prepare_cipher_methods();
575     prepare_digest_methods();
576
577     if ((e = ENGINE_new()) == NULL)
578         return;
579
580     if (!ENGINE_set_id(e, "devcrypto")
581         || !ENGINE_set_name(e, "/dev/crypto engine")
582         || !ENGINE_set_destroy_function(e, devcrypto_unload)
583 #if 0                            /* Not supported yet */
584 # ifndef OPENSSL_NO_RSA
585         || !ENGINE_set_RSA(e, devcrypto_rsa)
586 # endif
587 # ifndef OPENSSL_NO_DSA
588         || !ENGINE_set_DSA(e, devcrypto_dsa)
589 # endif
590 # ifndef OPENSSL_NO_DH
591         || !ENGINE_set_DH(e, devcrypto_dh)
592 # endif
593 # ifndef OPENSSL_NO_EC
594         || !ENGINE_set_EC(e, devcrypto_ec)
595 # endif
596 #endif
597         || !ENGINE_set_ciphers(e, devcrypto_ciphers)
598         || !ENGINE_set_digests(e, devcrypto_digests)) {
599         ENGINE_free(e);
600         return;
601     }
602
603     ENGINE_add(e);
604     ENGINE_free(e);          /* Loose our local reference */
605     ERR_clear_error();
606 }