@origincloud/kms 0.0.0-stage → 0.27.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# @origincloud/kms
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The client of Origin Cloud's KMS service: grants: permission for one platform
+host to use one key for one operation and one encryption context, for at most an
+hour at a time. Part of the [Origin Cloud SDK for
+TypeScript](https://github.com/origincloudhq/sdk-typescript), generated from the
+API definitions in [origincloudhq/api](https://github.com/origincloudhq/api).
+
+```ts
+import { Client } from "@origincloud/core";
+import { GrantClient } from "@origincloud/kms/v1beta1";
+
+const grants = new GrantClient(new Client());
+```
+
+| Import | API |
+|---|---|
+| `@origincloud/kms/v1beta1` | Grants: permission for one platform host to use one key for one operation and one encryption context, for at most an hour at a time |
+
+`v1beta1` is a preview version and may change in incompatible ways, like the API
+itself. See the [repository's
+README](https://github.com/origincloudhq/sdk-typescript#readme) for credentials
+and behaviour.
+
+Apache License 2.0.

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@origincloud/kms",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.27.0",
+  "description": "Origin Cloud's KMS service: grants: permission for one platform host to use one key for one operation and one encryption context, for at most an hour at a time.",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/origincloudhq/sdk-typescript#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/origincloudhq/sdk-typescript.git",
+    "directory": "packages/kms"
+  },
+  "bugs": "https://github.com/origincloudhq/sdk-typescript/issues",
+  "keywords": [
+    "origincloud",
+    "origin-cloud",
+    "sdk",
+    "kms"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    "./*": {
+      "types": "./dist/*/index.d.ts",
+      "default": "./dist/*/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "!dist/**/*.tsbuildinfo"
+  ],
+  "peerDependencies": {
+    "@origincloud/core": "^0.27.0"
+  },
+  "devDependencies": {
+    "@origincloud/core": "^0.27.0"
+  }
+}

package/src/v1beta1/grant.ts

@@ -0,0 +1,240 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/kms/v1beta1/grant.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type Empty,
+  type Service,
+  newRequestId,
+  pathValue,
+  query,
+} from "@origincloud/core";
+
+/**
+ * Calls GrantService.
+ *
+ * A key's grants.
+ *
+ * Making, renewing and deleting a grant needs `kms.grant.create`,
+ * `kms.grant.update` and `kms.grant.delete` on the key's project, which the
+ * platform's own services hold where you let them use your keys; none of
+ * them lets the holder use the key itself. Reading and listing need
+ * `kms.grant.get` and `kms.grant.list`.
+ */
+export class GrantClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of GrantService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("kms", true);
+  }
+
+  /**
+   * Returns a grant that hasn't expired; an expired one is `NOT_FOUND`. A
+   * grant made moments ago may be refused with `SERVICE_UNAVAILABLE`,
+   * retryable, until its zone's change arrives. Needs `kms.grant.get` on
+   * the project.
+   */
+  async getGrant(request: GetGrantRequest, options?: CallOptions): Promise<Grant> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*/grants/*");
+    return this.service.call<Grant>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists a key's grants that haven't expired, in every zone, ordered by
+   * name. A grant made moments ago may be missing from the list until its
+   * zone's change arrives. Needs `kms.grant.list` on the project.
+   */
+  async listGrants(request: ListGrantsRequest, options?: CallOptions): Promise<ListGrantsResponse> {
+    const p0 = pathValue("parent", request.parent, "projects/*/regions/*/keys/*");
+    return this.service.call<ListGrantsResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}/grants`,
+        query: query(request, ["parent"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listGrants lists from the request's page on,
+   * fetching the next page as the loop reaches it. A page that fails ends
+   * the iteration with its error.
+   */
+  async *allGrants(request: ListGrantsRequest, options?: CallOptions): AsyncGenerator<Grant, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listGrants(page, options);
+      yield* response.grants ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Makes a grant on an `ENCRYPT_DECRYPT` key for one host, refused with
+   * `BAD_REQUEST` for a key of another purpose, a host that isn't one of
+   * the region's, an empty encryption context, or a `ttl` outside 1 to 60
+   * minutes, and with `CONFLICT` for a key that isn't enabled. Needs
+   * `kms.grant.create` on the project.
+   */
+  async createGrant(request: CreateGrantRequest, options?: CallOptions): Promise<Grant> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/regions/*/keys/*");
+    return this.service.call<Grant>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/grants`,
+        body: request.grant,
+        query: query(request, ["parent", "grant"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Extends a grant that hasn't expired to `ttl` from now. An expired
+   * grant isn't renewed: `CONFLICT`, and a new one is made instead. Needs
+   * `kms.grant.update` on the project.
+   */
+  async renewGrant(request: RenewGrantRequest, options?: CallOptions): Promise<Grant> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*/grants/*");
+    return this.service.call<Grant>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:renew`,
+        body: request,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Ends a grant before it expires: from then on it opens nothing. Needs
+   * `kms.grant.delete` on the project.
+   */
+  async deleteGrant(request: DeleteGrantRequest, options?: CallOptions): Promise<Empty> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*/grants/*");
+    return this.service.call<Empty>(
+      {
+        method: "DELETE",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+      },
+      options,
+    );
+  }
+}
+
+/**
+ * A grant: one host may use one key for one operation, with exactly one
+ * encryption context, until `expireTime`.
+ */
+export interface Grant {
+  /** The grant's resource name. */
+  name?: string;
+  /** What the host may do with the key. */
+  operation?: Grant_Operation;
+  /**
+   * The platform host the grant is for, by the SPIFFE ID its certificate
+   * names, which ends in `/zones/{zone}/hosts/{host}`.
+   */
+  grantee?: string;
+  /** The encryption context a use must carry, exactly; never empty. */
+  encryptionContext?: Record<string, string>;
+  /** How long the grant lives from now: 1 to 60 minutes. */
+  ttl?: string;
+  /** The zone that keeps the grant: its host's. */
+  zone?: string;
+  /** Who made the grant. */
+  delegate?: string;
+  /** When the grant was made. */
+  createTime?: string;
+  /** When the grant was last renewed, or made. */
+  renewTime?: string;
+  /** When the grant stops opening anything unless renewed before. */
+  expireTime?: string;
+}
+
+/** What a grant lets its host do. */
+export const Grant_Operation = {
+  /** Not set. */
+  OPERATION_UNSPECIFIED: "OPERATION_UNSPECIFIED",
+  /**
+   * Decrypt ciphertexts made under the key with the grant's encryption
+   * context.
+   */
+  DECRYPT: "DECRYPT",
+} as const;
+
+/** What a grant lets its host do. */
+export type Grant_Operation = (typeof Grant_Operation)[keyof typeof Grant_Operation];
+
+/** The request for GetGrant. */
+export interface GetGrantRequest {
+  /** The grant to return. */
+  name?: string;
+}
+
+/** The request for ListGrants. */
+export interface ListGrantsRequest {
+  /** The key whose grants to list. */
+  parent?: string;
+  /**
+   * The most grants to return; the server clamps it, and 0 means its
+   * default.
+   */
+  pageSize?: number;
+  /** A previous response's `nextPageToken`, for the page after it. */
+  pageToken?: string;
+}
+
+/** The response for ListGrants. */
+export interface ListGrantsResponse {
+  /** The grants on this page. */
+  grants?: Grant[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for CreateGrant. */
+export interface CreateGrantRequest {
+  /** The key to grant. */
+  parent?: string;
+  /** The grant to make: its operation, host, encryption context and `ttl`. */
+  grant?: Grant;
+  /**
+   * A UUID; a repeat with the same id within a day returns the grant the
+   * first request made, instead of making a second.
+   */
+  requestId?: string;
+}
+
+/** The request for RenewGrant. */
+export interface RenewGrantRequest {
+  /** The grant to renew. */
+  name?: string;
+  /** How long the grant lives from now: 1 to 60 minutes. */
+  ttl?: string;
+}
+
+/** The request for DeleteGrant. */
+export interface DeleteGrantRequest {
+  /** The grant to end. */
+  name?: string;
+}

package/src/v1beta1/index.ts

@@ -0,0 +1,4 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+
+export * from "./grant.js";
+export * from "./key.js";

package/src/v1beta1/key.ts

@@ -0,0 +1,590 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/kms/v1beta1/key.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type Service,
+  newRequestId,
+  pathValue,
+  query,
+} from "@origincloud/core";
+
+/**
+ * Calls KeyService.
+ *
+ * Keys and the operations made with them.
+ *
+ * An `ENCRYPT_DECRYPT` key encrypts with AES-256-GCM-SIV. Its ciphertext
+ * names the key version that made it but not the key: Decrypt names the
+ * key, and a ciphertext decrypts only under the key and the encryption
+ * context it was made with. A signing key signs with ECDSA over P-256 and
+ * SHA-256 (ASN.1 DER signatures) or with Ed25519; its public keys are read
+ * with GetPublicKey.
+ */
+export class KeyClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of KeyService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("kms", true);
+  }
+
+  /** Returns a key, deleted or not. Needs `kms.key.get` on the project. */
+  async getKey(request: GetKeyRequest, options?: CallOptions): Promise<Key> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<Key>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists a project's keys in a region, ordered by name. Deleted ones are
+   * listed only when `showDeleted` is set, so a page may hold fewer keys
+   * than `pageSize` and still be followed by another. Needs `kms.key.list`
+   * on the project.
+   */
+  async listKeys(request: ListKeysRequest, options?: CallOptions): Promise<ListKeysResponse> {
+    const p0 = pathValue("parent", request.parent, "projects/*/regions/*");
+    return this.service.call<ListKeysResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}/keys`,
+        query: query(request, ["parent"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listKeys lists from the request's page on,
+   * fetching the next page as the loop reaches it. A page that fails ends
+   * the iteration with its error.
+   */
+  async *allKeys(request: ListKeysRequest, options?: CallOptions): AsyncGenerator<Key, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listKeys(page, options);
+      yield* response.keys ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Creates a key, `ENABLED`, with its first version as the primary. The
+   * platform assigns its id, which its `name` returns; an id is never used
+   * again. Needs `kms.key.create` on the project.
+   */
+  async createKey(request: CreateKeyRequest, options?: CallOptions): Promise<Key> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/regions/*");
+    return this.service.call<Key>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/keys`,
+        body: request.key,
+        query: query(request, ["parent", "key"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Enables or disables a key, or changes its tags: `state` and `tags` are
+   * the fields it changes. A disabled key refuses every operation but
+   * GetPublicKey with `CONFLICT` until it is enabled again. Setting the
+   * state or the tags the key has already succeeds and changes nothing. A
+   * deleted key can't be changed: undelete it first. A key the platform
+   * manages (`platformManaged`) is refused with `FORBIDDEN`, even when the
+   * request would change nothing. Needs
+   * `kms.key.update` on the project.
+   */
+  async updateKey(request: UpdateKeyRequest, options?: CallOptions): Promise<Key> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("key.name", request.key?.name, "projects/*/regions/*/keys/*");
+    return this.service.call<Key>(
+      {
+        method: "PATCH",
+        path: `/v1beta1/${p0}`,
+        body: request.key,
+        query: query(request, ["key.name", "key"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Deletes a key: it becomes `DELETED` at once, refuses every operation
+   * but GetPublicKey, and its material is destroyed at `purgeTime`, after
+   * `destroyDelay`. Until then UndeleteKey restores it, disabled. After it,
+   * nothing it encrypted can ever be decrypted again. Deleting a deleted key
+   * succeeds and changes nothing. A key the platform manages is refused with
+   * `FORBIDDEN`, deleted or not. Needs `kms.key.delete` on the project.
+   */
+  async deleteKey(request: DeleteKeyRequest, options?: CallOptions): Promise<Key> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<Key>(
+      {
+        method: "DELETE",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Restores a deleted key whose material isn't destroyed yet: it becomes
+   * `DISABLED`, to be enabled with UpdateKey. Refused with `CONFLICT` for a
+   * key that isn't deleted, or whose `purgeTime` has passed, and with
+   * `FORBIDDEN` for a key the platform manages. Needs `kms.key.delete` on
+   * the project.
+   */
+  async undeleteKey(request: UndeleteKeyRequest, options?: CallOptions): Promise<Key> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<Key>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:undelete`,
+        body: request,
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Adds a new version to a key and makes it the primary: new ciphertexts
+   * and signatures use it, and every earlier version still decrypts and
+   * its public key stays readable. Refused with `CONFLICT` for a key that
+   * isn't enabled, and with `FORBIDDEN` for a key the platform manages.
+   * Needs `kms.key.rotate` on the project.
+   */
+  async rotateKey(request: RotateKeyRequest, options?: CallOptions): Promise<Key> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<Key>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:rotate`,
+        body: request,
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Encrypts up to 64 KiB with an `ENCRYPT_DECRYPT` key's primary version,
+   * bound to the encryption context. For more data, encrypt it yourself
+   * with a data key from GenerateDataKey. Refused with `CONFLICT` for a key
+   * that isn't enabled, and with `BAD_REQUEST` for a signing key. Needs
+   * `kms.key.encrypt` on the project.
+   */
+  async encrypt(request: EncryptRequest, options?: CallOptions): Promise<EncryptResponse> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<EncryptResponse>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:encrypt`,
+        body: request,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Decrypts a ciphertext Encrypt or GenerateDataKey made with this key,
+   * given the same encryption context. Refused with `BAD_REQUEST` for a
+   * ciphertext that doesn't decrypt under this key and context, and with
+   * `CONFLICT` for a key that isn't enabled. Needs `kms.key.decrypt` on the
+   * project.
+   */
+  async decrypt(request: DecryptRequest, options?: CallOptions): Promise<DecryptResponse> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<DecryptResponse>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:decrypt`,
+        body: request,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Returns a new random 256-bit data key, in plaintext and encrypted under
+   * an `ENCRYPT_DECRYPT` key's primary version with the encryption context.
+   * Encrypt your data with the plaintext, keep only the ciphertext beside
+   * it, and recover the data key with Decrypt when you need it. Needs
+   * `kms.key.generate_data_key` on the project.
+   */
+  async generateDataKey(request: GenerateDataKeyRequest, options?: CallOptions): Promise<GenerateDataKeyResponse> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<GenerateDataKeyResponse>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:generateDataKey`,
+        body: request,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Signs up to 64 KiB with a signing key's primary version, or the
+   * version `keyVersion` names. ECDSA hashes
+   * the data with SHA-256 itself: send the data, not a digest. Refused with
+   * `CONFLICT` for a key that isn't enabled, and with `BAD_REQUEST` for an
+   * `ENCRYPT_DECRYPT` key. Needs `kms.key.sign` on the project.
+   */
+  async sign(request: SignRequest, options?: CallOptions): Promise<SignResponse> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*");
+    return this.service.call<SignResponse>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}:sign`,
+        body: request,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Returns a signing key version's public key, to verify its signatures
+   * with. Answered for a disabled or deleted key too, until its material is
+   * destroyed. Refused with `BAD_REQUEST` for an `ENCRYPT_DECRYPT` key.
+   * Needs `kms.key.get_public_key` on the project.
+   */
+  async getPublicKey(request: GetPublicKeyRequest, options?: CallOptions): Promise<PublicKey> {
+    const p0 = pathValue("name", request.name, "projects/*/regions/*/keys/*/versions/*/publicKey");
+    return this.service.call<PublicKey>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/**
+ * A key: its versions' material is kept by the platform and never leaves
+ * it.
+ */
+export interface Key {
+  /** The key's resource name. */
+  name?: string;
+  /** What the key is for. */
+  purpose?: Key_Purpose;
+  /**
+   * Whether the key can be used. A new key is `ENABLED`; UpdateKey sets it
+   * to `ENABLED` or `DISABLED`, and DeleteKey makes it `DELETED`.
+   */
+  state?: Key_State;
+  /** The version new ciphertexts and signatures use. */
+  primaryVersion?: string;
+  /** Every version, oldest first. RotateKey adds one. */
+  versions?: Key_Version[];
+  /** When the key was created. */
+  createTime?: string;
+  /** When the key last changed. */
+  updateTime?: string;
+  /**
+   * When a deleted key's material is destroyed, or was; unset unless the
+   * key is `DELETED`.
+   */
+  purgeTime?: string;
+  /**
+   * Labels of your own, at most 50. The `origin:name` tag is the name the
+   * console shows.
+   */
+  tags?: Record<string, string>;
+  /**
+   * Whether the platform manages the key: it made the key in your project
+   * for its own use of the project's data, such as the key, tagged
+   * `origin:name=volumes`, that protects your volumes' data keys. You see it,
+   * its grants and its audit log entries like any key of yours, but
+   * UpdateKey, DeleteKey, UndeleteKey and RotateKey refuse it with
+   * `FORBIDDEN`, whatever roles you hold.
+   */
+  platformManaged?: boolean;
+}
+
+/** What a key is for, and the algorithm it uses. */
+export const Key_Purpose = {
+  /** Not set. */
+  PURPOSE_UNSPECIFIED: "PURPOSE_UNSPECIFIED",
+  /** Encrypt, Decrypt and GenerateDataKey, with AES-256-GCM-SIV. */
+  ENCRYPT_DECRYPT: "ENCRYPT_DECRYPT",
+  /** Sign with ECDSA over P-256 and SHA-256; signatures are ASN.1 DER. */
+  SIGN_ECDSA_P256_SHA256: "SIGN_ECDSA_P256_SHA256",
+  /** Sign with Ed25519; signatures are 64 bytes. */
+  SIGN_ED25519: "SIGN_ED25519",
+} as const;
+
+/** What a key is for, and the algorithm it uses. */
+export type Key_Purpose = (typeof Key_Purpose)[keyof typeof Key_Purpose];
+
+/** Whether a key can be used. */
+export const Key_State = {
+  /** Not set. */
+  STATE_UNSPECIFIED: "STATE_UNSPECIFIED",
+  /** Serves every operation of its purpose. */
+  ENABLED: "ENABLED",
+  /** Refuses every operation but GetPublicKey until enabled again. */
+  DISABLED: "DISABLED",
+  /**
+   * Deleted: refuses every operation but GetPublicKey. Until
+   * `purgeTime` UndeleteKey restores it; after it, its material is
+   * destroyed.
+   */
+  DELETED: "DELETED",
+} as const;
+
+/** Whether a key can be used. */
+export type Key_State = (typeof Key_State)[keyof typeof Key_State];
+
+/** A version of the key: one generation of its material. */
+export interface Key_Version {
+  /**
+   * The version's resource name,
+   * `projects/{project}/regions/{region}/keys/{key}/versions/{version}`,
+   * numbered from 1.
+   */
+  keyVersion?: string;
+  /** When the version was created. */
+  createTime?: string;
+}
+
+/** A signing key version's public key. */
+export interface PublicKey {
+  /**
+   * The public key's resource name: its version's, followed by
+   * `/publicKey`.
+   */
+  name?: string;
+  /** The algorithm the key version signs with. */
+  algorithm?: Key_Purpose;
+  /**
+   * The public key as a PEM-encoded SubjectPublicKeyInfo, which OpenSSL and
+   * most libraries read.
+   */
+  pem?: string;
+}
+
+/** The request for GetKey. */
+export interface GetKeyRequest {
+  /** The key to return. */
+  name?: string;
+}
+
+/** The request for ListKeys. */
+export interface ListKeysRequest {
+  /**
+   * The project and region whose keys to list,
+   * `projects/{project}/regions/{region}`.
+   */
+  parent?: string;
+  /**
+   * The most keys to return; the server clamps it, and 0 means its
+   * default.
+   */
+  pageSize?: number;
+  /** A previous response's `nextPageToken`, for the page after it. */
+  pageToken?: string;
+  /** Whether deleted keys are listed too. */
+  showDeleted?: boolean;
+}
+
+/** The response for ListKeys. */
+export interface ListKeysResponse {
+  /** The keys on this page. */
+  keys?: Key[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for CreateKey. */
+export interface CreateKeyRequest {
+  /**
+   * The project and region to create the key in,
+   * `projects/{project}/regions/{region}`.
+   */
+  parent?: string;
+  /** The key to create: its `purpose`, and optionally its tags. */
+  key?: Key;
+  /**
+   * A UUID; a repeat with the same id within a day returns the key the
+   * first request created, as it was then, instead of creating a second
+   * one.
+   */
+  requestId?: string;
+}
+
+/** The request for UpdateKey. */
+export interface UpdateKeyRequest {
+  /**
+   * The key, by its name, with the state to set (`ENABLED` or `DISABLED`)
+   * or the tags to replace its tags with.
+   */
+  key?: Key;
+  /** The fields to change: `state`, `tags`, or both. `*` is both. */
+  updateMask?: string;
+  /**
+   * A UUID; a repeat with the same id within a day returns the key as the
+   * first request left it, instead of changing it again.
+   */
+  requestId?: string;
+}
+
+/** The request for DeleteKey. */
+export interface DeleteKeyRequest {
+  /** The key to delete. */
+  name?: string;
+  /**
+   * How long until the key's material is destroyed: whole days, from 1 to
+   * 90; 30 days when unset.
+   */
+  destroyDelay?: string;
+  /**
+   * A UUID; a repeat with the same id within a day returns the key as the
+   * first request left it.
+   */
+  requestId?: string;
+}
+
+/** The request for UndeleteKey. */
+export interface UndeleteKeyRequest {
+  /** The deleted key to restore. */
+  name?: string;
+  /**
+   * A UUID; a repeat with the same id within a day returns the key as the
+   * first request left it, instead of answering `CONFLICT`.
+   */
+  requestId?: string;
+}
+
+/** The request for RotateKey. */
+export interface RotateKeyRequest {
+  /** The key to rotate. */
+  name?: string;
+  /**
+   * A UUID; a repeat with the same id within a day returns the key as the
+   * first request left it, instead of adding another version.
+   */
+  requestId?: string;
+}
+
+/** The request for Encrypt. */
+export interface EncryptRequest {
+  /** The `ENCRYPT_DECRYPT` key to encrypt with. */
+  name?: string;
+  /** The data to encrypt, at most 64 KiB. */
+  plaintext?: string;
+  /**
+   * Pairs bound into the ciphertext, which Decrypt must be given again,
+   * exactly. They aren't secret: the audit log records them. At most 16
+   * pairs, each key and value 1 to 256 bytes.
+   */
+  encryptionContext?: Record<string, string>;
+}
+
+/** The response for Encrypt. */
+export interface EncryptResponse {
+  /** The ciphertext, to store and pass to Decrypt. */
+  ciphertext?: string;
+  /** The key version that encrypted it. */
+  keyVersion?: string;
+}
+
+/** The request for Decrypt. */
+export interface DecryptRequest {
+  /** The key the ciphertext was made with. */
+  name?: string;
+  /** What Encrypt or GenerateDataKey returned as `ciphertext`. */
+  ciphertext?: string;
+  /** The encryption context the ciphertext was made with. */
+  encryptionContext?: Record<string, string>;
+}
+
+/** The response for Decrypt. */
+export interface DecryptResponse {
+  /** The decrypted data. */
+  plaintext?: string;
+  /** The key version that decrypted it. */
+  keyVersion?: string;
+}
+
+/** The request for GenerateDataKey. */
+export interface GenerateDataKeyRequest {
+  /** The `ENCRYPT_DECRYPT` key to encrypt the data key with. */
+  name?: string;
+  /** Pairs bound into the data key's ciphertext, as Encrypt's. */
+  encryptionContext?: Record<string, string>;
+}
+
+/** The response for GenerateDataKey. */
+export interface GenerateDataKeyResponse {
+  /** The 32-byte data key. Use it, then discard it: never store it. */
+  plaintext?: string;
+  /**
+   * The data key encrypted under the key, to store beside your data and
+   * pass to Decrypt.
+   */
+  ciphertext?: string;
+  /** The key version that encrypted it. */
+  keyVersion?: string;
+}
+
+/** The request for Sign. */
+export interface SignRequest {
+  /** The signing key to sign with. */
+  name?: string;
+  /** The data to sign, at most 64 KiB. */
+  data?: string;
+  /**
+   * The version of `name` to sign with, `{name}/versions/{version}`.
+   * Without it, the key's primary version signs. Name it when the
+   * signature's verifiers must know the version before the signature
+   * exists, for example a token whose header names its key: the primary
+   * can change between reading it and signing. Refused with `BAD_REQUEST`
+   * for a version of another key or a destroyed version.
+   */
+  keyVersion?: string;
+}
+
+/** The response for Sign. */
+export interface SignResponse {
+  /** The signature: ASN.1 DER for ECDSA, 64 bytes for Ed25519. */
+  signature?: string;
+  /** The key version that signed, whose public key verifies it. */
+  keyVersion?: string;
+}
+
+/** The request for GetPublicKey. */
+export interface GetPublicKeyRequest {
+  /**
+   * The public key to return: a key version's name followed by
+   * `/publicKey`.
+   */
+  name?: string;
+}