xref: /illumos-gate/usr/src/common/crypto/ecc/ecl.h (revision c40a6cd7)
1 /*
2  * ***** BEGIN LICENSE BLOCK *****
3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4  *
5  * The contents of this file are subject to the Mozilla Public License Version
6  * 1.1 (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  * http://www.mozilla.org/MPL/
9  *
10  * Software distributed under the License is distributed on an "AS IS" basis,
11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12  * for the specific language governing rights and limitations under the
13  * License.
14  *
15  * The Original Code is the elliptic curve math library.
16  *
17  * The Initial Developer of the Original Code is
18  * Sun Microsystems, Inc.
19  * Portions created by the Initial Developer are Copyright (C) 2003
20  * the Initial Developer. All Rights Reserved.
21  *
22  * Contributor(s):
23  *   Douglas Stebila <douglas@stebila.ca>, Sun Microsystems Laboratories
24  *
25  * Alternatively, the contents of this file may be used under the terms of
26  * either the GNU General Public License Version 2 or later (the "GPL"), or
27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28  * in which case the provisions of the GPL or the LGPL are applicable instead
29  * of those above. If you wish to allow use of your version of this file only
30  * under the terms of either the GPL or the LGPL, and not to allow others to
31  * use your version of this file under the terms of the MPL, indicate your
32  * decision by deleting the provisions above and replace them with the notice
33  * and other provisions required by the GPL or the LGPL. If you do not delete
34  * the provisions above, a recipient may use your version of this file under
35  * the terms of any one of the MPL, the GPL or the LGPL.
36  *
37  * ***** END LICENSE BLOCK ***** */
38 /*
39  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
40  * Use is subject to license terms.
41  *
42  * Sun elects to use this software under the MPL license.
43  */
44 
45 #ifndef _ECL_H
46 #define _ECL_H
47 
48 /* Although this is not an exported header file, code which uses elliptic
49  * curve point operations will need to include it. */
50 
51 #include "ecl-exp.h"
52 #include "mpi.h"
53 
54 struct ECGroupStr;
55 typedef struct ECGroupStr ECGroup;
56 
57 /* Construct ECGroup from hexadecimal representations of parameters. */
58 ECGroup *ECGroup_fromHex(const ECCurveParams * params, int kmflag);
59 
60 /* Construct ECGroup from named parameters. */
61 ECGroup *ECGroup_fromName(const ECCurveName name, int kmflag);
62 
63 /* Free an allocated ECGroup. */
64 void ECGroup_free(ECGroup *group);
65 
66 /* Construct ECCurveParams from an ECCurveName */
67 ECCurveParams *EC_GetNamedCurveParams(const ECCurveName name, int kmflag);
68 
69 /* Duplicates an ECCurveParams */
70 ECCurveParams *ECCurveParams_dup(const ECCurveParams * params, int kmflag);
71 
72 /* Free an allocated ECCurveParams */
73 void EC_FreeCurveParams(ECCurveParams * params);
74 
75 /* Elliptic curve scalar-point multiplication. Computes Q(x, y) = k * P(x,
76  * y).  If x, y = NULL, then P is assumed to be the generator (base point)
77  * of the group of points on the elliptic curve. Input and output values
78  * are assumed to be NOT field-encoded. */
79 mp_err ECPoint_mul(const ECGroup *group, const mp_int *k, const mp_int *px,
80 				   const mp_int *py, mp_int *qx, mp_int *qy);
81 
82 /* Elliptic curve scalar-point multiplication. Computes Q(x, y) = k1 * G +
83  * k2 * P(x, y), where G is the generator (base point) of the group of
84  * points on the elliptic curve. Input and output values are assumed to
85  * be NOT field-encoded. */
86 mp_err ECPoints_mul(const ECGroup *group, const mp_int *k1,
87 					const mp_int *k2, const mp_int *px, const mp_int *py,
88 					mp_int *qx, mp_int *qy);
89 
90 /* Validates an EC public key as described in Section 5.2.2 of X9.62.
91  * Returns MP_YES if the public key is valid, MP_NO if the public key
92  * is invalid, or an error code if the validation could not be
93  * performed. */
94 mp_err ECPoint_validate(const ECGroup *group, const mp_int *px, const
95 					mp_int *py);
96 
97 #endif /* _ECL_H */
98