Platforms to show: All Mac Windows Linux Cross-Platform

Previous items Next items

CURLSMBS.OptionSSHCompression as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable/disable SSH compression.
Notes: (Read and Write property)

See also SSH_COMPRESSION option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSHHostPublicKeyMD5 as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A string containing 32 hexadecimal digits with the 128 bit MD5 checksum of the remote host's public key.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSHKnownhosts as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 10.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A string holding the file name of the known_host file to use.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSHPrivateKeyfile as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Pass a path pointing to a file name for your private key.
Example:
Dim c As New CURLSMBS

c.OptionSSHPrivateKeyfile = "/Users/test/.ssh/id_rsa"
c.OptionSSHPublicKeyfile = "/Users/test/.ssh/id_rsa.pub"
c.OptionUsername = "test"
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSHPublicKeyfile as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Pass a path pointing to a file name for your public key.
Example:
Dim c As New CURLSMBS

c.OptionSSHPrivateKeyfile = "/Users/test/.ssh/id_rsa"
c.OptionSSHPublicKeyfile = "/Users/test/.ssh/id_rsa.pub"
c.OptionUsername = "test"
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLCert as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The string should be the file name of your certificate.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLCertBlob as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set SSL client certificate from memory blob.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLCertPassword as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 11.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The certificate password.
This item is deprecated and should no longer be used. You can use OptionKeyPassword instead.
Notes: (Read and Write property)

Feedback, Comments & Corrections

CURLSMBS.OptionSSLCertType as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The string should be the format of your certificate.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLCipherList as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: A string holding the list of ciphers to use for the SSL connection.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLEnableALPN as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable/disable TLS ALPN extension (http2 over ssl might fail without).
Notes: (Read and Write property)

See also SSL_ENABLE_ALPN option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLEnableNPN as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable/disable TLS NPN extension (http2 over ssl might fail without)
Notes: (Read and Write property)

See also SSL_ENABLE_NPN option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLEngine as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: It will be used as the identifier for the crypto engine you want to use for your private key.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLEngineDefault as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Sets the actual crypto engine as the default for (asymmetric) crypto operations.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLFalseStart as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set if we should enable TLS false start.
Notes: (Read and Write property)

See also SSL_FALSESTART option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLKey as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The string should be the file name of your private key.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLKeyBlob as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 20.3 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set private key for client cert from memory blob.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLKeyPassword as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The password required to use the OptionSSLKEY private key.
This item is deprecated and should no longer be used. You can use OptionKeyPassword instead.
Notes:
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)

Feedback, Comments & Corrections

CURLSMBS.OptionSSLKeyType as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: The string should be the format of your private key.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLOptions as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Enable/disable specific SSL features with a bitmask.
Notes: (Read and Write property)

See also SSL_OPTIONS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLSessionIDCache as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Whether to use the SSL session ID cache.
Notes:
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.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVerifyHost as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: This option determines whether libCURL verifies that the server cert is for the server it is known as.
Example:
// if you use SSL, maybe put in a certificate or disable verification?

dim d as CURLSMBS
// your CURL object

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

// or better provide root certificates:

Dim cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionCAInfo = cacert.NativePath
d.OptionSSLVerifyHost = 2
d.OptionSSLVerifyPeer = 1
Notes:
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)

See also SSL_VERIFYHOST option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVerifyPeer as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Configure whether this CURL instance will verify the SSL peer certificate.
Example:
// if you use SSL, maybe put in a certificate or disable verification?

dim d as CURLSMBS
// your CURL object

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

// or better provide root certificates:

Dim cacert As FolderItem = GetFolderItem("cacert.pem")
d.OptionCAInfo = cacert.NativePath
d.OptionSSLVerifyHost = 2
d.OptionSSLVerifyPeer = 1
Notes:
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)

See also SSL_VERIFYPEER option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVerifyStatus as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set if we should verify the certificate status.
Notes: (Read and Write property)

See also SSL_VERIFYSTATUS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSSLVersion as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 9.8 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: What version of SSL/TLS to attempt to use.
Example:
dim c as CURLSMBS
c.OptionUseSSL = c.kFTPSSL_ALL
c.OptionSSLVersion = c.kSSLVersionTLSv12
Notes:
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:

Default0The 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).
TLSv11TLS v1.0 or later
SSLv22SSL v2 (but not SSLv3)
SSLv33SSL v3 (but not SSLv2)
TLSv1.04TLS v1.0 or later (Added in 7.34.0)
TLSv1.15TLS v1.1 or later (Added in 7.34.0)
TLSv1.26TLS v1.2 or later (Added in 7.34.0)
TLSv1.37TLS 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&h10000The 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&h40000The flag defines maximum supported TLS version as TLS v1.0. (Added in 7.54.0)
Max TLSv1.1&h50000The flag defines maximum supported TLS version as TLS v1.1. (Added in 7.54.0)
Max TLSv1.2&h60000The flag defines maximum supported TLS version as TLS v1.2. (Added in 7.54.0)
Max TLSv1.3&h70000The 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 SSLVERSION option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionStreamDepends as CURLSMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set stream dependency on another CURL handle.
Notes: (Read and Write property)

See also STREAM_DEPENDS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionStreamDependsE as CURLSMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set E-xclusive stream dependency on another CURL handle.
Notes: (Read and Write property)

See also STREAM_DEPENDS_E option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionStreamWeight as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set stream weight, 1 - 256.
Notes:
Default is 16.
(Read and Write property)

See also STREAM_WEIGHT option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionSuppressConnectHeaders as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Suppress proxy CONNECT response headers from user callbacks.
Notes: (Read and Write property)

See also SUPPRESS_CONNECT_HEADERS option in CURL manual.

Feedback, Comments & Corrections

CURLSMBS.OptionTCPFastOpen as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property CURL MBS CURL Plugin 18.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Function: Set TCP Fast Open.
Notes: (Read and Write property)

See also TCP_FASTOPEN option in CURL manual.

Feedback, Comments & Corrections

Previous items Next items

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

The biggest plugin in space...




Links
MBS FileMaker Plugins

Start Chat