en

• Language ISO code

This configures the language for the web file transfer client user interface.

The available languages are: * en - English

When left empty, it will default to English.

ui-gen-1

• ui-gen-1

• ui-gen-2

This defined the UI variant to be used for the web file manager.

The latest version is ui-gen-2.

To use the legacy UI found in SFTPPlus version 4.15.0 or older, set this to ui-gen-1.

Empty

• Absolute path on the local filesystem.

Absolute path to a local directory containing the files required to customize the HTTP transfer service.

The folder needs to contain at least the 'main.css' and main.js files.

Leave it empty when you don't want to customize the appearance of the HTTP file transfer service.

You can find more information on the usage of a theme path on the HTTP/HTTPS operations page.

Empty

• UUID to application account.

• Empty.

This configuration option can be used to make a set of files available over HTTP/HTTPS without requiring an username or password.

The files for this account will be available under the /public/ URL or another suffix of your choosing, as configured for public_name.

Leave it empty to not allow public access. Trying to access the '/public/' URL will result in 404 Page Not Found error.

Credentials will still be required when accessing the '/home/' URL, which is dedicated to the private/protected access.

Using a dedicated application account to configure public access allows you to set fine grained access to the public files. The public files are not limited to read-only access.

Only application accounts defined in the main configuration are supported. OS accounts or external application accounts are not supported.

public

• Name of the URL fragment.

• ROOT

This defines the URL name under which the public files are available.

For example, when public_name = public-access, public files are available under an URL ending with /public-access, such as https://www.domain.com/public-access.

Set it to ROOT to have nothing special appended to the URL corresponding to the root of the HTTP/HTTPS file transfer service.

When this is empty, the default value of public is used.

This configuration is ignored when public_account_uuid is not defined.

as2receive

• Name of the URL fragment for AS2 receive requests.

This defines the URL name used to receive AS2 requests.

For example, when as2_receive_name = as2receive, AS2 files should be sent to URL like: https://www.domain.com/as2receive.

Empty

• Path to a directory in the user's home folder.

• Empty

This defines the path used to store the files received via AS2 for each user.

This is a path relative to the home path of each user.

For example, when as2_receive_path = /as2/receive, and an account has home_folder_path = C:/Users/JohnD, files received through AS2 are stored in C:/Users/JohnD/as2/receive.

Leave it empty to store the files in the account's root home directory.

Empty

• Fixed name for a file

• Template for filename.

This defines the file name used to store the received AS2 data when there are no AS2 request headers for the file name.

When this configuration is empty, and the AS2 request doesn't include a filename, the data is stored using a file named as2-received-file.TIMESTAMP.

This can also be configured as a file name template. For example, with the following configuration the actual file name created to store the received data will look like john_d-20210902T174910.xml, where john_d is the name of the account uploading the file:

as2_default_filename = {account.name}-{timestamp.iso_8601_compact}.xml

The following variables (case-insensitive) are provided as context data containing information about the event being triggered:

• uuid

• account.name

• account.peer.address

• account.peer.port

• account.peer.protocol

• account.uuid

• timestamp.cwa_14051

• timestamp.iso_8601

• timestamp.iso_8601_fractional

• timestamp.iso_8601_local

• timestamp.iso_8601_basic

• timestamp.iso_8601_compact

• timestamp.timestamp

Empty

• Certificate key in PEM format.

• Empty

This defines the certificate associated with the private key used to sign the message disposition notification (MDN) response.

This configuration option can also contain the private key associated with this certificate.

Leave it empty to use the general server certificate.

Empty

• RSA private key in PEM format.

• Empty

This defines the private key used to decrypt the files received via AS2 and to sign the message disposition notification (MDN) responses.

Leave it empty to use the general server private key.

Empty

• Any text

This defines the response sent by SFTPPlus AS2 server when a message was successfully received but the client has not requested a MDN response.

Leave it empty to not return any explicit message. SFPPlus will use the standard HTTP 201 Created status to let the client know that the file was successfully created on the server.

Empty

• Comma-separated values.

• Action name, Button Colour, Optional Group UUID

This configuration allows defining one or more custom buttons for the client web interface.

You can define multiple trigger buttons, one definition per line.

The first value is the name of the trigger and the text shown on the button. The second value is the type of the button and is defined as a button colour.

The third value is optional and defines the group of users for which the trigger is available. When not defined, the trigger is available to all groups.

Leave it empty to not show any additional buttons in the client web interface.

You can find more information on the usage of trigger buttons on the HTTP/HTTPS operations page.

Empty

• Empty

• Name of HTTP header.

• key name matching expression, list of options

This is used to configure the expected metadata header used making an HTTP API requests.

This is configured as a multi-line option.

The first line contains the name of the header used to extract the associated metadata and an optional list of header options.

The following lines contain comma separated definitions for the expected key/value metadata.

The first value on each line is the name of the metadata key or a matching expression for the metadata key.

The other values from the line are one of the following options:

• optional - request is processed even if metadata is missing

• required - request fails if metadata is not provided in the request

Leave it empty to not process any metadata for file operations.

When the metadata header name is configured without any key/value specification the request will accept any provided metadata and will handle them as optional.

The requested HTTP header value should be a key=value comma separated values (CSV) list. For example the following HTTP header:

X-Metadata: tag=report, tag=monthly, project-owner=John Doe

is parsed as the following JSON structure:

{
"tag": ["report", "monthly"],
"project-owner": ["John Doe"]
}

The simplest configuration in which any value from the x-sftpplus header is accessible is:

metadata_fields = x-sftpplus

A more complex configuration example in which:

• the x-metadata header is required and expected to have the tag key/value fields, and

• keys starting with project- are accepted but optional.

The request will succeed if the x-metadata header is not provided, as by default the processing of the header is optional:

metadata_fields =
  x-metadata
  tag, required
  project-*, optional

If you require a set of predefined keys but also accept any arbitrary keys, you can configure it as below. This will fail if the x-metadata HTTP header is not provided. This will fail if the tag metadata is not provided in the header's value and will accept any other extra metadata:

metadata_fields =
  x-metadata, required,
  tag, required
  *, optional

You can find more information on API requests with a metadata header on the HTTP REST API page.

Empty

• Single header with a name and at least one value.

• Multiple headers, each header on a separate line.

This configuration option can be used to extend the list of headers returned by SFTPPlus for each HTTP response.

Each line should start with the header name, followed by :. Each line should end with the header's values.

For example:

[services/9ac4-1054-f0e4]
name = HTTPS File Transfer Service
type = https
headers = Strict-Transport-Security: max-age=1607040; includeSubDomains

You can configure multiple headers by defining each header on a separate line.

Using this configuration option, you can overwrite the Server header, in order to obscure the identity and/or version of SFTPPlus.

If your header contains a comma, you will need to enclose the whole option in double quotation marks:

[services/5300-19d0-92ce]
type = http
headers = "Keep-Alive: timeout=5, max=100"

Empty

• Comma-separated values of fully qualified domain names.

• Comma-separated pairs of FQDN:PORT values.

When running behind a load balancer or a reverse proxy, you can configure a list of domain names handled by the load balancer for which SFTPPlus should accept forwarded requests.

When not using standard ports (80 for HTTP and 443 for HTTPS), you will also need to add the port number after the domain name.

You might see 400 Possible CSRF errors if this configuration is not set, as the same-origin policy is broken.

Leave it empty when SFTPPlus is not behind a load balancer.

Empty

• empty.

• Forwarded.

• X-Forwarded-For.

• Header name.

When running behind a load balancer or a reverse proxy, you can configure the HTTP header to be parsed for the client's source IP address.

When left empty, it will use the low-level TCP connection source address as the source peer for the authenticated user. This is the default value, to be used when clients are connecting directly to SFTPPlus server without using any proxy or balancer.

Set it to X-Forwarded-For to extract the source address from the X-Forwarded-For / XFF header used by many proxies as the de-facto standard. It expects the proxy header in the following format: X-Forwarded-For: <client>, <proxy1>, <proxy2> where proxy1 and proxy2 are optional.

The following custom and X-Forwarded-For IP address formats are supported:

• 1.2.4.5 - IPv4 without port number

• 1.2.4.5:6789 - IPv4 with port number

• 2001:db8::8a2e:370:7334 - IPv6 without port number

• [2001:db8::8a2e:370:7334] - IPv6 without port number

• [2001:db8::8a2e:370:7334]:1234 - IPv6 with port number

• ::ffff:192.0.2.128 - IPv4-mapped IPv6 address without a port number

• [::ffff:192.0.2.128]:1234 - IPv4-mapped IPv6 address with a port number

Set it to Forwarded, to extract the source address from the Forwarded header as defined in RFC 7238 section 4.

You can set it to any other header name. For example, X-ProxyUser-Ip is the header used by some Google services, while other products might use an X-Forwarded-Host header.

When a header value does not include a port number, port 0 is used as a placeholder.

When a header name is configured and the request is missing that header, the request uses the TCP source address.

If the value of the header is malformed, the request uses the TCP source address.

Empty

• Fully qualified domain name (FQDN)

• Comma separated list of fully qualified domain names

• Empty

Empty

• Absolute path on the local filesystem.

• Certificate in PEM text format (Since 3.40.0).

• Certificate in PKCS12 / PXF binary format (Since 4.0.0).

• Empty

None

Empty

• Absolute path on the local filesystem.

• Key as PEM text format (Since 3.40.0).

• Empty

This can be defined as an absolute path on the local filesystem to the X.509 private key file used by this component.

File content should be encoded in the Privacy-Enhanced Mail (PEM) format.

When the value is defined as PEM text, the configuration will look as in the following example:

ssl_key = -----BEGIN RSA PRIVATE KEY-----
    MIICXgIBAAKBgQDOoZUYd8KMYbre5zZIwR+V6dO2+cCYVS46BHbRbqt7gczkoIWh
    ...
    MORE KEY DATA
    ...
    Wh+QF3UArO8r8RYv3HRcnBjrGh+yEK93wIifVNGgy63FIQ==
    -----END RSA PRIVATE KEY-----

If ssl_certificate is not defined, any value defined for this ssl_key configuration is ignored and the global ssl_key value is used.

If the value defined in ssl_certificate option already contains the private key, this option can be omitted by leaving it empty.

Empty

• Password as plain text.

• Empty

This is used to define the password of the private key, when the private X.509 key is stored as an encrypted file.

Leave it empty to not use a password for the private key file.

Empty

• Absolute path on the local file.

• Content of the CA chain (Since 3.40.0).

• ${LETS_ENCRYPT_X3_CA}

• ${MICROSOFT_IT_CA}

• ${GO_DADDY_G2_G1}

• Empty

This can be defined as an absolute path on the local filesystem to a file containing the certificates of the Certificate Authorities used to validate the remote peer.

This is used only for certificate-based peer validation. To add the CA certificate for an SSL certificate for this component, simply add it to ssl_certificate, possibly together with other certificates needed to complete the full chain of certificates.

The remote peer identity can only be validated when the remote address is configured using a fully qualified domain name. IP based validation will always fail, this is not a method accepted by the public certificate authorities.

You can define the content of the CA as text in PEM format.

When the value is defined as PEM text, the configuration will look as in the following example:

ssl_certificate_authority = -----BEGIN CERTIFICATE-----
    MIICaDCCAdGgAwIBAgIBDjANBgkqhkiG9w0BAQUFADBGMQswCQYDVQQGEwJHQjEP
    ...
    MORE CERTIFICATE DATA
    ...
    JZQaMjV9XxNTFOlNUTWswff3uE677wSVDPSuNkxo2FLRcGfPUxAQGsgL5Ts=
    -----END CERTIFICATE-----

When a certificate authority is defined, this will result in initiating the two-way SSL/TLS authentication/handshake validation. For a successful connection, make sure the remote peer sends a valid certificate. If the connection fails, the event with ID 40009 is emitted.

The certificate authority file should be stored as a file in PEM format. For multiple CA, place all certificates in the same file.

A series of bundle CA are distributed with SFTPPlus. They can be configured together and mixed with other CA certificates. The bundle CAs are available under the following names:

• ${LETS_ENCRYPT_X3_CA} - For Let's Encrypt X3 certificate authority.

• ${MICROSOFT_IT_CA} - For all Microsoft IT CA certificates, used by SharePoint Online and other services provided by Microsoft.

• ${GO_DADDY_G2_G1} - For all GoDaddy Certificate Bundles, G2 With Cross to G1.

To configure a component to accept the remote peer certificates signed by Microsoft IT CA, which is the CA used by SharePoint Online, you can set the configuration as:

ssl_certificate_authority = ${MICROSOFT_IT_CRL}

This defines the path on the local filesystem to a file containing the certificate in PEM format for the single certificate authority or multiple authorities authorities with which this component will communicate.

Only peer connections using certificates signed by one of these certificate authorities will be permitted to communicate to this component.

When this component should communicate with peers holding certificates issued by multiple certificate authorities, put each CA certificate in PEM format inside a single file.

Leave it empty to disable checking the issuer of the peer's certificates.

When certificate authority check is disabled, connection peers are not required to send a certificate. If the peer sends a certificate, it is ignored.

Empty

• Comma separated list of CRL paths or HTTP URLs.

• crl-distribution-points

• ${MICROSOFT_IT_CRL}

• Empty

It defines the locations from where one or more CRLs will be loaded.

Multiple CRLs are defined as a comma separated list.

It supports local files with absolute paths, in either of the following formats:

• file:///unix/absolute/test-ca.crl

• file://c:\\windows\\absolute\\test-ca.crl

Retrieving the CRL over HTTP is also supported. The HTTP request is done using non-persistent HTTP/1.1 connections. The URL will look as follows:

• http://example.com/some.crl

CRL distribution points (CDP) are supported by using the crl-distribution-points configuration value.

When CRL distribution points are configured, the local certificate defined at ssl_certificate needs to have the CDP extension. The CDP advertised in the local certificate is loaded at startup in order to validate the configuration.

The distribution points configuration is mutually exclusive with local file or HTTP url configurations. When the certificate revocation list is configured to use CDP, all other configured CRL location are ignored.

Leave it empty to disable certificate revocation checks.

The certificate revocation list can only be used when the component is configured with CA certificates stored in a single file in PEM format.

When multiple or chained CA certificates are configured the CRL is only checked for the peer's certificate and not for the CA certificate or for an intermediate CA.

The CRL file should be stored in PEM or DER format.

0

• Number of seconds

• 0

This defined the number of seconds after which a configured CRL is reloaded by this component.

When set to 0, the CRL file is initially loaded at startup and then loaded again after the Next Update field advertised in the CRL.

If the Next Publish extension is present in the CRL and this option is set to 0, the CRL will be loaded again at the date and time specified in the Next Publish extension.

If the CRL does not advertise the Next Update field you will have to configure a number of seconds after which the CRL should be reloaded, otherwise you will get a configuration error.

For example, a value of 86400 means that the CRL will be re-read after one day.

For more details about the CRL reloading see the documentation for CRL reloading rules

secure

• List of SSL/TLS ciphers in OpenSSL format.

• secure

This defined the list of ciphers accepted by this component while communicating over the network.

The special keyword secure contains all the algorithms that we currently consider secure.

Connections are closed if the remote peer has no common cipher in its list of configured ciphers.

When left empty, it will default to the secure configuration.

More information about the accepted values can be found at the cryptography guide

The format for this value is the same as the one used for defining the OpenSSL cipher list. More information can be found on the OpenSSL site.

secure

• secure

• all

• tlsv1.0

• tlsv1.1

• tlsv1.2

• tlsv1.3

This defines the comma-separated list of SSL and TLS methods that are accepted by this component during the secure communication handshake.

Set this to secure to allow only the TLS methods that are currently considered secure. For now, this is TLS 1.2 and TLS 1.3 but this might be changed in the future. Any other configured value is ignored.

Set this to all to allow any supported SSL or TLS method. Any other configured value is ignored.

Currently, the following methods are officially supported:

• tlsv1 or tlsv1.0, which is TLS 1.0.

• tlsv1.1, which is TLS 1.1.

• tlsv1.2, which is TLS 1.2.

• tlsv1.3, which is TLS 1.3.

[services/681f5f5d-0502-4ebb-90d5-5d5c549fac6b]
ssl_cipher_list = RC4-SHA

Support for SSLv3 will be removed in future versions.

SSLv2 is no longer supported since it is not secure.

In version 2.8.0, the following new methods were added: tlsv1.0 (alias for tlsv1), tlsv1.1 and tlsv1.2

Support for tlsv1.3 was added in version 3.47.0.

Prior to version 4.17.0, this was configured as a space separated value.

10000

• Number of maximum concurrent connections accepted by the service.

• 0 - To disable the limit.

None