IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


CHIP.INI [WEB]


[WEB]
ENABLE=0/1

Define if the Web 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 Web server is enabled per default. If safe mode is on, the Web server is disabled per default.
Example:
 [WEB]
 ENABLE=0
Since:
SC2x3 V1.00


[WEB]
PRIO=prio

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


[WEB]
MAINPAGE=name of the web server main page

Defines the name of Web server's main page. The Web server opens this page if a browser request like "http://192.168.200.4/" is received. Typical names are "main.htm" or "index.htm".

The console command webstat shows the current main page.
Default:
Default is "main.htm", which is an internal CGI page.
Example:
 [WEB]
 MAINPAGE=index.html
Since:
SC2x3 V1.00
See also:
CGI_SetMainPage()


[WEB]
MAINPAGE_POST=name of the web server main page (POST method)

Defines the name of Web server's main page when POST method is used. The Web server opens this page if a browser request like "http://192.168.200.4/" is received. Typical names are "main.htm" or "index.htm".

The console command webstat shows the current main page.
Default:
If this entry is not present, the MAINPAGE entry will specify the mainpage for both methods (GET and POST).
Example:
 [WEB]
 MAINPAGE_POST=index2.html
Since:
SC2x3 V1.00
See also:
CGI_SetMainPagePost()


[WEB]
TEMPPATH=name of a temporary Web server path

Defines a temporary path for finding files. If the Web server cannot find the file in its default directory, it will try to find it in this temporary path. Pathname should include the drive specification. This function allows the Web server to locate HTML files produced on the IPC@CHIP® RAMDISK by application programs. The maximum string length is 32.

The webstat command shows the current temporary path.
Default:
No default.
Example:
 [WEB]
 TEMPPATH=C:\web
Since:
SC2x3 V1.00


[WEB]
DRIVE=disk drive number

Set Web server's disk drive.
     0: Drive A
     1: Drive B
     .............
     5: Drive F


The webstat command shows the current Web server drive.
Default:
If the drive does not exist, the default drive A will be set.
Example:
 [WEB]
 DRIVE=1
Since:
SC2x3 V1.00
See also:
CGI_SetRootDrive()


[WEB]
ROOTDIR=directory name

Defines the name of Web server's root directory.

The webstat command shows the current Web server root direcory.
Important notice:
To avoid security leaks you should define a directory below the "\\" directory. If you use "\" as web root directory, everybody can read all your files.
Default:
If the directory does not exist, the Web server sets "\" as the default root directory.
Example:
 [WEB]
 ROOTDIR=\web
Since:
SC2x3 V1.00
See also:
CGI_SetRootDir()


[WEB]
MAXCGIENTRIES=number of available CGI entries

Set the maximum number of entries for the Web server. Range: 2 to 128.

The cgistat command shows the current number. root direcory.
Default:
Default are 10 entries.
Example:
 [WEB]
 MAXCGIENTRIES=20
Since:
SC2x3 V1.00


[WEB]
WEBSERVERSTACK=stack size in bytes

Sets the stack size (bytes) for the Web server task during user CGI execution. The minimal stack size is 4096 Bytes. The maximum value is 65536 bytes. The size is rounded to the nearest 4 kbyte multiple. You can increase the stack size with this entry, if your CGI functions require more stack space. If you increase the BODY_SIZE or the HEADER_SIZE parameters, you should also increase this value.
Default:
The default stack size is 4096 Bytes.
Example:
 [WEB]
 WEBSERVERSTACK=8192
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.02 - Increased allowed maximum value from 20480 to 65536.


[WEB]
HTTPPORT=port

Sets the port number of the web server.
Default:
Default HTTP port: 80
Example:
 [WEB]
 HTTPPORT=81
Since:
SC2x3 V1.00


[WEB]
HEADER_SIZE=size in bytes

Sets the web server maximum header length in bytes. This applies to all lines in the HTTP header, the method line as well as all header fields. Allowed value range: 256-8192
Default:
Default header length: 1792 characters.
Example:
 [WEB]
 HEADER_SIZE=2000
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.02 - Maximum allowed value changed from 5120 to 8192.


[WEB]
HEADER_REJECT=0/1

Choose whether or not to reject incoming requests that contain headers longer than the internal buffer can store. If this is set to 0, and the received header is longer than the default or configured maximum header length, the corresponding header will be truncated. If this is set to 1 the request will be rejected.
Default:
The default is to reject long headers.
Example:
 [WEB]
 HEADER_REJECT=0
Since:
SC2x3 V1.00


[WEB]
BODY_SIZE=size in bytes

Sets the web server maximum body length in bytes. Allowed value range: 256-2097152
Default:
Default body length: 3000 bytes.
Example:
 [WEB]
 BODY_SIZE=4000
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.02 - Maximum allowed value changed from 8192 to 32768.
SC2x3 V1.50 - Maximum allowed value changed from 32768 to 65280.
SC2x3 V1.70 - Maximum allowed value changed from 65280 to 2097152.


[WEB]
CONNECTIONS=number of web server HTTP connections

Configure how many concurrent HTTP connections the web server can handle. Maximum connections are 100. This setting will heavily affect the TCP/IP memory pool usage amount.
Default:
Default are 20 connections.
Example:
 [WEB]
 CONNECTIONS=30
Since:
SC2x3 V1.00


[WEB]
TIMEOUT=seconds for HTTP connection timeout

Configure after which timeout the web server closes an idle connection. Minimum is 1 second. Maximum is 3600 seconds.
Default:
Default are 60 seconds.
Example:
 [WEB]
 TIMEOUT=10
Since:
SC2x3 V1.02


[WEB]
HTTPVERSION=HTTP version

Configure which HTTP version the web server will use.
     2 = HTTP 1.0 (web server will close the connection)
     3 = HTTP 1.1 (web server will leave the connection open)
Default:
Default is to use the HTTP 1.1 version.
Example:
 [WEB]
 HTTPVERSION=2
Since:
SC2x3 V1.02


[WEB]
DETECT_ENCODING=0/1

If this option is set to 1 (default: 0), static files will be opened to check their first few bytes for a magic signature. Currently only gzip compressed files are supported. If such a file is detected a special content encoding header (Content-Encoding: gzip) will be sent to the HTTP client. The client then knows that the file needs to be unpacked.
By setting this option you can compress any files before putting them onto your chip without having to rename them and thus without having to adapt links etc.
Default:
By default the detection of the encoding is disabled.
Example:
 [WEB]
 DETECT_ENCODING=1
Since:
SC2x3 V1.11


[WEB]
UPLOAD=0/1

Define if the Web server file upload should be activated. Use 0 to disable, 1 to enable.
Default:
By default, the Web server file upload is disabled.
Example:
 [WEB]
 UPLOAD=1
Since:
SC2x3 V1.00


[WEB]
UPLOAD_PATH=name of a Web server path used for HTTP file uploads

Defines the name of Web server's drive and directory used for http file uploads. If the directory does not exist, file uploads will fail.

The path specified here is used when the DESTINATION-PATH form item field is used.

The webstat command shows the current upload path.
Default:
Empty, which means that the web server root drive and directory is used.
Example:
 [WEB]
 UPLOAD_PATH=C:\uploads
Since:
SC2x3 V1.02


[WEB]
UPLOAD_PATH2=additional name of a Web server path used for HTTP file uploads

Defines a second name of Web server's drive and directory used for http file uploads. If the directory does not exist, file uploads will fail.

The path specified here is used when the DESTINATION-PATH2 form item field is used.

The webstat command shows the current upload path.
Default:
Empty, which means that the web server root drive and directory is used.
Example:
 [WEB]
 UPLOAD_PATH2=C:\uploads
Since:
SC2x3 V1.50


[WEB]
UPLOAD_MAX_SIZE=maximal file size in bytes

Define the maximum size for HTTP uploaded files. When the uploaded file exceeds that size it will not be saved. As result the web server returns an server error to the browser. The maximum file size is 4294967295 bytes.
Default:
The default max upload size is 4294967295.
Example:
 [WEB]
 UPLOAD_MAX_SIZE=4096
Since:
SC2x3 V1.02


[WEB]
USERx=user name

Defines a user name for transferring files to the Web server's upload directory using the HTTP web file upload feature. You can define USER0 to USER9.
Important notice:
To avoid security leaks you should define a user name and password. If the user name and password of the first entry are empty, then the authorization will not be checked.
Default:
The standard user name for the first user is 'web'.
Example:
 [WEB]
 UPLOAD=1
 USER0=user
 PASSWORD0=pass
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.50 - Increased maximum users/passwords from 1 to 10


[WEB]
PASSWORDx=password

Defines the password used to transfer files to the Web server's upload directory using the HTTP web file upload feature. You can define PASSWORD0 to PASSWORD9. PASSWORD0 is used with USER0, etc.
Important notice:
To avoid security leaks you should define a user name and password. If the user name and password of the first entry are empty, then the authorization will not be checked.
Default:
The standard password for the first user is 'web'.
Example:
 [WEB]
 UPLOAD=1
 USER0=user
 PASSWORD0=pass
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.50 - Increased maximum users/passwords from 1 to 10


[WEB]
SECURE=0/1

Defines whether the security feature for the Web Server is active or not.
     0 = security feature deactivated
     1 = security feature activated

The Web Server security feature allows up to ten paths to be protected with user name and password. When this security feature is activated, users must then authenticate themselves to get Web access to these paths.
Default:
Per default the security feature is deactivated.
Example:
 [WEB]
 SECURE=1
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.08 - Increased paths, realm strings, user names and password entries from two to ten.


[WEB]
SEC_URLx=path

Defines a specified URL for the Web security feature. The user can define SEC_URL0 to SEC_URL9. All sub URLs of SEC_URLx are then protected by user name and password. The SEC_URL0 path is protected by SEC_USER0 user name and SEC_PASSWORD0 password, and SEC_URL1 by SEC_USER1 user name and SEC_PASSWORD1 password, and so on.

The maximum length for the paths is 63 characters.
Default:
No default.
Example:
 [WEB]
 SECURE=1
 SEC_URL0=/sec/
 SEC_USER0=otto
 SEC_PASSWORD0=web
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.08 - Increased paths, realm strings, user names and password entries from two to ten.


[WEB]
SEC_USERx=user name

Defines a user name for the Web security feature. The user can define SEC_USER0 to SEC_USER9. The max length of the user name is 19 characters.

If the security feature is activated, the user should define a path, user name and password.
Default:
No default.
Example:
 [WEB]
 SECURE=1
 SEC_URL0=/sec/
 SEC_USER0=otto
 SEC_PASSWORD0=web
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.08 - Increased paths, realm strings, user names and password entries from two to ten.


[WEB]
SEC_PASSWORDx=password

Defines a password for the Web security feature. The user can define SEC_PASSWORD0 to SEC_PASSWORD9. The max length of the password is 19 characters.

If the security feature is activated, the user should define a path, user name and password.
Default:
No default.
Example:
 [WEB]
 SECURE=1
 SEC_URL0=/sec
 SEC_USER0=otto
 SEC_PASSWORD0=web
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.08 - Increased paths, realm strings, user names and password entries from two to ten.


[WEB]
SEC_REALMx=realm string

Defines a realm string for the Web security feature. The user can define SEC_REALM0 to SEC_REALM9. The max length of the realm string is 259 characters.
Default:
The default strings for are "Secure URL0" for SEC_REALM0 and "Secure URL1" for SEC_REALM1. The other realm strings are empty by default.
Example:
 [WEB]
 SEC_REALM0=SecurityArea
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.08 - Increased paths, realm strings, user names and password entries from two to ten.


[WEB]
SSL_ENABLE=0/1/2

Defines whether the SSL web server is used or not. IF SSL_ENABLE=1 the SSL web server task is started and running. IF SSL_ENABLE=2 the SSL web server task is started but suspended. In this case the user program must enable the server with BIOS_Server_On_Off().

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


[WEB]
SSL_PRIO=prio

Defines the task priority of the SSL web server task (SSLW). Allowed value are 2-127.
Default:
Default is 90.
Example:
 [WEB]
 SSL_PRIO=80
Since:
SC2x3 V1.00


[WEB]
SSL_DRIVE=disk drive number

Set SSL Web server's disk drive.
     0: Drive A
     1: Drive B
     2: Drive C
     3: Drive D

If the drive does not exist, the default drive A will be set.

The webstat command shows the current Web server drive.
Default:
If this entry is not present the normal Web server/s disk drive and root directory will be used.
Example:
 [WEB]
 SSL_DRIVE=3
Since:
SC2x3 V1.00


[WEB]
SSL_ROOTDIR=directory name

Defines the name of SSL Web server's root directory. If the directory does not exist, the Web server sets "\" as the default root directory.

The webstat command shows the current Web server root directory.
Important notice:
To avoid security leaks you should define a directory below the "\" directory. If you use "\" as web root directory, everybody can read all your files.
Default:
If the SSL_DRIVE entry is not present the normal Web server/s root directory will be used.
Example:
 [WEB]
 SSL_ROOTDIR=\sslweb
Since:
SC2x3 V1.00


[WEB]
SSL_HTTPPORT=port

Sets the port number of the SSL web server.
Default:
Default SSL HTTP port: 443
Example:
 [WEB]
 SSL_HTTPPORT=8201
Since:
SC2x3 V1.00


[WEB]
SSL_CONNECTIONS=number of web server HTTPS connections

Configure how many concurrent HTTPS connections the web server can handle. Maximum connections are 100. This setting will heavily affect the TCP/IP memory pool usage amount.
Default:
Default are 10 connections.
Example:
 [WEB]
 SSL_CONNECTIONS=15
Since:
SC2x3 V1.00


[WEB]
SSL_TIMEOUT=seconds for HTTPS connection timeout

Configure after which timeout the SSL web server closes an idle connection. Minimum is 1 second. Maximum is 3600 seconds.
Default:
Default are 60 seconds.
Example:
 [WEB]
 SSL_TIMEOUT=10
Since:
SC2x3 V1.02


[WEB]
SSL_HTTPVERSION=HTTP version

Configure which HTTP version the SSL web server will use.
     2 = HTTP 1.0 (SSL web server will close the connection)
     3 = HTTP 1.1 (SSL web server will leave the connection open)
Default:
Default is to use the HTTP 1.1 version.
Example:
 [WEB]
 SSL_HTTPVERSION=2
Since:
SC2x3 V1.02


[WEB]
SSL_VERSION=select supported SSL version

Defines what SSL version the SSL web 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:
 [WEB]
 SSL_VERSION=2
Since:
SC2x3 V1.00


[WEB]
SSL_CACERTx=CA certificate filename

Defines the name of Web server's CA certificate. SSL_CACERT0 must be the name of the web 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:
 [WEB]
 SSL_CACERT0=ROOTCERT.DER
Since:
SC2x3 V1.00


[WEB]
SSL_CLICACERTx=Filename of client's CA certificate

Defines the name of Web server client's CA certificate. If this entry is present, the web server will request a client authentication in his ServerHello message. The server will list all CAs added by these entries in his message.

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


[WEB]
SSL_SERVERCERT=Filename of the server certificate

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


[WEB]
SSL_KEYFILE=Filename of the server key file

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

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


[WEB]
SSL_EPHFILE=Filename of the ephemeral key file

Defines the name of Web server's ephemeral private and public key file. Possible file formats are *.PEM and *.DER. When exportable cipher suite is used and the server's certificate is RSA with key length more than 512 bits, we can not use that RSA key pair to exchange keys, because the exportable cipher suite is only allowed to have a maximum key size of 512 bits. Instead we have to use ephemeral RSA keys. To generate the RSA key pair in real-time would have cost an excessive amount of CPU time, that's why this is not supported. In these cases the user must add ephemeral RSA keys, with a maximum size of 512 bits, using this entry.
Default:
No default.
Example:
 [WEB]
 SSL_EPHFILE=EPHKEY.DER
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