lib/libcrypto/man/BN_mod_inverse.3

   1 .\"     $OpenBSD: BN_mod_inverse.3,v 1.6 2017/01/30 01:29:31 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Ulf Moeller <ulf@openssl.org>.
   5 .\" Copyright (c) 2000 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: January 30 2017 $
  52 .Dt BN_MOD_INVERSE 3
  53 .Os
  54 .Sh NAME
  55 .Nm BN_mod_inverse
  56 .Nd compute inverse modulo n
  57 .Sh SYNOPSIS
  58 .In openssl/bn.h
  59 .Ft BIGNUM *
  60 .Fo BN_mod_inverse
  61 .Fa "BIGNUM *r"
  62 .Fa "BIGNUM *a"
  63 .Fa "const BIGNUM *n"
  64 .Fa "BN_CTX *ctx"
  65 .Fc
  66 .Sh DESCRIPTION
  67 .Fn BN_mod_inverse
  68 computes the inverse of
  69 .Fa a
  70 modulo
  71 .Fa n
  72 and places the result in
  73 .Fa r
  74 .Pq Li (a*r)%n==1 .
  75 If
  76 .Fa r
  77 is
  78 .Dv NULL ,
  79 a new
  80 .Vt BIGNUM
  81 is created.
  82 .Pp
  83 .Fa ctx
  84 is a previously allocated
  85 .Vt BN_CTX
  86 used for temporary variables.
  87 .Fa r
  88 may be the same
  89 .Vt BIGNUM
  90 as
  91 .Fa a
  92 or
  93 .Fa n .
  94 .Sh RETURN VALUES
  95 .Fn BN_mod_inverse
  96 returns the
  97 .Vt BIGNUM
  98 containing the inverse, or
  99 .Dv NULL
 100 on error.
 101 The error codes can be obtained by
 102 .Xr ERR_get_error 3 .
 103 .Sh SEE ALSO
 104 .Xr BN_add 3 ,
 105 .Xr BN_new 3 ,
 106 .Xr BN_set_flags 3
 107 .Sh HISTORY
 108 .Fn BN_mod_inverse
 109 is available in all versions of SSLeay and OpenSSL.