string? ProjectId { get; set; }
Source
Gets or sets the Google Cloud project id used for short secret ids.
GoogleSecretManager
GoogleSecretManagerResultStatus
SourceClassifies Google Secret Manager configuration resolution outcomes.
AppSurfaceGoogleSecretTransferDiagnostic
SourceDescribes a value-safe Google Secret Manager transfer diagnostic.
ToDisplayString
string ToDisplayString()
Source
Renders the diagnostic for terminal output without secret payloads.
Returns
A display-safe diagnostic string.
AppSurfaceGoogleSecretProbeResult
SourceDescribes a value-safe Google Secret Manager probe result.
Parameters
StatusThe probe status.ResourceNameThe requested resource name.HasEnabledVersionsWhether an existing secret has at least one enabled version.DiagnosticA display-safe diagnostic for failed probes.
Ready
AppSurfaceGoogleSecretProbeResult Ready(string resourceName, bool hasEnabledVersions = false)
Source
Creates a successful probe result.
Parameters
resourceNameThe requested resource name.hasEnabledVersionsWhether an existing secret has enabled versions.
Returns
The successful probe result.
Failed
AppSurfaceGoogleSecretProbeResult Failed(GoogleSecretManagerTransferStatus status, string resourceName, AppSurfaceGoogleSecretTransferDiagnostic diagnostic)
Source
Creates a failed probe result.
Parameters
statusThe failure status.resourceNameThe requested resource name.diagnosticThe display-safe diagnostic.
Returns
The failed probe result.
AppSurfaceGoogleSecretWriteResult
SourceDescribes a value-safe Google Secret Manager write result.
Parameters
StatusThe write status.ResourceNameThe requested secret parent resource name.WrittenVersionResourceNameThe written version resource name, when Google returned one.DiagnosticA display-safe diagnostic for failed writes.
Written
AppSurfaceGoogleSecretWriteResult Written(string resourceName, string? writtenVersionResourceName)
Source
Creates a successful write result.
Parameters
resourceNameThe secret parent resource name.writtenVersionResourceNameThe written version resource name.
Returns
The successful write result.
Failed
AppSurfaceGoogleSecretWriteResult Failed(GoogleSecretManagerTransferStatus status, string resourceName, AppSurfaceGoogleSecretTransferDiagnostic diagnostic)
Source
Creates a failed write result.
Parameters
statusThe failure status.resourceNameThe requested secret parent resource name.diagnosticThe display-safe diagnostic.
Returns
The failed write result.
AppSurfaceGoogleSecretAccessResult
SourceDescribes a value-safe Google Secret Manager payload access result.
Parameters
StatusThe access status.ResourceNameThe requested version resource name.PayloadThe payload when access succeeded.DiagnosticA display-safe diagnostic for failed access.
Accessed
AppSurfaceGoogleSecretAccessResult Accessed(string resourceName, AppSurfaceGoogleSecretPayload payload)
Source
Creates a successful access result.
Parameters
resourceNameThe requested version resource name.payloadThe accessed payload.
Returns
The successful access result.
Failed
AppSurfaceGoogleSecretAccessResult Failed(GoogleSecretManagerTransferStatus status, string resourceName, AppSurfaceGoogleSecretTransferDiagnostic diagnostic)
Source
Creates a failed access result.
Parameters
statusThe failure status.resourceNameThe requested version resource name.diagnosticThe display-safe diagnostic.
Returns
The failed access result.
IAppSurfaceGoogleSecretTransferClient
SourceProbes and writes Google Secret Manager resources for explicit AppSurface secret transfer workflows.
Remarks
This seam is intentionally separate from IAppSurfaceGoogleSecretManagerClient, which remains the read-only runtime configuration provider client. Implementations must keep diagnostics value-safe and must not create, disable, destroy, rotate, or provision secrets. Version 1 transfer workflows can write an existing Google secret; version 2 workflows use this client only to probe and read a pinned Google version before guarded local materialization.
ProbeSecret
AppSurfaceGoogleSecretProbeResult ProbeSecret(string secretResourceName, TimeSpan timeout)
Source
Probes one existing Google Secret Manager secret parent.
Parameters
secretResourceNameThe fullprojects/.../secrets/...resource name.timeoutThe bounded probe timeout.
Returns
The probe result.
ProbeSecretVersion
AppSurfaceGoogleSecretProbeResult ProbeSecretVersion(string versionResourceName, TimeSpan timeout)
Source
Probes one existing Google Secret Manager secret version.
Parameters
versionResourceNameThe fullprojects/.../secrets/.../versions/...resource name.timeoutThe bounded probe timeout.
Returns
The probe result, whose resource name is the canonical provider response identity.
AccessSecretVersion
AppSurfaceGoogleSecretAccessResult AccessSecretVersion(string versionResourceName, TimeSpan timeout)
Source
Accesses one Google Secret Manager version payload for an apply operation.
Parameters
versionResourceNameThe full version resource name.timeoutThe bounded access timeout.
Returns
The version payload.
AddSecretVersion
AppSurfaceGoogleSecretWriteResult AddSecretVersion(string secretResourceName, string value, TimeSpan timeout)
Source
Adds a new enabled version to an existing Google Secret Manager secret.
Parameters
secretResourceNameThe full secret parent resource name.valueThe UTF-8 text secret value.timeoutThe bounded write timeout.
Returns
The write result.
GoogleSecretManagerTransferClientAdapter
SourceDefault transfer client backed by Google Cloud Secret Manager.
FromCredentialFile
GoogleSecretManagerTransferClientAdapter FromCredentialFile(string credentialFilePath)
Source
Creates a transfer client that uses one explicit service-account credential file.
Parameters
credentialFilePathAbsolute path to the Google credential file.
Returns
A client isolated from ambient Application Default Credentials.
Remarks
Use this factory for operator-owned transfer profiles only. The caller owns file validation and must never include the path or file contents in diagnostics. Runtime configuration continues to use its existing credential flow.
GoogleSecretManagerTransferStatus
SourceClassifies Google Secret Manager transfer operations without exposing payload bytes.
AppSurfaceGoogleSecretPayload
SourceCarries one Google Secret Manager version payload.
Parameters
DataThe raw payload bytes.ResolvedResourceNameThe resolved Secret Manager version resource name, if available.
Remarks
Record equality compares Data by array reference, not by content, because byte[] does not override equality. Compare payload contents explicitly when byte identity matters.
GoogleSecretManagerClientAdapter
SourceDefault IAppSurfaceGoogleSecretManagerClient backed by Google Cloud Secret Manager.
Remarks
The default constructor creates the Google client lazily so applications that register the provider but do not resolve Google-backed keys avoid opening Secret Manager transport during service registration.
AppSurfaceGoogleSecretManagerOptions
SourceConfigures the AppSurface Google Secret Manager provider.
Remarks
Keys are claimed explicitly by MapSecret or by an opt-in convention resolver. Claimed keys fail closed by default when Google Secret Manager cannot safely return the value. Environment variables still remain the top AppSurface emergency override because DefaultConfigManager checks them before normal providers.
AllowLatest
AppSurfaceGoogleSecretManagerOptions AllowLatest()
Source
Allows use of the mutable latest Secret Manager version alias.
Returns
The same options instance.
MapSecret
AppSurfaceGoogleSecretManagerOptions MapSecret(string logicalKey, string secretIdOrResourceName, string? version = null)
Source
Maps an AppSurface logical configuration key to a Google Secret Manager secret id or full version resource name.
Parameters
logicalKeyThe logical AppSurface configuration key, for exampleStripe:ApiKey.secretIdOrResourceNameA short secret id or fullprojects/.../secrets/.../versions/...name.versionThe version or alias for short secret ids. OverridesDefaultVersion.
Returns
The same options instance.
EnableConventionResolver
AppSurfaceGoogleSecretManagerOptions EnableConventionResolver(string logicalKeyPrefix, string secretIdPrefix = "", string? version = null)
Source
Enables a scoped convention resolver for logical keys under logicalKeyPrefix.
Parameters
logicalKeyPrefixThe required logical-key prefix that the convention may claim.secretIdPrefixAn optional prefix prepended to normalized secret ids.versionThe version or alias used by claimed convention keys.
Returns
The same options instance.
ProjectId
DefaultVersion
string? DefaultVersion { get; set; }
Source
Gets or sets the default secret version used by mappings that do not specify one.
Remarks
Keep this unset for production unless every mapping supplies its own version or alias. Set AllowLatestVersion before using latest; mutable latest is an explicit opt-in, not the silent production default.
AllowLatestVersion
bool AllowLatestVersion { get; set; }
Source
Gets or sets a value indicating whether the mutable latest version alias is allowed.
FailClosedOnProviderFailure
bool FailClosedOnProviderFailure { get; set; }
Source
Gets or sets a value indicating whether claimed-key failures should stop lower-priority providers.
LookupTimeout
TimeSpan LookupTimeout { get; set; }
Source
Gets or sets the bounded timeout for one Secret Manager lookup.
CacheTtl
TimeSpan? CacheTtl { get; set; }
Source
Gets or sets the optional in-memory cache duration for successful secret values.
Remarks
Leave unset for strict read-through behavior. When enabled, rotation is visible after this duration or after the app rebuilds the provider. The provider does not run background refresh.
Mappings
IReadOnlyList<AppSurfaceGoogleSecretMapping> Mappings { get; }
Source
Gets explicit logical-key to Secret Manager mappings.
Conventions
IReadOnlyList<AppSurfaceGoogleSecretConvention> Conventions { get; }
Source
Gets opt-in convention resolvers.
ServiceCollectionGoogleSecretManagerExtensions
SourceProvides service collection helpers for AppSurface Google Secret Manager.
ConfigureAppSurfaceGoogleSecretManager
IServiceCollection ConfigureAppSurfaceGoogleSecretManager(this IServiceCollection services, Action<AppSurfaceGoogleSecretManagerOptions> configure)
Source
Configures Google Secret Manager options.
Parameters
servicesThe service collection to configure.configureThe options callback.
Returns
The original service collection.
UseAppSurfaceGoogleSecretManagerClient
2 overloads
IServiceCollection UseAppSurfaceGoogleSecretManagerClient<TClient>(this IServiceCollection services)
Source
Replaces the Google Secret Manager client seam.
Type Parameters
TClientThe client implementation type.
Parameters
servicesThe service collection to configure.
Returns
The original service collection.
IServiceCollection UseAppSurfaceGoogleSecretManagerClient(this IServiceCollection services, IAppSurfaceGoogleSecretManagerClient client)
Source
Replaces the Google Secret Manager client seam with a specific instance.
Parameters
servicesThe service collection to configure.clientThe client instance.
Returns
The original service collection.
UseAppSurfaceGoogleSecretTransferClient
2 overloads
IServiceCollection UseAppSurfaceGoogleSecretTransferClient<TClient>(this IServiceCollection services)
Source
Replaces the Google Secret Manager transfer client seam.
Type Parameters
TClientThe transfer client implementation type.
Parameters
servicesThe service collection to configure.
Returns
The original service collection.
IServiceCollection UseAppSurfaceGoogleSecretTransferClient(this IServiceCollection services, IAppSurfaceGoogleSecretTransferClient client)
Source
Replaces the Google Secret Manager transfer client seam with a specific instance.
Parameters
servicesThe service collection to configure.clientThe transfer client instance.
Returns
The original service collection.
GoogleSecretManagerConfigResolution<T>
SourceDescribes a typed Google Secret Manager configuration resolution.
Type Parameters
TThe requested configuration type.
Unclaimed
GoogleSecretManagerConfigResolution<T> Unclaimed()
Source
Creates an unclaimed resolution.
Returns
An unclaimed resolution.
Found
GoogleSecretManagerConfigResolution<T> Found(T? value, string source)
Source
Creates a found resolution.
Parameters
valueThe converted value.sourceThe source name.
Returns
A found resolution.
Failed
GoogleSecretManagerConfigResolution<T> Failed(GoogleSecretManagerResultStatus status, ConfigProviderTerminalDiagnostic diagnostic, string source)
Source
Creates a failed claimed-key resolution.
Parameters
statusThe failed status.diagnosticThe display-safe diagnostic.sourceThe source name.
Returns
A failed resolution.
Status
GoogleSecretManagerResultStatus Status { get; }
Source
Gets the resolution status.
Value
T? Value { get; }
Source
Gets the converted value when Status is GoogleSecretManagerResultStatus.Found.
Diagnostic
ConfigProviderTerminalDiagnostic? Diagnostic { get; }
Source
Gets the display-safe terminal diagnostic when resolution failed for a claimed key.
Source
string? Source { get; }
Source
Gets the provider source name.
AppSurfaceGoogleSecretManagerOptionsValidator
SourceValidates AppSurfaceGoogleSecretManagerOptions before provider lookup.
IAppSurfaceGoogleSecretManagerClient
SourceReads Secret Manager version payloads for the AppSurface Google Secret Manager provider.
AccessSecretVersion
AppSurfaceGoogleSecretPayload AccessSecretVersion(string resourceName, TimeSpan timeout)
Source
Accesses one Secret Manager version.
Parameters
resourceNameThe full Secret Manager version resource name.timeoutThe bounded lookup timeout.
Returns
The secret version payload.
GoogleSecretManagerConfigProvider
SourceAppSurface configuration provider that resolves claimed keys from Google Secret Manager.
Remarks
The provider sits above LocalSecrets and file configuration but below environment variables. Only explicitly mapped or convention-claimed keys are owned by this provider; unclaimed keys fall through. Claimed-key failures are terminal when fail-closed behavior is enabled.
ResolveValue
GoogleSecretManagerConfigResolution<T> ResolveValue<T>(string environment, string key)
Source
Resolves a value and returns the structured provider status before config-provider adaptation.
Type Parameters
TThe requested configuration value type.
Parameters
environmentThe AppSurface environment being resolved.keyThe logical AppSurface configuration key.
Returns
The typed Google Secret Manager resolution.
AppSurfaceGoogleSecretConvention
SourceDescribes a scoped convention resolver for Google Secret Manager mappings.
Parameters
LogicalKeyPrefixThe logical-key prefix this convention may claim.SecretIdPrefixThe optional prefix prepended to normalized secret ids.VersionThe optional version or alias used by this convention.
AppSurfaceGoogleSecretManagerModule
SourceRegisters the AppSurface Google Secret Manager configuration provider.
AppSurfaceGoogleSecretMapping
SourceMaps one AppSurface logical configuration key to a Google Secret Manager secret.
Parameters
LogicalKeyThe logical AppSurface configuration key.SecretIdOrResourceNameA short secret id or full Secret Manager version resource name.VersionThe optional version or alias for short secret ids.