Safe Haskell	None
Language	GHC2021

Ecluse.Config.Types

Synopsis

newtype Url = Url Text
mkUrl :: Text -> Either Text Url
unUrl :: Url -> Text
data MirrorCredential
- = MirrorCodeArtifact CodeArtifactConfig
- | MirrorStatic Secret
data MountConfig = MountConfig {
- mntEnabled :: Maybe Bool
- mntPrivateUpstream :: Maybe RegistryUrl
- mntPublicUpstream :: RegistryUrl
- mntMirrorTarget :: Maybe RegistryUrl
- mntMirrorTargetToken :: Maybe Secret
- mntMirrorCodeArtifactTokenDuration :: Maybe Natural
- mntPublicationTarget :: Maybe RegistryUrl
- mntPublicationTargetToken :: Maybe Secret
- mntPublishAllow :: [Scope]
- mntMinTrustedIntegrity :: Maybe MinTrustedIntegrity
- mntDivergencePolicy :: Maybe DivergencePolicy
- mntAdditionalRules :: RulePatch
}
data AppConfig = AppConfig {
- cfgServer :: ServerSettings
- cfgQueue :: QueueSettings
- cfgLimits :: LimitsSettings
- cfgCache :: CacheSettings
- cfgIntegrity :: IntegritySettings
- cfgEgress :: EgressSettings
- cfgAdvisories :: AdvisoriesSettings
- cfgRuntime :: RuntimeSettings
- cfgObservability :: ObservabilitySettings
- cfgMounts :: Map Ecosystem MountConfig
}
data ServerSettings = ServerSettings {
- srvPort :: Int
- srvPublicUrl :: Maybe Url
- srvAuthToken :: Maybe Secret
- srvHelpMessage :: Maybe Text
- srvShutdownDrainTimeout :: Int
}
data QueueSettings = QueueSettings {
- qsUrl :: Maybe Url
- qsMemoryMaxDepth :: Maybe Int
}
data LimitsSettings = LimitsSettings {
- limMaxResponseBytes :: Maybe Int
- limMaxVersionCount :: Int
- limMaxNestingDepth :: Int
- limMaxRequestBytes :: Maybe Int
- limMaxArtifactBytes :: Maybe Int
}
data CacheSettings = CacheSettings {
- csTtl :: NominalDiffTime
- csMaxEntries :: Maybe Int
- csMaxBytes :: Maybe Int
}
data IntegritySettings = IntegritySettings {
- intMinPublic :: MinIntegrity
- intMinTrusted :: MinTrustedIntegrity
- intDivergencePolicy :: DivergencePolicy
}
newtype EgressSettings = EgressSettings {
- egrAdditionalBlockedRanges :: [IPRange]
}
data AdvisoriesSettings = AdvisoriesSettings {
- advBucket :: Maybe Text
- advPollInterval :: NominalDiffTime
- advCompileInterval :: NominalDiffTime
- advDataDir :: FilePath
- advOsvExportBaseUrl :: Text
- advMaxDatabaseBytes :: Int
}
data RuntimeSettings = RuntimeSettings {
- rtCores :: Maybe Int
- rtMaxHeapBytes :: Maybe Int
- rtServeMaxInFlight :: Maybe Int
- rtPublicConnectionsPerHost :: Maybe Int
- rtPrivateConnectionsPerHost :: Maybe Int
}
data ObservabilitySettings = ObservabilitySettings {
- obsLogFormat :: LogFormat
- obsTelemetry :: TelemetrySwitch
}
data MountRegistries = MountRegistries {
- regPublicUpstream :: RegistryUrl
- regMode :: MountMode
}
data MountMode
- = Mirrored MirroredLegs
- | ServeOnly (Maybe RegistryUrl)
data MirroredLegs = MirroredLegs {
- mlPrivateUpstream :: RegistryUrl
- mlMirrorTarget :: MirrorTarget
}
regPrivateUpstream :: MountRegistries -> Maybe RegistryUrl
regMirrorTarget :: MountRegistries -> Maybe MirrorTarget
data MirrorTarget = MirrorTarget {
- mtUrl :: RegistryUrl
- mtCredential :: MirrorCredential
}
data Mount = Mount {
- mountEcosystem :: Ecosystem
- mountRegistries :: MountRegistries
- mountPolicy :: [PrecededRule]
}
type MountMap = Map Ecosystem Mount
data Config = Config {
- configApp :: AppConfig
- configMounts :: MountMap
}
data ConfigError
- = ParseError Text
- | PolicyErrors [PolicyError]
- | PublicUrlRequired
- | MountMissingPrivateUpstream Ecosystem
- | MirrorSettingWithoutWrite Ecosystem Text
- | MirrorCredentialTokenMissing Ecosystem
- | MirrorCredentialConflict Ecosystem
renderConfigError :: ConfigError -> Text

Documentation

newtype Url Source #

Constructors

Url Text

Instances

Instances details

Show Url Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> Url -> ShowS # show :: Url -> String # showList :: [Url] -> ShowS #
Eq Url Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: Url -> Url -> Bool # (/=) :: Url -> Url -> Bool #
Ord Url Source #
Instance details Defined in Ecluse.Config.Types Methods compare :: Url -> Url -> Ordering # (<) :: Url -> Url -> Bool # (<=) :: Url -> Url -> Bool # (>) :: Url -> Url -> Bool # (>=) :: Url -> Url -> Bool # max :: Url -> Url -> Url # min :: Url -> Url -> Url #

mkUrl :: Text -> Either Text Url Source #

unUrl :: Url -> Text Source #

data MirrorCredential Source #

The mirror-write credential, derived from the mirror-target URL so a token can never be paired with an endpoint it was not minted for. A CodeArtifact endpoint encodes its whole identity in its host, so that identity is parsed straight from the URL; any other host is written with an operator-supplied static bearer. The choice is made once, at config load (resolveMirrorCredential), and carried here so the pairing is correct by construction.

Constructors

MirrorCodeArtifact CodeArtifactConfig	A CodeArtifact mirror target: the mint identity parsed from its host.
MirrorStatic Secret	Any other mirror target: an operator-supplied static write token.

Instances

Instances details

Show MirrorCredential Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MirrorCredential -> ShowS # show :: MirrorCredential -> String # showList :: [MirrorCredential] -> ShowS #
Eq MirrorCredential Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: MirrorCredential -> MirrorCredential -> Bool # (/=) :: MirrorCredential -> MirrorCredential -> Bool #

data MountConfig Source #

Constructors

MountConfig

Fields

mntEnabled :: Maybe Bool
The mount's explicit on/off switch. Any operator-declared key under the mount activates it, so enabled: true exists for the mount that needs no other key (a serve-only pure public gate on the template public upstream), and enabled: false switches off a mount whose other keys remain in place.
mntPrivateUpstream :: Maybe RegistryUrl
mntPublicUpstream :: RegistryUrl
mntMirrorTarget :: Maybe RegistryUrl
mntMirrorTargetToken :: Maybe Secret
mntMirrorCodeArtifactTokenDuration :: Maybe Natural
mntPublicationTarget :: Maybe RegistryUrl
mntPublicationTargetToken :: Maybe Secret
mntPublishAllow :: [Scope]
mntMinTrustedIntegrity :: Maybe MinTrustedIntegrity
A per-mount refinement of the global trusted-integrity floor, for the one legacy private registry whose loosening must not leak onto other mounts.
mntDivergencePolicy :: Maybe DivergencePolicy
A per-mount refinement of the global cross-upstream divergence policy.
mntAdditionalRules :: RulePatch

Instances

Instances details

FromJSON MountConfig Source #
Instance details Defined in Ecluse.Config.Aeson Methods parseJSON :: Value -> Parser MountConfig Source # parseJSONList :: Value -> Parser [MountConfig] Source # omittedField :: Maybe MountConfig Source #
Show MountConfig Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MountConfig -> ShowS # show :: MountConfig -> String # showList :: [MountConfig] -> ShowS #
Eq MountConfig Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: MountConfig -> MountConfig -> Bool # (/=) :: MountConfig -> MountConfig -> Bool #

data AppConfig Source #

The resolved application configuration, one sub-record per document group so a field's home says what it governs (the document schema and this type mirror each other one to one).

Constructors

AppConfig
Fields cfgServer :: ServerSettings cfgQueue :: QueueSettings cfgLimits :: LimitsSettings cfgCache :: CacheSettings cfgIntegrity :: IntegritySettings cfgEgress :: EgressSettings cfgAdvisories :: AdvisoriesSettings cfgRuntime :: RuntimeSettings cfgObservability :: ObservabilitySettings cfgMounts :: Map Ecosystem MountConfig

Instances

Instances details

FromJSON AppConfig Source #
Instance details Defined in Ecluse.Config.Aeson Methods parseJSON :: Value -> Parser AppConfig Source # parseJSONList :: Value -> Parser [AppConfig] Source # omittedField :: Maybe AppConfig Source #
Show AppConfig Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> AppConfig -> ShowS # show :: AppConfig -> String # showList :: [AppConfig] -> ShowS #
Eq AppConfig Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: AppConfig -> AppConfig -> Bool # (/=) :: AppConfig -> AppConfig -> Bool #

data ServerSettings Source #

The server group: the inbound edge Écluse itself presents.

Constructors

ServerSettings
Fields srvPort :: Int srvPublicUrl :: Maybe Url Required whenever a mount is active (`loadConfig` refuses otherwise): served artifact URLs are rewritten against it. srvAuthToken :: Maybe Secret srvHelpMessage :: Maybe Text srvShutdownDrainTimeout :: Int

Instances

Instances details

Show ServerSettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> ServerSettings -> ShowS # show :: ServerSettings -> String # showList :: [ServerSettings] -> ShowS #
Eq ServerSettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: ServerSettings -> ServerSettings -> Bool # (/=) :: ServerSettings -> ServerSettings -> Bool #

data QueueSettings Source #

The queue group: the mirror queue's destination and the in-memory rollover's depth cap. The backend is derived from the URL's shape (Ecluse.Config.QueueTarget), never named here.

Constructors

QueueSettings
Fields qsUrl :: Maybe Url qsMemoryMaxDepth :: Maybe Int Computed from the runtime posture when unset; a configured value wins.

Instances

Instances details

Show QueueSettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> QueueSettings -> ShowS # show :: QueueSettings -> String # showList :: [QueueSettings] -> ShowS #
Eq QueueSettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: QueueSettings -> QueueSettings -> Bool # (/=) :: QueueSettings -> QueueSettings -> Bool #

data LimitsSettings Source #

The limits group: the hostile-input bounds. The structural counts are pinned policy defaults; the byte-valued caps are computed from the memory plan when unset (Ecluse.Composition.MemoryPlan), a configured value always winning.

Constructors

LimitsSettings
Fields limMaxResponseBytes :: Maybe Int limMaxVersionCount :: Int limMaxNestingDepth :: Int limMaxRequestBytes :: Maybe Int limMaxArtifactBytes :: Maybe Int The mirror worker's per-artifact fetch byte cap; computed from the memory plan's mirror-artifact tenant when unset, a configured value winning.

Instances

Instances details

Show LimitsSettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> LimitsSettings -> ShowS # show :: LimitsSettings -> String # showList :: [LimitsSettings] -> ShowS #
Eq LimitsSettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: LimitsSettings -> LimitsSettings -> Bool # (/=) :: LimitsSettings -> LimitsSettings -> Bool #

data CacheSettings Source #

The cache group: the metadata cache's TTL and its computed-by-default bounds.

Constructors

CacheSettings
Fields csTtl :: NominalDiffTime csMaxEntries :: Maybe Int Computed from the runtime posture when unset; a configured value wins. csMaxBytes :: Maybe Int Computed from the runtime posture when unset; a configured value wins.

Instances

Instances details

Show CacheSettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> CacheSettings -> ShowS # show :: CacheSettings -> String # showList :: [CacheSettings] -> ShowS #
Eq CacheSettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: CacheSettings -> CacheSettings -> Bool # (/=) :: CacheSettings -> CacheSettings -> Bool #

data IntegritySettings Source #

The integrity group: the global integrity floors and divergence policy (minTrusted and divergencePolicy refinable per mount).

Constructors

IntegritySettings
Fields intMinPublic :: MinIntegrity intMinTrusted :: MinTrustedIntegrity intDivergencePolicy :: DivergencePolicy

Instances

Instances details

Show IntegritySettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> IntegritySettings -> ShowS # show :: IntegritySettings -> String # showList :: [IntegritySettings] -> ShowS #
Eq IntegritySettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: IntegritySettings -> IntegritySettings -> Bool # (/=) :: IntegritySettings -> IntegritySettings -> Bool #

newtype EgressSettings Source #

The egress group: the operator's additions to the blocked target ranges.

Constructors

EgressSettings
Fields egrAdditionalBlockedRanges :: [IPRange]

Instances

Instances details

Show EgressSettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> EgressSettings -> ShowS # show :: EgressSettings -> String # showList :: [EgressSettings] -> ShowS #
Eq EgressSettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: EgressSettings -> EgressSettings -> Bool # (/=) :: EgressSettings -> EgressSettings -> Bool #

data AdvisoriesSettings Source #

The advisories group: the OSV/CVE pipeline's bucket, cadences, and bounds.

Constructors

AdvisoriesSettings
Fields advBucket :: Maybe Text advPollInterval :: NominalDiffTime advCompileInterval :: NominalDiffTime advDataDir :: FilePath advOsvExportBaseUrl :: Text advMaxDatabaseBytes :: Int

Instances

Instances details

Show AdvisoriesSettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> AdvisoriesSettings -> ShowS # show :: AdvisoriesSettings -> String # showList :: [AdvisoriesSettings] -> ShowS #
Eq AdvisoriesSettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: AdvisoriesSettings -> AdvisoriesSettings -> Bool # (/=) :: AdvisoriesSettings -> AdvisoriesSettings -> Bool #

data RuntimeSettings Source #

The runtime group: the process-sizing overrides. Every field is optional; unset, each is computed from the runtime posture (cgroups, RTS, file-descriptor limit) with its provenance boot-logged.

Constructors

RuntimeSettings
Fields rtCores :: Maybe Int rtMaxHeapBytes :: Maybe Int rtServeMaxInFlight :: Maybe Int rtPublicConnectionsPerHost :: Maybe Int rtPrivateConnectionsPerHost :: Maybe Int

Instances

Instances details

Show RuntimeSettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> RuntimeSettings -> ShowS # show :: RuntimeSettings -> String # showList :: [RuntimeSettings] -> ShowS #
Eq RuntimeSettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: RuntimeSettings -> RuntimeSettings -> Bool # (/=) :: RuntimeSettings -> RuntimeSettings -> Bool #

data ObservabilitySettings Source #

The observability group: log shape and telemetry switch.

Constructors

ObservabilitySettings
Fields obsLogFormat :: LogFormat obsTelemetry :: TelemetrySwitch

Instances

Instances details

Show ObservabilitySettings Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> ObservabilitySettings -> ShowS # show :: ObservabilitySettings -> String # showList :: [ObservabilitySettings] -> ShowS #
Eq ObservabilitySettings Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: ObservabilitySettings -> ObservabilitySettings -> Bool # (/=) :: ObservabilitySettings -> ObservabilitySettings -> Bool #

data MountRegistries Source #

Constructors

MountRegistries
Fields regPublicUpstream :: RegistryUrl regMode :: MountMode

Instances

Instances details

Show MountRegistries Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MountRegistries -> ShowS # show :: MountRegistries -> String # showList :: [MountRegistries] -> ShowS #
Eq MountRegistries Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: MountRegistries -> MountRegistries -> Bool # (/=) :: MountRegistries -> MountRegistries -> Bool #

data MountMode Source #

Whether a mount mirrors, derived from its declared endpoints: a declared mirrorTarget makes the mount Mirrored (and its private upstream is then required, so the mirror can be read back), an absent one makes it ServeOnly (never writes anywhere; the private upstream is optional, and a mount with neither is the pure public gate). The coupling is structural, so a mirrored mount without a readable private leg is unrepresentable.

Constructors

Mirrored MirroredLegs	The mount mirrors admitted public artifacts; both legs are required.
ServeOnly (Maybe RegistryUrl)	The mount never writes; the optional private upstream is still merged when present.

Instances

Instances details

Show MountMode Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MountMode -> ShowS # show :: MountMode -> String # showList :: [MountMode] -> ShowS #
Eq MountMode Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: MountMode -> MountMode -> Bool # (/=) :: MountMode -> MountMode -> Bool #

data MirroredLegs Source #

A mirrored mount's two required halves: the readable private upstream and the mirror target married to its derived write credential.

Constructors

MirroredLegs
Fields mlPrivateUpstream :: RegistryUrl mlMirrorTarget :: MirrorTarget

Instances

Instances details

Show MirroredLegs Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MirroredLegs -> ShowS # show :: MirroredLegs -> String # showList :: [MirroredLegs] -> ShowS #
Eq MirroredLegs Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: MirroredLegs -> MirroredLegs -> Bool # (/=) :: MirroredLegs -> MirroredLegs -> Bool #

regPrivateUpstream :: MountRegistries -> Maybe RegistryUrl Source #

The mount's private upstream, when it has one: total over both modes, so call sites read as before while the compiler makes them face the serve-only absence.

regMirrorTarget :: MountRegistries -> Maybe MirrorTarget Source #

The mount's mirror target (with its derived credential), when it mirrors.

data MirrorTarget Source #

Constructors

MirrorTarget
Fields mtUrl :: RegistryUrl mtCredential :: MirrorCredential

Instances

Instances details

Show MirrorTarget Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> MirrorTarget -> ShowS # show :: MirrorTarget -> String # showList :: [MirrorTarget] -> ShowS #
Eq MirrorTarget Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: MirrorTarget -> MirrorTarget -> Bool # (/=) :: MirrorTarget -> MirrorTarget -> Bool #

data Mount Source #

Constructors

Mount
Fields mountEcosystem :: Ecosystem mountRegistries :: MountRegistries mountPolicy :: [PrecededRule]

Instances

Instances details

Show Mount Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> Mount -> ShowS # show :: Mount -> String # showList :: [Mount] -> ShowS #
Eq Mount Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: Mount -> Mount -> Bool # (/=) :: Mount -> Mount -> Bool #

type MountMap = Map Ecosystem Mount Source #

data Config Source #

Constructors

Config
Fields configApp :: AppConfig configMounts :: MountMap

Instances

Instances details

Show Config Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Eq Config Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #

data ConfigError Source #

Constructors

ParseError Text
PolicyErrors [PolicyError]
PublicUrlRequired	A mount is active but `server.publicUrl` is unset. Served artifact URLs must be rewritten against the proxy's own externally-reachable base URL; a relative `dist.tarball` reads to the npm CLI as a `file:` path and every install fails, so the omission is refused at boot rather than discovered client by client. Host-header derivation is deliberately not offered (a spoofed header would poison every shared-cache entry with an attacker-chosen artifact URL).
MountMissingPrivateUpstream Ecosystem	A mirrored mount (one that declares a `mirrorTarget`) does not define its private upstream. The mirror write must be readable back through the private leg, so a mirrored mount without one is refused; a serve-only mount (no `mirrorTarget`) never raises this.
MirrorSettingWithoutWrite Ecosystem Text	A serve-only mount (no `mirrorTarget` declared) carries a mirror-write setting anyway. A write credential or token duration on a mount that never writes signals a misunderstanding (most likely a missing `mirrorTarget`), so it is refused per offending key rather than silently ignored. Carries the mount's ecosystem and the offending document key.
MirrorCredentialTokenMissing Ecosystem	An active mount's mirror target is not a CodeArtifact endpoint (whose write token would be minted), so it needs an explicit static write token, and none was supplied. Carries the mount's ecosystem.
MirrorCredentialConflict Ecosystem	An active mount's mirror target is a CodeArtifact endpoint (its write token is minted automatically from the host identity) yet a static write token was also supplied. Refused so the two credential sources can never silently contend. Carries the mount's ecosystem.

Instances

Instances details

Show ConfigError Source #
Instance details Defined in Ecluse.Config.Types Methods showsPrec :: Int -> ConfigError -> ShowS # show :: ConfigError -> String # showList :: [ConfigError] -> ShowS #
Eq ConfigError Source #
Instance details Defined in Ecluse.Config.Types Methods (==) :: ConfigError -> ConfigError -> Bool # (/=) :: ConfigError -> ConfigError -> Bool #

renderConfigError :: ConfigError -> Text Source #