CURLSMBS.OptionRTSPTransport as String

(Read and Write property)

See also RTSP_TRANSPORT option in CURL manual.

CURLSMBS.OptionSASLAuthZID as String

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.

CURLSMBS.OptionSASLIR as Integer

(Read and Write property)

See also SASL_IR option in CURL manual.

CURLSMBS.OptionServerResponseTimeout as Integer

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.

CURLSMBS.OptionServiceName as String

(Read and Write property)

See also SERVICE_NAME option in CURL manual.

CURLSMBS.OptionSocks5Auth as Integer

(Read and Write property)

See also SOCKS5_AUTH option in CURL manual.

CURLSMBS.OptionSocks5GSSAPINEC as Boolean

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.

CURLSMBS.OptionSocks5GSSAPIService as String   Deprecated

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)

CURLSMBS.OptionSSHAuthTypes as Integer

Var c as CURLSMBS // 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)

Some examples using this property:

• /CURL/FTP/CURLS ftp file upload direct
• /CURL/SFTP/CURLS sftp batch download
• /CURL/SFTP/CURLS sftp batch upload
• /CURL/SFTP/CURLS SFTP Client

See also SSH_AUTH_TYPES option in CURL manual.

CURLSMBS.OptionSSHCompression as Boolean

(Read and Write property)

See also SSH_COMPRESSION option in CURL manual.

CURLSMBS.OptionSSHHostPublicKeyMD5 as String

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.

CURLSMBS.OptionSSHHostPublicKeySHA256 as String

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.

CURLSMBS.OptionSSHKnownhosts as String

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.

CURLSMBS.OptionSSHPrivateKeyfile as String

Var c As New CURLSMBS

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.

CURLSMBS.OptionSSHPublicKeyfile as String

Var c As New CURLSMBS

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.

CURLSMBS.OptionSSLCert as String

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)

Some examples using this property:

• /CURL/Send Email/older examples/CURLS send email with SSL

See also SSLCERT option in CURL manual.

CURLSMBS.OptionSSLCertBlob as String

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.

CURLSMBS.OptionSSLCertPassword as String   Deprecated

(Read and Write property)

CURLSMBS.OptionSSLCertType as String

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.

CURLSMBS.OptionSSLCipherList as String

// 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.

CURLSMBS.OptionSSLEnableALPN as Integer

(Read and Write property)

See also SSL_ENABLE_ALPN option in CURL manual.

CURLSMBS.OptionSSLEnableNPN as Integer   Deprecated

(Read and Write property)

CURLSMBS.OptionSSLEngine as String   Deprecated

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.

CURLSMBS.OptionSSLEngineDefault as Integer   Deprecated

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.

CURLSMBS.OptionSSLFalseStart as Integer   Deprecated

(Read and Write property)

CURLSMBS.OptionSSLKey as String

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.

CURLSMBS.OptionSSLKeyBlob as String

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.

CURLSMBS.OptionSSLKeyPassword as String   Deprecated

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)

CURLSMBS.OptionSSLKeyType as String

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.

CURLSMBS.OptionSSLOptions as Integer

(Read and Write property)

See also SSL_OPTIONS option in CURL manual.

CURLSMBS.OptionSSLSessionIDCache as Boolean

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)

Some examples using this property:

• /CURL/Send Email/older examples/CURLS send email with SSL

See also SSL_SESSIONID_CACHE option in CURL manual.

CURLSMBS.OptionSSLSignatureAlgorithms as String

Specify colon-delimited list of signature scheme names.
e.g. "DSA+SHA256:rsa_pss_pss_sha256"
(Read and Write property)

See also SSL_SIGNATURE_ALGORITHMS option in CURL manual.

CURLSMBS.OptionSSLVerifyHost as Integer

// if you use SSL, maybe put in a certificate or disable verification?

Var d as CURLSMBS
// your CURL object

// disable
d.OptionSSLVerifyHost = 0
d.OptionSSLVerifyPeer = 0

// or better provide root certificates:

Var cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionCAInfo = cacert.NativePath
d.OptionSSLVerifyHost = 2
d.OptionSSLVerifyPeer = 1

When negotiating an SSL connection, the server sends a certificate indicating its identity.

When OptionSSLVerifyHost is 2, that certificate must indicate that the server is the server to which you meant to connect, or the connection fails.

CURL considers the server the intended one when the Common Name field or a Subject Alternate Name field in the certificate matches the host name in the URL to which you told CURL to connect.

When the value is 1, the certificate must contain a Common Name field, but it doesn't matter what name it says. (This is not ordinarily a useful setting).

When the value is 0, the connection succeeds regardless of the names in the certificate.

The default, since 7.10, is 2.

The checking this option controls is of the identity that the server claims. The server could be lying. To control lying, see OptionSSLVerifyPeer.

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.

When you don't set the options for certificate path or load system certificates, the MBS Plugin will disable the verify step to let the transfer run.
(Read and Write property)

Some examples using this property:

• /CURL/CURLS LDAP Query
• /CURL/CURLS simple download compressed
• /CURL/CURLS SSL verification/CURLS SSL verification
• /CURL/CURLS text download
• /CURL/CURLS text download web 2.0
• /CURL/FTP/CURLS ftp download to desktop
• /CURL/FTP/CURLS ftp download to desktop with thread
• /CURL/Send Email/MassEmailer
• /CURL/Send Email/older examples/CURLS send email
• /CURL/Send Email/older examples/CURLS send email with images

See also SSL_VERIFYHOST option in CURL manual.

CURLSMBS.OptionSSLVerifyPeer as Integer

// if you use SSL, maybe put in a certificate or disable verification?

Var d as CURLSMBS
// your CURL object

// disable
d.OptionSSLVerifyHost = 0
d.OptionSSLVerifyPeer = 0

// or better provide root certificates:

Var cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionCAInfo = cacert.NativePath
d.OptionSSLVerifyHost = 2
d.OptionSSLVerifyPeer = 1

This option determines whether CURL verifies the authenticity of the peer's certificate. A value of 1 means CURL verifies; zero means it doesn't. The default is nonzero, but before 7.10, it was zero.

When negotiating an SSL connection, the server sends a certificate indicating its identity. CURL verifies whether the certificate is authentic, i.e. that you can trust that the server is who the certificate says it is. This trust is based on a chain of digital signatures, rooted in certification authority (CA) certificates you supply. As of 7.10, CURL installs a default bundle of CA certificates and you can specify alternate certificates with the OptionCAINFO option or the OptionCAPATH option.

When OptionSSLVerifyPeer is nonzero, and the verification fails to prove that the certificate is authentic, the connection fails. When the option is zero, the connection succeeds regardless.

Authenticating the certificate is not by itself very useful. You typically want to ensure that the server, as authentically identified by its certificate, is the server you mean to be talking to. Use OptionSSLVerifyHost to control that.

When you don't set the options for certificate path or load system certificates, the MBS Plugin will disable the verify step to let the transfer run.
(Read and Write property)

Some examples using this property:

• /CURL/CURLS LDAP Query
• /CURL/CURLS picture download
• /CURL/CURLS pop3 email delete
• /CURL/CURLS SSL verification/CURLS SSL verification
• /CURL/FTP/CURLS ftp directory listing with CURLFileInfoMBS
• /CURL/FTP/CURLS ftp download to desktop
• /CURL/Send Email/MassEmailer
• /CURL/Send Email/older examples/CURLS send email with images
• /CURL/Send Email/older examples/CURLS send email with SSL
• /CURL/SFTP/CURLS SFTP Client

See also SSL_VERIFYPEER option in CURL manual.

CURLSMBS.OptionSSLVerifyStatus as Integer

(Read and Write property)

See also SSL_VERIFYSTATUS option in CURL manual.

CURLSMBS.OptionSSLVersion as Integer

Var c as CURLSMBS
c.OptionUseSSL = c.kFTPSSL_ALL
c.OptionSSLVersion = c.kSSLVersionTLSv12

The SSL and TLS versions have typically developed from the most insecure version to be more and more secure in this order through history: SSL v2, SSLv3, TLS v1.0, TLS v1.1, TLS v1.2 and the most recent TLS v1.3.

Use one of the available defines for this purpose. The available options are:

Default	0	The default acceptable version range. The minimum acceptable version is by default TLS v1.0 since 7.39.0 (unless the TLS library has a stricter rule).
TLSv1	1	TLS v1.0 or later
SSLv2	2	SSL v2 (but not SSLv3)
SSLv3	3	SSL v3 (but not SSLv2)
TLSv1.0	4	TLS v1.0 or later (Added in 7.34.0)
TLSv1.1	5	TLS v1.1 or later (Added in 7.34.0)
TLSv1.2	6	TLS v1.2 or later (Added in 7.34.0)
TLSv1.3	7	TLS v1.3 or later (Added in 7.52.0)

See also kSSLVersion* constants.

The maximum TLS version can be set by using one of the CURL_SSLVERSION_MAX_ macros below. It is also possible to OR one of the CURL_SSLVERSION_ macros with one of the CURL_SSLVERSION_MAX_ macros.

Default	&h10000	The flag defines the maximum supported TLS version by libcurl, or the default value from the SSL library is used. libcurl will use a sensible default maximum, which was TLS v1.2 up to before 7.61.0 and is TLS v1.3 since then - assuming the TLS library support it. (Added in 7.54.0)
Max TLSv1.0	&h40000	The flag defines maximum supported TLS version as TLS v1.0. (Added in 7.54.0)
Max TLSv1.1	&h50000	The flag defines maximum supported TLS version as TLS v1.1. (Added in 7.54.0)
Max TLSv1.2	&h60000	The flag defines maximum supported TLS version as TLS v1.2. (Added in 7.54.0)
Max TLSv1.3	&h70000	The flag defines maximum supported TLS version as TLS v1.3. (Added in 7.54.0)

Please note that MBS Plugin does not yet support TLS v1.3 now, but may in future.
(Read and Write property)

Some examples using this property:

• /CURL/Receive Email/CURLS email client
• /CURL/Send Email/MassEmailer
• /CURL/Send Email/older examples/CURLS send email with SSL
• /CURL/WebServices/Stripe WebService

See also SSLVERSION option in CURL manual.

CURLSMBS.OptionStreamDepends as CURLSMBS

(Read and Write property)

See also STREAM_DEPENDS option in CURL manual.

CURLSMBS.OptionStreamDependsE as CURLSMBS

(Read and Write property)

See also STREAM_DEPENDS_E option in CURL manual.

CURLSMBS.OptionStreamWeight as Integer

Default is 16.
(Read and Write property)

See also STREAM_WEIGHT option in CURL manual.

CURLSMBS.OptionSuppressConnectHeaders as Boolean

(Read and Write property)

See also SUPPRESS_CONNECT_HEADERS option in CURL manual.

CURLSMBS.OptionTCPFastOpen as Integer

(Read and Write property)

See also TCP_FASTOPEN option in CURL manual.

CURLSMBS.OptionTCPKeepAlive as Boolean

The delay and frequency of these probes can be controlled by the OptionTCPKeepIdle and OptionTCPKeepInterval options, provided the operating system supports them. Set to false (default behavior) to disable keepalive probes (Added in 7.25.0).
(Read and Write property)

Some examples using this property:

• /CURL/MQTT

See also TCP_KEEPALIVE option in CURL manual.

CURLSMBS.OptionTCPKeepCount as Integer

Sets the number of probes to send before dropping the connection. Not all operating systems support this option. (Added in curl 8.9.0)

The maximum value this option accepts is INT_MAX or whatever your system allows. Any larger value is capped to this amount.

Default is 9.
(Read and Write property)

CURLSMBS.OptionTCPKeepIdle as Integer

Not all operating systems support this option. (Added in 7.25.0)
(Read and Write property)

See also TCP_KEEPIDLE option in CURL manual.

CURLSMBS.OptionTCPKeepInterval as Integer

Not all operating systems support this option. (Added in 7.25.0)
(Read and Write property)

See also TCP_KEEPINTVL option in CURL manual.