xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/SSL_set_retry_verify.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: SSL_set_retry_verify.3,v 1.5 2024/09/08 13:08:35 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 "SSL_set_retry_verify 3"
SSL_set_retry_verify 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
SSL_set_retry_verify - indicate that certificate verification should be retried
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& int SSL_set_retry_verify(SSL *ssl); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_set_retry_verify() should be called from the certificate verification callback on a client when the application wants to indicate that the handshake should be suspended and the control should be returned to the application. \fBSSL_want_retry_verify\|(3) will return 1 as a consequence until the handshake is resumed again by the application, retrying the verification step.

Please refer to SSL_CTX_set_cert_verify_callback\|(3) for further details.

NOTES
Header "NOTES" The effect of calling SSL_set_retry_verify() outside of the certificate verification callback on the client side is undefined.
"RETURN VALUES"
Header "RETURN VALUES" SSL_set_retry verify() returns 1 on success, 0 otherwise.
EXAMPLES
Header "EXAMPLES" The following code snippet shows how to obtain the SSL object associated with the X509_STORE_CTX to call the SSL_set_retry_verify() function:

.Vb 2 int idx = SSL_get_ex_data_X509_STORE_CTX_idx(); SSL *ssl; \& /* this should not happen but check anyway */ if (idx < 0 || (ssl = X509_STORE_CTX_get_ex_data(ctx, idx)) == NULL) return 0; \& if (/* we need to retry verification callback */) return SSL_set_retry_verify(ssl); \& /* do normal processing of the verification callback */ .Ve

"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7), SSL_connect\|(3), SSL_CTX_set_cert_verify_callback\|(3), \fBSSL_want_retry_verify\|(3)
HISTORY
Header "HISTORY" \fBSSL_set_retry_verify() was added in OpenSSL 3.0.2 to replace backwards incompatible handling of a negative return value from the verification callback.
COPYRIGHT
Header "COPYRIGHT" Copyright 2022 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>.