Class SopsOptions

Namespace

Nops.Core

Assembly

Nops.Core.dll

Options for SOPS file decryption. An options bag (not positional arguments).

public sealed class SopsOptions

Inheritance

object

SopsOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AgeIdentities

Age private key identities (Bech32 "AGE-SECRET-KEY-..." strings or file paths).

public IReadOnlyList<string>? AgeIdentities { get; set; }

Property Value

IReadOnlyList<string>

FilePath

Path of the file being decrypted (used for diagnostics).

public string? FilePath { get; set; }

Property Value

string

MasterKeys

Explicit master key providers (age, PGP, AWS KMS, GCP KMS, Azure KV, Vault).

public IReadOnlyList<IMasterKeyProvider>? MasterKeys { get; set; }

Property Value

IReadOnlyList<IMasterKeyProvider>

PgpKeys

PGP private keys as (key bytes, optional passphrase) tuples.

public IReadOnlyList<(byte[] Key, string? Passphrase)>? PgpKeys { get; set; }

Property Value

IReadOnlyList<(byte[] Key, string Passphrase)>

ThrowOnMacMismatch

Throw a MacMismatchException when the MAC does not match (default). Setting this to false is the equivalent of sops --ignore-mac: a modified or truncated file is then decrypted anyway, so only do it to recover a damaged file you already trust.

public bool ThrowOnMacMismatch { get; set; }

Property Value

bool

UseSopsEnvironment

Also use the age identities the sops CLI would find: SOPS_AGE_KEY, SOPS_AGE_KEY_FILE and the default sops/age/keys.txt in the user config directory. Default true; set false to use only explicit keys.

public bool UseSopsEnvironment { get; set; }

Property Value

bool