Interface IAuthorizationMechanism

Interface for all authorization mechanisms.

Namespace: FubarDev.FtpServer.Authorization
Assembly: FubarDev.FtpServer.Abstractions.dll
Syntax
public interface IAuthorizationMechanism

Methods

| Improve this Doc View Source

HandleAcctAsync(String, CancellationToken)

Handles the ACCT command.

Declaration
Task<IFtpResponse> HandleAcctAsync(string account, CancellationToken cancellationToken)
Parameters
Type Name Description
String account

The account to select.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task<IFtpResponse>

The task returning the FTP response.
| Improve this Doc View Source

HandlePassAsync(String, CancellationToken)

Handles the PASS command.

Declaration
Task<IFtpResponse> HandlePassAsync(string password, CancellationToken cancellationToken)
Parameters
Type Name Description
String password

The password.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task<IFtpResponse>

The task returning the FTP response.
| Improve this Doc View Source

HandleUserAsync(String, CancellationToken)

Handles the USER command.

Declaration
Task<IFtpResponse> HandleUserAsync(string userIdentifier, CancellationToken cancellationToken)
Parameters
Type Name Description
String userIdentifier

The user identifier.
CancellationToken cancellationToken

The cancellation token.
Returns
Type Description
Task<IFtpResponse>

The task returning the FTP response.
| Improve this Doc View Source

Reset(Nullable<IAuthenticationMechanism>)

Resets the authorization mechanism.

Declaration
void Reset(IAuthenticationMechanism? authenticationMechanism)
Parameters
Type Name Description
Nullable<IAuthenticationMechanism> authenticationMechanism

The previously selected authentication mechanism.