52 lines
2.2 KiB
Groff
52 lines
2.2 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_PINNEDPUBLICKEY 3 "27 Aug 2014" "libcurl 7.38.0" "curl_easy_setopt options"
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_PINNEDPUBLICKEY \- set pinned public key
|
||
|
|
.SH SYNOPSIS
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PINNEDPUBLICKEY, char *pinnedpubkey);
|
||
|
|
.SH DESCRIPTION
|
||
|
|
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".
|
||
|
|
|
||
|
|
When negotiating a TLS or SSL connection, the server sends a certificate
|
||
|
|
indicating its identity. A public key is extracted from this certificate
|
||
|
|
and if it does not exactly match the public key provided to this option,
|
||
|
|
curl will 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
|
||
|
|
NULL
|
||
|
|
.SH PROTOCOLS
|
||
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
|
||
|
|
.SH EXAMPLE
|
||
|
|
TODO
|
||
|
|
.SH AVAILABILITY
|
||
|
|
If built TLS enabled.
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
|
||
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|