Home | History | Annotate | Line # | Download | only in man 
 $NetBSD: EVP_PKEY_verify.3,v 1.26 2025/04/16 15:23:15 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

 Standard preamble:
 ========================================================================
..

..


..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
 ========================================================================

 Title "EVP_PKEY_verify 3" 
 EVP_PKEY_verify 3 2025-02-11 3.0.16 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh

 NAME
EVP_PKEY_verify_init, EVP_PKEY_verify_init_ex, EVP_PKEY_verify
\- signature verification using a public key algorithm

 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/evp.h>
\&
 int EVP_PKEY_verify_init(EVP_PKEY_CTX *ctx);
 int EVP_PKEY_verify_init_ex(EVP_PKEY_CTX *ctx, const OSSL_PARAM params[]);
 int EVP_PKEY_verify(EVP_PKEY_CTX *ctx,
  const unsigned char *sig, size_t siglen,
  const unsigned char *tbs, size_t tbslen);
.Ve

 DESCRIPTION
 Header "DESCRIPTION" \fBEVP_PKEY_verify_init() initializes a public key algorithm context ctx for
signing using the algorithm given when the context was created
using EVP_PKEY_CTX_new\|(3) or variants thereof. The algorithm is used to
fetch a EVP_SIGNATURE method implicitly, see "Implicit fetch" in provider\|(7)
for more information about implicit fetches.


\fBEVP_PKEY_verify_init_ex() is the same as EVP_PKEY_verify_init() but additionally
sets the passed parameters params on the context before returning.


The EVP_PKEY_verify() function performs a public key verification operation
using ctx. The signature is specified using the sig and
\fIsiglen parameters. The verified data (i.e. the data believed originally
signed) is specified using the tbs and tbslen parameters.

 NOTES
 Header "NOTES" After the call to EVP_PKEY_verify_init() algorithm specific control
operations can be performed to set any appropriate parameters for the
operation.


The function EVP_PKEY_verify() can be called more than once on the same
context if several operations are performed using the same parameters.

 "RETURN VALUES"
 Header "RETURN VALUES" \fBEVP_PKEY_verify_init() and EVP_PKEY_verify() return 1 if the verification was
successful and 0 if it failed. Unlike other functions the return value 0 from
\fBEVP_PKEY_verify() only indicates that the signature did not verify
successfully (that is tbs did not match the original data or the signature was
of invalid form) it is not an indication of a more serious error.


A negative value indicates an error other that signature verification failure.
In particular a return value of -2 indicates the operation is not supported by
the public key algorithm.

 EXAMPLES
 Header "EXAMPLES" Verify signature using PKCS#1 and SHA256 digest:


.Vb 2
 #include <openssl/evp.h>
 #include <openssl/rsa.h>
\&
 EVP_PKEY_CTX *ctx;
 unsigned char *md, *sig;
 size_t mdlen, siglen;
 EVP_PKEY *verify_key;
\&
 /*
  * NB: assumes verify_key, sig, siglen md and mdlen are already set up
  * and that verify_key is an RSA public key
  */
 ctx = EVP_PKEY_CTX_new(verify_key, NULL /* no engine */);
 if (!ctx)
  /* Error occurred */
 if (EVP_PKEY_verify_init(ctx) <= 0)
  /* Error */
 if (EVP_PKEY_CTX_set_rsa_padding(ctx, RSA_PKCS1_PADDING) <= 0)
  /* Error */
 if (EVP_PKEY_CTX_set_signature_md(ctx, EVP_sha256()) <= 0)
  /* Error */
\&
 /* Perform operation */
 ret = EVP_PKEY_verify(ctx, sig, siglen, md, mdlen);
\&
 /*
  * ret == 1 indicates success, 0 verify failure and < 0 for some
  * other error.
  */
.Ve

 "SEE ALSO"
 Header "SEE ALSO" \fBEVP_PKEY_CTX_new\|(3),
\fBEVP_PKEY_encrypt\|(3),
\fBEVP_PKEY_decrypt\|(3),
\fBEVP_PKEY_sign\|(3),
\fBEVP_PKEY_verify_recover\|(3),
\fBEVP_PKEY_derive\|(3)

 HISTORY
 Header "HISTORY" The EVP_PKEY_verify_init() and EVP_PKEY_verify() functions were added in
OpenSSL 1.0.0.


The EVP_PKEY_verify_init_ex() function was added in OpenSSL 3.0.

 COPYRIGHT
 Header "COPYRIGHT" Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.


Licensed under the Apache License 2.0 (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
<https://www.openssl.org/source/license.html>.