Debian Codegraph @

upstream/debian-unstable/man3/BN_security_bits.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_SECURITY_BITS 3SSL"
58 .TH BN_SECURITY_BITS 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_security_bits \- returns bits of security based on given numbers
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/bn.h>
69 \&
70 \& int BN_security_bits(int L, int N);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBBN_security_bits()\fR returns the number of bits of security provided by a
75 specific algorithm and a particular key size. The bits of security is
76 defined in NIST SP800\-57. Currently, \fBBN_security_bits()\fR support two types
77 of asymmetric algorithms: the FFC (Finite Field Cryptography) and IFC
78 (Integer Factorization Cryptography). For FFC, e.g., DSA and DH, both
79 parameters \fBL\fR and \fBN\fR are used to decide the bits of security, where
80 \&\fBL\fR is the size of the public key and \fBN\fR is the size of the private
81 key. For IFC, e.g., RSA, only \fBL\fR is used and it's commonly considered
82 to be the key size (modulus).
83 .SH "RETURN VALUES"
84 .IX Header "RETURN VALUES"
85 Number of security bits.
86 .SH NOTES
87 .IX Header "NOTES"
88 ECC (Elliptic Curve Cryptography) is not covered by the \fBBN_security_bits()\fR
89 function. The symmetric algorithms are not covered neither.
90 .SH "SEE ALSO"
91 .IX Header "SEE ALSO"
92 \&\fBDH_security_bits\fR\|(3), \fBDSA_security_bits\fR\|(3), \fBRSA_security_bits\fR\|(3)
93 .SH HISTORY
94 .IX Header "HISTORY"
95 The \fBBN_security_bits()\fR function was added in OpenSSL 1.1.0.
96 .SH COPYRIGHT
97 .IX Header "COPYRIGHT"
98 Copyright 2017\-2019 The OpenSSL Project Authors. All Rights Reserved.
99 .PP
100 Licensed under the Apache License 2.0 (the "License"). You may not use
101 this file except in compliance with the License. You can obtain a copy
102 in the file LICENSE in the source distribution or at
103 <https://www.openssl.org/source/license.html>.