Update documentation
[openssl.git] / doc / man3 / o2i_SCT_LIST.pod
1 =pod
2
3 =head1 NAME
4
5 o2i_SCT_LIST, i2o_SCT_LIST, o2i_SCT, i2o_SCT -
6 decode and encode Signed Certificate Timestamp lists in TLS wire format
7
8 =head1 SYNOPSIS
9
10  #include <openssl/ct.h>
11
12  STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp, size_t len);
13  int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
14  SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len);
15  int i2o_SCT(const SCT *sct, unsigned char **out);
16
17 =head1 DESCRIPTION
18
19 The SCT_LIST and SCT functions are very similar to the i2d and d2i family of
20 functions, except that they convert to and from TLS wire format, as described in
21 RFC 6962. See L<d2i_SCT_LIST> for more information about how the parameters are
22 treated and the return values.
23
24 =head1 RETURN VALUES
25
26 All of the functions have return values consistent with those stated for
27 L<d2i_SCT_LIST> and L<i2d_SCT_LIST>.
28
29 =head1 SEE ALSO
30
31 L<ct(7)>,
32 L<d2i_SCT_LIST(3)>,
33 L<i2d_SCT_LIST(3)>
34
35 =head1 HISTORY
36
37 These functions were added in OpenSSL 1.1.0.
38
39 =head1 COPYRIGHT
40
41 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
42
43 Licensed under the OpenSSL license (the "License").  You may not use
44 this file except in compliance with the License.  You can obtain a copy
45 in the file LICENSE in the source distribution or at
46 L<https://www.openssl.org/source/license.html>.
47
48 =cut