Documentation for new SSL functions
[openssl.git] / doc / ssl / SSL_get0_peer_scts.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get0_peer_scts - get SCTs received
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s);
12
13 =head1 DESCRIPTION
14
15 SSL_get0_peer_scts() returns the signed certificate timestamps (SCTs) that have
16 been received. If this is the first time that this function has been called for
17 a given B<SSL> instance, it will examine the TLS extensions, OCSP response and
18 the peer's certificate for SCTs. Future calls will return the same SCTs.
19
20 =head1 RESTRICTIONS
21
22 If no Certificate Transparency validation callback has been set (using
23 B<SSL_CTX_set_ct_validation_callback> or B<SSL_set_ct_validation_callback>),
24 this function is not guarantee to return all of the SCTs that the peer is
25 capable of sending.
26
27 =head1 RETURN VALUES
28
29 SSL_get0_peer_scts() returns a list of SCTs found, or NULL if an error occurs.
30
31 =head1 SEE ALSO
32
33 L<ssl(3)>,
34 L<SSL_CTX_set_ct_validation_callback(3)>
35
36 =cut