PowerTCP SSH and SFTP for .NET
Authenticate(String) Method




The username used for authentication.
Performs 'none' authentication, sending only the username to the server.
Syntax
'Declaration
 
Public Overloads Sub Authenticate( _
   ByVal username As String _
) 
'Usage
 
Dim instance As SshConnection
Dim username As String
 
instance.Authenticate(username)
public void Authenticate( 
   string username
)
public: void Authenticate( 
   string* username
) 
public:
void Authenticate( 
   String^ username
) 

Parameters

username
The username used for authentication.
Exceptions
ExceptionDescription
System.Security.Authentication.AuthenticationException Authentication was unsuccessful. The server does not support this authentication method, or the username is invalid.
Remarks

Servers will not typically accept this authentication method as the sole authentication factor, and will never announce it (the 'none' token will never show up in the list returned by Connection.GetRemainingAuthMethods).

The technique used to invoke this method is dependent upon the value of ThreadingModel. If ThreadingModel.Free, this method executes on the current thread and returns when complete (this is standard for creating applications in multi-threading environments like .NET). If ThreadingModel.ApartmentBlocking, this method blocks and processes windows UI messages while a worker thread executes (this is useful for making a simple blocking call in an apartment model environment like VB6). If ThreadingModel.ApartmentAsync, this method immediately returns after starting a worker thread that executes asynchronously (this is useful for creating advanced communications applications in an apartment model environment like VB6). The StateChanged event will be raised upon completion, or the Error event raised if an exception is thrown.

To support multi-factor authentication, the value of State can be checked after this method completes. If it returns ConnectionState.ConnectedAndPartiallyAuthenticated, further authentication is required and Connection.GetRemainingAuthMethods can be checked for a list of authentication methods that the server will accept as the subsequent authentication factor.

See Also

Reference

SshConnection Class
SshConnection Members
Overload List


PowerTCP SSH and SFTP for .NET Documentation Version 7.0
© 2023 Dart Communications. All Rights Reserved.
Send comments on this topic