IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


CHIP.INI [SSH]


[SSH]
ENABLE=0/1

Enable/disable the SSH server. Defines whether the SSH server is used or not. If 1 the SSH server is started. If you do not provide your own key filename, a default RSA key will be used. You can provide a RSA Key filename, and/or DSA Key filename.

To enable STDIO on SSH sessions, you have to set STDIN and STDOUT to SSH.
Default:
If safe mode is off, the SSH server is enabled per default. If safe mode is on, the SSH server is disabled per default.
Example:
 [SSH]
 ENABLE=1
Since:
SC2x3 V1.00


[SSH]
SSHPORT=port

Sets the port number of the SSH server.
Default:
Default SSH port: 22
Example:
 [SSH]
 SSH_PORT=8300
Since:
SC2x3 V1.00


[SSH]
PRIO=prio

Defines the task priority of the SSH server tasks (SSHx) during the session. Allowed value are 2-127.
Default:
Default is 37.
Example:
 [SSH]
 PRIO=11
Since:
SC2x3 V1.00


[SSH]
PRIO_KEX=prio

Defines the task priority of the SSH server tasks (SSHx) during the key exchange. The key exchange will occupy 100% of the CPU performance for a long time period. Thus the task will have a different task priority during the key exchange. Allowed value are 2-127.
Default:
Default is 50.
Example:
 [SSH]
 PRIO_KEX=60
Since:
SC2x3 V1.00


[SSH]
RSA_KEYFILE=prio

Defines the name of SSH server's private key file, used to authenticate the server to the client. The file must be in the 'OpenSSH' format.

Key lengths longer than 2048 bits are not supported.
Default:
Use an internal RSA key.
Example:
 [SSH]
 RSA_KEYFILE=rsa_key
Since:
SC2x3 V1.00


[SSH]
DSA_KEYFILE=prio

Defines the name of SSH server's private key file, used to authenticate the server to the client. The file must be in the 'OpenSSH' format.

Key lengths longer than 2048 bits are not supported.
Default:
No DSA key.
Example:
 [SSH]
 RSA_KEYFILE=rsa_key
Since:
SC2x3 V1.00


[SSH]
USERx=user name

Defines a user name for SSH. You can define a USER0 and a USER1. User name and password are case sensitive. Maximum user name size: 19 characters.
Default:
The default user name and password is ssh.
Example:
 [SSH]
 USER0=otto
Since:
SC2x3 V1.00


[SSH]
PASSWORDx=password

Define the password for a SSH user. You can define a PASSWORD0 for USER0 and a PASSWORD1 for USER1. User name and password are case sensitive. Maximum password size: 19 characters.

If no password is specified for a user, public key authentication will be the only allowed user authentication method. In this case the section USERx_KEYFILE must be provided.
Default:
The default user name and password is ssh.
Example:
 [SSH]
 USER0=otto
 PASSWORD0=ottopass
Since:
SC2x3 V1.00


[SSH]
USERx_KEYFILE=filename

Defines a filename for SSH USER0 or USER1, that contains one or multiple public keys for user authentication. This is an alternate method for user authentication, beside the password method. It is more secure than the password method.

If the SSH server should allow password and public key authentication, both entries (PASSWORDx and USERx_KEYFILE) must be provided.

The file must be in 'OpenSSH authorized_keys' format. Every key must be listed in one line. Within one key no line breaks are allowed.

Key lengths longer than 2048 bits are not supported.
Default:
No user key file.
Example:
 [SSH]
 USER0=myself
 USER0_KEYFILE=user0_keys
Since:
SC2x3 V1.00


[SSH]
LOCAL_FORWARD=0/1

Enables/Disables the SSH Local TCP Port Forwarding.
Default:
By default the Local Forwarding option is disabled.
Example:
 [SSH]
 LOCAL_FORWARD=1
Since:
SC2x3 V1.00


[SSH]
REMOTE_FORWARD=0/1

Enables/Disables the SSH Remote TCP Port Forwarding.
Default:
By default the Remote Forwarding option is disabled.
Example:
 [SSH]
 REMOTE_FORWARD=1
Since:
SC2x3 V1.00


[SSH]
FORWARD_ALL=0/1

Allows/Disallows TCP connections to remote forwarded ports from any host.
Default:
By default only connections from the Local Loopback device are allowed (forwarded over SSH).
Example:
 [SSH]
 FORWARD_ALL=1
Since:
SC2x3 V1.00


[SSH]
REKEY_DATA=size in bytes

Sets the transfered (sent + received) data size, before rekeying is requested. A value of 0 will disable the rekeying by reason of data size.
Note:
Remember that the SSH client can also request rekeying. Most clients also allow to configure this setting.
Default:
The default data size is 1073741824 Bytes (1 GB).
Example:
 [SSH]
 REKEY_DATA=5000000
Since:
SC2x3 V1.00


[SSH]
REKEY_TIME=milliseconds

Sets the time in milliseconds, before rekeying is requested. A value of 0 will disable the rekeying by reason of timeout.
Note:
Remember that the SSH client can also request rekeying. Most clients also allow to configure this setting.
Default:
The default time is 28800000 ms (3600000*8 = 8 hours).
Example:
 [SSH]
 REKEY_TIME=20000000
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