@homeflare/distilled-openbao 0.2.0

package/src/services/root.ts

@@ -0,0 +1,393 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-openbao, generated — see fetch-specs.ts). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  OpenBaoProtocol,
+  type OpenBaoOpError,
+  type OpenBaoOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { OpenBaoOpError, OpenBaoOpContext };
+
+export interface CancelRootTokenGenerationRequest {}
+export const CancelRootTokenGenerationRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "DELETE", uri: "/sys/generate-root/attempt", code: 200 }),
+  ),
+).annotate({
+  identifier: "CancelRootTokenGenerationRequest",
+}) as any as S.Schema<CancelRootTokenGenerationRequest>;
+
+export interface CancelRootTokenGenerationResponse {}
+export const CancelRootTokenGenerationResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "CancelRootTokenGenerationResponse",
+}) as any as S.Schema<CancelRootTokenGenerationResponse>;
+
+export interface RootTokenGenerationCancel2Request {}
+export const RootTokenGenerationCancel2Request = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "DELETE", uri: "/sys/generate-root", code: 200 }),
+  ),
+).annotate({
+  identifier: "RootTokenGenerationCancel2Request",
+}) as any as S.Schema<RootTokenGenerationCancel2Request>;
+
+export interface RootTokenGenerationCancel2Response {}
+export const RootTokenGenerationCancel2Response = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RootTokenGenerationCancel2Response",
+}) as any as S.Schema<RootTokenGenerationCancel2Response>;
+
+export interface RootTokenGenerationInitializeRequest {
+  /** Specifies a base64-encoded PGP public key. */
+  pgp_key?: string;
+}
+export const RootTokenGenerationInitializeRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      pgp_key: S.optional(S.String),
+    }).pipe(
+      T.Http({ method: "POST", uri: "/sys/generate-root/attempt", code: 200 }),
+    ),
+).annotate({
+  identifier: "RootTokenGenerationInitializeRequest",
+}) as any as S.Schema<RootTokenGenerationInitializeRequest>;
+
+export interface RootTokenGenerationInitializeResponse {
+  complete?: boolean;
+  encoded_root_token?: string;
+  encoded_token?: string;
+  nonce?: string;
+  otp?: string;
+  otp_length?: number;
+  pgp_fingerprint?: string;
+  progress?: number;
+  required?: number;
+  started?: boolean;
+}
+export const RootTokenGenerationInitializeResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      complete: S.optional(S.Boolean),
+      encoded_root_token: S.optional(S.String),
+      encoded_token: S.optional(S.String),
+      nonce: S.optional(S.String),
+      otp: S.optional(S.String),
+      otp_length: S.optional(S.Number),
+      pgp_fingerprint: S.optional(S.String),
+      progress: S.optional(S.Number),
+      required: S.optional(S.Number),
+      started: S.optional(S.Boolean),
+    }),
+).annotate({
+  identifier: "RootTokenGenerationInitializeResponse",
+}) as any as S.Schema<RootTokenGenerationInitializeResponse>;
+
+export interface RootTokenGenerationInitialize2Request {
+  /** Specifies a base64-encoded PGP public key. */
+  pgp_key?: string;
+}
+export const RootTokenGenerationInitialize2Request = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      pgp_key: S.optional(S.String),
+    }).pipe(T.Http({ method: "POST", uri: "/sys/generate-root", code: 200 })),
+).annotate({
+  identifier: "RootTokenGenerationInitialize2Request",
+}) as any as S.Schema<RootTokenGenerationInitialize2Request>;
+
+export interface RootTokenGenerationInitialize2Response {
+  complete?: boolean;
+  encoded_root_token?: string;
+  encoded_token?: string;
+  nonce?: string;
+  otp?: string;
+  otp_length?: number;
+  pgp_fingerprint?: string;
+  progress?: number;
+  required?: number;
+  started?: boolean;
+}
+export const RootTokenGenerationInitialize2Response = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      complete: S.optional(S.Boolean),
+      encoded_root_token: S.optional(S.String),
+      encoded_token: S.optional(S.String),
+      nonce: S.optional(S.String),
+      otp: S.optional(S.String),
+      otp_length: S.optional(S.Number),
+      pgp_fingerprint: S.optional(S.String),
+      progress: S.optional(S.Number),
+      required: S.optional(S.Number),
+      started: S.optional(S.Boolean),
+    }),
+).annotate({
+  identifier: "RootTokenGenerationInitialize2Response",
+}) as any as S.Schema<RootTokenGenerationInitialize2Response>;
+
+export interface RootTokenGenerationReadProgressRequest {}
+export const RootTokenGenerationReadProgressRequest = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({}).pipe(
+      T.Http({ method: "GET", uri: "/sys/generate-root/attempt", code: 200 }),
+    ),
+).annotate({
+  identifier: "RootTokenGenerationReadProgressRequest",
+}) as any as S.Schema<RootTokenGenerationReadProgressRequest>;
+
+export interface RootTokenGenerationReadProgressResponse {
+  complete?: boolean;
+  encoded_root_token?: string;
+  encoded_token?: string;
+  nonce?: string;
+  otp?: string;
+  otp_length?: number;
+  pgp_fingerprint?: string;
+  progress?: number;
+  required?: number;
+  started?: boolean;
+}
+export const RootTokenGenerationReadProgressResponse = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      complete: S.optional(S.Boolean),
+      encoded_root_token: S.optional(S.String),
+      encoded_token: S.optional(S.String),
+      nonce: S.optional(S.String),
+      otp: S.optional(S.String),
+      otp_length: S.optional(S.Number),
+      pgp_fingerprint: S.optional(S.String),
+      progress: S.optional(S.Number),
+      required: S.optional(S.Number),
+      started: S.optional(S.Boolean),
+    }),
+).annotate({
+  identifier: "RootTokenGenerationReadProgressResponse",
+}) as any as S.Schema<RootTokenGenerationReadProgressResponse>;
+
+export interface RootTokenGenerationReadProgress2Request {}
+export const RootTokenGenerationReadProgress2Request = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({}).pipe(
+      T.Http({ method: "GET", uri: "/sys/generate-root", code: 200 }),
+    ),
+).annotate({
+  identifier: "RootTokenGenerationReadProgress2Request",
+}) as any as S.Schema<RootTokenGenerationReadProgress2Request>;
+
+export interface RootTokenGenerationReadProgress2Response {
+  complete?: boolean;
+  encoded_root_token?: string;
+  encoded_token?: string;
+  nonce?: string;
+  otp?: string;
+  otp_length?: number;
+  pgp_fingerprint?: string;
+  progress?: number;
+  required?: number;
+  started?: boolean;
+}
+export const RootTokenGenerationReadProgress2Response = /*@__PURE__*/ S.suspend(
+  () =>
+    S.Struct({
+      complete: S.optional(S.Boolean),
+      encoded_root_token: S.optional(S.String),
+      encoded_token: S.optional(S.String),
+      nonce: S.optional(S.String),
+      otp: S.optional(S.String),
+      otp_length: S.optional(S.Number),
+      pgp_fingerprint: S.optional(S.String),
+      progress: S.optional(S.Number),
+      required: S.optional(S.Number),
+      started: S.optional(S.Boolean),
+    }),
+).annotate({
+  identifier: "RootTokenGenerationReadProgress2Response",
+}) as any as S.Schema<RootTokenGenerationReadProgress2Response>;
+
+export interface RotateRootKeyRequest {}
+export const RotateRootKeyRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "POST", uri: "/sys/rotate/root", code: 200 }),
+  ),
+).annotate({
+  identifier: "RotateRootKeyRequest",
+}) as any as S.Schema<RotateRootKeyRequest>;
+
+export interface RotateRootKeyResponse {}
+export const RotateRootKeyResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "RotateRootKeyResponse",
+}) as any as S.Schema<RotateRootKeyResponse>;
+
+export interface UpdateRootTokenGenerationRequest {
+  /** Specifies a single unseal key share. */
+  key?: string;
+  /** Specifies the nonce of the attempt. */
+  nonce?: string;
+}
+export const UpdateRootTokenGenerationRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    key: S.optional(S.String),
+    nonce: S.optional(S.String),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/sys/generate-root/update", code: 200 }),
+  ),
+).annotate({
+  identifier: "UpdateRootTokenGenerationRequest",
+}) as any as S.Schema<UpdateRootTokenGenerationRequest>;
+
+export interface RootTokenGenerationUpdateResponse {
+  complete?: boolean;
+  encoded_root_token?: string;
+  encoded_token?: string;
+  nonce?: string;
+  otp?: string;
+  otp_length?: number;
+  pgp_fingerprint?: string;
+  progress?: number;
+  required?: number;
+  started?: boolean;
+}
+export const RootTokenGenerationUpdateResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    complete: S.optional(S.Boolean),
+    encoded_root_token: S.optional(S.String),
+    encoded_token: S.optional(S.String),
+    nonce: S.optional(S.String),
+    otp: S.optional(S.String),
+    otp_length: S.optional(S.Number),
+    pgp_fingerprint: S.optional(S.String),
+    progress: S.optional(S.Number),
+    required: S.optional(S.Number),
+    started: S.optional(S.Boolean),
+  }),
+).annotate({
+  identifier: "RootTokenGenerationUpdateResponse",
+}) as any as S.Schema<RootTokenGenerationUpdateResponse>;
+
+export type CancelRootTokenGenerationError = OpenBaoOpError;
+/** Cancels any in-progress root generation attempt. */
+export const cancelRootTokenGeneration: API.OperationMethod<
+  CancelRootTokenGenerationRequest,
+  CancelRootTokenGenerationResponse,
+  CancelRootTokenGenerationError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CancelRootTokenGenerationRequest,
+  output: CancelRootTokenGenerationResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RootTokenGenerationCancel2Error = OpenBaoOpError;
+/** Cancels any in-progress root generation attempt. */
+export const rootTokenGenerationCancel2: API.OperationMethod<
+  RootTokenGenerationCancel2Request,
+  RootTokenGenerationCancel2Response,
+  RootTokenGenerationCancel2Error,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RootTokenGenerationCancel2Request,
+  output: RootTokenGenerationCancel2Response,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RootTokenGenerationInitializeError = OpenBaoOpError;
+/** Initializes a new root generation attempt. Only a single root generation attempt can take place at a time. One (and only one) of otp or pgp_key are required. */
+export const rootTokenGenerationInitialize: API.OperationMethod<
+  RootTokenGenerationInitializeRequest,
+  RootTokenGenerationInitializeResponse,
+  RootTokenGenerationInitializeError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RootTokenGenerationInitializeRequest,
+  output: RootTokenGenerationInitializeResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RootTokenGenerationInitialize2Error = OpenBaoOpError;
+/** Initializes a new root generation attempt. Only a single root generation attempt can take place at a time. One (and only one) of otp or pgp_key are required. */
+export const rootTokenGenerationInitialize2: API.OperationMethod<
+  RootTokenGenerationInitialize2Request,
+  RootTokenGenerationInitialize2Response,
+  RootTokenGenerationInitialize2Error,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RootTokenGenerationInitialize2Request,
+  output: RootTokenGenerationInitialize2Response,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RootTokenGenerationReadProgressError = OpenBaoOpError;
+/** Read the configuration and progress of the current root generation attempt. */
+export const rootTokenGenerationReadProgress: API.OperationMethod<
+  RootTokenGenerationReadProgressRequest,
+  RootTokenGenerationReadProgressResponse,
+  RootTokenGenerationReadProgressError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RootTokenGenerationReadProgressRequest,
+  output: RootTokenGenerationReadProgressResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RootTokenGenerationReadProgress2Error = OpenBaoOpError;
+/** Read the configuration and progress of the current root generation attempt. */
+export const rootTokenGenerationReadProgress2: API.OperationMethod<
+  RootTokenGenerationReadProgress2Request,
+  RootTokenGenerationReadProgress2Response,
+  RootTokenGenerationReadProgress2Error,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RootTokenGenerationReadProgress2Request,
+  output: RootTokenGenerationReadProgress2Response,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type RotateRootKeyError = OpenBaoOpError;
+export const rotateRootKey: API.OperationMethod<
+  RotateRootKeyRequest,
+  RotateRootKeyResponse,
+  RotateRootKeyError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: RotateRootKeyRequest,
+  output: RotateRootKeyResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));
+
+export type UpdateRootTokenGenerationError = OpenBaoOpError;
+/** Enter a single unseal key share to progress the root generation attempt. If the threshold number of unseal key shares is reached, OpenBao will complete the root generation and issue the new token. Otherwise, this API must be called multiple times until that threshold is met. The attempt nonce must be provided with each call. */
+export const updateRootTokenGeneration: API.OperationMethod<
+  UpdateRootTokenGenerationRequest,
+  RootTokenGenerationUpdateResponse,
+  UpdateRootTokenGenerationError,
+  OpenBaoOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: UpdateRootTokenGenerationRequest,
+  output: RootTokenGenerationUpdateResponse,
+  errors: [],
+  protocol: OpenBaoProtocol,
+  retry: Retry.Retry,
+}));