openssl/doc/man3/o2i_SCT_LIST.pod
Beat Bolli e9b7724687 doc/man3: reformat the function prototypes in the synopses
I tried hard to keep the lines at 80 characters or less, but in a few
cases I had to punt and just indented the subsequent lines by 4 spaces.

A few well-placed typedefs for callback functions would really help, but
these would be part of the API, so that's probably for later.

I also took the liberty of inserting empty lines in overlong blocks to
provide some visual space.

Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/1956)
2017-06-08 11:54:16 +01:00

49 lines
1.3 KiB
Text

=pod
=head1 NAME
o2i_SCT_LIST, i2o_SCT_LIST, o2i_SCT, i2o_SCT -
decode and encode Signed Certificate Timestamp lists in TLS wire format
=head1 SYNOPSIS
#include <openssl/ct.h>
STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
size_t len);
int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len);
int i2o_SCT(const SCT *sct, unsigned char **out);
=head1 DESCRIPTION
The SCT_LIST and SCT functions are very similar to the i2d and d2i family of
functions, except that they convert to and from TLS wire format, as described in
RFC 6962. See L<d2i_SCT_LIST> for more information about how the parameters are
treated and the return values.
=head1 RETURN VALUES
All of the functions have return values consistent with those stated for
L<d2i_SCT_LIST> and L<i2d_SCT_LIST>.
=head1 SEE ALSO
L<ct(7)>,
L<d2i_SCT_LIST(3)>,
L<i2d_SCT_LIST(3)>
=head1 HISTORY
These functions were added in OpenSSL 1.1.0.
=head1 COPYRIGHT
Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (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
L<https://www.openssl.org/source/license.html>.
=cut