xref: /freebsd/crypto/openssl/doc/man3/CTLOG_new.pod (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6)
1=pod
2
3=head1 NAME
4
5CTLOG_new, CTLOG_new_from_base64, CTLOG_free,
6CTLOG_get0_name, CTLOG_get0_log_id, CTLOG_get0_public_key -
7encapsulates information about a Certificate Transparency log
8
9=head1 SYNOPSIS
10
11 #include <openssl/ct.h>
12
13 CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name);
14 int CTLOG_new_from_base64(CTLOG ** ct_log,
15                           const char *pkey_base64, const char *name);
16 void CTLOG_free(CTLOG *log);
17 const char *CTLOG_get0_name(const CTLOG *log);
18 void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id,
19                        size_t *log_id_len);
20 EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log);
21
22=head1 DESCRIPTION
23
24CTLOG_new() returns a new CTLOG that represents the Certificate Transparency
25(CT) log with the given public key. A name must also be provided that can be
26used to help users identify this log. Ownership of the public key is
27transferred.
28
29CTLOG_new_from_base64() also creates a new CTLOG, but takes the public key in
30base64-encoded DER form and sets the ct_log pointer to point to the new CTLOG.
31The base64 will be decoded and the public key parsed.
32
33Regardless of whether CTLOG_new() or CTLOG_new_from_base64() is used, it is the
34caller's responsibility to pass the CTLOG to CTLOG_free() once it is no longer
35needed. This will delete it and, if created by CTLOG_new(), the EVP_PKEY that
36was passed to it.
37
38CTLOG_get0_name() returns the name of the log, as provided when the CTLOG was
39created. Ownership of the string remains with the CTLOG.
40
41CTLOG_get0_log_id() sets *log_id to point to a string containing that log's
42LogID (see RFC 6962). It sets *log_id_len to the length of that LogID. For a
43v1 CT log, the LogID will be a SHA-256 hash (i.e. 32 bytes long). Ownership of
44the string remains with the CTLOG.
45
46CTLOG_get0_public_key() returns the public key of the CT log. Ownership of the
47EVP_PKEY remains with the CTLOG.
48
49=head1 RETURN VALUES
50
51CTLOG_new() will return NULL if an error occurs.
52
53CTLOG_new_from_base64() will return 1 on success, 0 otherwise.
54
55=head1 SEE ALSO
56
57L<ct(7)>
58
59=head1 HISTORY
60
61These functions were added in OpenSSL 1.1.0.
62
63=head1 COPYRIGHT
64
65Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
66
67Licensed under the OpenSSL license (the "License").  You may not use
68this file except in compliance with the License.  You can obtain a copy
69in the file LICENSE in the source distribution or at
70L<https://www.openssl.org/source/license.html>.
71
72=cut
73