mirror of
https://github.com/openssl/openssl.git
synced 2024-12-27 06:21:43 +08:00
9b86974e0c
L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
58 lines
1.5 KiB
Plaintext
58 lines
1.5 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
BN_num_bits, BN_num_bytes, BN_num_bits_word - get BIGNUM size
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/bn.h>
|
|
|
|
int BN_num_bytes(const BIGNUM *a);
|
|
|
|
int BN_num_bits(const BIGNUM *a);
|
|
|
|
int BN_num_bits_word(BN_ULONG w);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
BN_num_bytes() returns the size of a B<BIGNUM> in bytes.
|
|
|
|
BN_num_bits_word() returns the number of significant bits in a word.
|
|
If we take 0x00000432 as an example, it returns 11, not 16, not 32.
|
|
Basically, except for a zero, it returns I<floor(log2(w))+1>.
|
|
|
|
BN_num_bits() returns the number of significant bits in a B<BIGNUM>,
|
|
following the same principle as BN_num_bits_word().
|
|
|
|
BN_num_bytes() is a macro.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
The size.
|
|
|
|
=head1 NOTES
|
|
|
|
Some have tried using BN_num_bits() on individual numbers in RSA keys,
|
|
DH keys and DSA keys, and found that they don't always come up with
|
|
the number of bits they expected (something like 512, 1024, 2048,
|
|
...). This is because generating a number with some specific number
|
|
of bits doesn't always set the highest bits, thereby making the number
|
|
of I<significant> bits a little lower. If you want to know the "key
|
|
size" of such a key, either use functions like RSA_size(), DH_size()
|
|
and DSA_size(), or use BN_num_bytes() and multiply with 8 (although
|
|
there's no real guarantee that will match the "key size", just a lot
|
|
more probability).
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<bn(3)>, L<DH_size(3)>, L<DSA_size(3)>,
|
|
L<RSA_size(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
BN_num_bytes(), BN_num_bits() and BN_num_bits_word() are available in
|
|
all versions of SSLeay and OpenSSL.
|
|
|
|
=cut
|