Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CURLOPT_KEYPASSWD(3)	   curl_easy_setopt options	  CURLOPT_KEYPASSWD(3)

NAME
       CURLOPT_KEYPASSWD - set passphrase to private key

SYNOPSIS
       #include	<curl/curl.h>

       CURLcode	curl_easy_setopt(CURL *handle, CURLOPT_KEYPASSWD, char *pwd);

DESCRIPTION
       Pass  a	pointer	 to  a zero terminated string as parameter. It will be
       used as the password required to	 use  the  CURLOPT_SSLKEY(3)  or  CUR-
       LOPT_SSH_PRIVATE_KEYFILE(3)  private  key.   You	 never	needed	a pass
       phrase to load a	certificate but	you need one to	load your private key.

       The application does not	have to	keep the string	around	after  setting
       this option.

DEFAULT
       NULL

PROTOCOLS
       All TLS based protocols:	HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl)	{
	 curl_easy_setopt(curl,	CURLOPT_URL, "http://example.com/foo.bin");
	 curl_easy_setopt(curl,	CURLOPT_SSLCERT, "client.pem");
	 curl_easy_setopt(curl,	CURLOPT_SSLKEY,	"key.pem");
	 curl_easy_setopt(curl,	CURLOPT_KEYPASSWD, "superman");
	 ret = curl_easy_perform(curl);
	 curl_easy_cleanup(curl);
       }

AVAILABILITY
       This  option  was  known	 as CURLOPT_SSLKEYPASSWD up to 7.16.4 and CUR-
       LOPT_SSLCERTPASSWD up to	7.9.2.

RETURN VALUE
       Returns CURLE_OK	 if  TLS  enabled,  CURLE_UNKNOWN_OPTION  if  not,  or
       CURLE_OUT_OF_MEMORY if there was	insufficient heap space.

SEE ALSO
       CURLOPT_SSLKEY(3), CURLOPT_SSH_PRIVATE_KEYFILE(3),

libcurl	7.54.1			 May 31, 2017		  CURLOPT_KEYPASSWD(3)

NAME | SYNOPSIS | DESCRIPTION | DEFAULT | PROTOCOLS | EXAMPLE | AVAILABILITY | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CURLOPT_KEYPASSWD&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help