generic-library/curl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CURLOPT_PINNEDPUBLICKEY.3: added details

Browse Source
This commit is contained in:
Daniel Stenberg
2014-10-30 14:56:53 +01:00
parent b274dedf1b
commit 006556713e
1 changed files with 22 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/libcurl/opts/CURLOPT_PINNEDPUBLICKEY.3
View File

@@ -32,20 +32,34 @@ Pass a pointer to a zero terminated string as parameter. The string should be
the file name of your pinned public key. The format expected is "DER". the file name of your pinned public key. The format expected is "DER".
When negotiating a TLS or SSL connection, the server sends a certificate When negotiating a TLS or SSL connection, the server sends a certificate
indicating its identity. A public key is extracted from this certificate indicating its identity. A public key is extracted from this certificate and
and if it does not exactly match the public key provided to this option, if it does not exactly match the public key provided to this option, curl will
curl will abort the connection before sending or receiving any data. abort the connection before sending or receiving any data.
This is currently only implemented in the OpenSSL backend, with more backends
expected to follow shortly.
.SH DEFAULT .SH DEFAULT
NULL NULL
.SH PROTOCOLS .SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
.SH EXAMPLE .SH EXAMPLE
TODO .nf
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
curl_easy_setopt(curl, CURLOPT_PINNEDPUBLICKEY, "/etc/publickey.der");
/* Perform the request */
curl_easy_perform(curl);
}
.fi
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. If built TLS enabled. This is currently only implemented in the OpenSSL,
GnuTLS and GSKit backends.
Added in libcurl 7.39.0
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO"
.BR CURLOPT_SSL_VERIFYPEER "(3), "
.BR CURLOPT_SSL_VERIFYHOST "(3), "
.BR CURLOPT_CAINFO "(3), "
.BR CURLOPT_CAPATH "(3), "