diff options
author | Paul Yang <yang.yang@baishancloud.com> | 2017-08-09 11:25:19 -0400 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2017-08-09 11:25:19 -0400 |
commit | 6a2da30347d81245dd4841833808621d189a9629 (patch) | |
tree | a03d91c83003e420f2d8c8019632e94edcca2703 /doc/man3/BN_security_bits.pod | |
parent | 7a301f08bc102179248173426ea15e00fa9211d1 (diff) |
Add XXX_security_bits documentation
This is a 'code health' commit to respond to this round of code health
Tuesday...
Reviewed-by: Andy Polyakov <appro@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4099)
Diffstat (limited to 'doc/man3/BN_security_bits.pod')
-rw-r--r-- | doc/man3/BN_security_bits.pod | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/man3/BN_security_bits.pod b/doc/man3/BN_security_bits.pod new file mode 100644 index 0000000000..1aed85a71a --- /dev/null +++ b/doc/man3/BN_security_bits.pod @@ -0,0 +1,51 @@ +=pod + +=head1 NAME + +BN_security_bits - returns bits of security based on given numbers + +=head1 SYNOPSIS + + #include <openssl/bn.h> + + int BN_security_bits(int L, int N); + +=head1 DESCRIPTION + +BN_security_bits() returns the number of bits of security provided by a +specific algorithm and a particular key size. The bits of security is +defined in NIST SP800-57. Currently, BN_security_bits() support two types +of asymmetric algorithms: the FFC (Finite Field Cryptography) and IFC +(Integer Factorization Cryptography). For FFC, e.g., DSA and DH, both +parameters B<L> and B<N> are used to decide the bits of security, where +B<L> is the size of the public key and B<N> is the size of the private +key. For IFC, e.g., RSA, only B<L> is used and it's commonly considered +to be the key size (modulus). + +=head1 RETURN VALUES + +Number of security bits. + +=head1 NOTES + +ECC (Elliptic Curve Cryptography) is not covered by the BN_security_bits() +function. The symmetric algorithms are not covered neither. + +=head1 HISTORY + +BN_security_bits() was added in OpenSSL 1.1.0. + +=head1 SEE ALSO + +L<DH_security_bits(3)>, L<DSA_security_bits(3)>, L<RSA_security_bits(3)> + +=head1 COPYRIGHT + +Copyright 2017 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 |