diff options
Diffstat (limited to 'src/lib/libcrypto/man/BN_mod_inverse.3')
| -rw-r--r-- | src/lib/libcrypto/man/BN_mod_inverse.3 | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/BN_mod_inverse.3 b/src/lib/libcrypto/man/BN_mod_inverse.3 new file mode 100644 index 0000000000..db63269fb8 --- /dev/null +++ b/src/lib/libcrypto/man/BN_mod_inverse.3 | |||
| @@ -0,0 +1,59 @@ | |||
| 1 | .Dd $Mdocdate: February 23 2015 $ | ||
| 2 | .Dt BN_MOD_INVERSE 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm BN_mod_inverse | ||
| 6 | .Nd compute inverse modulo n | ||
| 7 | .Sh SYNOPSIS | ||
| 8 | .In openssl/bn.h | ||
| 9 | .Ft BIGNUM * | ||
| 10 | .Fo BN_mod_inverse | ||
| 11 | .Fa "BIGNUM *r" | ||
| 12 | .Fa "BIGNUM *a" | ||
| 13 | .Fa "const BIGNUM *n" | ||
| 14 | .Fa "BN_CTX *ctx" | ||
| 15 | .Fc | ||
| 16 | .Sh DESCRIPTION | ||
| 17 | .Fn BN_mod_inverse | ||
| 18 | computes the inverse of | ||
| 19 | .Fa a | ||
| 20 | modulo | ||
| 21 | .Fa n | ||
| 22 | add places the result in | ||
| 23 | .Fa r | ||
| 24 | .Pq Li (a*r)%n==1 . | ||
| 25 | If | ||
| 26 | .Fa r | ||
| 27 | is | ||
| 28 | .Dv NULL , | ||
| 29 | a new | ||
| 30 | .Vt BIGNUM | ||
| 31 | is created. | ||
| 32 | .Pp | ||
| 33 | .Fa ctx | ||
| 34 | is a previously allocated | ||
| 35 | .Vt BN_CTX | ||
| 36 | used for temporary variables. | ||
| 37 | .Fa r | ||
| 38 | may be the same | ||
| 39 | .Vt BIGNUM | ||
| 40 | as | ||
| 41 | .Fa a | ||
| 42 | or | ||
| 43 | .Fa n . | ||
| 44 | .Sh RETURN VALUES | ||
| 45 | .Fn BN_mod_inverse | ||
| 46 | returns the | ||
| 47 | .Vt BIGNUM | ||
| 48 | containing the inverse, or | ||
| 49 | .Dv NULL | ||
| 50 | on error. | ||
| 51 | The error codes can be obtained by | ||
| 52 | .Xr ERR_get_error 3 . | ||
| 53 | .Sh SEE ALSO | ||
| 54 | .Xr bn 3 , | ||
| 55 | .Xr BN_add 3 , | ||
| 56 | .Xr ERR_get_error 3 | ||
| 57 | .Sh HISTORY | ||
| 58 | .Fn BN_mod_inverse | ||
| 59 | is available in all versions of SSLeay and OpenSSL. | ||