diff options
author | Shane Lontis <shane.lontis@oracle.com> | 2020-07-26 17:32:05 +1000 |
---|---|---|
committer | Shane Lontis <shane.lontis@oracle.com> | 2020-08-09 17:34:52 +1000 |
commit | 0ab18e7924727f7b613edc187f3a5074d0ce9bc6 (patch) | |
tree | 15d960fa8fd6adca2f9bf74621fada77098a8be5 /doc/man3/EVP_SignInit.pod | |
parent | 11eef7e766ad76158be8da497fba2bc048b02ca1 (diff) |
Add EVP signature with libctx methods.
-Added EVP_SignFinal_with_libctx() and EVP_VerifyFinal_with_libctx()
-Renamed EVP_DigestSignInit_ex() and EVP_DigestVerifyInit_with_libctx() to
EVP_DigestSignInit_with_libctx() and EVP_DigestVerifyInit_with_libctx()
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/11884)
Diffstat (limited to 'doc/man3/EVP_SignInit.pod')
-rw-r--r-- | doc/man3/EVP_SignInit.pod | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/doc/man3/EVP_SignInit.pod b/doc/man3/EVP_SignInit.pod index 13bba5b507..f6165f0468 100644 --- a/doc/man3/EVP_SignInit.pod +++ b/doc/man3/EVP_SignInit.pod @@ -2,7 +2,8 @@ =head1 NAME -EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate, EVP_SignFinal +EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate, +EVP_SignFinal_with_libctx, EVP_SignFinal - EVP signing functions =head1 SYNOPSIS @@ -11,7 +12,11 @@ EVP_SignInit, EVP_SignInit_ex, EVP_SignUpdate, EVP_SignFinal int EVP_SignInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl); int EVP_SignUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt); - int EVP_SignFinal(EVP_MD_CTX *ctx, unsigned char *sig, unsigned int *s, EVP_PKEY *pkey); + int EVP_SignFinal_with_libctx(EVP_MD_CTX *ctx, unsigned char *md, + unsigned int *s, EVP_PKEY *pkey, + OPENSSL_CTX *libctx, const char *propq); + int EVP_SignFinal(EVP_MD_CTX *ctx, unsigned char *sig, unsigned int *s, + EVP_PKEY *pkey); void EVP_SignInit(EVP_MD_CTX *ctx, const EVP_MD *type); @@ -28,20 +33,25 @@ EVP_SignUpdate() hashes I<cnt> bytes of data at I<d> into the signature context I<ctx>. This function can be called several times on the same I<ctx> to include additional data. -EVP_SignFinal() signs the data in I<ctx> using the private key I<pkey> and -places the signature in I<sig>. I<sig> must be at least C<EVP_PKEY_size(pkey)> -bytes in size. I<s> is an OUT parameter, and not used as an IN parameter. +EVP_SignFinal_with_libctx() signs the data in I<ctx> using the private key +I<pkey> and places the signature in I<sig>. The library context I<libctx> and +property query I<propq> are used when creating a context to use with the key +I<pkey>. I<sig> must be at least C<EVP_PKEY_size(pkey)> bytes in size. I<s> is +an OUT parameter, and not used as an IN parameter. The number of bytes of data written (i.e. the length of the signature) will be written to the integer at I<s>, at most C<EVP_PKEY_size(pkey)> bytes will be written. +EVP_SignFinal() is similar to EVP_SignFinal_with_libctx() but uses default +values of NULL for the library context I<libctx> and the property query I<propq>. + EVP_SignInit() initializes a signing context I<ctx> to use the default implementation of digest I<type>. =head1 RETURN VALUES -EVP_SignInit_ex(), EVP_SignUpdate() and EVP_SignFinal() return 1 -for success and 0 for failure. +EVP_SignInit_ex(), EVP_SignUpdate(), EVP_SignFinal_with_libctx() and +EVP_SignFinal() return 1 for success and 0 for failure. The error codes can be obtained by L<ERR_get_error(3)>. @@ -87,6 +97,10 @@ L<evp(7)>, L<HMAC(3)>, L<MD2(3)>, L<MD5(3)>, L<MDC2(3)>, L<RIPEMD160(3)>, L<SHA1(3)>, L<openssl-dgst(1)> +=head1 HISTORY + +The function EVP_SignFinal_with_libctx() was added in OpenSSL 3.0. + =head1 COPYRIGHT Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved. |