xref: /freebsd/crypto/libecc/src/examples/sig/dsa/dsa.h (revision f0865ec9906d5a18fa2a3b61381f22ce16e606ad)
1*f0865ec9SKyle Evans /*
2*f0865ec9SKyle Evans  *  Copyright (C) 2021 - This file is part of libecc project
3*f0865ec9SKyle Evans  *
4*f0865ec9SKyle Evans  *  Authors:
5*f0865ec9SKyle Evans  *      Ryad BENADJILA <ryadbenadjila@gmail.com>
6*f0865ec9SKyle Evans  *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
7*f0865ec9SKyle Evans  *
8*f0865ec9SKyle Evans  *  This software is licensed under a dual BSD and GPL v2 license.
9*f0865ec9SKyle Evans  *  See LICENSE file at the root folder of the project.
10*f0865ec9SKyle Evans  */
11*f0865ec9SKyle Evans #ifndef __DSA_H__
12*f0865ec9SKyle Evans #define __DSA_H__
13*f0865ec9SKyle Evans 
14*f0865ec9SKyle Evans /*
15*f0865ec9SKyle Evans  * NOTE: although we only need libarith for DSA as we
16*f0865ec9SKyle Evans  * manipulate a ring of integers, we include libsig for
17*f0865ec9SKyle Evans  * the hash algorithms.
18*f0865ec9SKyle Evans  */
19*f0865ec9SKyle Evans #include <libecc/lib_ecc_config.h>
20*f0865ec9SKyle Evans 
21*f0865ec9SKyle Evans /* The hash algorithms wrapper */
22*f0865ec9SKyle Evans #include "../../hash/hash.h"
23*f0865ec9SKyle Evans 
24*f0865ec9SKyle Evans /* We define hereafter the types and functions for DSA.
25*f0865ec9SKyle Evans  * The notations are taken from NIST FIPS 186-4 and should be
26*f0865ec9SKyle Evans  * compliant with it.
27*f0865ec9SKyle Evans  */
28*f0865ec9SKyle Evans 
29*f0865ec9SKyle Evans /* DSA public key, composed of:
30*f0865ec9SKyle Evans  *       p        the DSA prime modulus
31*f0865ec9SKyle Evans  *       q        the DSA prime order (prime divisor of (p-1))
32*f0865ec9SKyle Evans  *       g        the DSA generator
33*f0865ec9SKyle Evans  *       y        the public key = g^x (p)
34*f0865ec9SKyle Evans  */
35*f0865ec9SKyle Evans typedef struct {
36*f0865ec9SKyle Evans 	nn p;
37*f0865ec9SKyle Evans 	nn q;
38*f0865ec9SKyle Evans 	nn g;
39*f0865ec9SKyle Evans 	nn y;
40*f0865ec9SKyle Evans } dsa_pub_key;
41*f0865ec9SKyle Evans 
42*f0865ec9SKyle Evans /* DSA private key, composed of:
43*f0865ec9SKyle Evans  *       p        the DSA prime modulus
44*f0865ec9SKyle Evans  *       q        the DSA prime order (prime divisor of (p-1))
45*f0865ec9SKyle Evans  *       g        the DSA generator
46*f0865ec9SKyle Evans  *       x        the secret key
47*f0865ec9SKyle Evans  */
48*f0865ec9SKyle Evans typedef struct {
49*f0865ec9SKyle Evans 	nn p;
50*f0865ec9SKyle Evans 	nn q;
51*f0865ec9SKyle Evans 	nn g;
52*f0865ec9SKyle Evans 	nn x;
53*f0865ec9SKyle Evans } dsa_priv_key;
54*f0865ec9SKyle Evans 
55*f0865ec9SKyle Evans ATTRIBUTE_WARN_UNUSED_RET int dsa_import_priv_key(dsa_priv_key *priv, const u8 *p, u16 plen,
56*f0865ec9SKyle Evans 			                          const u8 *q, u16 qlen,
57*f0865ec9SKyle Evans 			                          const u8 *g, u16 glen,
58*f0865ec9SKyle Evans 			                          const u8 *x, u16 xlen);
59*f0865ec9SKyle Evans 
60*f0865ec9SKyle Evans ATTRIBUTE_WARN_UNUSED_RET int dsa_import_pub_key(dsa_pub_key *pub, const u8 *p, u16 plen,
61*f0865ec9SKyle Evans 			                         const u8 *q, u16 qlen,
62*f0865ec9SKyle Evans 			                         const u8 *g, u16 glen,
63*f0865ec9SKyle Evans 			                         const u8 *y, u16 ylen);
64*f0865ec9SKyle Evans 
65*f0865ec9SKyle Evans ATTRIBUTE_WARN_UNUSED_RET int dsa_compute_pub_from_priv(dsa_pub_key *pub,
66*f0865ec9SKyle Evans 							const dsa_priv_key *priv);
67*f0865ec9SKyle Evans 
68*f0865ec9SKyle Evans ATTRIBUTE_WARN_UNUSED_RET int dsa_sign(const dsa_priv_key *priv, const u8 *msg, u32 msglen,
69*f0865ec9SKyle Evans 			               const u8 *nonce, u16 noncelen,
70*f0865ec9SKyle Evans 			               u8 *sig, u16 siglen, gen_hash_alg_type dsa_hash);
71*f0865ec9SKyle Evans 
72*f0865ec9SKyle Evans ATTRIBUTE_WARN_UNUSED_RET int dsa_verify(const dsa_pub_key *pub, const u8 *msg, u32 msglen,
73*f0865ec9SKyle Evans 			                 const u8 *sig, u16 siglen, gen_hash_alg_type dsa_hash);
74*f0865ec9SKyle Evans 
75*f0865ec9SKyle Evans #endif /* __DSA_H__ */
76