Debian Codegraph @

upstream/debian-unstable/man3/BN_num_bytes.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BN_NUM_BYTES 3SSL"
58 .TH BN_NUM_BYTES 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BN_num_bits, BN_num_bytes, BN_num_bits_word \- get BIGNUM size
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bn.h>
69 \&
70 \& int BN_num_bytes(const BIGNUM *a);
71 \&
72 \& int BN_num_bits(const BIGNUM *a);
73 \&
74 \& int BN_num_bits_word(BN_ULONG w);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBBN_num_bytes()\fR returns the size of a \fBBIGNUM\fR in bytes.
79 .PP
80 \&\fBBN_num_bits_word()\fR returns the number of significant bits in a word.
81 If we take 0x00000432 as an example, it returns 11, not 16, not 32.
82 Basically, except for a zero, it returns \fIfloor(log2(w))+1\fR.
83 .PP
84 \&\fBBN_num_bits()\fR returns the number of significant bits in a \fBBIGNUM\fR,
85 following the same principle as \fBBN_num_bits_word()\fR.
86 .PP
87 \&\fBBN_num_bytes()\fR is a macro.
88 .SH "RETURN VALUES"
89 .IX Header "RETURN VALUES"
90 The size.
91 .SH NOTES
92 .IX Header "NOTES"
93 Some have tried using \fBBN_num_bits()\fR on individual numbers in RSA keys,
94 DH keys and DSA keys, and found that they don't always come up with
95 the number of bits they expected (something like 512, 1024, 2048,
96 \&...). This is because generating a number with some specific number
97 of bits doesn't always set the highest bits, thereby making the number
98 of \fIsignificant\fR bits a little lower. If you want to know the "key
99 size" of such a key, either use functions like \fBRSA_size()\fR, \fBDH_size()\fR
100 and \fBDSA_size()\fR, or use \fBBN_num_bytes()\fR and multiply with 8 (although
101 there's no real guarantee that will match the "key size", just a lot
102 more probability).
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 \&\fBDH_size\fR\|(3), \fBDSA_size\fR\|(3),
106 \&\fBRSA_size\fR\|(3)
107 .SH COPYRIGHT
108 .IX Header "COPYRIGHT"
109 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
110 .PP
111 Licensed under the Apache License 2.0 (the "License"). You may not use
112 this file except in compliance with the License. You can obtain a copy
113 in the file LICENSE in the source distribution or at
114 <https://www.openssl.org/source/license.html>.