83a3293f7c034bbcc816a4a2762c81e4fb4c57b9
[openssl.git] / include / openssl / srp.h
1 /*
2  * Written by Christophe Renou (christophe.renou@edelweb.fr) with the
3  * precious help of Peter Sylvester (peter.sylvester@edelweb.fr) for the
4  * EdelKey project and contributed to the OpenSSL project 2004.
5  */
6 /* ====================================================================
7  * Copyright (c) 2004 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This product includes cryptographic software written by Eric Young
55  * (eay@cryptsoft.com).  This product includes software written by Tim
56  * Hudson (tjh@cryptsoft.com).
57  *
58  */
59 #ifndef __SRP_H__
60 # define __SRP_H__
61
62 #include <openssl/opensslconf.h>
63
64 # ifdef OPENSSL_NO_SRP
65 #  error SRP is disabled.
66 # endif
67
68 # include <stdio.h>
69 # include <string.h>
70
71 #ifdef  __cplusplus
72 extern "C" {
73 #endif
74
75 # include <openssl/safestack.h>
76 # include <openssl/bn.h>
77 # include <openssl/crypto.h>
78
79 typedef struct SRP_gN_cache_st {
80     char *b64_bn;
81     BIGNUM *bn;
82 } SRP_gN_cache;
83
84
85 DEFINE_STACK_OF(SRP_gN_cache)
86
87 typedef struct SRP_user_pwd_st {
88     char *id;
89     BIGNUM *s;
90     BIGNUM *v;
91     const BIGNUM *g;
92     const BIGNUM *N;
93     char *info;
94 } SRP_user_pwd;
95
96 DEFINE_STACK_OF(SRP_user_pwd)
97
98 typedef struct SRP_VBASE_st {
99     STACK_OF(SRP_user_pwd) *users_pwd;
100     STACK_OF(SRP_gN_cache) *gN_cache;
101 /* to simulate a user */
102     char *seed_key;
103     BIGNUM *default_g;
104     BIGNUM *default_N;
105 } SRP_VBASE;
106
107 /*
108  * Structure interne pour retenir les couples N et g
109  */
110 typedef struct SRP_gN_st {
111     char *id;
112     BIGNUM *g;
113     BIGNUM *N;
114 } SRP_gN;
115
116 DEFINE_STACK_OF(SRP_gN)
117
118 SRP_VBASE *SRP_VBASE_new(char *seed_key);
119 void SRP_VBASE_free(SRP_VBASE *vb);
120 int SRP_VBASE_init(SRP_VBASE *vb, char *verifier_file);
121 SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username);
122 char *SRP_create_verifier(const char *user, const char *pass, char **salt,
123                           char **verifier, const char *N, const char *g);
124 int SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt,
125                            BIGNUM **verifier, const BIGNUM *N,
126                            const BIGNUM *g);
127
128 # define SRP_NO_ERROR 0
129 # define SRP_ERR_VBASE_INCOMPLETE_FILE 1
130 # define SRP_ERR_VBASE_BN_LIB 2
131 # define SRP_ERR_OPEN_FILE 3
132 # define SRP_ERR_MEMORY 4
133
134 # define DB_srptype      0
135 # define DB_srpverifier  1
136 # define DB_srpsalt      2
137 # define DB_srpid        3
138 # define DB_srpgN        4
139 # define DB_srpinfo      5
140 # undef  DB_NUMBER
141 # define DB_NUMBER       6
142
143 # define DB_SRP_INDEX    'I'
144 # define DB_SRP_VALID    'V'
145 # define DB_SRP_REVOKED  'R'
146 # define DB_SRP_MODIF    'v'
147
148 /* see srp.c */
149 char *SRP_check_known_gN_param(BIGNUM *g, BIGNUM *N);
150 SRP_gN *SRP_get_default_gN(const char *id);
151
152 /* server side .... */
153 BIGNUM *SRP_Calc_server_key(BIGNUM *A, BIGNUM *v, BIGNUM *u, BIGNUM *b,
154                             BIGNUM *N);
155 BIGNUM *SRP_Calc_B(BIGNUM *b, BIGNUM *N, BIGNUM *g, BIGNUM *v);
156 int SRP_Verify_A_mod_N(BIGNUM *A, BIGNUM *N);
157 BIGNUM *SRP_Calc_u(BIGNUM *A, BIGNUM *B, BIGNUM *N);
158
159 /* client side .... */
160 BIGNUM *SRP_Calc_x(BIGNUM *s, const char *user, const char *pass);
161 BIGNUM *SRP_Calc_A(BIGNUM *a, BIGNUM *N, BIGNUM *g);
162 BIGNUM *SRP_Calc_client_key(BIGNUM *N, BIGNUM *B, BIGNUM *g, BIGNUM *x,
163                             BIGNUM *a, BIGNUM *u);
164 int SRP_Verify_B_mod_N(BIGNUM *B, BIGNUM *N);
165
166 # define SRP_MINIMAL_N 1024
167
168 #ifdef  __cplusplus
169 }
170 #endif
171
172 #endif