Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 11.1   11.2   11.3   11.4   11.5   12.0   12.1   12.2   12.3   12.4    Statistic    FMM    Blog  

CURL.SetOptionKeyPassword

Sets the password for the SSL or SSH private key.

Component Version macOS Windows Linux Server iOS SDK
CURL 2.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "CURL.SetOptionKeyPassword"; curl; Value { ; Encoding } )   More

(old name: CURL.SetOptionSSLCertPassword)

(old name: CURL.SetOptionSSLKeyPassword)

Parameters

Parameter Description Example Flags
curl The CURL session handle. $curl
Value The password text. "hello"
Encoding The text encoding for text parameter.
Default is UTF-8.
Possible encoding names: ANSI, ISO-8859-1, Latin1, Mac, Native, UTF-8, DOS, Hex, Base64 or Windows. More listed in the FAQ.
"UTF8" Optional

Result

Returns "OK" on success.

Description

Sets the password for the SSL or SSH private key.
Pass a string as parameter. It will be used as the password required to use the CURL.SetOptionSSLKey private key. You never needed a pass phrase to load a certificate but you need one to load your private key.

See also KEYPASSWD option in CURL manual.

Examples

Set a client SSL certificate:

Set Variable [$r; Value:MBS("CURL.SetOptionSSLCert"; $curl; "/some/certfile.pem")]
Set Variable [$r; Value:MBS("CURL.SetOptionSSLCertType"; $curl; "PEM")]
Set Variable [$r; Value:MBS("CURL.SetOptionKeyPassword"; $curl; "secret")]

See also

Blog Entries

Created 18th August 2014, last changed 18th April 2016


CURL.SetOptionKeepSendingOnError - CURL.SetOptionLocalPort

Feedback: Report problem or ask question.


Start Chat