Zum Hauptinhalt springen

SecretReadInfo

Namespace: Meshmakers.Octo.Runtime.Contracts.Secrets

Everything a reader may learn about a Secret value without decrypting it: the read state, the storage form, the key id (SecretStorageForm.EncV2 / SecretStorageForm.KeyMissing only) and when it was set (RtSecretValue.SetAt, protected values only).

public struct SecretReadInfo

Inheritance Object → ValueType → SecretReadInfo
Implements IEquatable<SecretReadInfo>

Properties​

State​

Read state (isSet = State == Set, keyMissing = State == KeyMissing)

public SecretValueState State { get; set; }

Property Value​

SecretValueState

Form​

Storage form

public SecretStorageForm Form { get; set; }

Property Value​

SecretStorageForm

KeyId​

Key id of a protected value; null otherwise

public string KeyId { get; set; }

Property Value​

String

SetAt​

"Set at" (UTC) of a protected value; null for legacy / not set / unknown

public Nullable<DateTime> SetAt { get; set; }

Property Value​

Nullable<DateTime>

IsSet​

True when the value reads as set.

public bool IsSet { get; }

Property Value​

Boolean

KeyMissing​

True when a value is stored but its key id is not in the key ring.

public bool KeyMissing { get; }

Property Value​

Boolean

Constructors​

SecretReadInfo(SecretValueState, SecretStorageForm, String, Nullable<DateTime>)​

Everything a reader may learn about a Secret value without decrypting it: the read state, the storage form, the key id (SecretStorageForm.EncV2 / SecretStorageForm.KeyMissing only) and when it was set (RtSecretValue.SetAt, protected values only).

public SecretReadInfo(SecretValueState State, SecretStorageForm Form, string KeyId, Nullable<DateTime> SetAt)

Parameters​

State SecretValueState
Read state (isSet = State == Set, keyMissing = State == KeyMissing)

Form SecretStorageForm
Storage form

KeyId String
Key id of a protected value; null otherwise

SetAt Nullable<DateTime>
"Set at" (UTC) of a protected value; null for legacy / not set / unknown