Class PrivateKeyAuthenticationMethod

Namespace

Renci.SshNet

Assembly

Renci.SshNet.dll

Provides functionality to perform private key authentication.

public class PrivateKeyAuthenticationMethod : AuthenticationMethod, IDisposable

Inheritance

object

AuthenticationMethod

PrivateKeyAuthenticationMethod

Implements

IDisposable

Inherited Members

AuthenticationMethod.Name

AuthenticationMethod.Username

AuthenticationMethod.AllowedAuthentications

AuthenticationMethod.Authenticate(Session)

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Constructors

PrivateKeyAuthenticationMethod(string, params IPrivateKeySource[])

Initializes a new instance of the Renci.SshNet.PrivateKeyAuthenticationMethod class.

public PrivateKeyAuthenticationMethod(string username, params IPrivateKeySource[] keyFiles)

Parameters

username string

The username.

keyFiles IPrivateKeySource[]

The key files.

Exceptions

ArgumentException

username is whitespace or null.

Properties

KeyFiles

Gets the key files used for authentication.

public ICollection<IPrivateKeySource> KeyFiles { get; }

Property Value

ICollection<IPrivateKeySource>

Name

Gets the name of the authentication method.

public override string Name { get; }

Property Value

string

Methods

Authenticate(Session)

Authenticates the specified session.

public override AuthenticationResult Authenticate(Session session)

Parameters

session Session

The session to authenticate.

Returns

AuthenticationResult

Result of authentication process.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.