crypto/srp/srp.h

   1 /* crypto/srp/srp.h */
   2 /* Written by Christophe Renou (christophe.renou@edelweb.fr) with
   3  * the precious help of Peter Sylvester (peter.sylvester@edelweb.fr)
   4  * for the 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 #ifndef OPENSSL_NO_SRP
  63
  64 #include <stdio.h>
  65 #include <string.h>
  66
  67 #ifdef  __cplusplus
  68 extern "C" {
  69 #endif
  70
  71 #include <openssl/safestack.h>
  72 #include <openssl/bn.h>
  73 #include <openssl/crypto.h>
  74
  75 typedef struct SRP_gN_cache_st
  76         {
  77         char *b64_bn;
  78         BIGNUM *bn;
  79         } SRP_gN_cache;
  80
  81
  82 DECLARE_STACK_OF(SRP_gN_cache)
  83
  84 typedef struct SRP_user_pwd_st
  85         {
  86         char *id;
  87         BIGNUM *s;
  88         BIGNUM *v;
  89         const BIGNUM *g;
  90         const BIGNUM *N;
  91         char *info;
  92         } SRP_user_pwd;
  93
  94 DECLARE_STACK_OF(SRP_user_pwd)
  95
  96 typedef struct SRP_VBASE_st
  97         {
  98         STACK_OF(SRP_user_pwd) *users_pwd;
  99         STACK_OF(SRP_gN_cache) *gN_cache;
 100 /* to simulate a user */
 101         char *seed_key;
 102         BIGNUM *default_g;
 103         BIGNUM *default_N;
 104         } SRP_VBASE;
 105
 106
 107 /*Structure interne pour retenir les couples N et g*/
 108 typedef struct SRP_gN_st
 109         {
 110         char *id;
 111         BIGNUM *g;
 112         BIGNUM *N;
 113         } SRP_gN;
 114
 115 DECLARE_STACK_OF(SRP_gN)
 116
 117 SRP_VBASE *SRP_VBASE_new(char *seed_key);
 118 int SRP_VBASE_free(SRP_VBASE *vb);
 119 int SRP_VBASE_init(SRP_VBASE *vb, char * verifier_file);
 120 SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username);
 121 char *SRP_create_verifier(const char *user, const char *pass, char **salt,
 122                           char **verifier, const char *N, const char *g);
 123 int SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt, BIGNUM **verifier, BIGNUM *N, BIGNUM *g);
 124
 125
 126 #define SRP_NO_ERROR 0
 127 #define SRP_ERR_VBASE_INCOMPLETE_FILE 1
 128 #define SRP_ERR_VBASE_BN_LIB 2
 129 #define SRP_ERR_OPEN_FILE 3
 130 #define SRP_ERR_MEMORY 4
 131
 132 #define DB_srptype      0
 133 #define DB_srpverifier  1
 134 #define DB_srpsalt      2
 135 #define DB_srpid        3
 136 #define DB_srpgN        4
 137 #define DB_srpinfo      5
 138 #undef  DB_NUMBER
 139 #define DB_NUMBER       6
 140
 141 #define DB_SRP_INDEX    'I'
 142 #define DB_SRP_VALID    'V'
 143 #define DB_SRP_REVOKED  'R'
 144 #define DB_SRP_MODIF    'v'
 145
 146
 147 /* see srp.c */
 148 char * SRP_check_known_gN_param(BIGNUM* g, BIGNUM* N);
 149 SRP_gN *SRP_get_default_gN(const char * id) ;
 150
 151 /* server side .... */
 152 BIGNUM *SRP_Calc_server_key(BIGNUM *A, BIGNUM *v, BIGNUM *u, BIGNUM *b, BIGNUM *N);
 153 BIGNUM *SRP_Calc_B(BIGNUM *b, BIGNUM *N, BIGNUM *g, BIGNUM *v);
 154 int SRP_Verify_A_mod_N(BIGNUM *A, BIGNUM *N);
 155 BIGNUM *SRP_Calc_u(BIGNUM *A, BIGNUM *B, BIGNUM *N) ;
 156
 157
 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, BIGNUM *a, BIGNUM *u);
 163 int SRP_Verify_B_mod_N(BIGNUM *B, BIGNUM *N);
 164
 165 #define SRP_MINIMAL_N 1024
 166
 167 #ifdef  __cplusplus
 168 }
 169 #endif
 170
 171 #endif
 172 #endif