profile
The profile
element defines a connection
profile. It has seven attributes: id
,
name
, host
, port
,
connect-on-startup
, user
, and
gateway-profile
.
The profile id
must be a unique identifier that
does not change during the lifetime of the profile.
An additional name
can be given to the profile.
This is a free-form text string. Define a unique name for each profile.
The host
address and port
must also be given. The
address can be either an IP address or a domain name. The default port is
22
.
If the profile is used for transparent FTP tunneling, and the
host
attribute is left empty, the Secure Shell tunnel is opened
to the destination host given in the SOCKS request. Otherwise the Secure
Shell tunnel is opened to the host specified in the profile and FTP
connections are forwarded to the requested hosts.
If you want to make the connection specified by the profile
automatically when the SOCKS Proxy is started, set the value of the
connect-on-startup
attribute to yes
. In
this case, give also the user
attribute (the username
the connection is made with). You also need to set up some form of
non-interactive authentication for the connection.
In the user
attribute, the value
%USERNAME%
can be used to set the username to the
current user.
If the profile is used for transparent FTP tunneling and the user
attribute is left empty, the username given by the FTP client is used when
opening the Secure Shell connection.
The gateway-profile
attribute can be used to
create nested tunnels. The profile name through which the
connection is made is given as the value of the attribute. The
first tunnel is created using the gateway host profile and from
there the second tunnel is created to the host defined in
this profile.
- hostkey
This element gives the path to the remote server host
public key file as a value of the file
attribute.
Alternatively, the public key can be included as a base64-encoded ASCII block.
- ciphers
This element defines the ciphers used with this profile. See
Section The default-settings Element.
- macs
This element defines the MACs used with this profile. See
Section The default-settings Element.
- transport-distribution
This element defines the transport distribution for this
profile. See Section The default-settings Element.
- rekey
This element defines the rekeying settings used with this
profile. See Section The default-settings Element.
- authentication-methods
This element defines the authentication methods used with this
profile. See Section The default-settings Element.
- compression
This element defines the compression settings used with this
profile. See Section The default-settings Element.
- proxy
This element defines the SOCKS Proxy proxy settings used with this
profile. See Section The default-settings Element.
If a gateway profile (gateway-profile
) has been
defined for this profile, the proxy setting is ignored and the
default proxy setting or the proxy setting of the gateway profile is
used.
- idle-timeout
This element defines the idle timeout settings used with this
profile. See Section The default-settings Element.
An example connection profile is shown below:
<profile name="dynamic-ftp"
id="id1"
host=""
port="22"
connect-on-startup="NO"
user=""
gateway-profile="">
<authentication-methods>
<authentication-method name="publickey" />
<authentication-method name="password" />
</authentication-methods>
</profile>
|