crypto/engine/tb_cipher.c

   1 /*
   2  * Copyright 2001-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /* We need to use some engine deprecated APIs */
  11 #define OPENSSL_SUPPRESS_DEPRECATED
  12
  13 #include "eng_local.h"
  14
  15 static ENGINE_TABLE *cipher_table = NULL;
  16
  17 void ENGINE_unregister_ciphers(ENGINE *e)
  18 {
  19     engine_table_unregister(&cipher_table, e);
  20 }
  21
  22 static void engine_unregister_all_ciphers(void)
  23 {
  24     engine_table_cleanup(&cipher_table);
  25 }
  26
  27 int ENGINE_register_ciphers(ENGINE *e)
  28 {
  29     if (e->ciphers) {
  30         const int *nids;
  31         int num_nids = e->ciphers(e, NULL, &nids, 0);
  32         if (num_nids > 0)
  33             return engine_table_register(&cipher_table,
  34                                          engine_unregister_all_ciphers, e,
  35                                          nids, num_nids, 0);
  36     }
  37     return 1;
  38 }
  39
  40 void ENGINE_register_all_ciphers(void)
  41 {
  42     ENGINE *e;
  43
  44     for (e = ENGINE_get_first(); e; e = ENGINE_get_next(e))
  45         ENGINE_register_ciphers(e);
  46 }
  47
  48 int ENGINE_set_default_ciphers(ENGINE *e)
  49 {
  50     if (e->ciphers) {
  51         const int *nids;
  52         int num_nids = e->ciphers(e, NULL, &nids, 0);
  53         if (num_nids > 0)
  54             return engine_table_register(&cipher_table,
  55                                          engine_unregister_all_ciphers, e,
  56                                          nids, num_nids, 1);
  57     }
  58     return 1;
  59 }
  60
  61 /*
  62  * Exposed API function to get a functional reference from the implementation
  63  * table (ie. try to get a functional reference from the tabled structural
  64  * references) for a given cipher 'nid'
  65  */
  66 ENGINE *ENGINE_get_cipher_engine(int nid)
  67 {
  68     return ossl_engine_table_select(&cipher_table, nid,
  69                                     OPENSSL_FILE, OPENSSL_LINE);
  70 }
  71
  72 /* Obtains a cipher implementation from an ENGINE functional reference */
  73 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid)
  74 {
  75     const EVP_CIPHER *ret;
  76     ENGINE_CIPHERS_PTR fn = ENGINE_get_ciphers(e);
  77     if (!fn || !fn(e, &ret, NULL, nid)) {
  78         ERR_raise(ERR_LIB_ENGINE, ENGINE_R_UNIMPLEMENTED_CIPHER);
  79         return NULL;
  80     }
  81     return ret;
  82 }
  83
  84 /* Gets the cipher callback from an ENGINE structure */
  85 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e)
  86 {
  87     return e->ciphers;
  88 }
  89
  90 /* Sets the cipher callback in an ENGINE structure */
  91 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f)
  92 {
  93     e->ciphers = f;
  94     return 1;
  95 }