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/EVP_SignInit.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/EVP_SignInit.pod')
-rw-r--r-- | doc/man3/EVP_SignInit.pod | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/man3/EVP_SignInit.pod b/doc/man3/EVP_SignInit.pod index c40da1ea3a..987526c4e4 100644 --- a/doc/man3/EVP_SignInit.pod +++ b/doc/man3/EVP_SignInit.pod @@ -3,7 +3,8 @@ =head1 NAME EVP_PKEY_size, -EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate, EVP_SignFinal - EVP signing +EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate, EVP_SignFinal, +EVP_PKEY_security_bits - EVP signing functions =head1 SYNOPSIS @@ -17,6 +18,7 @@ functions void EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type); int EVP_PKEY_size(EVP_PKEY *pkey); + int EVP_PKEY_security_bits(const EVP_PKEY *pkey); =head1 DESCRIPTION @@ -44,6 +46,9 @@ implementation of digest B<type>. EVP_PKEY_size() returns the maximum size of a signature in bytes. The actual signature returned by EVP_SignFinal() may be smaller. +EVP_PKEY_security_bits() returns the number of security bits of the given B<pkey>, +bits of security is defined in NIST SP800-57. + =head1 RETURN VALUES EVP_SignInit_ex(), EVP_SignUpdate() and EVP_SignFinal() return 1 @@ -53,6 +58,8 @@ EVP_PKEY_size() returns the maximum size of a signature in bytes. The error codes can be obtained by L<ERR_get_error(3)>. +EVP_PKEY_security_bits() returns the number of security bits. + =head1 NOTES The B<EVP> interface to digital signatures should almost always be used in |