doc/man3/SRP_Calc_B.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SRP_Calc_server_key,
   6 SRP_Calc_A,
   7 SRP_Calc_B_ex,
   8 SRP_Calc_B,
   9 SRP_Calc_u_ex,
  10 SRP_Calc_u,
  11 SRP_Calc_x_ex,
  12 SRP_Calc_x,
  13 SRP_Calc_client_key_ex,
  14 SRP_Calc_client_key
  15 - SRP authentication primitives
  16
  17 =head1 SYNOPSIS
  18
  19  #include <openssl/srp.h>
  20
  21  /* server side .... */
  22  BIGNUM *SRP_Calc_server_key(const BIGNUM *A, const BIGNUM *v, const BIGNUM *u,
  23                              const BIGNUM *b, const BIGNUM *N);
  24  BIGNUM *SRP_Calc_B_ex(const BIGNUM *b, const BIGNUM *N, const BIGNUM *g,
  25                        const BIGNUM *v, OPENSSL_CTX *libctx, const char *propq);
  26  BIGNUM *SRP_Calc_B(const BIGNUM *b, const BIGNUM *N, const BIGNUM *g,
  27                    const BIGNUM *v);
  28
  29  BIGNUM *SRP_Calc_u_ex(const BIGNUM *A, const BIGNUM *B, const BIGNUM *N,
  30                        OPENSSL_CTX *libctx, const char *propq);
  31  BIGNUM *SRP_Calc_u(const BIGNUM *A, const BIGNUM *B, const BIGNUM *N);
  32
  33  /* client side .... */
  34  BIGNUM *SRP_Calc_client_key_ex(const BIGNUM *N, const BIGNUM *B, const BIGNUM *g,
  35                              const BIGNUM *x, const BIGNUM *a, const BIGNUM *u,
  36                              OPENSSL_CTX *libctx, const char *propq);
  37  BIGNUM *SRP_Calc_client_key(const BIGNUM *N, const BIGNUM *B, const BIGNUM *g,
  38                              const BIGNUM *x, const BIGNUM *a, const BIGNUM *u);
  39  BIGNUM *SRP_Calc_x_ex(const BIGNUM *s, const char *user, const char *pass,
  40                        OPENSSL_CTX *libctx, const char *propq);
  41  BIGNUM *SRP_Calc_x(const BIGNUM *s, const char *user, const char *pass);
  42  BIGNUM *SRP_Calc_A(const BIGNUM *a, const BIGNUM *N, const BIGNUM *g);
  43
  44 =head1 DESCRIPTION
  45
  46 The SRP functions described on this page are used to calculate various
  47 parameters and keys used by SRP as defined in RFC2945. The server key and I<B>
  48 and I<u> parameters are used on the server side and are calculated via
  49 SRP_Calc_server_key(), SRP_Calc_B_ex(), SRP_Calc_B(), SRP_Calc_u_ex() and
  50 SRP_Calc_u(). The client key and B<x> and B<A> parameters are used on the
  51 client side and are calculated via the functions SRP_Calc_client_key_ex(),
  52 SRP_Calc_client_key(), SRP_Calc_x_ex(), SRP_Calc_x() and SRP_Calc_A(). See
  53 RFC2945 for a detailed description of their usage and the meaning of the various
  54 BIGNUM parameters to these functions.
  55
  56 Most of these functions come in two forms. Those that take a I<libctx> and
  57 I<propq> parameter, and those that don't. Any cryptogrpahic functions that
  58 are fetched and used during the calculation use the provided I<libctx> and
  59 I<propq>. See L<provider(7)/Fetching algorithms> for more details. The variants
  60 that do not take a I<libctx> and I<propq> parameter use the default library
  61 context and property query string. The SRP_Calc_server_key() and SRP_Calc_A()
  62 functions do not have a form that takes I<libctx> or I<propq> parameters because
  63 they do not need to fetch any cryptographic algorithms.
  64
  65 =head1 RETURN VALUES
  66
  67 All these functions return the calculated key or parameter, or NULL on error.
  68
  69 =head1 SEE ALSO
  70
  71 L<openssl-srp(1)>,
  72 L<SRP_VBASE_new(3)>,
  73 L<SRP_user_pwd_new(3)>
  74
  75 =head1 HISTORY
  76
  77 These functions were added in OpenSSL 1.0.1.
  78
  79 =head1 COPYRIGHT
  80
  81 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  82
  83 Licensed under the Apache License 2.0 (the "License").  You may not use
  84 this file except in compliance with the License.  You can obtain a copy
  85 in the file LICENSE in the source distribution or at
  86 L<https://www.openssl.org/source/license.html>.
  87
  88 =cut