Interface ISecretStore

Namespace: Fabricator.Core

Assembly: Fabricator.Core.dll

A secret store: a storage of the secrets (passwords, tokens, etc.) required by the resources, see Secrets.

[Interface]
[CompilationMapping(SourceConstructFlags.ObjectType)]
public interface ISecretStore

Remarks

Before running any resource checks or applications, Fabricator opens every store required by them once, and disposes the opened scopes after all the checks and applications are finished. The stores are opened one by one (never concurrently), so they are free to interact with the user while opening.

Stores are compared by reference: every store object is a separate store, no matter how its Equals is defined.

Methods

Open(ISecretStoreUi, SecretStoreContext)

Opens the store.

FSharpAsync<ISecretStoreScope> Open(ISecretStoreUi ui, SecretStoreContext context)

Parameters

ui ISecretStoreUi: The user interface the store may use while opening, e.g. to ask for the password of the store itself.
context SecretStoreContext: Optional information about the upcoming use of the store.

Returns