CURLSMBS.OptionProtocolsString as String

Var c as new CURLSMBS
c.OptionProtocolsString = "http,tftp,sftp"

Pass a string that holds a comma-separated list of case insensitive protocol names (URL schemes) to allow in the transfer. This option allows applications to use libcurl built to support a wide range of protocols but still limit specific transfers to only be allowed to use a subset of them. By default, libcurl accepts all protocols it was built with support for. See also OptionReditProtocolsString.

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

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.

CURLVersionMBS class can be used to get a list of all supported protocols in the current libcurl. GetInfoProtocol function is the recommended way to figure out the protocol used in a previous transfer.
(Read and Write property)

CURLSMBS.OptionProxy as String

// setup explicit proxy:

var c as new CURLSMBS
c.OptionProxy = "http://192.168.1.123"
c.OptionNoProxy = "localhost,192.168.0.0/16,.somename.com"

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.

The parameter should be a string holding the host name or dotted IP address. To specify port number in this string, append :[port] to the end of the host name. The proxy string may be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate option ProxyHost.

When you tell the library to use an HTTP proxy, libCURL will transparently convert operations to HTTP even if you specify an FTP URL etc. This may have an impact on what other features of the library you can use, such as CURLOPT_QUOTE and similar FTP specifics that don't work unless you tunnel through the HTTP proxy. Such tunneling is activated with HTTPProxyTunnel.

libCURL respects the environment variables http_proxy, ftp_proxy, all_proxy etc, if any of those is set. The Proxy option does however override any possibly set environment variables.

Starting with 7.14.1, the proxy host string given in environment variables can be specified the exact same way as the proxy can be set with Proxy, include protocol prefix (http://) and embedded user + password.

You can use WinHTTPClientMBS class on Windows or CFProxyMBS on Mac to discover system proxy settings.
(Read and Write property)

Some examples using this property:

• /MacExtras/Sparkle/UpdaterKit/Updater Example

See also PROXY option in CURL manual.

CURLSMBS.OptionProxyAuth as Integer

Pass an integer as parameter, which is set to a bitmask, to tell libCURL what authentication method(s) you want it to use for your proxy authentication. If more than one bit is set, libCURL will first query the site to see what authentication methods it supports and then pick the best one you allow it to use. For some methods, this will induce an extra network round-trip. Set the actual name and password with the ProxyUserPassword option. The bitmask can be constructed by or'ing together the bits listed above for the HTTPAuth option. As of this writing, only Basic, Digest and NTLM work. (Added in 7.10.7)

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 PROXYAUTH option in CURL manual.

CURLSMBS.OptionProxyCAInfo as String

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

Var d as CURLSMBS
// your CURL object

// disable
d.OptionProxySSLVerifyHost = 0
d.OptionProxySSLVerifyPeer = 0

// or better provide root certificates:

Var cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionProxyCAInfo = cacert.NativePath
d.OptionProxySSLVerifyHost = 2
d.OptionProxySSLVerifyPeer = 1

Pass native file path.
This option is used only if CURLSMBS.OptionProxySSLVerifyPeer is true
(Read and Write property)

See also PROXY_CAINFO option in CURL manual.

CURLSMBS.OptionProxyCAInfoBlob as String

This option is for connecting to an HTTPS proxy, not an HTTPS server.
Certificate Authority (CA) bundle in PEM format passed PEM encoded content holding one or more certificates to verify the HTTPS server with.
(Read and Write property)

See also PROXY_CAINFO_BLOB option in CURL manual.

CURLSMBS.OptionProxyCAPath as String

Pass native file path.
This option is used only if CURLSMBS.OptionProxySSLVerifyPeer is true
(Read and Write property)

See also PROXY_CAPATH option in CURL manual.

CURLSMBS.OptionProxyCRLFile as String

Pass native file path.
(Read and Write property)

See also PROXY_CRLFILE option in CURL manual.

CURLSMBS.OptionProxyIssuerCert as String

Pass a string naming a file holding a CA certificate in PEM format. If the option is set, an additional check against the peer certificate is performed to verify the issuer of the the HTTPS proxy is indeed the one associated with the certificate provided by the option. This additional check is useful in multi-level PKI where one needs to enforce that the peer certificate is from a specific branch of the tree.

This option makes sense only when used in combination with the OptionProxySSLVerifyPeer option. Otherwise, the result of the check is not considered as failure.

A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option, which is returned if the setup of the SSL/TLS session has failed due to a mismatch with the issuer of peer certificate (OptionProxySSLVerifyPeer has to be set too for the check to fail).
(Read and Write property)

See also PROXY_ISSUERCERT option in CURL manual.

CURLSMBS.OptionProxyIssuerCertBlob as String

Pass data, which contains binary data of a CA certificate in PEM format. If the option is set, an additional check against the peer certificate is performed to verify the issuer of the the HTTPS proxy is indeed the one associated with the certificate provided by the option. This additional check is useful in multi-level PKI where one needs to enforce that the peer certificate is from a specific branch of the tree.

This option should be used in combination with the OptionProxySSLVerifyPeer option. Otherwise, the result of the check is not considered as failure.

A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option, which is returned if the setup of the SSL/TLS session has failed due to a mismatch with the issuer of peer certificate (OptionProxySSLVerifyPeer has to be set too for the check to fail).

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

See also PROXY_ISSUERCERT_BLOB option in CURL manual.

CURLSMBS.OptionProxyKeyPassword as String

(Read and Write property)

See also PROXY_KEYPASSWD option in CURL manual.

CURLSMBS.OptionProxyPassword as String

The OptionProxyPassword option should be used in conjunction with the OptionProxyUsername option. (Added in 7.19.1)
(Read and Write property)

See also PROXYPASSWORD option in CURL manual.

CURLSMBS.OptionProxyPinnedPublicKey as String

This option is used only if CURLSMBS.OptionProxySSLVerifyPeer is true.
Please path native file path to key file.
(Read and Write property)

See also PROXY_PINNEDPUBLICKEY option in CURL manual.

CURLSMBS.OptionProxyPort as Integer

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.

You can use OptionProxy with port, e.g. "12.34.56.78:8080" or pass port here and proxy without port.
For some users it seems like the option with OptionProxy including port works better.
(Read and Write property)

See also PROXYPORT option in CURL manual.

CURLSMBS.OptionProxyServiceName as String

(Read and Write property)

See also PROXY_SERVICE_NAME option in CURL manual.

CURLSMBS.OptionProxySSLCert as String

(Read and Write property)

See also PROXY_SSLCERT option in CURL manual.

CURLSMBS.OptionProxySSLCertBlob as String

Pass data, which contains the private key for connecting to the HTTPS proxy. Compatible with OpenSSL. The format (like "PEM") must be specified with CURL.SetOptionProxySSLKeyType.
(Read and Write property)

See also PROXY_SSLCERT_BLOB option in CURL manual.

CURLSMBS.OptionProxySSLCertType as String

Value can be "DER", "PEM" or "ENG".
(Read and Write property)

See also PROXY_SSLCERTTYPE option in CURL manual.

CURLSMBS.OptionProxySSLCipherList as String

(Read and Write property)

See also PROXY_SSL_CIPHER_LIST option in CURL manual.

CURLSMBS.OptionProxySSLKey as String

Pass native file path.
(Read and Write property)

See also PROXY_SSLKEY option in CURL manual.

CURLSMBS.OptionProxySSLKeyBlob as String

Pass data, which contains a private key for connecting to the HTTPS proxy. Compatible with OpenSSL. The format (like "PEM") must be specified with OptionProxySSLKeyType.

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

See also PROXY_SSLKEY_BLOB option in CURL manual.

CURLSMBS.OptionProxySSLKeyType as String

Value is DER, PEM or ENG.
(Read and Write property)

See also PROXY_SSLKEYTYPE option in CURL manual.

CURLSMBS.OptionProxySSLOptions as Integer

(Read and Write property)

See also PROXY_SSL_OPTIONS option in CURL manual.

CURLSMBS.OptionProxySSLVerifyHost as Integer

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

Var d as CURLSMBS
// your CURL object

// disable
d.OptionProxySSLVerifyHost = 0
d.OptionProxySSLVerifyPeer = 0

// or better provide root certificates:

Var cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionProxyCAInfo = cacert.NativePath
d.OptionProxySSLVerifyHost = 2
d.OptionProxySSLVerifyPeer = 1

Set if we should verify the Common name from the proxy certificate in ssl handshake, set 1 to check existence, 2 to ensure that it matches the provided hostname.
(Read and Write property)

See also PROXY_SSL_VERIFYHOST option in CURL manual.

CURLSMBS.OptionProxySSLVerifyPeer as Integer

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

Var d as CURLSMBS
// your CURL object

// disable
d.OptionProxySSLVerifyHost = 0
d.OptionProxySSLVerifyPeer = 0

// or better provide root certificates:

Var cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionProxyCAInfo = cacert.NativePath
d.OptionProxySSLVerifyHost = 2
d.OptionProxySSLVerifyPeer = 1

set 1 to verify.
(Read and Write property)

See also PROXY_SSL_VERIFYPEER option in CURL manual.

CURLSMBS.OptionProxySSLVersion as Integer

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)

See also PROXY_SSLVERSION option in CURL manual.

CURLSMBS.OptionProxyTLS13Ciphers as String

The list of cipher suites to use for the TLS 1.3 connection to a proxy. The list must be syntactically correct, it consists of one or more cipher suite strings separated by colons.

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

https://curl.haxx.se/docs/ssl-ciphers.html

The application does not have to keep the string around after setting this option.
(Read and Write property)

See also PROXY_TLS13_CIPHERS option in CURL manual.

CURLSMBS.OptionProxyTLSAuthPassword as String   Deprecated

(Read and Write property)

CURLSMBS.OptionProxyTLSAuthType as String   Deprecated

(Read and Write property)

CURLSMBS.OptionProxyTLSAuthUsername as String   Deprecated

(Read and Write property)

CURLSMBS.OptionProxyTransferMode as Integer

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.

CURLSMBS.OptionProxyType as Integer

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.

CURLSMBS.OptionProxyUsername as String

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.

CURLSMBS.OptionPut as Boolean   Deprecated

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)

CURLSMBS.OptionQuickExit as Integer

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.

CURLSMBS.OptionRandomFile as String   Deprecated

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)

CURLSMBS.OptionRange as String

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.

CURLSMBS.OptionRedirProtocols as Integer   Deprecated

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)

CURLSMBS.OptionReditProtocolsString as String

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

CURLSMBS.OptionReferer as String

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.

CURLSMBS.OptionRequestTarget as String

(Read and Write property)

See also REQUEST_TARGET option in CURL manual.

CURLSMBS.OptionResumeFrom as Int64

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)

Some examples using this property:

• /CURL/FTP/CURLS ftp file upload resume
• /CURL/Upload resume

See also RESUME_FROM option in CURL manual.

CURLSMBS.OptionResumeFromLarge as Int64   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.OptionRTSPClientCSEQ as Integer

(Read and Write property)

See also RTSP_CLIENT_CSEQ option in CURL manual.

CURLSMBS.OptionRTSPRequest as Integer

(Read and Write property)

See also RTSP_REQUEST option in CURL manual.