IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


CHIP.INI [FTP]


[FTP]
ENABLE=0/1

Define if the FTP server should be activated. Use 0 to disable, 1 to enable.

BIOS_Server_On_Off() may be used to enable the server if disabled at startup due to this CHIP.INI entry.
Default:
If safe mode is off, the FTP server is enabled per default. If safe mode is on, the FTP server is disabled per default.
Example:
 [FTP]
 ENABLE=0
Since:
SC2x3 V1.00


[FTP]
LOGINDELAY=0/1

Define if the delayed login of the FTP server should be (de)activated.

Use 0 to deactivate, 1 to activate. The delay time starts with 400 milliseconds. After each following failed login, the delay time will be doubled until it reaches 20 seconds. After a successful login the delay time will be set back to 400 milliseconds.
Default:
By default, the delayed login is enabled.
Example:
 [FTP]
 LOGINDELAY=0
Since:
SC2x3 V1.00


[FTP]
CMDPORT=port

Set the command port number of the FTP server.
Default:
Default FTP command port: 21
Example:
 [FTP]
 CMDPORT=5000
Since:
SC2x3 V1.00


[FTP]
TIMEOUT=seconds

Defines the inactivity timeout for the FTP server in seconds. The minimum value for the timeout is 20 seconds and maximum is 65535 seconds. RFC 1123 states that the minimum idle timeout should be 5 minutes.
Default:
Default FTP timeout is 300 seconds.
Example:
 [FTP]
 TIMEOUT=50
Since:
SC2x3 V1.00


[FTP]
USERx=user name

Defines the user name for FTP. You can define a USER0 and a USER1.
You must specify both the user name and their password. Both user name and password are case sensitive. Maximum name size: 19 characters
Important notice:
To avoid security leaks you must define both user names and passwords.
Default:
Default users are: 'anonymous' (no password) and 'ftp' (password is 'ftp').
Example:
 [FTP]
 USER0=me
 PASSWORD0=mepass
 USER1=myself
 PASSWORD1=myselfpass
Since:
SC2x3 V1.00


[FTP]
PASSWORDx=password

Defines the pasword for a FTP user. You can define a PASSWORD0 for USER0 and a PASSWORD1 for USER1.
Both user name and password are case sensitive. Maximum password size: 19 characters
Default:
Default users are: 'anonymous' (no password) and 'ftp' (password is 'ftp').
Example:
 [FTP]
 USER0=me
 PASSWORD0=mepass
 USER1=myself
 PASSWORD1=myselfpass
Since:
SC2x3 V1.00


[FTP]
ACCESSRIGHTx=Access rights for defined users

This CHIP.INI entry allows you to deny write access to FTP USER0 or USER1.

0 - write and read access enabled
1 - write access denied, read access enabled


You can only forbid write access if you have defined the respective user with the FTP USERx and PASSWORDx entries.
Default:
By default write access is enabled for both FTP users.
Example:
Disable write access for USER0:
 [FTP]
 USER0=otto
 PASSWORD0=otto53pass
 ACESSRIGHT0=1
Since:
SC2x3 V1.00


[FTP]
DRIVEx=drive number

Set user's FTP drive. Entries DRIVE0 or DRIVE1 can be made to specify a particular drive for use by FTP USER0 and USER1 respectively. The drive numbers are coded as follows:
     0: Drive A
     1: Drive B
     ...........
     5: Drive F


If the DRIVE entry and the ROOTDIR entry do not exist, a virtual root directory will be set, that lists all available drives.
If only the drive entry does not exist, the default drive A: will be set.
Default:
Virtual root directory if DRIVE and ROOTDIR entries are missing.
Example:
The following example defines the root drive for USER0 to be on B: drive.
 [FTP]
 DRIVE0=1
Since:
SC2x3 V1.00


[FTP]
ROOTDIRx=directory name

Defines the name of user's FTP server root directory. If the specified FTP directory doesn't exist, the FTP server closes the connection. If ROOTDIRx is set you must also specify the FTP DRIVEx entry. Maximum ROOTDIRx path string length: 64 characters.
Important notice:
To avoid security leaks you should define one "normal" user with a directory below the "\" root directory. A user with the ROOTDIR setting "\" has access to every subdirectory on every drive. If the ROOTDIR is set to a subdirectory below the "\", the file access is restricted to the defined subdirectory and its subfolders on the specified drive DRIVEx.
Default:
Virtual root directory if DRIVE and ROOTDIR entries are missing. If only DRIVE is set the FTP root directory is the drive root directory, "\".
Example:
 [FTP]
 ROOTDIR1=userdir
Since:
SC2x3 V1.00


[FTP]
PRIO=prio

Defines the task priority of the FTP server task (FTPS). Allowed value are 2-127.
Default:
Default is 90.
Example:
 [FTP]
 PRIO=80
Since:
SC2x3 V1.00


[FTP]
CONNECTIONS=number of FTP server connections

Configure how many concurrent FTP connections the FTP server can handle. Maximum connections are 5.
Default:
Default are 2 connections.
Example:
 [FTP]
 CONNECTIONS=3
Since:
SC2x3 V1.00


[FTP]
SSL_ENABLE=0/1

Defines whether the FTP server supports SSL (FTPS) connections. IF SSL_ENABLE=1 the FTP server task is started with SSL support. IF SSL_ENABLE=0 the FTP server task is started without SSL support.

You have to provide a CA certificate filename(s), a local server certificate filename, a private and public key pair filename.
Default:
SSL option is disabled per default.
Example:
 [FTP]
 SSL_ENABLE=1
Since:
SC2x3 V1.00


[FTP]
SSL_VERSION=select supported SSL version

Defines what SSL version the SSL FTP server should support.
     1 = SSL 3.0
     2 = TLS 1.0
     3 = SSL 3.0 and TLS 1.0
Default:
SSL 3.0 and TLS 1.0
Example:
 [FTP]
 SSL_VERSION=2
Since:
SC2x3 V1.00


[FTP]
SSL_CACERTx=CA certificate filename

Defines the name of FTP server's CA certificate. SSL_CACERT0 must be the name of the FTP server's root CA certificate. If needed SSL_CACERT1 is the next CA certificate in the certificate chain. SSL_CACERT2 is then the next in the chain and so on. Possible file formats are *.PEM and *.DER.

A maximume of five CA certificate files may be listed with tags SSL_CACERT0 up to SSL_CACERT4. The entry tag search is terminated at the first non-existant tag in this sequence.
Default:
No default.
Example:
 [FTP]
 SSL_CACERT0=ROOTCERT.DER
Since:
SC2x3 V1.00


[FTP]
SSL_SERVERCERT=Filename of the server certificate

Defines the name of FTP server's own local certificate. Possible file formats are *.PEM and *.DER.
Default:
No default.
Example:
 [FTP]
 SSL_SERVERCERT=SRVCERT.DER
Since:
SC2x3 V1.00


[FTP]
SSL_KEYFILE=Filename of the server key file

Defines the name of FTP server's private and public key file. Possible file formats are *.PEM and *.DER.

Key lengths longer than 2048 bits are not supported.
Default:
No default.
Example:
 [FTP]
 SSL_KEYFILE=PRIVKEY.DER
Since:
SC2x3 V1.00


[FTP]
SSL_CTRLPERM=Permission of the FTP control connection

Whether or not the FTP server allows or requires authentication on the control channel.

     1 = SSL is allowed
     2 = SSL is required
Default:
SSL is allowed.
Example:
 [FTP]
 SSL_CTRLPERM=2
Since:
SC2x3 V1.00


[FTP]
SSL_DATAPERM=Permission of the FTP data connection

Whether or not the FTP server allows or requires authentication on the data channel.

     1 = SSL is allowed
     2 = SSL is required
Default:
SSL is allowed.
Example:
 [FTP]
 SSL_DATAPERM=2
Since:
SC2x3 V1.00





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:35 2017 by Doxygen 1.6.1