crypto/engine/tb_cipher.c

   1 /* ====================================================================
   2  * Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * 3. All advertising materials mentioning features or use of this
  17  *    software must display the following acknowledgment:
  18  *    "This product includes software developed by the OpenSSL Project
  19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  20  *
  21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For written permission, please contact
  24  *    licensing@OpenSSL.org.
  25  *
  26  * 5. Products derived from this software may not be called "OpenSSL"
  27  *    nor may "OpenSSL" appear in their names without prior written
  28  *    permission of the OpenSSL Project.
  29  *
  30  * 6. Redistributions of any form whatsoever must retain the following
  31  *    acknowledgment:
  32  *    "This product includes software developed by the OpenSSL Project
  33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This product includes cryptographic software written by Eric Young
  50  * (eay@cryptsoft.com).  This product includes software written by Tim
  51  * Hudson (tjh@cryptsoft.com).
  52  *
  53  */
  54
  55 #include "eng_int.h"
  56
  57 /*
  58  * If this symbol is defined then ENGINE_get_cipher_engine(), the function
  59  * that is used by EVP to hook in cipher code and cache defaults (etc), will
  60  * display brief debugging summaries to stderr with the 'nid'.
  61  */
  62 /* #define ENGINE_CIPHER_DEBUG */
  63
  64 static ENGINE_TABLE *cipher_table = NULL;
  65
  66 void ENGINE_unregister_ciphers(ENGINE *e)
  67 {
  68     engine_table_unregister(&cipher_table, e);
  69 }
  70
  71 static void engine_unregister_all_ciphers(void)
  72 {
  73     engine_table_cleanup(&cipher_table);
  74 }
  75
  76 int ENGINE_register_ciphers(ENGINE *e)
  77 {
  78     if (e->ciphers) {
  79         const int *nids;
  80         int num_nids = e->ciphers(e, NULL, &nids, 0);
  81         if (num_nids > 0)
  82             return engine_table_register(&cipher_table,
  83                                          engine_unregister_all_ciphers, e,
  84                                          nids, num_nids, 0);
  85     }
  86     return 1;
  87 }
  88
  89 void ENGINE_register_all_ciphers()
  90 {
  91     ENGINE *e;
  92
  93     for (e = ENGINE_get_first(); e; e = ENGINE_get_next(e))
  94         ENGINE_register_ciphers(e);
  95 }
  96
  97 int ENGINE_set_default_ciphers(ENGINE *e)
  98 {
  99     if (e->ciphers) {
 100         const int *nids;
 101         int num_nids = e->ciphers(e, NULL, &nids, 0);
 102         if (num_nids > 0)
 103             return engine_table_register(&cipher_table,
 104                                          engine_unregister_all_ciphers, e,
 105                                          nids, num_nids, 1);
 106     }
 107     return 1;
 108 }
 109
 110 /*
 111  * Exposed API function to get a functional reference from the implementation
 112  * table (ie. try to get a functional reference from the tabled structural
 113  * references) for a given cipher 'nid'
 114  */
 115 ENGINE *ENGINE_get_cipher_engine(int nid)
 116 {
 117     return engine_table_select(&cipher_table, nid);
 118 }
 119
 120 /* Obtains a cipher implementation from an ENGINE functional reference */
 121 const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid)
 122 {
 123     const EVP_CIPHER *ret;
 124     ENGINE_CIPHERS_PTR fn = ENGINE_get_ciphers(e);
 125     if (!fn || !fn(e, &ret, NULL, nid)) {
 126         ENGINEerr(ENGINE_F_ENGINE_GET_CIPHER, ENGINE_R_UNIMPLEMENTED_CIPHER);
 127         return NULL;
 128     }
 129     return ret;
 130 }
 131
 132 /* Gets the cipher callback from an ENGINE structure */
 133 ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e)
 134 {
 135     return e->ciphers;
 136 }
 137
 138 /* Sets the cipher callback in an ENGINE structure */
 139 int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f)
 140 {
 141     e->ciphers = f;
 142     return 1;
 143 }