Change C++ style comments
[openssl.git] / crypto / engine / tb_ecdh.c
1 /* crypto/engine/tb_ecdh.c */
2 /* ====================================================================
3  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
4  *
5  * The Elliptic Curve Public-Key Crypto Library (ECC Code) included
6  * herein is developed by SUN MICROSYSTEMS, INC., and is contributed
7  * to the OpenSSL project.
8  *
9  * The ECC Code is licensed pursuant to the OpenSSL open source
10  * license provided below.
11  *
12  * In addition, Sun covenants to all licensees who provide a reciprocal
13  * covenant with respect to their own patents if any, not to sue under
14  * current and future patent claims necessarily infringed by the making,
15  * using, practicing, selling, offering for sale and/or otherwise
16  * disposing of the ECC Code as delivered hereunder (or portions thereof),
17  * provided that such covenant shall not apply:
18  *  1) for code that a licensee deletes from the ECC Code;
19  *  2) separates from the ECC Code; or
20  *  3) for infringements caused by:
21  *       i) the modification of the ECC Code or
22  *      ii) the combination of the ECC Code with other software or
23  *          devices where such combination causes the infringement.
24  *
25  * The ECDH engine software is originally written by Nils Gura and
26  * Douglas Stebila of Sun Microsystems Laboratories.
27  *
28  */
29 /* ====================================================================
30  * Copyright (c) 2000-2002 The OpenSSL Project.  All rights reserved.
31  *
32  * Redistribution and use in source and binary forms, with or without
33  * modification, are permitted provided that the following conditions
34  * are met:
35  *
36  * 1. Redistributions of source code must retain the above copyright
37  *    notice, this list of conditions and the following disclaimer. 
38  *
39  * 2. Redistributions in binary form must reproduce the above copyright
40  *    notice, this list of conditions and the following disclaimer in
41  *    the documentation and/or other materials provided with the
42  *    distribution.
43  *
44  * 3. All advertising materials mentioning features or use of this
45  *    software must display the following acknowledgment:
46  *    "This product includes software developed by the OpenSSL Project
47  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
48  *
49  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
50  *    endorse or promote products derived from this software without
51  *    prior written permission. For written permission, please contact
52  *    licensing@OpenSSL.org.
53  *
54  * 5. Products derived from this software may not be called "OpenSSL"
55  *    nor may "OpenSSL" appear in their names without prior written
56  *    permission of the OpenSSL Project.
57  *
58  * 6. Redistributions of any form whatsoever must retain the following
59  *    acknowledgment:
60  *    "This product includes software developed by the OpenSSL Project
61  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
62  *
63  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
64  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
65  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
66  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
67  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
68  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
69  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
71  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
72  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
73  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
74  * OF THE POSSIBILITY OF SUCH DAMAGE.
75  * ====================================================================
76  *
77  * This product includes cryptographic software written by Eric Young
78  * (eay@cryptsoft.com).  This product includes software written by Tim
79  * Hudson (tjh@cryptsoft.com).
80  *
81  */
82
83 #include <openssl/evp.h>
84 #include <openssl/engine.h>
85 #include "eng_int.h"
86
87 /* If this symbol is defined then ENGINE_get_default_ECDH(), the function that is
88  * used by ECDH to hook in implementation code and cache defaults (etc), will
89  * display brief debugging summaries to stderr with the 'nid'. */
90 /* #define ENGINE_ECDH_DEBUG */
91
92 static ENGINE_TABLE *ecdh_table = NULL;
93 static const int dummy_nid = 1;
94
95 void ENGINE_unregister_ECDH(ENGINE *e)
96         {
97         engine_table_unregister(&ecdh_table, e);
98         }
99
100 static void engine_unregister_all_ECDH(void)
101         {
102         engine_table_cleanup(&ecdh_table);
103         }
104
105 int ENGINE_register_ECDH(ENGINE *e)
106         {
107         if(e->ecdh_meth)
108                 return engine_table_register(&ecdh_table,
109                                 &engine_unregister_all_ECDH, e, &dummy_nid, 1, 0);
110         return 1;
111         }
112
113 void ENGINE_register_all_ECDH()
114         {
115         ENGINE *e;
116
117         for(e=ENGINE_get_first() ; e ; e=ENGINE_get_next(e))
118                 ENGINE_register_ECDH(e);
119         }
120
121 int ENGINE_set_default_ECDH(ENGINE *e)
122         {
123         if(e->ecdh_meth)
124                 return engine_table_register(&ecdh_table,
125                                 &engine_unregister_all_ECDH, e, &dummy_nid, 1, 0);
126         return 1;
127         }
128
129 /* Exposed API function to get a functional reference from the implementation
130  * table (ie. try to get a functional reference from the tabled structural
131  * references). */
132 ENGINE *ENGINE_get_default_ECDH(void)
133         {
134         return engine_table_select(&ecdh_table, dummy_nid);
135         }
136
137 /* Obtains an ECDH implementation from an ENGINE functional reference */
138 const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e)
139         {
140         return e->ecdh_meth;
141         }
142
143 /* Sets an ECDH implementation in an ENGINE structure */
144 int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *ecdh_meth)
145         {
146         e->ecdh_meth = ecdh_meth;
147         return 1;
148         }