Platforms to show: All Mac Windows Linux Cross-Platform

Back to CURLMBS class.

Previous items Next items

CURLMBS.OptionProxyTLSAuthUsername as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set a username for authenticated TLS for proxy.

(Read and Write property)

See also PROXY_TLSAUTH_USERNAME option in CURL manual.

CURLMBS.OptionProxyTransferMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If this integer value is set to 1 (one), it tells libCURL to set the transfer mode (binary or ASCII) for FTP transfers done via an HTTP proxy, by appending ;type=a or ;type=i to the URL.

Without this setting, or it being set to 0 (zero, the default), OptionTransferText has no effect when doing FTP via a proxy. Beware that not all proxies support this feature. (Added in 7.18.0)
(Read and Write property)

See also PROXY_TRANSFER_MODE option in CURL manual.

CURLMBS.OptionProxyType as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This option is to set type of the proxy.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

Available options for this are kPROXY_HTTP, kPROXY_SOCKS4 (added in 7.15.2) kPROXY_SOCKS5. The HTTP type is default.
(Read and Write property)

See also PROXYTYPE option in CURL manual.

CURLMBS.OptionProxyUsername as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A string, which should be pointing to the user name to use for the transfer while connecting to Proxy.

In order to specify the password to be used in conjunction with the user name use the OptionProxyPassword option.
(Read and Write property)

See also PROXYUSERNAME option in CURL manual.

CURLMBS.OptionPut as Boolean   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionUpload instead.
A non-zero parameter tells the library to use HTTP PUT to transfer data.

The data should be set with OptionInFileSize.

This option is deprecated and starting with version 7.12.1 you should instead use OptionUpload.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionQuickExit as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 23.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to allow to exit quickly.

Pass a number as a parameter, 1 meaning that when recovering from a timeout, libcurl should skip lengthy cleanups that are intended to avoid all kinds of leaks (threads etc.), as the caller program is about to call exit() anyway. This allows for a swift termination after a DNS timeout for example, by canceling and/or forgetting about a resolver thread, at the expense of a possible (though short-lived) leak of associated resources.
(Read and Write property)

See also QUICK_EXIT option in CURL manual.

CURLMBS.OptionRandomFile as String   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used.
A file name for the random file.

The file will be used to read from to seed the random engine for SSL. The more random the specified file is, the more secure the SSL connection will become.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

Starting with version 18.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.
(Read and Write property)

CURLMBS.OptionRange as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A string which should contain the specified range you want.

It should be in the format "X-Y", where X or Y may be left out. HTTP transfers also support several intervals, separated with commas as in "X-Y,N-M". Using this kind of multiple intervals will cause the HTTP server to send the response document in pieces (using standard MIME separation techniques). Pass a NULL to this option to disable the use of ranges.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also RANGE option in CURL manual.

CURLMBS.OptionRedirProtocols as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionRedirProtocolsString instead.
An integer that holds a bitmask of kProtocol* constants.

If used, this bitmask limits what protocols libCURL may use in a transfer that it follows to in a redirect when OptionFollowLocation is enabled. This allows you to limit specific transfers to only be allowed to use a subset of protocols in redirections. By default libCURL will allow all protocols except for FILE and SCP. This is a difference compared to pre-7.19.4 versions which unconditionally would follow to all protocols supported. (Added in 7.19.4)
(Read and Write property)

CURLMBS.OptionReditProtocolsString as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 22.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The protocols allowed to redirect to.
Example
Var c as new CURLMBS
c.OptionReditProtocolsString = "http,https"

Pass string that holds a comma-separated list of case insensitive protocol names (URL schemes). That list limits what protocols libcurl may use in a transfer that it follows to in a redirect when OptionFollowLocation is enabled. This option allows applications to limit specific transfers to only be allowed to use a subset of protocols in redirections.

Protocols denied by OptionProtocolsString are not overridden by this option.

By default libcurl will allow HTTP, HTTPS, FTP and FTPS on redirects (since 7.65.2). Older versions of libcurl allowed all protocols on redirect except several disabled for security reasons: Since 7.19.4 FILE and SCP are disabled, and since 7.40.0 SMB and SMBS are also disabled.

These are the available protocols:

DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, POP3, POP3S, RTMP, RTMPE, RTMPS, RTMPT, RTMPTE, RTMPTS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP

You can set "ALL" as a short-cut to enable all protocols. Note that by setting all, you may enable protocols that were not supported the day you write this but are introduced in a future libcurl version.

If trying to set a non-existing protocol or if no matching protocol at all is set, it returns error.

Default

HTTP, HTTPS, FTP and FTPS (Added in 7.65.2).

Older versions defaulted to all protocols except FILE, SCP and since 7.40.0 SMB and SMBS.
(Read and Write property)

CURLMBS.OptionReferer as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The referer to pass to the server.

It will be used to set the Referer: header in the http request sent to the remote server. This can be used to fool servers or scripts. You can also set any custom header with OptionHTTPHeader.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also REFERER option in CURL manual.

CURLMBS.OptionRequestTarget as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The request target, instead of extracted from the URL.

(Read and Write property)

See also REQUEST_TARGET option in CURL manual.

CURLMBS.OptionResumeFrom as Int64

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
It contains the offset in number of bytes that you want the transfer to start from.

Set this option to 0 to make the transfer start from the beginning (effectively disabling resume). For FTP, set this option to -1 to make the transfer start from the end of the target file (useful to continue an interrupted upload).

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also RESUME_FROM option in CURL manual.

CURLMBS.OptionResumeFromLarge as Int64   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionResumeFrom instead.
It contains the offset in number of bytes that you want the transfer to start from.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionRTSPClientCSEQ as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Manually initialize the client RTSP CSeq for this handle.

(Read and Write property)

See also RTSP_CLIENT_CSEQ option in CURL manual.

CURLMBS.OptionRTSPRequest as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
RTSP request method (OPTIONS, SETUP, PLAY, etc...).

(Read and Write property)

See also RTSP_REQUEST option in CURL manual.

CURLMBS.OptionRTSPServerCSEQ as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Manually initialize the server RTSP CSeq for this handle.

(Read and Write property)

See also RTSP_SERVER_CSEQ option in CURL manual.

CURLMBS.OptionRTSPSessionID as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The RTSP session identifier.

(Read and Write property)

See also RTSP_SESSION_ID option in CURL manual.

CURLMBS.OptionRTSPStreamURI as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The RTSP stream URI.

(Read and Write property)

See also RTSP_STREAM_URI option in CURL manual.

CURLMBS.OptionRTSPTransport as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The Transport: header to use in RTSP requests.

(Read and Write property)

See also RTSP_TRANSPORT option in CURL manual.

CURLMBS.OptionSASLAuthZID as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 19.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The authorisation identity (identity to act as).

Sets the authorisation identity (identity to act as).
Pass a text as parameter, which should be pointing to the authorisation identity (authzid) for the transfer. Only applicable to the PLAIN SASL authentication mechanism where it is optional.
When not specified only the authentication identity (authcid) as specified by the username will be sent to the server, along with the password. The server will derive a authzid from the authcid when not provided, which it will then uses internally.
When the authzid is specified, the use of which is server dependent, it can be used to access another user's inbox, that the user has been granted access to, or a shared mailbox for example.
(Read and Write property)

See also SASL_AUTHZID option in CURL manual.

CURLMBS.OptionSASLIR as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Enable/disable SASL initial response.

(Read and Write property)

See also SASL_IR option in CURL manual.

CURLMBS.OptionServerResponseTimeout as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 22.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Causes libcurl to set a timeout period (in seconds) on the amount of time that the server is allowed to take in order to send a response message for a command before the session is considered dead.

While libcurl is waiting for a response, this value overrides OptionTimeout. It is recommended that if used in conjunction with OptionTimeout, you set OptionServerResponseTimeout to a value smaller than OptionTimeout.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also SERVER_RESPONSE_TIMEOUT option in CURL manual.

CURLMBS.OptionServiceName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Service Name.

(Read and Write property)

See also SERVICE_NAME option in CURL manual.

CURLMBS.OptionSocks5Auth as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Bitmask of allowed auth methods for connections to SOCKS5 proxies.

(Read and Write property)

See also SOCKS5_AUTH option in CURL manual.

CURLMBS.OptionSocks5GSSAPINEC as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to protect SOCKS5 connection is protected.

Set to true to enable or false to disable. As part of the gssapi negotiation a protection mode is negotiated. The rfc1961 says in section 4.3/4.4 it should be protected, but the NEC reference implementation does not. If enabled, this option allows the unprotected exchange of the protection mode negotiation. (Added in 7.19.4).
(Read and Write property)

See also SOCKS5_GSSAPI_NEC option in CURL manual.

CURLMBS.OptionSocks5GSSAPIService as String   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used.
A string holding the name of the service.

The default service name for a SOCKS5 server is rcmd/server-fqdn. This option allows you to change it. (Added in 7.19.4)
(Read and Write property)

CURLMBS.OptionSSHAuthTypes as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Define the SSH authorization types.
Example
Var c as CURLMBS // your instance

// only do password
c.OptionSSHAuthTypes = c.kSSHAuthKeyboard or c.kSSHAuthPassword

Pass a long set to a bitmask consisting of one or more of CURLSSH_AUTH_PUBLICKEY, CURLSSH_AUTH_PASSWORD, CURLSSH_AUTH_HOST, CURLSSH_AUTH_KEYBOARD. Set CURLSSH_AUTH_ANY to let libCURL pick one. (Added in 7.16.1)

See kSSHAuth* constants.
(Read and Write property)

See also SSH_AUTH_TYPES option in CURL manual.

CURLMBS.OptionSSHCompression as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Enable/disable SSH compression.

(Read and Write property)

See also SSH_COMPRESSION option in CURL manual.

CURLMBS.OptionSSHHostPublicKeyMD5 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A string containing 32 hexadecimal digits with the 128 bit MD5 checksum of the remote host's public key.

libCURL will reject the connection to the host unless the md5sums match. This option is only for SCP and SFTP transfers. (Added in 7.17.1)
(Read and Write property)

See also SSH_HOST_PUBLIC_KEY_MD5 option in CURL manual.

CURLMBS.OptionSSHHostPublicKeySHA256 as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 22.4 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
SHA256 hash of SSH server public key.

Pass a string containing a Base64-encoded SHA256 hash of the remote host's public key. The transfer will fail if the given hash does not match the hash the remote host provides.
(Read and Write property)

See also SSH_HOST_PUBLIC_KEY_SHA256 option in CURL manual.

CURLMBS.OptionSSHKnownhosts as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A string holding the file name of the known_host file to use.

The known_hosts file should use the OpenSSH file format as supported by libssh2. If this file is specified, libCURL will only accept connections with hosts that are known and present in that file, with a matching public key. (Added in 7.19.6)
(Read and Write property)

See also SSH_KNOWNHOSTS option in CURL manual.

CURLMBS.OptionSSHPrivateKeyfile as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Pass a path pointing to a file name for your private key.
Example
Var c As New CURLMBS

c.OptionSSHPrivateKeyfile = "/Users/test/.ssh/id_rsa"
c.OptionSSHPublicKeyfile = "/Users/test/.ssh/id_rsa.pub"
c.OptionUsername = "test"

If not used, libCURL defaults to using ~/.ssh/id_dsa. If the file is password-protected, set the password with OptionSSLKeyPassword. (Added in 7.16.1)

For a SFTP transfer (= file transfer over SSH), you would tell the plugin your public and private keys, so the plugin can login.

Starting with version 18.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.
(Read and Write property)

See also SSH_PRIVATE_KEYFILE option in CURL manual.

CURLMBS.OptionSSHPublicKeyfile as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Pass a path pointing to a file name for your public key.
Example
Var c As New CURLMBS

c.OptionSSHPrivateKeyfile = "/Users/test/.ssh/id_rsa"
c.OptionSSHPublicKeyfile = "/Users/test/.ssh/id_rsa.pub"
c.OptionUsername = "test"

If not used, libCURL defaults to using ~/.ssh/id_dsa.pub. (Added in 7.16.1)

For a SFTP transfer (= file transfer over SSH), you would tell the plugin your public and private keys, so the plugin can login.

Starting with version 18.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.
(Read and Write property)

See also SSH_PUBLIC_KEYFILE option in CURL manual.

CURLMBS.OptionSSLCert as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The string should be the file name of your certificate.

The default format is "PEM" and can be changed with OptionSSLCERTTYPE.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

Starting with version 18.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.
(Read and Write property)

See also SSLCERT option in CURL manual.

CURLMBS.OptionSSLCertBlob as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set SSL client certificate from memory blob.

Pass data, which contains a client certificate. The format must be "P12" on Secure Transport or Schannel. The format must be "P12" or "PEM" on OpenSSL. The string "P12" or "PEM" must be specified with OptionSSLCertType.

This option is an alternative to OptionSSLCert which instead expects a file name as input.
(Read and Write property)

See also SSLCERT_BLOB option in CURL manual.

CURLMBS.OptionSSLCertPassword as String   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionKeyPassword instead.
The certificate password.

(Read and Write property)

CURLMBS.OptionSSLCertType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The string should be the format of your certificate.

Supported formats are "PEM" and "DER". (Added in 7.9.3)

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also SSLCERTTYPE option in CURL manual.

CURLMBS.OptionSSLCipherList as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
A string holding the list of ciphers to use for the SSL connection.
Example
// allow lower secure ciphers
curl.OptionSSLCipherList = "DEFAULT@SECLEVEL=0"

The list must be syntactically correct, it consists of one or more cipher strings separated by colons. Commas or spaces are also acceptable separators but colons are normally used, !, - and + can be used as operators. Valid examples of cipher lists include 'RC4-SHA', 'SHA1+DES', 'TLSv1' and 'DEFAULT'. The default list is normally set when you compile OpenSSL.

You'll find more details about cipher lists on this URL:

http://www.openssl.org/docs/apps/ciphers.html

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also SSL_CIPHER_LIST option in CURL manual.

CURLMBS.OptionSSLEnableALPN as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Enable/disable TLS ALPN extension (http2 over ssl might fail without).

(Read and Write property)

See also SSL_ENABLE_ALPN option in CURL manual.

CURLMBS.OptionSSLEnableNPN as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used.
Enable/disable TLS NPN extension (http2 over ssl might fail without)

(Read and Write property)

CURLMBS.OptionSSLEngine as String   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used.
It will be used as the identifier for the crypto engine you want to use for your private key.

If the crypto device cannot be loaded, kError_SSL_ENGINE_NOTFOUND is returned.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also SSLENGINE option in CURL manual.

CURLMBS.OptionSSLEngineDefault as Integer   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used.
Sets the actual crypto engine as the default for (asymmetric) crypto operations.

If the crypto device cannot be set, kError_SSL_ENGINE_SETFAILED is returned.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also SSLENGINE_DEFAULT option in CURL manual.

CURLMBS.OptionSSLFalseStart as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set if we should enable TLS false start.

(Read and Write property)

See also SSL_FALSESTART option in CURL manual.

CURLMBS.OptionSSLKey as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The string should be the file name of your private key.

The default format is "PEM" and can be changed with OptionSSLKEYTYPE.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.

Starting with version 18.0 the plugin will always use UTF-8 encoding for file path on Linux and macOS. For macOS we also do the unicode character normalization for file names for you.
(Read and Write property)

See also SSLKEY option in CURL manual.

CURLMBS.OptionSSLKeyBlob as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Set private key for client cert from memory blob.

Pass data, which contains a private key. Compatible with OpenSSL. The format (like "PEM") must be specified with OptionSSLKeyType.

This option is an alternative to OptionSSLKey which instead expects a file name as input.
(Read and Write property)

See also SSLKEY_BLOB option in CURL manual.

CURLMBS.OptionSSLKeyPassword as String   Deprecated

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
This item is deprecated and should no longer be used. You can use OptionKeyPassword instead.
The password required to use the OptionSSLKEY private key.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

CURLMBS.OptionSSLKeyType as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The string should be the format of your private key.

Supported formats are "PEM", "DER" and "ENG".

The format "ENG" enables you to load the private key from a crypto engine. In this case OptionSSLKEY is used as an identifier passed to the engine. You have to set the crypto engine with OptionSSLENGINE. "DER" format key file currently does not work because of a bug in OpenSSL.

The Lasterror property is set. 0 for success.
You can set this value and later you can read it, but you cannot read the default value.
(Read and Write property)

See also SSLKEYTYPE option in CURL manual.

CURLMBS.OptionSSLOptions as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Enable/disable specific SSL features with a bitmask.

(Read and Write property)

See also SSL_OPTIONS option in CURL manual.

CURLMBS.OptionSSLSessionIDCache as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Whether to use the SSL session ID cache.

Pass false to disable libCURL's use of SSL session-ID caching. Set this to true to enable it. By default all transfers are done using the cache. Note that while nothing ever should get hurt by attempting to reuse SSL session-IDs, there seem to be broken SSL implementations in the wild that may require you to disable this in order for you to succeed. (Added in 7.16.0)
(Read and Write property)

See also SSL_SESSIONID_CACHE option in CURL manual.

Previous items Next items

The items on this page are in the following plugins: MBS CURL Plugin.


The biggest plugin in space...