106 lines
3.8 KiB
HTML
106 lines
3.8 KiB
HTML
|
<?xml version="1.0" ?>
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<title>CTLOG_new</title>
|
||
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||
|
|
<link rev="made" href="mailto:root@localhost" />
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body style="background-color: white">
|
||
|
|
|
||
|
|
|
||
|
|
<!-- INDEX BEGIN -->
|
||
|
|
<div name="index">
|
||
|
|
<p><a name="__index__"></a></p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
|
||
|
|
<li><a href="#name">NAME</a></li>
|
||
|
|
<li><a href="#synopsis">SYNOPSIS</a></li>
|
||
|
|
<li><a href="#description">DESCRIPTION</a></li>
|
||
|
|
<li><a href="#return_values">RETURN VALUES</a></li>
|
||
|
|
<li><a href="#see_also">SEE ALSO</a></li>
|
||
|
|
<li><a href="#history">HISTORY</a></li>
|
||
|
|
<li><a href="#copyright">COPYRIGHT</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<hr name="index" />
|
||
|
|
</div>
|
||
|
|
<!-- INDEX END -->
|
||
|
|
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="name">NAME</a></h1>
|
||
|
|
<p>CTLOG_new, CTLOG_new_from_base64, CTLOG_free,
|
||
|
|
CTLOG_get0_name, CTLOG_get0_log_id, CTLOG_get0_public_key -
|
||
|
|
encapsulates information about a Certificate Transparency log</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="synopsis">SYNOPSIS</a></h1>
|
||
|
|
<pre>
|
||
|
|
#include <openssl/ct.h></pre>
|
||
|
|
<pre>
|
||
|
|
CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name);
|
||
|
|
int CTLOG_new_from_base64(CTLOG ** ct_log,
|
||
|
|
const char *pkey_base64, const char *name);
|
||
|
|
void CTLOG_free(CTLOG *log);
|
||
|
|
const char *CTLOG_get0_name(const CTLOG *log);
|
||
|
|
void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id,
|
||
|
|
size_t *log_id_len);
|
||
|
|
EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log);</pre>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="description">DESCRIPTION</a></h1>
|
||
|
|
<p><code>CTLOG_new()</code> returns a new CTLOG that represents the Certificate Transparency
|
||
|
|
(CT) log with the given public key. A name must also be provided that can be
|
||
|
|
used to help users identify this log. Ownership of the public key is
|
||
|
|
transferred.</p>
|
||
|
|
<p>CTLOG_new_from_base64() also creates a new CTLOG, but takes the public key in
|
||
|
|
base64-encoded DER form and sets the ct_log pointer to point to the new CTLOG.
|
||
|
|
The base64 will be decoded and the public key parsed.</p>
|
||
|
|
<p>Regardless of whether <code>CTLOG_new()</code> or CTLOG_new_from_base64() is used, it is the
|
||
|
|
caller's responsibility to pass the CTLOG to <code>CTLOG_free()</code> once it is no longer
|
||
|
|
needed. This will delete it and, if created by <code>CTLOG_new()</code>, the EVP_PKEY that
|
||
|
|
was passed to it.</p>
|
||
|
|
<p>CTLOG_get0_name() returns the name of the log, as provided when the CTLOG was
|
||
|
|
created. Ownership of the string remains with the CTLOG.</p>
|
||
|
|
<p>CTLOG_get0_log_id() sets *log_id to point to a string containing that log's
|
||
|
|
LogID (see <a href="http://www.ietf.org/rfc/rfc6962.txt" class="rfc">RFC 6962</a>). It sets *log_id_len to the length of that LogID. For a
|
||
|
|
v1 CT log, the LogID will be a SHA-256 hash (i.e. 32 bytes long). Ownership of
|
||
|
|
the string remains with the CTLOG.</p>
|
||
|
|
<p>CTLOG_get0_public_key() returns the public key of the CT log. Ownership of the
|
||
|
|
EVP_PKEY remains with the CTLOG.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="return_values">RETURN VALUES</a></h1>
|
||
|
|
<p><code>CTLOG_new()</code> will return NULL if an error occurs.</p>
|
||
|
|
<p>CTLOG_new_from_base64() will return 1 on success, 0 otherwise.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="see_also">SEE ALSO</a></h1>
|
||
|
|
<p><em>ct(7)</em></p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="history">HISTORY</a></h1>
|
||
|
|
<p>These functions were added in OpenSSL 1.1.0.</p>
|
||
|
|
<p>
|
||
|
|
</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a name="copyright">COPYRIGHT</a></h1>
|
||
|
|
<p>Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.</p>
|
||
|
|
<p>Licensed under the Apache License 2.0 (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
|
||
|
|
<a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
|
||
|
|
</html>
|