SRP_Calc_B.pod 3.8 KB

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