include/openssl/srp.h

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