@k9o/kibo 0.0.0-stage → 1.0.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/LICENSE +201 -0
- package/NOTICE +4 -0
- package/dist/index.d.ts +266 -0
- package/dist/index.js +259 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +161 -0
- package/dist/types.js +1 -0
- package/dist/types.js.map +1 -0
- package/package.json +44 -4
- package/src/client-factory.ts +24 -0
- package/src/crypto-types.ts +117 -0
- package/src/crypto.ts +133 -0
- package/src/index.ts +33 -0
- package/src/types.ts +171 -0
- package/src/vault.ts +212 -0
- package/wasm/kibo_kms_rest_ffi.d.ts +54 -0
- package/wasm/kibo_kms_rest_ffi.js +887 -0
- package/wasm/kibo_kms_rest_ffi_bg.wasm +0 -0
- package/wasm/kibo_kms_rest_ffi_bg.wasm.d.ts +26 -0
- package/README.md +0 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
import { HttpClientConfig } from '@k9o/core/http';
|
|
2
|
+
import { Envelope } from '@k9o/core/envelope';
|
|
3
|
+
import { StoreZkDekInput, ZkDekHandle, ZkDekRecord, ListSecretsInput, ListSecretsResult, SecretSummary, CreateSecretInput, RevealChallenge, RevealSecretResult, UpdateSecretInput, UpdateSecretResult, RotateSecretResult, MoveSecretResult, KmsProvider } from './types.js';
|
|
4
|
+
export { AttestationTier, SecretVisibility } from './types.js';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* `client.kibo.vault.*` — the Kibo vault surface.
|
|
8
|
+
*
|
|
9
|
+
* v0.1.0: `vault.zkDeks.{store,fetch}` (ch08 §11.3.2 F.5) — member-plane,
|
|
10
|
+
* project-scoped storage of the opaque customer-wrapped DEK envelope. Zero
|
|
11
|
+
* crypto SDK-side: this is a plain authenticated REST round-trip carrying an
|
|
12
|
+
* opaque blob (the wrapping happens in the ZK core, piece C). The encryption
|
|
13
|
+
* surface (`kibo.encrypt`/`decrypt`) lands in a later version once the C
|
|
14
|
+
* binding is consumable.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
declare function makeVaultNamespace(config: HttpClientConfig): {
|
|
18
|
+
/** ZK-DEK opaque store/fetch (ch08 §11.3.2 F.5). */
|
|
19
|
+
zkDeks: {
|
|
20
|
+
/**
|
|
21
|
+
* Store an opaque customer-wrapped DEK envelope.
|
|
22
|
+
* `POST /@<projectSlug>/vault/zk-deks` → the `zkdek_<base62>` handle.
|
|
23
|
+
* The SDK ships the envelope verbatim; it is never parsed here.
|
|
24
|
+
*/
|
|
25
|
+
store(input: StoreZkDekInput): Promise<Envelope<ZkDekHandle>>;
|
|
26
|
+
/**
|
|
27
|
+
* Fetch a stored `WrappedDek` by its handle.
|
|
28
|
+
* `GET /@<projectSlug>/vault/zk-deks/<id>` → the opaque envelope + the
|
|
29
|
+
* non-secret `provider`/`keyVersionRef` the caller needs to unwrap it.
|
|
30
|
+
*/
|
|
31
|
+
fetch(id: string): Promise<Envelope<ZkDekRecord>>;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* §14 typed secrets surface (`services/gateway/src/routes/vault-secrets.ts`) — the full family:
|
|
35
|
+
* list/get/create/revealChallenge/reveal/update/rotate/move/delete. Every operation on a NAMED
|
|
36
|
+
* secret (everything except `list`) requires `region` — live-verified against staging, not
|
|
37
|
+
* documented in the route's OpenAPI schema. `list` is the one exception (verified it does NOT
|
|
38
|
+
* need `region`).
|
|
39
|
+
*
|
|
40
|
+
* Response shapes for `update`/`rotate`/`move` are typed to what the gateway ACTUALLY returns
|
|
41
|
+
* (live-verified), not the OpenAPI's documented (and inaccurate for these three) `SecretSummary` —
|
|
42
|
+
* see the 🔴 notes on `UpdateSecretResult`/`RotateSecretResult`/`MoveSecretResult` in `types.ts`.
|
|
43
|
+
*/
|
|
44
|
+
secrets: {
|
|
45
|
+
/** List secrets (metadata only — never lists ciphertext). `GET /@<projectSlug>/vault/secrets`.
|
|
46
|
+
* The one secrets operation that does NOT need `region` (live-verified). */
|
|
47
|
+
list(input?: ListSecretsInput): Promise<Envelope<ListSecretsResult>>;
|
|
48
|
+
/**
|
|
49
|
+
* Read a secret's metadata (never its value — use `revealChallenge`+`reveal` for that).
|
|
50
|
+
* `GET /@<projectSlug>/vault/secrets/<name>?region=<region>`.
|
|
51
|
+
*
|
|
52
|
+
* 🔴 KNOWN LIVE BUG (staging, 2026-09-05): this call currently fails with
|
|
53
|
+
* `K9O_REVEAL_CHALLENGE_REQUIRED` on every attempt — the gateway/kibo does not honor the
|
|
54
|
+
* documented "no `X-K9O-Reveal-Challenge` header ⇒ return metadata" behavior; it demands a
|
|
55
|
+
* challenge unconditionally. Implemented per the documented contract (this is a backend defect,
|
|
56
|
+
* not a client workaround); `list({prefix: exactName})` is the current working alternative for a
|
|
57
|
+
* single secret's metadata until the gateway/kibo side is fixed.
|
|
58
|
+
*/
|
|
59
|
+
get(name: string, opts: {
|
|
60
|
+
region: string;
|
|
61
|
+
}): Promise<Envelope<SecretSummary>>;
|
|
62
|
+
/**
|
|
63
|
+
* Create a secret under the caller's own auth.
|
|
64
|
+
* `POST /@<projectSlug>/vault/secrets/<name>?region=<region>` → the `sec_<base62>` summary.
|
|
65
|
+
*
|
|
66
|
+
* 🔴 `region` is REQUIRED on the query string, live-verified against staging — the vault-forward
|
|
67
|
+
* proxy fail-closes with `K9O_INVALID_FIELD_VALUE` ("this request requires an authoritative
|
|
68
|
+
* region") without it. Distinct from any `region` carried inside `input.value`'s envelope (e.g.
|
|
69
|
+
* the BYOS aws_sigv4 STS-signing region): this one scopes the vault WRITE itself, mirroring the
|
|
70
|
+
* gateway's `gatewayRegion()` residency guard (region-guard.ts) that closed a 2026-08 wrong-region
|
|
71
|
+
* incident for the audit path — the request-shape unit tests never caught this because they don't
|
|
72
|
+
* exercise a real gateway.
|
|
73
|
+
*/
|
|
74
|
+
create(input: CreateSecretInput): Promise<Envelope<SecretSummary>>;
|
|
75
|
+
/** Mint a single-use reveal challenge — present it as `X-K9O-Reveal-Challenge` on the
|
|
76
|
+
* immediately-following `reveal()` call. `POST .../<name>?op=reveal-challenge®ion=<region>`. */
|
|
77
|
+
revealChallenge(name: string, opts: {
|
|
78
|
+
region: string;
|
|
79
|
+
}): Promise<Envelope<RevealChallenge>>;
|
|
80
|
+
/** Reveal a secret's plaintext value using a single-use challenge from `revealChallenge()`.
|
|
81
|
+
* `GET .../<name>?region=<region>` with `X-K9O-Reveal-Challenge`. Decodes the wire's base64
|
|
82
|
+
* `value` back to plaintext (live-verified: the reveal response's `value` is base64, symmetric
|
|
83
|
+
* with `create`'s encode). */
|
|
84
|
+
reveal(name: string, opts: {
|
|
85
|
+
region: string;
|
|
86
|
+
challenge: string;
|
|
87
|
+
}): Promise<Envelope<RevealSecretResult>>;
|
|
88
|
+
/** Update a secret's value (bumps version) — owner-only. `PUT .../<name>?region=<region>`.
|
|
89
|
+
* 🔴 Returns only `{id, name, version}` live (see `UpdateSecretResult`), not the full summary
|
|
90
|
+
* the OpenAPI schema documents — call `get()` after if you need the rest. */
|
|
91
|
+
update(name: string, input: UpdateSecretInput): Promise<Envelope<UpdateSecretResult>>;
|
|
92
|
+
/** Rotate a secret's wrapping key (re-wraps under a fresh `kid`; content unchanged) — owner-only.
|
|
93
|
+
* `POST .../<name>?op=rotate®ion=<region>`. */
|
|
94
|
+
rotate(name: string, opts: {
|
|
95
|
+
region: string;
|
|
96
|
+
}): Promise<Envelope<RotateSecretResult>>;
|
|
97
|
+
/** Move (rename) a secret's hierarchical path — owner-only.
|
|
98
|
+
* `POST .../<name>?op=move®ion=<region>`. */
|
|
99
|
+
move(name: string, opts: {
|
|
100
|
+
region: string;
|
|
101
|
+
newPath: string;
|
|
102
|
+
}): Promise<Envelope<MoveSecretResult>>;
|
|
103
|
+
/** Retire a secret — owner-only. `DELETE .../<name>?region=<region>` → `204 No Content`. */
|
|
104
|
+
delete(name: string, opts: {
|
|
105
|
+
region: string;
|
|
106
|
+
}): Promise<Envelope<void>>;
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* `createKiboClient(config)` — per-instance Kibo (ZK vault) SDK factory.
|
|
112
|
+
*
|
|
113
|
+
* Composes into `@k9o/core` as `client.kibo` (re-export, available when a
|
|
114
|
+
* project is bound — the same composition pattern as `@k9o/gate`). Reuses the
|
|
115
|
+
* core HTTP layer (`@k9o/core/http`) so the bearer/header/retry contract is
|
|
116
|
+
* identical to the rest of the SDK pool.
|
|
117
|
+
*/
|
|
118
|
+
|
|
119
|
+
/** Shape of the per-instance client returned by `createKiboClient`. */
|
|
120
|
+
type KiboClient = {
|
|
121
|
+
/** Vault surface — `client.kibo.vault.zkDeks.{store,fetch}` (ch08 §11.3.2 F.5). */
|
|
122
|
+
vault: ReturnType<typeof makeVaultNamespace>;
|
|
123
|
+
};
|
|
124
|
+
/** Construct a Kibo client bound to the supplied (core) HTTP config. */
|
|
125
|
+
declare function createKiboClient(config: HttpClientConfig): KiboClient;
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* TS contract for the ZK encrypt/decrypt FFI surface — mirrors the Rust
|
|
129
|
+
* `kibo-kms-rest-ffi::types` (the bound core, piece C) field-for-field.
|
|
130
|
+
*
|
|
131
|
+
* These types cross the wasm boundary as plain JS objects (serde-wasm-bindgen),
|
|
132
|
+
* so the field names + enum wire-tokens must match the Rust serde exactly:
|
|
133
|
+
* - `KmsProvider` kebab-case (`aws-kms`, `gcp-kms`, `azure-kv`, `hashicorp-vault`)
|
|
134
|
+
* - all other enums snake_case (`byok`, `local_envelope`, `hardware_backed`, …)
|
|
135
|
+
* - bytes (`Vec<u8>`) `Uint8Array` at the boundary
|
|
136
|
+
*
|
|
137
|
+
* Strict-ZK invariant: the `secret` in `KiboCredential` is a customer-issued
|
|
138
|
+
* short-lived federated token — never a platform KEK; it is zeroized in the core
|
|
139
|
+
* after use and never logged or returned. The platform never sees plaintext.
|
|
140
|
+
*/
|
|
141
|
+
|
|
142
|
+
/** Custody posture for an encrypt call. `platform-managed` is structurally absent
|
|
143
|
+
* here — `kibo-kms-rest` is the KEK-free customer-KMS layer (ZK is never PM). */
|
|
144
|
+
type KiboPosture = "byok" | "hyok";
|
|
145
|
+
/** Explicit strategy pin. Omit → `local_envelope` (the posture default). */
|
|
146
|
+
type KiboStrategy = "local_envelope" | "customer_kms_oracle";
|
|
147
|
+
/** Oracle routing mode. Omit → `brokered` (default). */
|
|
148
|
+
type KiboOracleMode = "brokered" | "direct";
|
|
149
|
+
/** Device attestation tier bound into the AAD for every operation. */
|
|
150
|
+
type KiboAttestationTier = "software" | "hardware_backed" | "confidential";
|
|
151
|
+
/** The min-custody-posture floor ladder (3-mode; `platform_managed` = no floor).
|
|
152
|
+
* Ordering: `PLATFORM_MANAGED < BYOK < HYOK`. */
|
|
153
|
+
type KiboMinPosture = "platform_managed" | "byok" | "hyok";
|
|
154
|
+
/** Acceptable oracle-mode set (the `allowed_oracle_modes` policy dial). */
|
|
155
|
+
interface KiboAllowedOracleModes {
|
|
156
|
+
brokered: boolean;
|
|
157
|
+
direct: boolean;
|
|
158
|
+
}
|
|
159
|
+
/** Project-declared crypto-posture floor (ch08 §11.3.3.4). Omit fields for the
|
|
160
|
+
* most-permissive default (`platform_managed` floor + both oracle modes). */
|
|
161
|
+
interface KiboPosturePolicy {
|
|
162
|
+
min_custody_posture?: KiboMinPosture;
|
|
163
|
+
allowed_oracle_modes?: KiboAllowedOracleModes;
|
|
164
|
+
}
|
|
165
|
+
/** Short-lived customer KMS credential — the edge device's federated token.
|
|
166
|
+
* `secret` is treated as secret material (zeroized in-core; never returned). */
|
|
167
|
+
interface KiboCredential {
|
|
168
|
+
secret: string;
|
|
169
|
+
expires_at_unix_secs: number;
|
|
170
|
+
}
|
|
171
|
+
/** Key version reference identifying the customer KMS key. `external_ref` is
|
|
172
|
+
* provider-specific (AWS key ARN / GCP resource name / Azure key URL / Vault
|
|
173
|
+
* `<mount>/<key>:<ver>`). `version` is the monotone KEK-rotation counter. */
|
|
174
|
+
interface KiboKeyRef {
|
|
175
|
+
version: number;
|
|
176
|
+
external_ref: string;
|
|
177
|
+
}
|
|
178
|
+
/** Provider-specific init params. Only the compiled-in provider's field is read. */
|
|
179
|
+
interface KiboProviderConfig {
|
|
180
|
+
aws_region?: string;
|
|
181
|
+
vault_address?: string;
|
|
182
|
+
}
|
|
183
|
+
/** A single encryption-context key/value pair. Bound into the AAD at encrypt and
|
|
184
|
+
* re-supplied byte-for-byte at decrypt. (Record shape — uniffi can't cross
|
|
185
|
+
* tuples; the wasm JSON is `[{"key":"…","value":"…"}]`.) `kibo:` is reserved. */
|
|
186
|
+
interface KiboKvPair {
|
|
187
|
+
key: string;
|
|
188
|
+
value: string;
|
|
189
|
+
}
|
|
190
|
+
/** All inputs to `encrypt` — mirrors Rust `EncryptInput`. */
|
|
191
|
+
interface KiboEncryptInput {
|
|
192
|
+
provider: KmsProvider;
|
|
193
|
+
posture: KiboPosture;
|
|
194
|
+
strategy?: KiboStrategy;
|
|
195
|
+
oracle_mode?: KiboOracleMode;
|
|
196
|
+
kms_cred: KiboCredential;
|
|
197
|
+
key_ref: KiboKeyRef;
|
|
198
|
+
provider_config: KiboProviderConfig;
|
|
199
|
+
attestation_tier: KiboAttestationTier;
|
|
200
|
+
encryption_context: KiboKvPair[];
|
|
201
|
+
/** Plaintext bytes to encrypt. */
|
|
202
|
+
plaintext: Uint8Array;
|
|
203
|
+
posture_policy?: KiboPosturePolicy;
|
|
204
|
+
}
|
|
205
|
+
/** All inputs to `decrypt` — mirrors Rust `DecryptInput`. `strategy`,
|
|
206
|
+
* `attestation_tier`, and `encryption_context` MUST be re-supplied (never read
|
|
207
|
+
* from the envelope — anti-envelope-substitution discipline). */
|
|
208
|
+
interface KiboDecryptInput {
|
|
209
|
+
kms_cred: KiboCredential;
|
|
210
|
+
provider_config: KiboProviderConfig;
|
|
211
|
+
/** The canonical (`b"KIBO"`) envelope from a prior `encrypt`. */
|
|
212
|
+
envelope: Uint8Array;
|
|
213
|
+
strategy: KiboStrategy;
|
|
214
|
+
attestation_tier: KiboAttestationTier;
|
|
215
|
+
encryption_context: KiboKvPair[];
|
|
216
|
+
}
|
|
217
|
+
/** Output of `encrypt` — the opaque ZKFE envelope (pass straight to `decrypt`). */
|
|
218
|
+
interface KiboEncryptOutput {
|
|
219
|
+
envelope: Uint8Array;
|
|
220
|
+
}
|
|
221
|
+
/** Output of `decrypt` — the recovered plaintext. */
|
|
222
|
+
interface KiboDecryptOutput {
|
|
223
|
+
plaintext: Uint8Array;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
/**
|
|
227
|
+
* ZK encrypt/decrypt — the thin TS wrapper over the bound crypto core
|
|
228
|
+
* (`kibo-kms-rest-ffi`, piece C) compiled to wasm. ZERO crypto here: every
|
|
229
|
+
* wrap/unwrap, envelope framing, posture-floor enforcement, and KMS round-trip
|
|
230
|
+
* lives in the audited Rust core. This layer only marshals the typed input
|
|
231
|
+
* across the wasm boundary and maps the core's error string → `KError`.
|
|
232
|
+
*
|
|
233
|
+
* The core exposes `zk_encrypt`/`zk_decrypt` (async) taking/returning plain JS
|
|
234
|
+
* objects via serde-wasm-bindgen, and rejecting with the `ZkFfiError` display
|
|
235
|
+
* string (`"<K9O_CODE>: <message>"`, optionally with a posture-violation tail).
|
|
236
|
+
*
|
|
237
|
+
* Composes into `@k9o/core` as `client.kibo.encrypt`/`decrypt`; the F.5
|
|
238
|
+
* `vault.zkDeks.{store,fetch}` surface (envelope persistence) is separate +
|
|
239
|
+
* decoupled (the core never sees the store).
|
|
240
|
+
*/
|
|
241
|
+
|
|
242
|
+
/** The minimal surface the bound ZK-core wasm exposes. */
|
|
243
|
+
interface ZkWasm {
|
|
244
|
+
zk_encrypt(input: unknown): Promise<unknown>;
|
|
245
|
+
zk_decrypt(input: unknown): Promise<unknown>;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* Inject a pre-loaded core wasm module. Hosts that bundle the wasm themselves
|
|
249
|
+
* (browser/RN, or a test) call this; otherwise `encrypt`/`decrypt` lazy-load
|
|
250
|
+
* the vendored per-provider artifact.
|
|
251
|
+
*/
|
|
252
|
+
declare function setZkWasm(mod: ZkWasm): void;
|
|
253
|
+
/**
|
|
254
|
+
* Encrypt `input.plaintext` via the customer KMS, client-side. Returns the
|
|
255
|
+
* opaque ZKFE envelope — store it via `vault.zkDeks.store` (F.5) or keep it
|
|
256
|
+
* yourself; it is meaningless to the platform.
|
|
257
|
+
*/
|
|
258
|
+
declare function encrypt(input: KiboEncryptInput): Promise<KiboEncryptOutput>;
|
|
259
|
+
/**
|
|
260
|
+
* Decrypt a ZKFE `input.envelope`. `strategy`, `attestation_tier`, and
|
|
261
|
+
* `encryption_context` MUST match the values used at encrypt — they are AAD-bound
|
|
262
|
+
* and never recovered from the envelope (anti-substitution discipline).
|
|
263
|
+
*/
|
|
264
|
+
declare function decrypt(input: KiboDecryptInput): Promise<KiboDecryptOutput>;
|
|
265
|
+
|
|
266
|
+
export { CreateSecretInput, type KiboAllowedOracleModes, type KiboAttestationTier, type KiboClient, type KiboCredential, type KiboDecryptInput, type KiboDecryptOutput, type KiboEncryptInput, type KiboEncryptOutput, type KiboKeyRef, type KiboKvPair, type KiboMinPosture, type KiboOracleMode, type KiboPosture, type KiboPosturePolicy, type KiboProviderConfig, type KiboStrategy, KmsProvider, ListSecretsInput, ListSecretsResult, MoveSecretResult, RevealChallenge, RevealSecretResult, RotateSecretResult, SecretSummary, StoreZkDekInput, UpdateSecretInput, UpdateSecretResult, ZkDekHandle, ZkDekRecord, type ZkWasm, createKiboClient, decrypt, encrypt, makeVaultNamespace, setZkWasm };
|