projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| dd8dec69 UM |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| e1b78bc6 RL |
5 | BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment |
| 6 | operations | |
| dd8dec69 UM |
7 | |
| 8 | =head1 SYNOPSIS | |
| 9 | ||
| 10 | #include <openssl/bn.h> | |
| 11 | ||
| 98186eb4 | 12 | void BN_zero(BIGNUM *a); |
| dd8dec69 UM |
13 | int BN_one(BIGNUM *a); |
| 14 | ||
| 98499135 | 15 | const BIGNUM *BN_value_one(void); |
| dd8dec69 UM |
16 | |
| 17 | int BN_set_word(BIGNUM *a, unsigned long w); | |
| 18 | unsigned long BN_get_word(BIGNUM *a); | |
| 19 | ||
| 98186eb4 VD |
20 | Deprecated: |
| 21 | ||
| 22 | #if OPENSSL_API_COMPAT < 0x00908000L | |
| 23 | int BN_zero(BIGNUM *a); | |
| 24 | #endif | |
| 25 | ||
| dd8dec69 UM |
26 | =head1 DESCRIPTION |
| 27 | ||
| 28 | BN_zero(), BN_one() and BN_set_word() set B<a> to the values 0, 1 and | |
| 29 | B<w> respectively. BN_zero() and BN_one() are macros. | |
| 30 | ||
| 31 | BN_value_one() returns a B<BIGNUM> constant of value 1. This constant | |
| 32 | is useful for use in comparisons and assignment. | |
| 33 | ||
| 34 | BN_get_word() returns B<a>, if it can be represented as an unsigned | |
| 35 | long. | |
| 36 | ||
| 37 | =head1 RETURN VALUES | |
| 38 | ||
| 39 | BN_get_word() returns the value B<a>, and 0xffffffffL if B<a> cannot | |
| 40 | be represented as an unsigned long. | |
| 41 | ||
| 98186eb4 VD |
42 | BN_one(), BN_set_word() and the deprecated version of BN_zero() |
| 43 | return 1 on success, 0 otherwise. | |
| dd8dec69 | 44 | BN_value_one() returns the constant. |
| 6c1f368d | 45 | The preferred version of BN_zero() never fails and returns no value. |
| dd8dec69 UM |
46 | |
| 47 | =head1 BUGS | |
| 48 | ||
| 49 | Someone might change the constant. | |
| 50 | ||
| 15701211 DSH |
51 | If a B<BIGNUM> is equal to 0xffffffffL it can be represented as an |
| 52 | unsigned long but this value is also returned on error. | |
| 53 | ||
| dd8dec69 UM |
54 | =head1 SEE ALSO |
| 55 | ||
| 9e183d22 | 56 | L<BN_bn2bin(3)> |
| dd8dec69 | 57 | |
| e2f92610 RS |
58 | =head1 COPYRIGHT |
| 59 | ||
| 9e183d22 | 60 | Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. |
| e2f92610 RS |
61 | |
| 62 | Licensed under the OpenSSL license (the "License"). You may not use | |
| 63 | this file except in compliance with the License. You can obtain a copy | |
| 64 | in the file LICENSE in the source distribution or at | |
| 65 | L<https://www.openssl.org/source/license.html>. | |
| 66 | ||
| 67 | =cut |