doc/crypto/BN_mod_mul_montgomery.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BN_mod_mul_montgomery, BN_MONT_CTX_new, BN_MONT_CTX_init,
   6 BN_MONT_CTX_free, BN_MONT_CTX_set, BN_MONT_CTX_copy,
   7 BN_from_montgomery, BN_to_montgomery - Montgomery multiplication
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/bn.h>
  12
  13  BN_MONT_CTX *BN_MONT_CTX_new(void);
  14  void BN_MONT_CTX_free(BN_MONT_CTX *mont);
  15
  16  int BN_MONT_CTX_set(BN_MONT_CTX *mont, const BIGNUM *m, BN_CTX *ctx);
  17  BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to, BN_MONT_CTX *from);
  18
  19  int BN_mod_mul_montgomery(BIGNUM *r, BIGNUM *a, BIGNUM *b,
  20          BN_MONT_CTX *mont, BN_CTX *ctx);
  21
  22  int BN_from_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
  23          BN_CTX *ctx);
  24
  25  int BN_to_montgomery(BIGNUM *r, BIGNUM *a, BN_MONT_CTX *mont,
  26          BN_CTX *ctx);
  27
  28 =head1 DESCRIPTION
  29
  30 These functions implement Montgomery multiplication. They are used
  31 automatically when L<BN_mod_exp(3)|BN_mod_exp(3)> is called with suitable input,
  32 but they may be useful when several operations are to be performed
  33 using the same modulus.
  34
  35 BN_MONT_CTX_new() allocates and initializes a B<BN_MONT_CTX> structure.
  36
  37 BN_MONT_CTX_set() sets up the I<mont> structure from the modulus I<m>
  38 by precomputing its inverse and a value R.
  39
  40 BN_MONT_CTX_copy() copies the B<BN_MONT_CTX> I<from> to I<to>.
  41
  42 BN_MONT_CTX_free() frees the components of the B<BN_MONT_CTX>, and, if
  43 it was created by BN_MONT_CTX_new(), also the structure itself.
  44
  45 BN_mod_mul_montgomery() computes Mont(I<a>,I<b>):=I<a>*I<b>*R^-1 and places
  46 the result in I<r>.
  47
  48 BN_from_montgomery() performs the Montgomery reduction I<r> = I<a>*R^-1.
  49
  50 BN_to_montgomery() computes Mont(I<a>,R^2), i.e. I<a>*R.
  51 Note that I<a> must be non-negative and smaller than the modulus.
  52
  53 For all functions, I<ctx> is a previously allocated B<BN_CTX> used for
  54 temporary variables.
  55
  56 =head1 RETURN VALUES
  57
  58 BN_MONT_CTX_new() returns the newly allocated B<BN_MONT_CTX>, and NULL
  59 on error.
  60
  61 BN_MONT_CTX_free() has no return value.
  62
  63 For the other functions, 1 is returned for success, 0 on error.
  64 The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
  65
  66 =head1 WARNING
  67
  68 The inputs must be reduced modulo B<m>, otherwise the result will be
  69 outside the expected range.
  70
  71 =head1 REMOVED FUNCTIONALITY
  72
  73  void BN_MONT_CTX_init(BN_MONT_CTX *c);
  74
  75 BN_MONT_CTX_init() is no longer available as of OpenSSL 1.1.0. It was used to
  76 initialize an existing uninitialized B<BN_MONT_CTX>. Typically this would be
  77 done as follows:
  78
  79  BN_MONT_CTX ctx;
  80  BN_MONT_CTX_init(&ctx);
  81
  82 Instead applications should create a BN_MONT_CTX structure using
  83 BN_MONT_CTX_new:
  84
  85  BN_MONT_CTX *ctx;
  86  ctx = BN_MONT_CTX_new();
  87  if(!ctx) /* handle error */
  88  ...
  89  BN_MONT_CTX_free(ctx);
  90
  91 =head1 SEE ALSO
  92
  93 L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<BN_add(3)|BN_add(3)>,
  94 L<BN_CTX_new(3)|BN_CTX_new(3)>
  95
  96 =head1 HISTORY
  97
  98 BN_MONT_CTX_new(), BN_MONT_CTX_free(), BN_MONT_CTX_set(),
  99 BN_mod_mul_montgomery(), BN_from_montgomery() and BN_to_montgomery()
 100 are available in all versions of SSLeay and OpenSSL.
 101
 102 BN_MONT_CTX_init() and BN_MONT_CTX_copy() were added in SSLeay 0.9.1b.
 103 BN_MONT_CTX_init was removed in OpenSSL 1.1.0
 104
 105 =cut