@serve.zone/interfaces 32.59.0 → 32.61.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.smartconfig.json +4 -2
- package/changelog.md +87 -0
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/data/delegatedadmintoken.d.ts +142 -0
- package/dist_ts/data/delegatedadmintoken.js +197 -0
- package/dist_ts/data/externalregistry.d.ts +37 -1
- package/dist_ts/data/gateway.d.ts +23 -4
- package/dist_ts/data/gateway.js +1 -1
- package/dist_ts/data/index.d.ts +2 -0
- package/dist_ts/data/index.js +3 -1
- package/dist_ts/data/launchersecretowner.d.ts +60 -0
- package/dist_ts/data/launchersecretowner.js +94 -0
- package/dist_ts/data/secret.d.ts +67 -1
- package/dist_ts/data/secret.js +59 -6
- package/dist_ts/data/serviceruntime.d.ts +9 -2
- package/dist_ts/data/serviceruntime.js +2 -1
- package/dist_ts/platform/objectstorageenvironment.d.ts +12 -3
- package/dist_ts/platform/objectstorageenvironment.js +22 -6
- package/dist_ts/requests/admin.d.ts +52 -0
- package/dist_ts/requests/externalregistry.d.ts +12 -6
- package/dist_ts/requests/identity.d.ts +4 -0
- package/dist_ts/requests/service.d.ts +16 -1
- package/package.json +5 -8
- package/readme.md +76 -12
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/data/delegatedadmintoken.ts +282 -0
- package/ts/data/externalregistry.ts +60 -2
- package/ts/data/gateway.ts +24 -3
- package/ts/data/index.ts +2 -0
- package/ts/data/launchersecretowner.ts +145 -0
- package/ts/data/secret.ts +103 -7
- package/ts/data/serviceruntime.ts +9 -1
- package/ts/platform/objectstorageenvironment.ts +26 -8
- package/ts/requests/admin.ts +51 -0
- package/ts/requests/externalregistry.ts +12 -6
- package/ts/requests/identity.ts +4 -0
- package/ts/requests/service.ts +16 -1
package/.smartconfig.json
CHANGED
|
@@ -47,8 +47,10 @@
|
|
|
47
47
|
}
|
|
48
48
|
}
|
|
49
49
|
},
|
|
50
|
-
"@git.zone/
|
|
51
|
-
"
|
|
50
|
+
"@git.zone/tsrepo": {
|
|
51
|
+
"docs": {
|
|
52
|
+
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license.md](license.md) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
53
|
+
}
|
|
52
54
|
},
|
|
53
55
|
"@ship.zone/szci": {}
|
|
54
56
|
}
|
package/changelog.md
CHANGED
|
@@ -1,5 +1,92 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 2026-10-21 - 32.61.0
|
|
4
|
+
|
|
5
|
+
### Features
|
|
6
|
+
|
|
7
|
+
- Delegated admin temp tokens (`data.delegatedAdminTokenContract`): a human administrator who signed in within five minutes mints a token for explicit scopes, which lives one hour by default and at most one hour (`defaultLifetimeMs`, `maximumLifetimeMs`, `minimumLifetimeMs` one minute) and is never extended. `delegatedAdminTokenScopes` is the allowlist (`secrets`, `serviceCredentials`) and `delegatedAdminTokenScopeRequests` names exactly the wire methods each admits (typed as `TDelegatedAdminTokenScopeRequest`, judged by `isDelegatedAdminTokenScopeRequest`): `secrets` the operator-managed secret lifecycle (`getSecretIngressRecipient`, `listSecrets`, `getSecretMetadata`, `createSecret`, `rotateSecret`, `changeSecretLifecycle` with the actions `delegatedAdminTokenSecretLifecycleActions` names, `retire` and `revoke` of a granted key, never `delete`), `serviceCredentials` the service platform credential (`getServiceMachineCredential`, `mutateServiceMachineCredential`). A mint may grant `secretKeyPrefixes` (only with `secrets`, at most `maximumSecretKeyPrefixes` 16, each `isDelegatableSecretKeyPrefix`: `^[A-Z][A-Z0-9]*_$` and overlapping no reserved name either way, so a granted prefix is application-specific such as `GITSYNC_`, and `GIT_`, `NPM_` or `AWS_` are refused), under which alone the token creates, rotates, retires and revokes secrets (`isDelegatedSecretKey`); a token without prefixes does none of these. A token creates a secret only as a launcher-environment variable, never as a file. New requests `requests.admin.IReq_Admin_MintDelegatedAdminToken` (`mintDelegatedAdminToken`: `IDelegatedAdminTokenMint`, i.e. `scopes`, optional `lifetimeMs` and `secretKeyPrefixes`; answers the token once with its metadata), `IReq_Admin_GetDelegatedAdminTokens` (`getDelegatedAdminTokens`: the active tokens, value-free, newest first, at most `maximumListedTokens`, with `truncated`) and `IReq_Admin_RevokeDelegatedAdminToken` (`revokeDelegatedAdminToken`: by `tokenId`, any administrator), with value-free `IDelegatedAdminTokenMetadata` (scopes and `secretKeyPrefixes` included), refusals `delegatedAdminTokenRefusals` as `IDelegatedAdminTokenErrorData`, the exact token form `delegatedAdminToken_<tokenId>_<secret>` (`isDelegatedAdminToken`, `isDelegatedAdminTokenId`, `isDelegatedAdminTokenLifetime`) and exact-key snapshots (`snapshotDelegatedAdminTokenMint`, `snapshotDelegatedAdminTokenMetadata`, `snapshotDelegatedAdminTokenMintResult`). `getIdentityByToken` documents the session a token is exchanged for (`type: 'machine'`, `role: 'api'`, `userId: 'delegated-admin-token:<tokenId>'`). Specs: `test.delegatedadmintoken` (lifetime cap and token form, the scope and request lists and the delegated lifecycle actions, canonical scopes and exact keys, the token answered only by a mint, metadata without any value and with whole revocation, reserved names, grantable prefixes and delegated keys, named refusals).
|
|
8
|
+
- Reserved secret names (`data.secret`): `platformReservedSecretKeyPrefixes` (`SERVEZONE_`, the names the platform injects), `runtimeInjectionSecretKeyPrefixes` (`LD_`, `DYLD_`, `NODE_`, `DENO_`, `BUN_`, `PYTHON`, `PERL`, `RUBY`, `PHP`, `JAVA_`, `JDK_`, `_JAVA_`, `DOTNET_`, `CORECLR_`, `LUA_`, `GEM_`, `BUNDLE_`, `NPM_CONFIG_`, `PIP_`, `GLIBC_`, `MALLOC_`, `GCONV_`, `OPENSSL_`, `SSL_`, `CURL_`, `REQUESTS_`, `GIT_`), `runtimeInjectionSecretKeys` (`PATH`, `HOME`, `SHELL`, `ENV`, `BASH_ENV`, `IFS`, `TMPDIR`, `LOCPATH`, `NLSPATH`, `CLASSPATH`, `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`, `NO_PROXY`, `FTP_PROXY`, `AWS_CA_BUNDLE`, `SSLKEYLOGFILE`) and `isReservedSecretKey`. A delegated admin token never writes, retires or revokes such a name; human administrators are not restricted by them yet. The existing key pattern (`^[A-Z_][A-Z0-9_]{0,252}$`) admits a leading underscore, so `_JAVA_*` names exist and are covered.
|
|
9
|
+
|
|
10
|
+
### Fixes
|
|
11
|
+
|
|
12
|
+
- Gateway route DNS no longer claims manual records (AGL-523): the `reconcile` mode documentation (`data.TGatewayRouteDnsMode`) now says a gateway creates, updates and deletes only the exact-host A or AAAA record its route ownership holds and never adopts, replaces or deletes a record without gateway DNS ownership. Manual records satisfy a route only when no record at the name is owned and every manual A or AAAA record there matches the desired type, value and proxied flag; a differing record, any CNAME, owned and manual records together, or an operator-protected hostname is a non-retryable `record-conflict` with no mutation. While another enabled route on the gateway still serves the hostname, a withdrawn route releases its record to manual ownership instead of deleting it. `data.TGatewayRouteDnsStatus` gains `manual-satisfied` (every manual record matches; the gateway changes and claims nothing and reports them with `managed: false`) and `managed-released` (the record was released instead of deleted and is reported with `managed: false`); `managed-overwrote-manual`, `managed-orphan-deleted` and `IGatewayRouteDnsResult.overwrittenRecords` are deprecated, as no gateway reports them.
|
|
13
|
+
|
|
14
|
+
### Maintenance
|
|
15
|
+
|
|
16
|
+
- Release tooling: `@git.zone/tsrepo` ^1.1.1 replaces tsbuild, tstest, tsrun and tsdoc (deprecated in its favour): the scripts call `tsrepo build tsfolders`, `tsrepo test` and `tsrepo docs`, the specs import `@git.zone/tsrepo/tapbundle`, and the `.smartconfig.json` section `@git.zone/tsdoc` moved to `"@git.zone/tsrepo"` `docs`. `@types/node` 26.6.5 and pnpm 12.13.0 are current.
|
|
17
|
+
|
|
18
|
+
## 2026-10-20 - 32.60.0
|
|
19
|
+
|
|
20
|
+
### Fixes
|
|
21
|
+
|
|
22
|
+
- External registry reads stop carrying the credential the server must never send. Every
|
|
23
|
+
`requests.externalRegistry` response (`getExternalRegistryById`, `getExternalRegistries`,
|
|
24
|
+
`createExternalRegistry`, `updateExternalRegistry`, `verifyExternalRegistry`) now answers
|
|
25
|
+
`data.IExternalRegistryPublic`: the registry without `data.password` and with a required
|
|
26
|
+
`passwordConfigured`. `IExternalRegistry` stays the stored shape, and its `data.password` is
|
|
27
|
+
documented as write-only.
|
|
28
|
+
- `IReq_UpdateRegistry.request.registryData` is a `Partial` of the operator fields
|
|
29
|
+
(`TExternalRegistryOperatorData`, names in `TExternalRegistryOperatorField`): status, last error
|
|
30
|
+
and timestamps belong to Cloudly and can no longer be sent. A missing or empty `password` keeps
|
|
31
|
+
the stored one; `authType: 'none'` removes it.
|
|
32
|
+
- `IReq_VerifyRegistry.response` carries a required `outcome` (`TExternalRegistryVerifyOutcome`:
|
|
33
|
+
`authenticated`, `anonymous`, `credentials-not-exercised`, `authentication-failed`,
|
|
34
|
+
`unreachable`, `unsupported`) and a required `registry`, so a registry that answers anonymously
|
|
35
|
+
no longer reads as verified credentials.
|
|
36
|
+
|
|
37
|
+
### Features
|
|
38
|
+
|
|
39
|
+
- `composeObjectStorageServiceEnvironment(serviceEnvironment, sources, secretEnvironmentNames?)`:
|
|
40
|
+
the names, without values, of the variables the workload receives as launcher-environment
|
|
41
|
+
secrets. The launcher sets a secret over a plain variable of the same name, so a secret named
|
|
42
|
+
like one of a binding's names (`objectStorageBindingEnvironmentKeys`, such as `S3_ENDPOINT`)
|
|
43
|
+
would silently replace the binding's value; it is refused as
|
|
44
|
+
`objectstorage-environment-conflict`, exactly as the same name in the service's own environment
|
|
45
|
+
is, and the message names it as a secret. Other secret names, including the binding's own
|
|
46
|
+
credentials (`corestoreObjectStorageCredentialSecretKeys`), are not conflicts. Omitted, the
|
|
47
|
+
composition treats the workload as receiving none; the input becomes required in the coordinated
|
|
48
|
+
major.
|
|
49
|
+
- `IRequest_Any_Cloudly_UpdateService.request.serviceData` is a
|
|
50
|
+
`Partial<TServiceUpdateWritableData>`, matching the merge Cloudly performs: an omitted key keeps
|
|
51
|
+
its stored value, a stated key replaces it whole, and `containerArgs: null` removes the stored
|
|
52
|
+
argument vector. A client sends only the fields it changes, so an edit no longer has to restate
|
|
53
|
+
`placement` or `scaleFactor`, which a service with a runtime spec (and an immutable service)
|
|
54
|
+
refuses whenever an update states them. The full shape still type-checks, so existing callers
|
|
55
|
+
compile unchanged.
|
|
56
|
+
- `deriveLauncherSecretDeliveryOwner({ runAs, imageUsers, launcherDeliveries })` (`data`): the one
|
|
57
|
+
rule for the owner of a workload's launcher-environment secret files, which WorkloadInit reads as
|
|
58
|
+
the workload's own process identity. A `runAs` pair wins; under `runAs: null` an image without a
|
|
59
|
+
user is `0:0`, a numeric `user:group` is taken as stated, `root` stands for `0`, and a numeric
|
|
60
|
+
user without a group or with a named group is `user:0` while every launcher delivery is `0o400`.
|
|
61
|
+
`imageUsers` is Cloudly's canonical image user (`parseCanonicalImageUser`), one per platform of
|
|
62
|
+
the pinned digest; group readability is computed from `launcherDeliveries`. A named user, a
|
|
63
|
+
numeric part above the identity bound, a `0o440` delivery whose group the image does not state
|
|
64
|
+
numerically (the refusal names it in `variableName`), or platforms that derive different owners
|
|
65
|
+
refuse as the new service runtime refusal `launcher-secret-ownership-unknown`
|
|
66
|
+
(`TLauncherSecretDeliveryOwner`, with a `message`); a workload without launcher deliveries is
|
|
67
|
+
`not-required`. An image running as a non-root user is no longer handed secret files it cannot
|
|
68
|
+
read. Only a structurally malformed input throws.
|
|
69
|
+
- A resolved secret manifest's deliveries are their own type, `TSecretResolvedDelivery`, whose
|
|
70
|
+
launcher member `ISecretResolvedLauncherEnvironmentDelivery` requires `uid` and `gid`: the owner
|
|
71
|
+
the resolver derived, under the same keys, so the manifest's wire format and digest do not change
|
|
72
|
+
and every node keeps mounting it. `IResolvedSecretManifestEntry.delivery` is that type,
|
|
73
|
+
`validateSecretResolvedDelivery` checks it (`validateResolvedSecretManifest` uses it), and
|
|
74
|
+
`createResolvedSecretDelivery(delivery, owner)` builds it from a caller's delivery and the derived
|
|
75
|
+
owner.
|
|
76
|
+
|
|
77
|
+
### Deprecations
|
|
78
|
+
|
|
79
|
+
- `ISecretLauncherEnvironmentDelivery`, the launcher delivery a caller states (a Secret's
|
|
80
|
+
`defaultDelivery`, a SecretSet attachment override, a create request, an App Store declaration),
|
|
81
|
+
makes `uid` and `gid` optional and deprecated: the resolver ignores them and writes the derived
|
|
82
|
+
owner into the resolved delivery. `validateSecretDelivery` prefers neither and tolerates both
|
|
83
|
+
(bounded) until the next major, which removes them; a sealed context that states them still
|
|
84
|
+
verifies. File deliveries keep their stated owner.
|
|
85
|
+
|
|
86
|
+
### Maintenance
|
|
87
|
+
|
|
88
|
+
- Release tooling: pnpm 12.13.0; the other build and test tooling is current.
|
|
89
|
+
|
|
3
90
|
## 2026-10-18 - 32.59.0
|
|
4
91
|
|
|
5
92
|
### Features
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@serve.zone/interfaces',
|
|
6
|
-
version: '32.
|
|
6
|
+
version: '32.61.0',
|
|
7
7
|
description: 'Shared TypeScript interfaces and TypedRequest contracts for the serve.zone ecosystem.'
|
|
8
8
|
};
|
|
9
9
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx3QkFBd0I7SUFDOUIsT0FBTyxFQUFFLFNBQVM7SUFDbEIsV0FBVyxFQUFFLHVGQUF1RjtDQUNyRyxDQUFBIn0=
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A delegated administrator token (a "temp token") hands an agent a narrow, short-lived slice of
|
|
3
|
+
* one human administrator's authority, without the administrator's password or session.
|
|
4
|
+
*
|
|
5
|
+
* - Only a human administrator who signed in within five minutes mints one
|
|
6
|
+
* (`mintDelegatedAdminToken`), for scopes named explicitly from `delegatedAdminTokenScopes`.
|
|
7
|
+
* The plaintext token is answered exactly once; Cloudly stores only its hash.
|
|
8
|
+
* - It is exchanged with `getIdentityByToken` for a session that only the requests of its scopes
|
|
9
|
+
* (`delegatedAdminTokenScopeRequests`) admit. Every such request re-reads the token, so the
|
|
10
|
+
* session carries no validity of its own, and acts as `<administrator> via temp token <id>`.
|
|
11
|
+
* - It ends at its expiry, at most `maximumLifetimeMs` after the mint and never extended; when any
|
|
12
|
+
* administrator revokes it; or when the minting administrator's credential generation changes.
|
|
13
|
+
* - A delegated session never mints, lists or revokes tokens, and no scope reaches users, roles,
|
|
14
|
+
* human credentials, deployment tokens, authority records or organization membership.
|
|
15
|
+
*/
|
|
16
|
+
export declare const delegatedAdminTokenContract: Readonly<{
|
|
17
|
+
/** The lifetime a mint that names none receives. */
|
|
18
|
+
defaultLifetimeMs: number;
|
|
19
|
+
/** The hard cap: a token lives at most one hour from its mint and is never extended. */
|
|
20
|
+
maximumLifetimeMs: number;
|
|
21
|
+
minimumLifetimeMs: number;
|
|
22
|
+
/** Every token is `delegatedAdminToken_<tokenId>_<secret>`, both parts 64 lowercase hex. */
|
|
23
|
+
tokenPrefix: "delegatedAdminToken_";
|
|
24
|
+
/** Tokens one listing reports at most, newest first; a listing that leaves any out says so. */
|
|
25
|
+
maximumListedTokens: 256;
|
|
26
|
+
/** Secret key prefixes one token is granted at most. */
|
|
27
|
+
maximumSecretKeyPrefixes: 16;
|
|
28
|
+
}>;
|
|
29
|
+
/**
|
|
30
|
+
* What a token may be minted for. Each scope admits exactly the requests
|
|
31
|
+
* `delegatedAdminTokenScopeRequests` names for it, and nothing else does.
|
|
32
|
+
*
|
|
33
|
+
* - `secrets`: the operator-managed secrets of services and SecretSets: list and read their
|
|
34
|
+
* metadata and read the ingress recipient a value is sealed to; create, rotate, retire and revoke
|
|
35
|
+
* those whose key starts with a prefix the token was granted (`secretKeyPrefixes`, see
|
|
36
|
+
* `isDelegatedSecretKey`; `changeSecretLifecycle` only with the actions
|
|
37
|
+
* `delegatedAdminTokenSecretLifecycleActions` names, never `delete`). A token creates a secret
|
|
38
|
+
* only as a launcher-environment variable, never as a file. A token minted without prefixes
|
|
39
|
+
* creates, rotates, retires and revokes nothing.
|
|
40
|
+
* - `serviceCredentials`: a service's platform credential (`SERVEZONE_PLATFORM_AUTHORIZATION`):
|
|
41
|
+
* inspect, ensure, rotate and revoke it.
|
|
42
|
+
*/
|
|
43
|
+
export declare const delegatedAdminTokenScopes: readonly ['secrets', 'serviceCredentials'];
|
|
44
|
+
export type TDelegatedAdminTokenScope = typeof delegatedAdminTokenScopes[number];
|
|
45
|
+
/** The exact requests each scope admits a delegated session on, by their wire method names. */
|
|
46
|
+
export declare const delegatedAdminTokenScopeRequests: Readonly<{
|
|
47
|
+
secrets: readonly ["getSecretIngressRecipient", "listSecrets", "getSecretMetadata", "createSecret", "rotateSecret", "changeSecretLifecycle"];
|
|
48
|
+
serviceCredentials: readonly ["getServiceMachineCredential", "mutateServiceMachineCredential"];
|
|
49
|
+
}>;
|
|
50
|
+
/** A request one scope admits, by its wire method name. */
|
|
51
|
+
export type TDelegatedAdminTokenScopeRequest<TScope extends TDelegatedAdminTokenScope = TDelegatedAdminTokenScope> = (typeof delegatedAdminTokenScopeRequests)[TScope][number];
|
|
52
|
+
/** Whether `scopeArg` admits the request a wire method names. */
|
|
53
|
+
export declare const isDelegatedAdminTokenScopeRequest: <TScope extends TDelegatedAdminTokenScope>(scopeArg: TScope, methodArg: unknown) => methodArg is TDelegatedAdminTokenScopeRequest<TScope>;
|
|
54
|
+
/**
|
|
55
|
+
* The `changeSecretLifecycle` actions the `secrets` scope delegates, each only for a secret whose key
|
|
56
|
+
* the token's grant covers (`isDelegatedSecretKey`). Deleting a secret stays with a human
|
|
57
|
+
* administrator: a delegated session asking for it is refused like a request outside its scope.
|
|
58
|
+
*/
|
|
59
|
+
export declare const delegatedAdminTokenSecretLifecycleActions: readonly ["retire", "revoke"];
|
|
60
|
+
/** One token, value-free. Neither the token nor its hash is ever part of it. */
|
|
61
|
+
export interface IDelegatedAdminTokenMetadata {
|
|
62
|
+
/** 64 lowercase hex; the part of the token that names it. */
|
|
63
|
+
tokenId: string;
|
|
64
|
+
/** The human administrator who minted the token and whom every use acts for. */
|
|
65
|
+
userId: string;
|
|
66
|
+
/** Distinct, in `delegatedAdminTokenScopes` order. */
|
|
67
|
+
scopes: TDelegatedAdminTokenScope[];
|
|
68
|
+
/**
|
|
69
|
+
* The secret key prefixes the token creates, rotates, retires and revokes secrets under, sorted
|
|
70
|
+
* and distinct; empty when it was granted none. Only a token with the `secrets` scope carries any.
|
|
71
|
+
*/
|
|
72
|
+
secretKeyPrefixes: string[];
|
|
73
|
+
createdAt: number;
|
|
74
|
+
expiresAt: number;
|
|
75
|
+
/** When an administrator revoked the token; `null` while it was never revoked. */
|
|
76
|
+
revokedAt: number | null;
|
|
77
|
+
/** The administrator who revoked it; `null` exactly when `revokedAt` is. */
|
|
78
|
+
revokedBy: string | null;
|
|
79
|
+
}
|
|
80
|
+
/** What a mint states besides the administrator's identity. */
|
|
81
|
+
export interface IDelegatedAdminTokenMint {
|
|
82
|
+
scopes: TDelegatedAdminTokenScope[];
|
|
83
|
+
/** Absent: `defaultLifetimeMs`. Otherwise within `minimumLifetimeMs` and `maximumLifetimeMs`. */
|
|
84
|
+
lifetimeMs?: number;
|
|
85
|
+
/**
|
|
86
|
+
* The secret key prefixes the token may create, rotate, retire and revoke secrets under, each
|
|
87
|
+
* `isDelegatableSecretKeyPrefix`, distinct, at most `maximumSecretKeyPrefixes`; only with the
|
|
88
|
+
* `secrets` scope. Prefixes must be application-specific (`GITSYNC_`): a prefix that overlaps a
|
|
89
|
+
* reserved name is refused. Absent or empty: the token creates, rotates, retires and revokes
|
|
90
|
+
* nothing.
|
|
91
|
+
*/
|
|
92
|
+
secretKeyPrefixes?: string[];
|
|
93
|
+
}
|
|
94
|
+
export interface IDelegatedAdminTokenMintResult {
|
|
95
|
+
/** The plaintext token, answered on this answer only; Cloudly keeps only its hash. */
|
|
96
|
+
token: string;
|
|
97
|
+
metadata: IDelegatedAdminTokenMetadata;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Every refusal the token requests name, as `IDelegatedAdminTokenErrorData`.
|
|
101
|
+
*
|
|
102
|
+
* - `ADMIN_AUTHORIZATION_REQUIRED`: a mint by anyone but a human administrator who signed in
|
|
103
|
+
* within five minutes, or a listing or revocation by anyone but an administrator. A delegated
|
|
104
|
+
* session is refused here on every request.
|
|
105
|
+
* - `DELEGATED_ADMIN_TOKEN_REQUEST_INVALID`: the request does not satisfy this contract.
|
|
106
|
+
* - `DELEGATED_ADMIN_TOKEN_NOT_FOUND`: no token has that id.
|
|
107
|
+
* - `DELEGATED_ADMIN_TOKEN_INACTIVE`: the token already ended: it expired, was revoked, or its
|
|
108
|
+
* administrator is no longer a human administrator at the credential generation it was minted
|
|
109
|
+
* under.
|
|
110
|
+
*/
|
|
111
|
+
export declare const delegatedAdminTokenRefusals: readonly ['ADMIN_AUTHORIZATION_REQUIRED', 'DELEGATED_ADMIN_TOKEN_REQUEST_INVALID', 'DELEGATED_ADMIN_TOKEN_NOT_FOUND', 'DELEGATED_ADMIN_TOKEN_INACTIVE'];
|
|
112
|
+
export type TDelegatedAdminTokenRefusal = typeof delegatedAdminTokenRefusals[number];
|
|
113
|
+
export interface IDelegatedAdminTokenErrorData {
|
|
114
|
+
code: TDelegatedAdminTokenRefusal;
|
|
115
|
+
retryable: false;
|
|
116
|
+
}
|
|
117
|
+
/** Whether a value is a delegated admin token in its exact form; it proves nothing else. */
|
|
118
|
+
export declare const isDelegatedAdminToken: (value: unknown) => value is string;
|
|
119
|
+
/** Whether a value names a token: 64 lowercase hex. */
|
|
120
|
+
export declare const isDelegatedAdminTokenId: (value: unknown) => value is string;
|
|
121
|
+
/**
|
|
122
|
+
* Whether a prefix may be granted: `^[A-Z][A-Z0-9]*_$`, and overlapping no reserved name in
|
|
123
|
+
* either direction: it neither starts with nor is the start of an entry of
|
|
124
|
+
* `platformReservedSecretKeyPrefixes` or `runtimeInjectionSecretKeyPrefixes`, and no entry of
|
|
125
|
+
* `runtimeInjectionSecretKeys` starts with it. So a granted prefix is application-specific:
|
|
126
|
+
* `GIT_`, `NODE_`, `NPM_` and `AWS_` (`AWS_CA_BUNDLE`) are refused; `GITSYNC_` is not.
|
|
127
|
+
*/
|
|
128
|
+
export declare const isDelegatableSecretKeyPrefix: (value: unknown) => value is string;
|
|
129
|
+
/**
|
|
130
|
+
* Whether a token granted `prefixesArg` creates, rotates, retires or revokes a secret of key
|
|
131
|
+
* `keyArg`, or delivers a launcher variable of that name: the key starts with a granted prefix and
|
|
132
|
+
* is not reserved (`isReservedSecretKey`).
|
|
133
|
+
*/
|
|
134
|
+
export declare const isDelegatedSecretKey: (prefixesArg: readonly string[], keyArg: string) => boolean;
|
|
135
|
+
/** Whether a lifetime is one a mint may state. */
|
|
136
|
+
export declare const isDelegatedAdminTokenLifetime: (value: unknown) => value is number;
|
|
137
|
+
/** Structural copy of a mint; the backend authorizes the administrator and enforces the cap. */
|
|
138
|
+
export declare const snapshotDelegatedAdminTokenMint: (value: unknown) => IDelegatedAdminTokenMint;
|
|
139
|
+
/** Structural copy of listed or answered metadata. */
|
|
140
|
+
export declare const snapshotDelegatedAdminTokenMetadata: (value: unknown) => IDelegatedAdminTokenMetadata;
|
|
141
|
+
/** Structural copy of a mint's answer: a token in its exact form and the metadata that names it. */
|
|
142
|
+
export declare const snapshotDelegatedAdminTokenMintResult: (value: unknown) => IDelegatedAdminTokenMintResult;
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { readDataElements, readDataProperty, readExactDataRecord } from '../private/dataproperties.js';
|
|
2
|
+
import { isReservedSecretKey, platformReservedSecretKeyPrefixes, runtimeInjectionSecretKeyPrefixes, runtimeInjectionSecretKeys, } from './secret.js';
|
|
3
|
+
/**
|
|
4
|
+
* A delegated administrator token (a "temp token") hands an agent a narrow, short-lived slice of
|
|
5
|
+
* one human administrator's authority, without the administrator's password or session.
|
|
6
|
+
*
|
|
7
|
+
* - Only a human administrator who signed in within five minutes mints one
|
|
8
|
+
* (`mintDelegatedAdminToken`), for scopes named explicitly from `delegatedAdminTokenScopes`.
|
|
9
|
+
* The plaintext token is answered exactly once; Cloudly stores only its hash.
|
|
10
|
+
* - It is exchanged with `getIdentityByToken` for a session that only the requests of its scopes
|
|
11
|
+
* (`delegatedAdminTokenScopeRequests`) admit. Every such request re-reads the token, so the
|
|
12
|
+
* session carries no validity of its own, and acts as `<administrator> via temp token <id>`.
|
|
13
|
+
* - It ends at its expiry, at most `maximumLifetimeMs` after the mint and never extended; when any
|
|
14
|
+
* administrator revokes it; or when the minting administrator's credential generation changes.
|
|
15
|
+
* - A delegated session never mints, lists or revokes tokens, and no scope reaches users, roles,
|
|
16
|
+
* human credentials, deployment tokens, authority records or organization membership.
|
|
17
|
+
*/
|
|
18
|
+
export const delegatedAdminTokenContract = Object.freeze({
|
|
19
|
+
/** The lifetime a mint that names none receives. */
|
|
20
|
+
defaultLifetimeMs: 60 * 60 * 1000,
|
|
21
|
+
/** The hard cap: a token lives at most one hour from its mint and is never extended. */
|
|
22
|
+
maximumLifetimeMs: 60 * 60 * 1000,
|
|
23
|
+
minimumLifetimeMs: 60 * 1000,
|
|
24
|
+
/** Every token is `delegatedAdminToken_<tokenId>_<secret>`, both parts 64 lowercase hex. */
|
|
25
|
+
tokenPrefix: 'delegatedAdminToken_',
|
|
26
|
+
/** Tokens one listing reports at most, newest first; a listing that leaves any out says so. */
|
|
27
|
+
maximumListedTokens: 256,
|
|
28
|
+
/** Secret key prefixes one token is granted at most. */
|
|
29
|
+
maximumSecretKeyPrefixes: 16,
|
|
30
|
+
});
|
|
31
|
+
/**
|
|
32
|
+
* What a token may be minted for. Each scope admits exactly the requests
|
|
33
|
+
* `delegatedAdminTokenScopeRequests` names for it, and nothing else does.
|
|
34
|
+
*
|
|
35
|
+
* - `secrets`: the operator-managed secrets of services and SecretSets: list and read their
|
|
36
|
+
* metadata and read the ingress recipient a value is sealed to; create, rotate, retire and revoke
|
|
37
|
+
* those whose key starts with a prefix the token was granted (`secretKeyPrefixes`, see
|
|
38
|
+
* `isDelegatedSecretKey`; `changeSecretLifecycle` only with the actions
|
|
39
|
+
* `delegatedAdminTokenSecretLifecycleActions` names, never `delete`). A token creates a secret
|
|
40
|
+
* only as a launcher-environment variable, never as a file. A token minted without prefixes
|
|
41
|
+
* creates, rotates, retires and revokes nothing.
|
|
42
|
+
* - `serviceCredentials`: a service's platform credential (`SERVEZONE_PLATFORM_AUTHORIZATION`):
|
|
43
|
+
* inspect, ensure, rotate and revoke it.
|
|
44
|
+
*/
|
|
45
|
+
export const delegatedAdminTokenScopes = ['secrets', 'serviceCredentials'];
|
|
46
|
+
/** The exact requests each scope admits a delegated session on, by their wire method names. */
|
|
47
|
+
export const delegatedAdminTokenScopeRequests = Object.freeze({
|
|
48
|
+
secrets: Object.freeze([
|
|
49
|
+
'getSecretIngressRecipient', 'listSecrets', 'getSecretMetadata', 'createSecret', 'rotateSecret',
|
|
50
|
+
'changeSecretLifecycle',
|
|
51
|
+
]),
|
|
52
|
+
serviceCredentials: Object.freeze(['getServiceMachineCredential', 'mutateServiceMachineCredential']),
|
|
53
|
+
});
|
|
54
|
+
/** Whether `scopeArg` admits the request a wire method names. */
|
|
55
|
+
export const isDelegatedAdminTokenScopeRequest = (scopeArg, methodArg) => (delegatedAdminTokenScopeRequests[scopeArg].includes(methodArg));
|
|
56
|
+
/**
|
|
57
|
+
* The `changeSecretLifecycle` actions the `secrets` scope delegates, each only for a secret whose key
|
|
58
|
+
* the token's grant covers (`isDelegatedSecretKey`). Deleting a secret stays with a human
|
|
59
|
+
* administrator: a delegated session asking for it is refused like a request outside its scope.
|
|
60
|
+
*/
|
|
61
|
+
export const delegatedAdminTokenSecretLifecycleActions = Object.freeze(['retire', 'revoke']);
|
|
62
|
+
/**
|
|
63
|
+
* Every refusal the token requests name, as `IDelegatedAdminTokenErrorData`.
|
|
64
|
+
*
|
|
65
|
+
* - `ADMIN_AUTHORIZATION_REQUIRED`: a mint by anyone but a human administrator who signed in
|
|
66
|
+
* within five minutes, or a listing or revocation by anyone but an administrator. A delegated
|
|
67
|
+
* session is refused here on every request.
|
|
68
|
+
* - `DELEGATED_ADMIN_TOKEN_REQUEST_INVALID`: the request does not satisfy this contract.
|
|
69
|
+
* - `DELEGATED_ADMIN_TOKEN_NOT_FOUND`: no token has that id.
|
|
70
|
+
* - `DELEGATED_ADMIN_TOKEN_INACTIVE`: the token already ended: it expired, was revoked, or its
|
|
71
|
+
* administrator is no longer a human administrator at the credential generation it was minted
|
|
72
|
+
* under.
|
|
73
|
+
*/
|
|
74
|
+
export const delegatedAdminTokenRefusals = [
|
|
75
|
+
'ADMIN_AUTHORIZATION_REQUIRED',
|
|
76
|
+
'DELEGATED_ADMIN_TOKEN_REQUEST_INVALID',
|
|
77
|
+
'DELEGATED_ADMIN_TOKEN_NOT_FOUND',
|
|
78
|
+
'DELEGATED_ADMIN_TOKEN_INACTIVE',
|
|
79
|
+
];
|
|
80
|
+
const fail = () => { throw new Error('Delegated admin token contract rejected.'); };
|
|
81
|
+
function requireValue(value) { if (!value)
|
|
82
|
+
fail(); }
|
|
83
|
+
const safe = (operation) => { try {
|
|
84
|
+
return operation();
|
|
85
|
+
}
|
|
86
|
+
catch {
|
|
87
|
+
return fail();
|
|
88
|
+
} };
|
|
89
|
+
/** Exactly this shape's keys, read once as data; an accessor is refused, never invoked. */
|
|
90
|
+
const object = (value, keys) => {
|
|
91
|
+
const copy = readExactDataRecord(value, keys);
|
|
92
|
+
requireValue(copy !== null);
|
|
93
|
+
return copy;
|
|
94
|
+
};
|
|
95
|
+
const identifier = (value) => {
|
|
96
|
+
requireValue(typeof value === 'string' && /^[A-Za-z0-9][A-Za-z0-9:._-]{0,199}$/.test(value));
|
|
97
|
+
return value;
|
|
98
|
+
};
|
|
99
|
+
const timestamp = (value) => {
|
|
100
|
+
requireValue(typeof value === 'number' && Number.isSafeInteger(value) && value > 0);
|
|
101
|
+
return value;
|
|
102
|
+
};
|
|
103
|
+
const tokenIdPattern = /^[a-f0-9]{64}$/;
|
|
104
|
+
const tokenPattern = /^delegatedAdminToken_[a-f0-9]{64}_[a-f0-9]{64}$/;
|
|
105
|
+
/** Whether a value is a delegated admin token in its exact form; it proves nothing else. */
|
|
106
|
+
export const isDelegatedAdminToken = (value) => (typeof value === 'string' && tokenPattern.test(value));
|
|
107
|
+
/** Whether a value names a token: 64 lowercase hex. */
|
|
108
|
+
export const isDelegatedAdminTokenId = (value) => (typeof value === 'string' && tokenIdPattern.test(value));
|
|
109
|
+
const secretKeyPrefixPattern = /^[A-Z][A-Z0-9]*_$/;
|
|
110
|
+
/**
|
|
111
|
+
* Whether a prefix may be granted: `^[A-Z][A-Z0-9]*_$`, and overlapping no reserved name in
|
|
112
|
+
* either direction: it neither starts with nor is the start of an entry of
|
|
113
|
+
* `platformReservedSecretKeyPrefixes` or `runtimeInjectionSecretKeyPrefixes`, and no entry of
|
|
114
|
+
* `runtimeInjectionSecretKeys` starts with it. So a granted prefix is application-specific:
|
|
115
|
+
* `GIT_`, `NODE_`, `NPM_` and `AWS_` (`AWS_CA_BUNDLE`) are refused; `GITSYNC_` is not.
|
|
116
|
+
*/
|
|
117
|
+
export const isDelegatableSecretKeyPrefix = (value) => (typeof value === 'string' && value.length <= 64 && secretKeyPrefixPattern.test(value)
|
|
118
|
+
&& [...platformReservedSecretKeyPrefixes, ...runtimeInjectionSecretKeyPrefixes]
|
|
119
|
+
.every((reservedArg) => !value.startsWith(reservedArg) && !reservedArg.startsWith(value))
|
|
120
|
+
&& runtimeInjectionSecretKeys.every((reservedArg) => !reservedArg.startsWith(value)));
|
|
121
|
+
/**
|
|
122
|
+
* Whether a token granted `prefixesArg` creates, rotates, retires or revokes a secret of key
|
|
123
|
+
* `keyArg`, or delivers a launcher variable of that name: the key starts with a granted prefix and
|
|
124
|
+
* is not reserved (`isReservedSecretKey`).
|
|
125
|
+
*/
|
|
126
|
+
export const isDelegatedSecretKey = (prefixesArg, keyArg) => (prefixesArg.some((prefixArg) => keyArg.startsWith(prefixArg)) && !isReservedSecretKey(keyArg));
|
|
127
|
+
/** Whether a lifetime is one a mint may state. */
|
|
128
|
+
export const isDelegatedAdminTokenLifetime = (value) => (typeof value === 'number' && Number.isSafeInteger(value)
|
|
129
|
+
&& value >= delegatedAdminTokenContract.minimumLifetimeMs
|
|
130
|
+
&& value <= delegatedAdminTokenContract.maximumLifetimeMs);
|
|
131
|
+
/** Distinct known scopes, at least one, answered in `delegatedAdminTokenScopes` order. */
|
|
132
|
+
const scopes = (value, canonical) => {
|
|
133
|
+
const entries = readDataElements(value, delegatedAdminTokenScopes.length);
|
|
134
|
+
requireValue(entries !== null && entries.length > 0 && new Set(entries).size === entries.length
|
|
135
|
+
&& entries.every((entry) => delegatedAdminTokenScopes.some((scope) => scope === entry)));
|
|
136
|
+
const ordered = delegatedAdminTokenScopes.filter((scope) => entries.includes(scope));
|
|
137
|
+
requireValue(!canonical || ordered.every((scope, index) => entries[index] === scope));
|
|
138
|
+
return ordered;
|
|
139
|
+
};
|
|
140
|
+
/** Distinct grantable prefixes, at most the cap, answered sorted; `canonical` requires them sorted. */
|
|
141
|
+
const secretKeyPrefixes = (value, canonical) => {
|
|
142
|
+
const entries = readDataElements(value, delegatedAdminTokenContract.maximumSecretKeyPrefixes);
|
|
143
|
+
requireValue(entries !== null && new Set(entries).size === entries.length
|
|
144
|
+
&& entries.every((entry) => isDelegatableSecretKeyPrefix(entry)));
|
|
145
|
+
const prefixes = entries.slice().sort();
|
|
146
|
+
requireValue(!canonical || prefixes.every((prefix, index) => entries[index] === prefix));
|
|
147
|
+
return prefixes;
|
|
148
|
+
};
|
|
149
|
+
/** Structural copy of a mint; the backend authorizes the administrator and enforces the cap. */
|
|
150
|
+
export const snapshotDelegatedAdminTokenMint = (value) => safe(() => {
|
|
151
|
+
const namesLifetime = readDataProperty(value, 'lifetimeMs') !== null;
|
|
152
|
+
const namesPrefixes = readDataProperty(value, 'secretKeyPrefixes') !== null;
|
|
153
|
+
const mint = object(value, ['scopes', ...(namesLifetime ? ['lifetimeMs'] : []),
|
|
154
|
+
...(namesPrefixes ? ['secretKeyPrefixes'] : [])]);
|
|
155
|
+
const copy = { scopes: scopes(mint.scopes, false) };
|
|
156
|
+
if (namesLifetime) {
|
|
157
|
+
requireValue(isDelegatedAdminTokenLifetime(mint.lifetimeMs));
|
|
158
|
+
copy.lifetimeMs = mint.lifetimeMs;
|
|
159
|
+
}
|
|
160
|
+
if (namesPrefixes) {
|
|
161
|
+
const prefixes = secretKeyPrefixes(mint.secretKeyPrefixes, false);
|
|
162
|
+
requireValue(prefixes.length === 0 || copy.scopes.includes('secrets'));
|
|
163
|
+
copy.secretKeyPrefixes = prefixes;
|
|
164
|
+
}
|
|
165
|
+
return copy;
|
|
166
|
+
});
|
|
167
|
+
/** Structural copy of listed or answered metadata. */
|
|
168
|
+
export const snapshotDelegatedAdminTokenMetadata = (value) => safe(() => {
|
|
169
|
+
const metadata = object(value, ['tokenId', 'userId', 'scopes', 'secretKeyPrefixes', 'createdAt', 'expiresAt',
|
|
170
|
+
'revokedAt', 'revokedBy']);
|
|
171
|
+
requireValue(isDelegatedAdminTokenId(metadata.tokenId));
|
|
172
|
+
const createdAt = timestamp(metadata.createdAt);
|
|
173
|
+
const expiresAt = timestamp(metadata.expiresAt);
|
|
174
|
+
requireValue(expiresAt > createdAt
|
|
175
|
+
&& expiresAt - createdAt <= delegatedAdminTokenContract.maximumLifetimeMs);
|
|
176
|
+
const revoked = metadata.revokedAt !== null;
|
|
177
|
+
requireValue(revoked === (metadata.revokedBy !== null));
|
|
178
|
+
const revokedAt = revoked ? timestamp(metadata.revokedAt) : null;
|
|
179
|
+
requireValue(revokedAt === null || revokedAt >= createdAt);
|
|
180
|
+
const tokenScopes = scopes(metadata.scopes, true);
|
|
181
|
+
const prefixes = secretKeyPrefixes(metadata.secretKeyPrefixes, true);
|
|
182
|
+
requireValue(prefixes.length === 0 || tokenScopes.includes('secrets'));
|
|
183
|
+
return {
|
|
184
|
+
tokenId: metadata.tokenId, userId: identifier(metadata.userId), scopes: tokenScopes,
|
|
185
|
+
secretKeyPrefixes: prefixes, createdAt, expiresAt, revokedAt,
|
|
186
|
+
revokedBy: revoked ? identifier(metadata.revokedBy) : null,
|
|
187
|
+
};
|
|
188
|
+
});
|
|
189
|
+
/** Structural copy of a mint's answer: a token in its exact form and the metadata that names it. */
|
|
190
|
+
export const snapshotDelegatedAdminTokenMintResult = (value) => safe(() => {
|
|
191
|
+
const result = object(value, ['token', 'metadata']);
|
|
192
|
+
requireValue(isDelegatedAdminToken(result.token));
|
|
193
|
+
const metadata = snapshotDelegatedAdminTokenMetadata(result.metadata);
|
|
194
|
+
requireValue(result.token.slice(delegatedAdminTokenContract.tokenPrefix.length, delegatedAdminTokenContract.tokenPrefix.length + 64) === metadata.tokenId && metadata.revokedAt === null);
|
|
195
|
+
return { token: result.token, metadata };
|
|
196
|
+
});
|
|
197
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"delegatedadmintoken.js","sourceRoot":"","sources":["../../ts/data/delegatedadmintoken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACvG,OAAO,EACL,mBAAmB,EAAE,iCAAiC,EAAE,iCAAiC,EACzF,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,MAAM,CAAC,MAAM,CAAC;IACvD,oDAAoD;IACpD,iBAAiB,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;IACjC,wFAAwF;IACxF,iBAAiB,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;IACjC,iBAAiB,EAAE,EAAE,GAAG,IAAI;IAC5B,4FAA4F;IAC5F,WAAW,EAAE,sBAAsB;IACnC,+FAA+F;IAC/F,mBAAmB,EAAE,GAAG;IACxB,wDAAwD;IACxD,wBAAwB,EAAE,EAAE;CAC7B,CAAC,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,SAAS,EAAE,oBAAoB,CAAU,CAAC;AAIpF,+FAA+F;AAC/F,MAAM,CAAC,MAAM,gCAAgC,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5D,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,2BAA2B,EAAE,aAAa,EAAE,mBAAmB,EAAE,cAAc,EAAE,cAAc;QAC/F,uBAAuB;KACf,CAAC;IACX,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,6BAA6B,EAAE,gCAAgC,CAAU,CAAC;CAC9G,CAA0E,CAAC;AAM5E,iEAAiE;AACjE,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAC/C,QAAgB,EAChB,SAAkB,EACqC,EAAE,CAAC,CACzD,gCAAgC,CAAC,QAAQ,CAAwB,CAAC,QAAQ,CAAC,SAAS,CAAC,CACvF,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,yCAAyC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAU,CAAC,CAAC;AA4CtG;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,8BAA8B;IAC9B,uCAAuC;IACvC,iCAAiC;IACjC,gCAAgC;CACxB,CAAC;AASX,MAAM,IAAI,GAAG,GAAU,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3F,SAAS,YAAY,CAAC,KAAc,IAAmB,IAAI,CAAC,KAAK;IAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC5E,MAAM,IAAI,GAAG,CAAI,SAAkB,EAAK,EAAE,GAAG,IAAI,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;AAAC,CAAC;AAAC,MAAM,CAAC;IAAC,OAAO,IAAI,EAAE,CAAC;AAAC,CAAC,CAAC,CAAC,CAAC;AACpG,2FAA2F;AAC3F,MAAM,MAAM,GAAG,CAAC,KAAc,EAAE,IAAuB,EAA2B,EAAE;IAClF,MAAM,IAAI,GAAG,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC9C,YAAY,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC5B,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AACF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAU,EAAE;IAC5C,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,qCAAqC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,SAAS,GAAG,CAAC,KAAc,EAAU,EAAE;IAC3C,YAAY,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;IACpF,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,cAAc,GAAG,gBAAgB,CAAC;AACxC,MAAM,YAAY,GAAG,iDAAiD,CAAC;AAEvE,4FAA4F;AAC5F,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,CACxE,OAAO,KAAK,KAAK,QAAQ,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CACtD,CAAC;AAEF,uDAAuD;AACvD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,CAC1E,OAAO,KAAK,KAAK,QAAQ,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CACxD,CAAC;AAEF,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,CAC/E,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE,IAAI,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC;OAClF,CAAC,GAAG,iCAAiC,EAAE,GAAG,iCAAiC,CAAC;SAC5E,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;OACxF,0BAA0B,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CACrF,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,WAA8B,EAAE,MAAc,EAAW,EAAE,CAAC,CAC/F,WAAW,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAC9F,CAAC;AAEF,kDAAkD;AAClD,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,CAChF,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC;OACrD,KAAK,IAAI,2BAA2B,CAAC,iBAAiB;OACtD,KAAK,IAAI,2BAA2B,CAAC,iBAAiB,CAC1D,CAAC;AAEF,0FAA0F;AAC1F,MAAM,MAAM,GAAG,CAAC,KAAc,EAAE,SAAkB,EAA+B,EAAE;IACjF,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAC;IAC1E,YAAY,CAAC,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM;WAC1F,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3F,MAAM,OAAO,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACrF,YAAY,CAAC,CAAC,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;IACtF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,uGAAuG;AACvG,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAE,SAAkB,EAAY,EAAE;IACzE,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,EAAE,2BAA2B,CAAC,wBAAwB,CAAC,CAAC;IAC9F,YAAY,CAAC,OAAO,KAAK,IAAI,IAAI,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM;WACpE,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAI,OAAoB,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;IACtD,YAAY,CAAC,CAAC,SAAS,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC;IACzF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,gGAAgG;AAChG,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,KAAc,EAA4B,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACrG,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,IAAI,CAAC;IACrE,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,EAAE,mBAAmB,CAAC,KAAK,IAAI,CAAC;IAC5E,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpD,MAAM,IAAI,GAA6B,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;IAC9E,IAAI,aAAa,EAAE,CAAC;QAClB,YAAY,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACpC,CAAC;IACD,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAClE,YAAY,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC;IACpC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC,CAAC;AAEH,sDAAsD;AACtD,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,KAAc,EAAgC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IAC7G,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,mBAAmB,EAAE,WAAW,EAAE,WAAW;QAC1G,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAC7B,YAAY,CAAC,uBAAuB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAChD,MAAM,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAChD,YAAY,CAAC,SAAS,GAAG,SAAS;WAC7B,SAAS,GAAG,SAAS,IAAI,2BAA2B,CAAC,iBAAiB,CAAC,CAAC;IAC7E,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,KAAK,IAAI,CAAC;IAC5C,YAAY,CAAC,OAAO,KAAK,CAAC,QAAQ,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,YAAY,CAAC,SAAS,KAAK,IAAI,IAAI,SAAS,IAAI,SAAS,CAAC,CAAC;IAC3D,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IACrE,YAAY,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACvE,OAAO;QACL,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW;QACnF,iBAAiB,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS;QAC5D,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;KAC3D,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,oGAAoG;AACpG,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,KAAc,EAAkC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;IACjH,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IACpD,YAAY,CAAC,qBAAqB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,mCAAmC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACtE,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,2BAA2B,CAAC,WAAW,CAAC,MAAM,EAC5E,2BAA2B,CAAC,WAAW,CAAC,MAAM,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;IAC5G,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC3C,CAAC,CAAC,CAAC"}
|
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* An external registry as Cloudly stores it, credential included. Never answered: every external
|
|
3
|
+
* registry response carries `IExternalRegistryPublic`.
|
|
4
|
+
*/
|
|
1
5
|
export interface IExternalRegistry {
|
|
2
6
|
id: string;
|
|
3
7
|
data: {
|
|
@@ -18,7 +22,10 @@ export interface IExternalRegistry {
|
|
|
18
22
|
*/
|
|
19
23
|
username?: string;
|
|
20
24
|
/**
|
|
21
|
-
* Password, access token
|
|
25
|
+
* Password, access token or API key for authentication (optional for public registries).
|
|
26
|
+
*
|
|
27
|
+
* Write-only: Cloudly stores it and uses it server-side, and never answers it. Reads carry
|
|
28
|
+
* `IExternalRegistryPublic.passwordConfigured` instead.
|
|
22
29
|
*/
|
|
23
30
|
password?: string;
|
|
24
31
|
/**
|
|
@@ -90,3 +97,32 @@ export interface IExternalRegistry {
|
|
|
90
97
|
updatedAt?: number;
|
|
91
98
|
};
|
|
92
99
|
}
|
|
100
|
+
/**
|
|
101
|
+
* An external registry as Cloudly answers it: the stored registry without its credential, and
|
|
102
|
+
* whether one is stored.
|
|
103
|
+
*/
|
|
104
|
+
export interface IExternalRegistryPublic {
|
|
105
|
+
id: string;
|
|
106
|
+
data: Omit<IExternalRegistry['data'], 'password'>;
|
|
107
|
+
/** Whether a password, access token or API key is stored for the registry. */
|
|
108
|
+
passwordConfigured: boolean;
|
|
109
|
+
}
|
|
110
|
+
/** The registry fields an operator writes; Cloudly owns status, errors and timestamps. */
|
|
111
|
+
export type TExternalRegistryOperatorField = 'type' | 'name' | 'url' | 'username' | 'password' | 'description' | 'isDefault' | 'authType' | 'insecure' | 'namespace' | 'proxy' | 'config';
|
|
112
|
+
export type TExternalRegistryOperatorData = Pick<IExternalRegistry['data'], TExternalRegistryOperatorField>;
|
|
113
|
+
/**
|
|
114
|
+
* What a registry verification proved.
|
|
115
|
+
*
|
|
116
|
+
* - `authenticated`: the registry admitted the stored credentials (Basic, or a token its Bearer
|
|
117
|
+
* realm issued for them).
|
|
118
|
+
* - `anonymous`: the registry answers without authentication and none is configured.
|
|
119
|
+
* - `credentials-not-exercised`: credentials are configured, but the registry answers without
|
|
120
|
+
* authentication, so they were never checked.
|
|
121
|
+
* - `authentication-failed`: the registry, or its token realm, refused the credentials, or it
|
|
122
|
+
* requires authentication and none is configured.
|
|
123
|
+
* - `unreachable`: no usable answer (connection, TLS, timeout or an unexpected HTTP status).
|
|
124
|
+
* - `unsupported`: the registry or its configuration cannot be verified (an npm registry, OAuth2,
|
|
125
|
+
* an unknown or missing authentication challenge, a redirect, or credentials over plain HTTP
|
|
126
|
+
* without `insecure`).
|
|
127
|
+
*/
|
|
128
|
+
export type TExternalRegistryVerifyOutcome = 'authenticated' | 'anonymous' | 'credentials-not-exercised' | 'authentication-failed' | 'unreachable' | 'unsupported';
|
|
@@ -10,16 +10,32 @@ export type TManagedRouteKind = 'letsencrypt-http01-forward';
|
|
|
10
10
|
/**
|
|
11
11
|
* DNS handling requested alongside a gateway route synchronization.
|
|
12
12
|
*
|
|
13
|
-
* - 'reconcile'
|
|
14
|
-
*
|
|
13
|
+
* - 'reconcile' creates, updates and deletes the exact-host A or AAAA record
|
|
14
|
+
* the route's gateway DNS ownership holds. It never adopts, replaces or
|
|
15
|
+
* deletes a record without gateway DNS ownership. The route is satisfied by
|
|
16
|
+
* manual records only when no record at the name is owned and every manual A
|
|
17
|
+
* or AAAA record there matches the desired type, value and proxied flag (TTL
|
|
18
|
+
* ignored); anything else (a differing record, any CNAME, owned and manual
|
|
19
|
+
* records together) and an operator-protected hostname is a non-retryable
|
|
20
|
+
* `record-conflict` with no mutation. When the route stops claiming the
|
|
21
|
+
* hostname while another enabled route on the gateway serves it, the owned
|
|
22
|
+
* record is released to manual ownership instead of deleted.
|
|
15
23
|
* - 'observe' reports DNS state without mutating it.
|
|
16
24
|
* - 'skip' bypasses DNS inspection and mutation and is the default when omitted.
|
|
17
25
|
*/
|
|
18
26
|
export type TGatewayRouteDnsMode = 'reconcile' | 'observe' | 'skip';
|
|
19
27
|
/**
|
|
20
28
|
* Detailed DNS outcome reported by a gateway route synchronization.
|
|
29
|
+
*
|
|
30
|
+
* - `manual-satisfied`: every manual A or AAAA record at the name matches the desired type,
|
|
31
|
+
* value and proxied flag; the gateway changes and claims nothing and reports them in
|
|
32
|
+
* `records` with `managed: false`.
|
|
33
|
+
* - `managed-released`: the route no longer claims the hostname, but another enabled route on
|
|
34
|
+
* the gateway still serves it, so the gateway released its record to manual ownership instead
|
|
35
|
+
* of deleting it; the released record is reported in `records` with `managed: false`.
|
|
36
|
+
* - `managed-overwrote-manual` and `managed-orphan-deleted`: deprecated; no gateway reports them.
|
|
21
37
|
*/
|
|
22
|
-
export type TGatewayRouteDnsStatus = 'not-applicable' | 'skipped' | 'managed-created' | 'managed-updated' | 'managed-overwrote-manual' | 'managed-unchanged' | 'observed-satisfied' | 'managed-deleted' | 'managed-orphan-deleted' | 'record-missing' | 'target-invalid' | 'zone-unmanaged' | 'zone-unavailable' | 'record-conflict' | 'mutation-failed' | 'compensation-failed';
|
|
38
|
+
export type TGatewayRouteDnsStatus = 'not-applicable' | 'skipped' | 'managed-created' | 'managed-updated' | 'managed-overwrote-manual' | 'managed-unchanged' | 'manual-satisfied' | 'observed-satisfied' | 'managed-deleted' | 'managed-released' | 'managed-orphan-deleted' | 'record-missing' | 'target-invalid' | 'zone-unmanaged' | 'zone-unavailable' | 'record-conflict' | 'mutation-failed' | 'compensation-failed';
|
|
23
39
|
/**
|
|
24
40
|
* DNS record evidence attached to a gateway route synchronization result.
|
|
25
41
|
*/
|
|
@@ -48,7 +64,10 @@ export interface IGatewayRouteDnsResult {
|
|
|
48
64
|
zoneName?: string;
|
|
49
65
|
nameservers?: string[];
|
|
50
66
|
records?: IGatewayRouteDnsRecord[];
|
|
51
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* Prior manual records replaced by this reconciliation, preserved as evidence.
|
|
69
|
+
* @deprecated No gateway replaces manual records; it accompanied `managed-overwrote-manual`.
|
|
70
|
+
*/
|
|
52
71
|
overwrittenRecords?: IGatewayRouteDnsRecord[];
|
|
53
72
|
/** Time at which the gateway checked the DNS state, as Unix epoch milliseconds. */
|
|
54
73
|
checkedAt: number;
|
package/dist_ts/data/gateway.js
CHANGED
|
@@ -112,4 +112,4 @@ export const isGatewayClientDnsRecordAllowed = (recordArg, allowedDnsRecordAddre
|
|
|
112
112
|
return prefix !== null && ipPrefixContains(prefix, address);
|
|
113
113
|
});
|
|
114
114
|
};
|
|
115
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
115
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2F0ZXdheS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2RhdGEvZ2F0ZXdheS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBQUUsWUFBWSxFQUFFLGdCQUFnQixFQUFFLGtCQUFrQixFQUFFLE1BQU0sOEJBQThCLENBQUM7QUFDbEcsT0FBTyxFQUFFLHNCQUFzQixFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFDNUQsT0FBTyxFQUNMLGdCQUFnQixFQUNoQix1QkFBdUIsRUFDdkIsc0JBQXNCLEdBQ3ZCLE1BQU0seUJBQXlCLENBQUM7QUF5ZmpDOzs7OztHQUtHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sNkJBQTZCLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQztJQUN6RCxNQUFNLEVBQUUsRUFBRTtJQUNWLE1BQU0sRUFBRSxNQUFNO0lBQ2QsVUFBVSxFQUFFLEdBQUc7SUFDZiw0QkFBNEIsRUFBRSxFQUFFO0lBQ2hDLGNBQWMsRUFBRSxHQUFHO0lBQ25CLGlCQUFpQixFQUFFLEdBQUc7Q0FDdkIsQ0FBQyxDQUFDO0FBbUpILE1BQU0sb0JBQW9CLEdBQUcsd0NBQXdDLENBQUM7QUFDdEUsTUFBTSxZQUFZLEdBQUcsK0JBQStCLENBQUM7QUFFckQsb0dBQW9HO0FBQ3BHLE1BQU0sQ0FBQyxNQUFNLHVCQUF1QixHQUFHLENBQUMsUUFBaUIsRUFBc0IsRUFBRSxDQUFDLENBQ2hGLE9BQU8sUUFBUSxLQUFLLFFBQVE7T0FDekIsUUFBUSxDQUFDLE1BQU0sSUFBSSw2QkFBNkIsQ0FBQyxpQkFBaUI7T0FDbEUsUUFBUSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQztPQUMvQixRQUFRLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLFFBQVEsRUFBRSxFQUFFLENBQUMsb0JBQW9CLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQ2hGLENBQUM7QUFFRiw2RUFBNkU7QUFDN0UsTUFBTSxDQUFDLE1BQU0sc0NBQXNDLEdBQUcsQ0FDcEQsUUFBaUIsRUFDakIsT0FBTyxHQUFHLFdBQVcsRUFDWCxFQUFFO0lBQ1osTUFBTSxTQUFTLEdBQUcsa0JBQWtCLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDL0MsSUFBSSxTQUFTLEtBQUssSUFBSSxJQUFJLENBQUMsWUFBWSxDQUFDLFNBQVMsRUFBRSxDQUFDLE9BQU8sRUFBRSxVQUFVLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDMUUsT0FBTyxDQUFDLEdBQUcsT0FBTyw0QkFBNEIsQ0FBQyxDQUFDO0lBQ2xELENBQUM7SUFDRCxNQUFNLE1BQU0sR0FBYSxFQUFFLENBQUM7SUFDNUIsTUFBTSxLQUFLLEdBQUcsU0FBUyxDQUFDLEtBQUssQ0FBQztJQUM5QixJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxLQUFLLENBQUMsTUFBTSxHQUFHLDZCQUE2QixDQUFDLGNBQWM7V0FDdkYsQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDL0IsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8sdUJBQXVCLDZCQUE2QixDQUFDLGNBQWMsR0FBRztjQUN4RixrR0FBa0csQ0FBQyxDQUFDO0lBQzFHLENBQUM7SUFDRCxJQUFJLENBQUMsdUJBQXVCLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxFQUFFLENBQUM7UUFDakQsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLE9BQU8seURBQXlEO2NBQzNFLG9DQUFvQyxDQUFDLENBQUM7SUFDNUMsQ0FBQztJQUNELE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQztBQUVGLHVGQUF1RjtBQUN2RixNQUFNLENBQUMsTUFBTSxzQkFBc0IsR0FBRyxDQUFDLFFBQWlCLEVBQXNCLEVBQUUsQ0FDOUUsc0JBQXNCLENBQUMsUUFBUSxDQUFDLEtBQUssSUFBSSxDQUFDO0FBRTVDLG1GQUFtRjtBQUNuRixNQUFNLENBQUMsTUFBTSx3Q0FBd0MsR0FBRyxDQUN0RCxRQUFpQixFQUNqQixPQUFPLEdBQUcsMkJBQTJCLEVBQzNCLEVBQUU7SUFDWixNQUFNLE9BQU8sR0FBRyw2QkFBNkIsQ0FBQyw0QkFBNEIsQ0FBQztJQUMzRSxNQUFNLFFBQVEsR0FBRyxnQkFBZ0IsQ0FBQyxRQUFRLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDckQsSUFBSSxRQUFRLEtBQUssSUFBSSxFQUFFLENBQUM7UUFDdEIsT0FBTyxDQUFDLEdBQUcsT0FBTyw4QkFBOEIsT0FBTyxtQkFBbUIsQ0FBQyxDQUFDO0lBQzlFLENBQUM7SUFDRCxNQUFNLE1BQU0sR0FBYSxFQUFFLENBQUM7SUFDNUIsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDLFNBQVMsRUFBRSxRQUFRLEVBQUUsRUFBRTtRQUN2QyxJQUFJLENBQUMsc0JBQXNCLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQztZQUN2QyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsT0FBTyxJQUFJLFFBQVEsK0RBQStELENBQUMsQ0FBQztRQUNyRyxDQUFDO2FBQU0sSUFBSSxRQUFRLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ3BELE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLElBQUksUUFBUSxhQUFhLFNBQVMsRUFBRSxDQUFDLENBQUM7UUFDOUQsQ0FBQztJQUNILENBQUMsQ0FBQyxDQUFDO0lBQ0gsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDO0FBRUYsK0ZBQStGO0FBQy9GLE1BQU0sK0JBQStCLEdBQUcsQ0FDdEMsT0FBb0MsRUFDcEMsUUFBaUIsRUFDRyxFQUFFO0lBQ3RCLElBQUksT0FBTyxLQUFLLEdBQUcsRUFBRSxDQUFDO1FBQ3BCLE9BQU8sc0JBQXNCLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDMUMsQ0FBQztJQUNELE1BQU0sT0FBTyxHQUFHLHVCQUF1QixDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2xELCtFQUErRTtJQUMvRSxPQUFPLE9BQU8sRUFBRSxNQUFNLEtBQUssQ0FBQyxJQUFJLE9BQU8sQ0FBQyxLQUFLLEtBQUssRUFBRSxJQUFJLE9BQU8sQ0FBQyxLQUFLLElBQUksSUFBSSxLQUFLLEtBQUssQ0FBQztBQUMxRixDQUFDLENBQUM7QUFFRixtRkFBbUY7QUFDbkYsTUFBTSxDQUFDLE1BQU0sOEJBQThCLEdBQUcsQ0FBQyxRQUFpQixFQUFFLE9BQU8sR0FBRyxRQUFRLEVBQVksRUFBRTtJQUNoRyxNQUFNLE1BQU0sR0FBRyxrQkFBa0IsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUM1QyxJQUFJLE1BQU0sS0FBSyxJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsTUFBTSxFQUFFLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxDQUFDO1FBQ3pFLE9BQU8sQ0FBQyxHQUFHLE9BQU8sNEJBQTRCLENBQUMsQ0FBQztJQUNsRCxDQUFDO0lBQ0QsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQztJQUN6QixJQUFJLElBQUksS0FBSyxHQUFHLElBQUksSUFBSSxLQUFLLE1BQU0sRUFBRSxDQUFDO1FBQ3BDLE9BQU8sQ0FBQyxHQUFHLE9BQU8seUJBQXlCLENBQUMsQ0FBQztJQUMvQyxDQUFDO0lBQ0QsTUFBTSxNQUFNLEdBQWEsRUFBRSxDQUFDO0lBQzVCLElBQUksQ0FBQywrQkFBK0IsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDekQsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLEtBQUssR0FBRztZQUN0QixDQUFDLENBQUMsR0FBRyxPQUFPLHFGQUFxRjtZQUNqRyxDQUFDLENBQUMsR0FBRyxPQUFPLHNGQUFzRixDQUFDLENBQUM7SUFDeEcsQ0FBQztJQUNELE1BQU0sRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLEdBQUcsNkJBQTZCLENBQUM7SUFDekQsSUFBSSxNQUFNLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsT0FBTyxNQUFNLENBQUMsR0FBRyxLQUFLLFFBQVE7V0FDL0QsTUFBTSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksTUFBTSxDQUFDLEdBQUcsSUFBSSxNQUFNLElBQUksTUFBTSxDQUFDLEdBQUcsSUFBSSxNQUFNLENBQUMsRUFBRSxDQUFDO1FBQ3ZGLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLGdDQUFnQyxNQUFNLE9BQU8sTUFBTSxVQUFVLENBQUMsQ0FBQztJQUN2RixDQUFDO0lBQ0QsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyxDQUFDO0FBRUY7Ozs7O0dBS0c7QUFDSCxNQUFNLENBQUMsTUFBTSwrQkFBK0IsR0FBRyxDQUM3QyxTQUFrQyxFQUNsQyw0QkFBMkQsRUFDbEQsRUFBRTtJQUNYLElBQUksOEJBQThCLENBQUMsU0FBUyxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO1FBQ3pELE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUNELE1BQU0sT0FBTyxHQUFHLHVCQUF1QixDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUN6RCxNQUFNLFNBQVMsR0FBRyw0QkFBNEIsS0FBSyxTQUFTO1FBQzFELENBQUMsQ0FBQyxFQUFFO1FBQ0osQ0FBQyxDQUFDLGdCQUFnQixDQUFDLDRCQUE0QixFQUFFLDZCQUE2QixDQUFDLDRCQUE0QixDQUFDLENBQUM7SUFDL0csT0FBTyxPQUFPLEtBQUssSUFBSSxJQUFJLFNBQVMsS0FBSyxJQUFJLElBQUksU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLFNBQVMsRUFBRSxFQUFFO1FBQzVFLE1BQU0sTUFBTSxHQUFHLHNCQUFzQixDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ2pELE9BQU8sTUFBTSxLQUFLLElBQUksSUFBSSxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDOUQsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDLENBQUMifQ==
|