diff options
| author | Rob Percival <robpercival@google.com> | 2016-08-23 16:17:09 +0100 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-08-24 13:58:19 +0100 |
| commit | 0e74d7ca440a3a7fbb7ddd6873e2f494d87f8d0e (patch) | |
| tree | c22c3b3418ca753aaccd7ed228f42ae18404c303 /doc | |
| parent | a8d5d13a5f19cde07c189f5ca05d673a4e0c7653 (diff) | |
Document the i2o and o2i SCT functions
Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/crypto/o2i_SCT_LIST.pod | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/crypto/o2i_SCT_LIST.pod b/doc/crypto/o2i_SCT_LIST.pod index d0d1a8d522..99e4d3daf3 100644 --- a/doc/crypto/o2i_SCT_LIST.pod +++ b/doc/crypto/o2i_SCT_LIST.pod @@ -18,20 +18,32 @@ decode and encode Signed Certificate Timestamp lists in TLS wire format =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. +The SCT_signature functions are less similar. They still convert to and from +TLS wire format, but they require that an SCT is provided that the signature is +either taken from or inserted into. =head1 NOTES - +If an error occurs during a call to o2i_SCT_signature, the SCT may have its +signature NID updated but not the signature value. =head1 RETURN VALUES - +All of the functions have return values consist with those stated for +L<d2i_SCT_LIST>, except o2i_SCT_signature. The o2i_SCT_signature function +returns the number of bytes that were parsed, or a negative integer if an error +occurs. =head1 SEE ALSO L<ct(3)>, -L(d2i_SCT_LIST(3)> +L(d2i_SCT_LIST(3)>, +L(i2d_SCT_LIST(3)> =head1 HISTORY |