Interface IPasswordManager

A service use to retrieve or add password to the node's registry.

Namespace: Catalyst.Abstractions.Cryptography

Assembly: Catalyst.Abstractions.dll

Syntax

public interface IPasswordManager

Methods

AddPasswordToRegistry(PasswordRegistryTypes, SecureString)

Adds a password to the registry in order to make it reusable later without requiring a new input from the user.

Declaration

bool AddPasswordToRegistry(PasswordRegistryTypes passwordType, SecureString securePassword)

Parameters

Type	Name	Description
PasswordRegistryTypes	passwordType	The type of password to be retrieved.
System.Security.SecureString	securePassword

Returns

Type	Description
System.Boolean	bools

RetrieveOrPromptAndAddPasswordToRegistry(PasswordRegistryTypes, String)

Adds a password to the registry in order to make it reusable later without requiring a new input from the user.

Declaration

SecureString RetrieveOrPromptAndAddPasswordToRegistry(PasswordRegistryTypes passwordType, string promptMessage = null)

Parameters

Type	Name	Description
PasswordRegistryTypes	passwordType
System.String	promptMessage	A message providing some context to the user, for instance which password is being requested.

Returns

Type	Description
System.Security.SecureString	The password read and stored as a SecureString

Remarks

Once the password has been use, it is recommended to dispose of it. https://docs.microsoft.com/en-us/dotnet/api/system.security.securestring?view=netcore-2.2

RetrieveOrPromptPassword(PasswordRegistryTypes, String)

Try to retrieve a password from the registry, if not found, prompt the user for it.

Declaration

SecureString RetrieveOrPromptPassword(PasswordRegistryTypes passwordType, string promptMessage = null)

Parameters

Type	Name	Description
PasswordRegistryTypes	passwordType	The type of password to be retrieved.
System.String	promptMessage	A message providing some context to the user, for instance which password is being requested.

Returns

Type	Description
System.Security.SecureString	The password read and stored as a SecureString

Remarks

Once the password has been use, it is recommended to dispose of it. https://docs.microsoft.com/en-us/dotnet/api/system.security.securestring?view=netcore-2.2