]>
git.ipfire.org Git - thirdparty/openssl.git/blob - include/openssl/srp.h
2 * Copyright 2004-2020 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2004, EdelKey Project. All Rights Reserved.
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
10 * Originally written by Christophe Renou and Peter Sylvester,
11 * for the EdelKey project.
15 # define OPENSSL_SRP_H
18 # include <openssl/macros.h>
19 # ifndef OPENSSL_NO_DEPRECATED_3_0
23 #include <openssl/opensslconf.h>
25 #ifndef OPENSSL_NO_SRP
28 # include <openssl/safestack.h>
29 # include <openssl/bn.h>
30 # include <openssl/crypto.h>
36 DEFINE_OR_DECLARE_STACK_OF(SRP_gN_cache
)
37 DEFINE_OR_DECLARE_STACK_OF(SRP_user_pwd
)
38 DEFINE_OR_DECLARE_STACK_OF(SRP_gN
)
40 typedef struct SRP_gN_cache_st
{
45 typedef struct SRP_user_pwd_st
{
50 /* Not owned by us. */
57 SRP_user_pwd
*SRP_user_pwd_new(void);
58 void SRP_user_pwd_free(SRP_user_pwd
*user_pwd
);
60 void SRP_user_pwd_set_gN(SRP_user_pwd
*user_pwd
, const BIGNUM
*g
, const BIGNUM
*N
);
61 int SRP_user_pwd_set1_ids(SRP_user_pwd
*user_pwd
, const char *id
, const char *info
);
62 int SRP_user_pwd_set0_sv(SRP_user_pwd
*user_pwd
, BIGNUM
*s
, BIGNUM
*v
);
65 typedef struct SRP_VBASE_st
{
66 STACK_OF(SRP_user_pwd
) *users_pwd
;
67 STACK_OF(SRP_gN_cache
) *gN_cache
;
68 /* to simulate a user */
70 const BIGNUM
*default_g
;
71 const BIGNUM
*default_N
;
75 * Internal structure storing N and g pair
77 typedef struct SRP_gN_st
{
84 SRP_VBASE
*SRP_VBASE_new(char *seed_key
);
85 void SRP_VBASE_free(SRP_VBASE
*vb
);
86 int SRP_VBASE_init(SRP_VBASE
*vb
, char *verifier_file
);
88 int SRP_VBASE_add0_user(SRP_VBASE
*vb
, SRP_user_pwd
*user_pwd
);
89 /* This method ignores the configured seed and fails for an unknown user. */
90 DEPRECATEDIN_1_1_0(SRP_user_pwd
*SRP_VBASE_get_by_user(SRP_VBASE
*vb
, char *username
))
91 /* NOTE: unlike in SRP_VBASE_get_by_user, caller owns the returned pointer.*/
92 SRP_user_pwd
*SRP_VBASE_get1_by_user(SRP_VBASE
*vb
, char *username
);
94 char *SRP_create_verifier_ex(const char *user
, const char *pass
, char **salt
,
95 char **verifier
, const char *N
, const char *g
,
96 OPENSSL_CTX
*libctx
, const char *propq
);
97 char *SRP_create_verifier(const char *user
, const char *pass
, char **salt
,
98 char **verifier
, const char *N
, const char *g
);
99 int SRP_create_verifier_BN_ex(const char *user
, const char *pass
, BIGNUM
**salt
,
100 BIGNUM
**verifier
, const BIGNUM
*N
,
101 const BIGNUM
*g
, OPENSSL_CTX
*libctx
,
103 int SRP_create_verifier_BN(const char *user
, const char *pass
, BIGNUM
**salt
,
104 BIGNUM
**verifier
, const BIGNUM
*N
,
107 # define SRP_NO_ERROR 0
108 # define SRP_ERR_VBASE_INCOMPLETE_FILE 1
109 # define SRP_ERR_VBASE_BN_LIB 2
110 # define SRP_ERR_OPEN_FILE 3
111 # define SRP_ERR_MEMORY 4
113 # define DB_srptype 0
114 # define DB_srpverifier 1
115 # define DB_srpsalt 2
118 # define DB_srpinfo 5
122 # define DB_SRP_INDEX 'I'
123 # define DB_SRP_VALID 'V'
124 # define DB_SRP_REVOKED 'R'
125 # define DB_SRP_MODIF 'v'
128 char *SRP_check_known_gN_param(const BIGNUM
*g
, const BIGNUM
*N
);
129 SRP_gN
*SRP_get_default_gN(const char *id
);
131 /* server side .... */
132 BIGNUM
*SRP_Calc_server_key(const BIGNUM
*A
, const BIGNUM
*v
, const BIGNUM
*u
,
133 const BIGNUM
*b
, const BIGNUM
*N
);
134 BIGNUM
*SRP_Calc_B_ex(const BIGNUM
*b
, const BIGNUM
*N
, const BIGNUM
*g
,
135 const BIGNUM
*v
, OPENSSL_CTX
*libctx
, const char *propq
);
136 BIGNUM
*SRP_Calc_B(const BIGNUM
*b
, const BIGNUM
*N
, const BIGNUM
*g
,
138 int SRP_Verify_A_mod_N(const BIGNUM
*A
, const BIGNUM
*N
);
139 BIGNUM
*SRP_Calc_u_ex(const BIGNUM
*A
, const BIGNUM
*B
, const BIGNUM
*N
,
140 OPENSSL_CTX
*libctx
, const char *propq
);
141 BIGNUM
*SRP_Calc_u(const BIGNUM
*A
, const BIGNUM
*B
, const BIGNUM
*N
);
143 /* client side .... */
144 BIGNUM
*SRP_Calc_x_ex(const BIGNUM
*s
, const char *user
, const char *pass
,
145 OPENSSL_CTX
*libctx
, const char *propq
);
146 BIGNUM
*SRP_Calc_x(const BIGNUM
*s
, const char *user
, const char *pass
);
147 BIGNUM
*SRP_Calc_A(const BIGNUM
*a
, const BIGNUM
*N
, const BIGNUM
*g
);
148 BIGNUM
*SRP_Calc_client_key_ex(const BIGNUM
*N
, const BIGNUM
*B
, const BIGNUM
*g
,
149 const BIGNUM
*x
, const BIGNUM
*a
, const BIGNUM
*u
,
150 OPENSSL_CTX
*libctx
, const char *propq
);
151 BIGNUM
*SRP_Calc_client_key(const BIGNUM
*N
, const BIGNUM
*B
, const BIGNUM
*g
,
152 const BIGNUM
*x
, const BIGNUM
*a
, const BIGNUM
*u
);
153 int SRP_Verify_B_mod_N(const BIGNUM
*B
, const BIGNUM
*N
);
155 # define SRP_MINIMAL_N 1024