SessionOptions Class

Table of Contents

Syntax
Constructors
Properties
Methods
Remarks
Example

Defines information to allow an automatic connection and authentication of the session. Is used with Session.Open method.

Advertisements:

Syntax

Namespace: WinSCP

C#	public sealed class SessionOptions

VB.NET

Public NotInheritable Class SessionOptions

Constructors

Name	Description
SessionOptions()	Default constructor.

Properties

Name	Description
FtpMode FtpMode	FTP mode. Possible values are `FtpMode.Passive` (default) and `FtpMode.Active`.
FtpSecure FtpSecure	FTPS mode. Possible values are `FtpSecure.None` (default), `FtpSecure.Implicit`, `FtpSecure.ExplicitSsl` and `FtpSecure.ExplicitTls`.
bool GiveUpSecurityAndAcceptAnySshHostKey	Give up security and accept any SSH host key. To be used in exceptional situations only, when security is not required. When set, log files will include warning about insecure connection. To maintain security, use `SshHostKeyFingerprint`.
bool GiveUpSecurityAndAcceptAnySslHostCertificate	Give up security and accept any FTPS server SSL/TLS certificate. To be used in exceptional situations only, when security is not required. When set, log files will include warning about insecure connection. To maintain security, use `SslHostCertificateFingerprint`.
string HostName	Name of the host to connect to. Mandatory property.
string Password	Password for authentication.
int PortNumber	Port number to connect to. Keep default `0` to use the default port for the protocol.
Protocol Protocol	Protocol to use for the session. Possible values are `Protocol.Sftp` (default), `Protocol.Scp` and `Protocol.Ftp`.
string SshHostKeyFingerprint	Fingerprint of SSH server host key (or several alternative fingerprints separated by semicolon). It makes WinSCP automatically accept hostkey with the fingerprint. Mandatory for SFTP/SCP protocol.1) Learn how to obtain host key fingerprint.
string SshPrivateKeyPath	Full path to private key file. The key has to be passphrase-less or Pageant has to be running with the key loaded (`SshPrivateKeyPath` then serves only to select, what private key Pageant should use, in case more keys are loaded).
string SslHostCertificateFingerprint	Fingerprint of FTPS server SSL/TLS certificate to be automatically accepted (useful for certificates signed by untrusted authority).
TimeSpan Timeout	Server response timeout. Defaults to 15 seconds.
string UserName	Username for authentication. Mandatory property.

Methods

Name	Description
void AddRawSettings(string setting, string value)	Allows configuring any session settings using raw format as in an INI file. E.g. to enable SSH compression and agent forwarding use `AddRawSettings("Compression", "1")` and `AddRawSettings("AgentFwd", "1")`.

Remarks

You need to fill in all properties required to connect and authenticate your session automatically.

You always need to fill in Protocol, HostName and UserName2).

In most cases you need to fill in Password. Exceptions are:

You use different authentication method than a password authentication, such as public key authetication (with passphrase-less private key or with use of Pageant) for SSH session;
The server does not require password.

For SSH (SFTP/SCP) session you need to fill in the SshHostKeyFingerprint to verify the expected server host key.

Example

See overall example for WinSCP .NET assembly or any other example.

1) You can leave the property null, if you set GiveUpSecurityAndAcceptAnySshHostKey; or if you set Session.DefaultConfiguration to false and make sure the host key is already accepted in the configuration, only (not recommended).

2) Except for very rare occasions that the server does not require username.

WinSCP Free SFTP, SCP and FTP client for Windows

SessionOptions Class

Syntax

Constructors

Properties

Methods

Remarks

Example

Search Documentation

This page

Donate

Recommend

Associations