Imported Upstream version 7.53.1
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_SSLCERTTYPE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_SSLCERTTYPE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SSLCERTTYPE \- specify type of the client SSL certificate
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERTTYPE, char *type);
30 .SH DESCRIPTION
31 Pass a pointer to a zero terminated string as parameter. The string should be
32 the format of your certificate. Supported formats are "PEM" and "DER", except
33 with Secure Transport. OpenSSL (versions 0.9.3 and later) and Secure Transport
34 (on iOS 5 or later, or OS X 10.7 or later) also support "P12" for
35 PKCS#12-encoded files.
36
37 The application does not have to keep the string around after setting this
38 option.
39 .SH DEFAULT
40 "PEM"
41 .SH PROTOCOLS
42 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
43 .SH EXAMPLE
44 TODO
45 .SH AVAILABILITY
46 If built TLS enabled. Added in 7.9.3
47 .SH RETURN VALUE
48 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
49 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
50 .SH "SEE ALSO"
51 .BR CURLOPT_SSLCERT "(3), " CURLOPT_SSLKEY "(3), "