IPC@CHIP® RTOS-LNX – 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
V0.80


[FTP]
CMDPORT=port

Set the command port number of the FTP server.
Default:
Default FTP command port: 21
Example:
[FTP]
CMDPORT=5000
Since
V0.80


[FTP]
TIMEOUT=seconds

Defines the inactivity timeout for the FTP server in seconds. Please note that the timeout needs to be specified in seconds for compatibility to the legacy RTOS systems. However, the FTP server on the @CHIP-RTOS-LNX accepts the timeout only in minutes. Therefore the given value is rounded to the nearest fitting minute value. The minimum value for the timeout is 60 seconds. RFC 1123 states that the minimum idle timeout should be 5 minutes.
Default:
Default FTP timeout is 300 seconds.
Example:
[FTP]
TIMEOUT=60
Since
V1.14


[FTP]
USERx=user name

Defines the user name for FTP. You can define USER0 up to USER9.
You must specify both the user name and the corresponding password. Both user name and password are case sensitive.
Important notice:
To avoid security leaks you must define the first two user names and passwords.
Default:
Default users are: user0 is 'ftp' (password0 is 'ftp') and user1 is 'anonymous' (no password).
Example:
[FTP]
USER0=me
PASSWORD0=mepass
USER1=myself
PASSWORD1=myselfpass
Since
V0.80
Changes:
V1.21 - Extend the maximum number of entries from 2 to 10.


[FTP]
PASSWORDx=password

Defines the password for a FTP user. You can define PASSWORD0 for USER0 up to PASSWORD9 for USER9.
Both user name and password are case sensitive.
Default:
Default users are: user0 is 'ftp' (password0 is 'ftp') and user1 is 'anonymous' (no password).
Example:
[FTP]
USER0=me
PASSWORD0=mepass
USER1=myself
PASSWORD1=myselfpass
Since
V0.80
Changes:
V1.21 - Extend the maximum number of entries from 2 to 10.


[FTP]
PASSHASHx=password hash

Defines the password hash for a FTP user. This alternate method does not require a clear text password in the CHIP.INI. If this entry is present the PASSWORDx entry is ignored.
You can define PASSHASH0 for USER0 up to PASSHASH9 for USER9. Use the passhash command to generate a password hash.
Example:
[FTP]
USER0=me
PASSHASH0=$5$4lkah074$7qBJC0U5fQR2wJvonp9OE51VIw1iftyi6qF2.j5FbgB
USER1=myself
PASSHASH1=$5$UtGcvfoO$EP2Vpdt5SXmYds13Gq8QpmK1QBlLHm1.sDLWbvHSXG1
Since
V1.19
Changes:
V1.21 - Extend the maximum number of entries from 2 to 10.


[FTP]
ACCESSRIGHTx=Access rights for defined users

This CHIP.INI entry allows you to deny write access to FTP USER0 up to USER9.

0 - write and read access enabled
1 - write access denied, read access enabled
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
V0.80
Changes:
V1.21 - Extend the maximum number of entries from 2 to 10.


[FTP]
DRIVEx=drive number

Set user's FTP drive. Entries DRIVE0 up to DRIVE9 can be made to specify a particular drive for use by FTP USER0 and USER9 respectively. The drive numbers are coded as follows:
     0: Drive A
     1: Drive B
     2: Drive C
     3: Drive D


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
V0.80
Changes:
V1.21 - Extend the maximum number of entries from 2 to 10.


[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.
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
V0.80
Changes:
V1.21 - Extend the maximum number of entries from 2 to 10.


[FTP]
PRIO=prio

Defines the task priority of the FTP server task (@FTP). Legal values are in the range 0-90.
Default:
Default is 90.
Example:
[FTP]
PRIO=80
Since
V0.80


[FTP]
CONNECTIONS=number of FTP server connections

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


[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 certificate filename.
Default:
SSL option is disabled per default.
Example:
[FTP]
SSL_ENABLE=1
Since
V1.14


[FTP]
SSL_CERT=Filename of a PEM file

Defines the name of FTP server's PEM file. This file needs to hold the server certificate and the server private key and optionally the CA chain of the server certificate. Possible file formats are *.PEM.

Please note that the @CHIP-RTOS-LNX FTP server requires these information is a single file, whereas the legacy RTOS systems required it as separate files and separate CHIP.INI entries.
Default:
No default.
Example:
[FTP]
SSL_CERT=FTPCERT.PEM
Since
V1.14


[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
V1.14


[FTP]
SSL_DATAPERM=Permission of the FTP data connection

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

Please note that on the @CHIP-RTOS-LNX if SSL is required on the data channel, it will also be required on the control channel.

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





Top of page | Main page

Copyright © 2018 Beck IPC GmbH
Generated on Fri Jun 8 2018 12:48:20 by Doxygen 1.8.13