2000-01-23 22:06:24 +00:00
|
|
|
=pod
|
|
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
|
|
2000-09-14 21:23:28 +00:00
|
|
|
BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment
|
|
|
|
|
operations
|
2000-01-23 22:06:24 +00:00
|
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
|
|
|
|
|
#include <openssl/bn.h>
|
|
|
|
|
|
2016-01-05 04:00:33 +00:00
|
|
|
void BN_zero(BIGNUM *a);
|
2000-01-23 22:06:24 +00:00
|
|
|
int BN_one(BIGNUM *a);
|
|
|
|
|
|
2001-03-08 13:58:09 +00:00
|
|
|
const BIGNUM *BN_value_one(void);
|
2000-01-23 22:06:24 +00:00
|
|
|
|
|
|
|
|
int BN_set_word(BIGNUM *a, unsigned long w);
|
|
|
|
|
unsigned long BN_get_word(BIGNUM *a);
|
|
|
|
|
|
2016-01-05 04:00:33 +00:00
|
|
|
Deprecated:
|
|
|
|
|
|
|
|
|
|
#if OPENSSL_API_COMPAT < 0x00908000L
|
|
|
|
|
int BN_zero(BIGNUM *a);
|
|
|
|
|
#endif
|
|
|
|
|
|
2000-01-23 22:06:24 +00:00
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
|
|
|
|
|
BN_zero(), BN_one() and BN_set_word() set B<a> to the values 0, 1 and
|
|
|
|
|
B<w> respectively. BN_zero() and BN_one() are macros.
|
|
|
|
|
|
|
|
|
|
BN_value_one() returns a B<BIGNUM> constant of value 1. This constant
|
|
|
|
|
is useful for use in comparisons and assignment.
|
|
|
|
|
|
|
|
|
|
BN_get_word() returns B<a>, if it can be represented as an unsigned
|
|
|
|
|
long.
|
|
|
|
|
|
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
|
|
|
|
|
|
BN_get_word() returns the value B<a>, and 0xffffffffL if B<a> cannot
|
|
|
|
|
be represented as an unsigned long.
|
|
|
|
|
|
2016-01-05 04:00:33 +00:00
|
|
|
BN_one(), BN_set_word() and the deprecated version of BN_zero()
|
|
|
|
|
return 1 on success, 0 otherwise.
|
2000-01-23 22:06:24 +00:00
|
|
|
BN_value_one() returns the constant.
|
2016-07-31 12:11:12 +00:00
|
|
|
The preferred version of BN_zero() never fails and returns no value.
|
2000-01-23 22:06:24 +00:00
|
|
|
|
|
|
|
|
=head1 BUGS
|
|
|
|
|
|
|
|
|
|
Someone might change the constant.
|
|
|
|
|
|
2000-01-30 01:39:40 +00:00
|
|
|
If a B<BIGNUM> is equal to 0xffffffffL it can be represented as an
|
|
|
|
|
unsigned long but this value is also returned on error.
|
|
|
|
|
|
2000-01-23 22:06:24 +00:00
|
|
|
=head1 SEE ALSO
|
|
|
|
|
|
2016-11-11 08:33:09 +00:00
|
|
|
L<bn(7)>, L<BN_bn2bin(3)>
|
2000-01-23 22:06:24 +00:00
|
|
|
|
2016-05-18 15:44:05 +00:00
|
|
|
=head1 COPYRIGHT
|
|
|
|
|
|
|
|
|
|
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
|
|
|
|
|
|
Licensed under the OpenSSL license (the "License"). You may not use
|
|
|
|
|
this file except in compliance with the License. You can obtain a copy
|
|
|
|
|
in the file LICENSE in the source distribution or at
|
|
|
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
|
|
|
|
|
|
=cut
|
