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 HEADER_SRP_H
  60 # define HEADER_SRP_H
  61
  62 #include <openssl/opensslconf.h>
  63
  64 #ifndef OPENSSL_NO_SRP
  65 # include <stdio.h>
  66 # include <string.h>
  67 # include <openssl/safestack.h>
  68 # include <openssl/bn.h>
  69 # include <openssl/crypto.h>
  70
  71 # ifdef  __cplusplus
  72 extern "C" {
  73 # endif
  74
  75 typedef struct SRP_gN_cache_st {
  76     char *b64_bn;
  77     BIGNUM *bn;
  78 } SRP_gN_cache;
  79
  80
  81 DEFINE_STACK_OF(SRP_gN_cache)
  82
  83 typedef struct SRP_user_pwd_st {
  84     /* Owned by us. */
  85     char *id;
  86     BIGNUM *s;
  87     BIGNUM *v;
  88     /* Not owned by us. */
  89     const BIGNUM *g;
  90     const BIGNUM *N;
  91     /* Owned by us. */
  92     char *info;
  93 } SRP_user_pwd;
  94
  95 void SRP_user_pwd_free(SRP_user_pwd *user_pwd);
  96
  97 DEFINE_STACK_OF(SRP_user_pwd)
  98
  99 typedef struct SRP_VBASE_st {
 100     STACK_OF(SRP_user_pwd) *users_pwd;
 101     STACK_OF(SRP_gN_cache) *gN_cache;
 102 /* to simulate a user */
 103     char *seed_key;
 104     BIGNUM *default_g;
 105     BIGNUM *default_N;
 106 } SRP_VBASE;
 107
 108 /*
 109  * Internal structure storing N and g pair
 110  */
 111 typedef struct SRP_gN_st {
 112     char *id;
 113     BIGNUM *g;
 114     BIGNUM *N;
 115 } SRP_gN;
 116
 117 DEFINE_STACK_OF(SRP_gN)
 118
 119 SRP_VBASE *SRP_VBASE_new(char *seed_key);
 120 void SRP_VBASE_free(SRP_VBASE *vb);
 121 int SRP_VBASE_init(SRP_VBASE *vb, char *verifier_file);
 122
 123 /* This method ignores the configured seed and fails for an unknown user. */
 124 DEPRECATEDIN_1_1_0(SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username))
 125 /* NOTE: unlike in SRP_VBASE_get_by_user, caller owns the returned pointer.*/
 126 SRP_user_pwd *SRP_VBASE_get1_by_user(SRP_VBASE *vb, char *username);
 127
 128 char *SRP_create_verifier(const char *user, const char *pass, char **salt,
 129                           char **verifier, const char *N, const char *g);
 130 int SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt,
 131                            BIGNUM **verifier, const BIGNUM *N,
 132                            const BIGNUM *g);
 133
 134 # define SRP_NO_ERROR 0
 135 # define SRP_ERR_VBASE_INCOMPLETE_FILE 1
 136 # define SRP_ERR_VBASE_BN_LIB 2
 137 # define SRP_ERR_OPEN_FILE 3
 138 # define SRP_ERR_MEMORY 4
 139
 140 # define DB_srptype      0
 141 # define DB_srpverifier  1
 142 # define DB_srpsalt      2
 143 # define DB_srpid        3
 144 # define DB_srpgN        4
 145 # define DB_srpinfo      5
 146 # undef  DB_NUMBER
 147 # define DB_NUMBER       6
 148
 149 # define DB_SRP_INDEX    'I'
 150 # define DB_SRP_VALID    'V'
 151 # define DB_SRP_REVOKED  'R'
 152 # define DB_SRP_MODIF    'v'
 153
 154 /* see srp.c */
 155 char *SRP_check_known_gN_param(BIGNUM *g, BIGNUM *N);
 156 SRP_gN *SRP_get_default_gN(const char *id);
 157
 158 /* server side .... */
 159 BIGNUM *SRP_Calc_server_key(BIGNUM *A, BIGNUM *v, BIGNUM *u, BIGNUM *b,
 160                             BIGNUM *N);
 161 BIGNUM *SRP_Calc_B(BIGNUM *b, BIGNUM *N, BIGNUM *g, BIGNUM *v);
 162 int SRP_Verify_A_mod_N(BIGNUM *A, BIGNUM *N);
 163 BIGNUM *SRP_Calc_u(BIGNUM *A, BIGNUM *B, BIGNUM *N);
 164
 165 /* client side .... */
 166 BIGNUM *SRP_Calc_x(BIGNUM *s, const char *user, const char *pass);
 167 BIGNUM *SRP_Calc_A(BIGNUM *a, BIGNUM *N, BIGNUM *g);
 168 BIGNUM *SRP_Calc_client_key(BIGNUM *N, BIGNUM *B, BIGNUM *g, BIGNUM *x,
 169                             BIGNUM *a, BIGNUM *u);
 170 int SRP_Verify_B_mod_N(BIGNUM *B, BIGNUM *N);
 171
 172 # define SRP_MINIMAL_N 1024
 173
 174 # ifdef  __cplusplus
 175 }
 176 # endif
 177 # endif
 178
 179 #endif