include/openssl/srp.h

   1 /*
   2  * Copyright 2004-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright (c) 2004, EdelKey Project. All Rights Reserved.
   4  *
   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
   9  *
  10  * Originally written by Christophe Renou and Peter Sylvester,
  11  * for the EdelKey project.
  12  */
  13
  14 #ifndef OPENSSL_SRP_H
  15 # define OPENSSL_SRP_H
  16
  17 #include <openssl/opensslconf.h>
  18
  19 #ifndef OPENSSL_NO_SRP
  20 # include <stdio.h>
  21 # include <string.h>
  22 # include <openssl/safestack.h>
  23 # include <openssl/bn.h>
  24 # include <openssl/crypto.h>
  25
  26 # ifdef  __cplusplus
  27 extern "C" {
  28 # endif
  29
  30 typedef struct SRP_gN_cache_st {
  31     char *b64_bn;
  32     BIGNUM *bn;
  33 } SRP_gN_cache;
  34
  35
  36 DEFINE_STACK_OF(SRP_gN_cache)
  37
  38 typedef struct SRP_user_pwd_st {
  39     /* Owned by us. */
  40     char *id;
  41     BIGNUM *s;
  42     BIGNUM *v;
  43     /* Not owned by us. */
  44     const BIGNUM *g;
  45     const BIGNUM *N;
  46     /* Owned by us. */
  47     char *info;
  48 } SRP_user_pwd;
  49
  50 SRP_user_pwd *SRP_user_pwd_new(void);
  51 void SRP_user_pwd_free(SRP_user_pwd *user_pwd);
  52
  53 void SRP_user_pwd_set_gN(SRP_user_pwd *user_pwd, const BIGNUM *g, const BIGNUM *N);
  54 int SRP_user_pwd_set1_ids(SRP_user_pwd *user_pwd, const char *id, const char *info);
  55 int SRP_user_pwd_set0_sv(SRP_user_pwd *user_pwd, BIGNUM *s, BIGNUM *v);
  56
  57 DEFINE_STACK_OF(SRP_user_pwd)
  58
  59 typedef struct SRP_VBASE_st {
  60     STACK_OF(SRP_user_pwd) *users_pwd;
  61     STACK_OF(SRP_gN_cache) *gN_cache;
  62 /* to simulate a user */
  63     char *seed_key;
  64     const BIGNUM *default_g;
  65     const BIGNUM *default_N;
  66 } SRP_VBASE;
  67
  68 /*
  69  * Internal structure storing N and g pair
  70  */
  71 typedef struct SRP_gN_st {
  72     char *id;
  73     const BIGNUM *g;
  74     const BIGNUM *N;
  75 } SRP_gN;
  76
  77 DEFINE_STACK_OF(SRP_gN)
  78
  79 SRP_VBASE *SRP_VBASE_new(char *seed_key);
  80 void SRP_VBASE_free(SRP_VBASE *vb);
  81 int SRP_VBASE_init(SRP_VBASE *vb, char *verifier_file);
  82
  83 int SRP_VBASE_add0_user(SRP_VBASE *vb, SRP_user_pwd *user_pwd);
  84 /* This method ignores the configured seed and fails for an unknown user. */
  85 DEPRECATEDIN_1_1_0(SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username))
  86 /* NOTE: unlike in SRP_VBASE_get_by_user, caller owns the returned pointer.*/
  87 SRP_user_pwd *SRP_VBASE_get1_by_user(SRP_VBASE *vb, char *username);
  88
  89 char *SRP_create_verifier(const char *user, const char *pass, char **salt,
  90                           char **verifier, const char *N, const char *g);
  91 int SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt,
  92                            BIGNUM **verifier, const BIGNUM *N,
  93                            const BIGNUM *g);
  94
  95 # define SRP_NO_ERROR 0
  96 # define SRP_ERR_VBASE_INCOMPLETE_FILE 1
  97 # define SRP_ERR_VBASE_BN_LIB 2
  98 # define SRP_ERR_OPEN_FILE 3
  99 # define SRP_ERR_MEMORY 4
 100
 101 # define DB_srptype      0
 102 # define DB_srpverifier  1
 103 # define DB_srpsalt      2
 104 # define DB_srpid        3
 105 # define DB_srpgN        4
 106 # define DB_srpinfo      5
 107 # undef  DB_NUMBER
 108 # define DB_NUMBER       6
 109
 110 # define DB_SRP_INDEX    'I'
 111 # define DB_SRP_VALID    'V'
 112 # define DB_SRP_REVOKED  'R'
 113 # define DB_SRP_MODIF    'v'
 114
 115 /* see srp.c */
 116 char *SRP_check_known_gN_param(const BIGNUM *g, const BIGNUM *N);
 117 SRP_gN *SRP_get_default_gN(const char *id);
 118
 119 /* server side .... */
 120 BIGNUM *SRP_Calc_server_key(const BIGNUM *A, const BIGNUM *v, const BIGNUM *u,
 121                             const BIGNUM *b, const BIGNUM *N);
 122 BIGNUM *SRP_Calc_B(const BIGNUM *b, const BIGNUM *N, const BIGNUM *g,
 123                    const BIGNUM *v);
 124 int SRP_Verify_A_mod_N(const BIGNUM *A, const BIGNUM *N);
 125 BIGNUM *SRP_Calc_u(const BIGNUM *A, const BIGNUM *B, const BIGNUM *N);
 126
 127 /* client side .... */
 128 BIGNUM *SRP_Calc_x(const BIGNUM *s, const char *user, const char *pass);
 129 BIGNUM *SRP_Calc_A(const BIGNUM *a, const BIGNUM *N, const BIGNUM *g);
 130 BIGNUM *SRP_Calc_client_key(const BIGNUM *N, const BIGNUM *B, const BIGNUM *g,
 131                             const BIGNUM *x, const BIGNUM *a, const BIGNUM *u);
 132 int SRP_Verify_B_mod_N(const BIGNUM *B, const BIGNUM *N);
 133
 134 # define SRP_MINIMAL_N 1024
 135
 136 # ifdef  __cplusplus
 137 }
 138 # endif
 139 # endif
 140
 141 #endif