@bitwarden/sdk-internal 0.2.0-main.8 → 0.2.0-main.81

package/node/bitwarden_wasm_internal.d.ts

@@ -1,5 +1,32 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * Generate a new SSH key pair
+ *
+ * # Arguments
+ * - `key_algorithm` - The algorithm to use for the key pair
+ *
+ * # Returns
+ * - `Ok(SshKey)` if the key was successfully generated
+ * - `Err(KeyGenerationError)` if the key could not be generated
+ */
+export function generate_ssh_key(key_algorithm: KeyAlgorithm): SshKey;
+/**
+ * Convert a PCKS8 or OpenSSH encrypted or unencrypted private key
+ * to an OpenSSH private key with public key and fingerprint
+ *
+ * # Arguments
+ * - `imported_key` - The private key to convert
+ * - `password` - The password to use for decrypting the key
+ *
+ * # Returns
+ * - `Ok(SshKey)` if the key was successfully coneverted
+ * - `Err(PasswordRequired)` if the key is encrypted and no password was provided
+ * - `Err(WrongPassword)` if the password provided is incorrect
+ * - `Err(ParsingError)` if the key could not be parsed
+ * - `Err(UnsupportedKeyType)` if the key type is not supported
+ */
+export function import_ssh_key(imported_key: string, password?: string | null): SshKey;
 export enum LogLevel {
   Trace = 0,
   Debug = 1,
@@ -51,6 +78,43 @@ export interface InitOrgCryptoRequest {
   organizationKeys: Map<Uuid, AsymmetricEncString>;
 }
 
+export interface MakeKeyPairResponse {
+  /**
+   * The user\'s public key
+   */
+  userPublicKey: string;
+  /**
+   * User\'s private key, encrypted with the user key
+   */
+  userKeyEncryptedPrivateKey: EncString;
+}
+
+export interface VerifyAsymmetricKeysRequest {
+  /**
+   * The user\'s user key
+   */
+  userKey: string;
+  /**
+   * The user\'s public key
+   */
+  userPublicKey: string;
+  /**
+   * User\'s private key, encrypted with the user key
+   */
+  userKeyEncryptedPrivateKey: EncString;
+}
+
+export interface VerifyAsymmetricKeysResponse {
+  /**
+   * Whether the user\'s private key was decryptable by the user key.
+   */
+  privateKeyDecryptable: boolean;
+  /**
+   * Whether the user\'s private key was a valid RSA key and matched the public key provided.
+   */
+  validPrivateKey: boolean;
+}
+
 export interface CoreError extends Error {
   name: "CoreError";
   variant:
@@ -67,7 +131,6 @@ export interface CoreError extends Error {
     | "InvalidBase64"
     | "Chrono"
     | "ResponseContent"
-    | "ValidationError"
     | "InvalidStateFileVersion"
     | "InvalidStateFile"
     | "Internal"
@@ -161,6 +224,38 @@ export type Kdf =
   | { pBKDF2: { iterations: NonZeroU32 } }
   | { argon2id: { iterations: NonZeroU32; memory: NonZeroU32; parallelism: NonZeroU32 } };
 
+export interface SshKey {
+  /**
+   * The private key in OpenSSH format
+   */
+  private_key: string;
+  public_key: string;
+  key_fingerprint: string;
+}
+
+export type KeyAlgorithm = "Ed25519" | "Rsa3072" | "Rsa4096";
+
+export interface SshKeyExportError extends Error {
+  name: "SshKeyExportError";
+  variant: "KeyConversionError";
+}
+
+export function isSshKeyExportError(error: any): error is SshKeyExportError;
+
+export interface SshKeyImportError extends Error {
+  name: "SshKeyImportError";
+  variant: "ParsingError" | "PasswordRequired" | "WrongPassword" | "UnsupportedKeyType";
+}
+
+export function isSshKeyImportError(error: any): error is SshKeyImportError;
+
+export interface KeyGenerationError extends Error {
+  name: "KeyGenerationError";
+  variant: "KeyGenerationError" | "KeyConversionError";
+}
+
+export function isKeyGenerationError(error: any): error is KeyGenerationError;
+
 export interface Folder {
   id: Uuid | undefined;
   name: EncString;
@@ -173,6 +268,24 @@ export interface FolderView {
   revisionDate: DateTime<Utc>;
 }
 
+export interface TotpResponse {
+  /**
+   * Generated TOTP code
+   */
+  code: string;
+  /**
+   * Time period
+   */
+  period: number;
+}
+
+export interface TotpError extends Error {
+  name: "TotpError";
+  variant: "InvalidOtpauth" | "MissingSecret" | "CryptoError" | "VaultLocked";
+}
+
+export function isTotpError(error: any): error is TotpError;
+
 export interface TestError extends Error {
   name: "TestError";
 }
@@ -199,71 +312,75 @@ export type NonZeroU32 = number;
 
 export class BitwardenClient {
   free(): void;
-  /**
-   * @param {ClientSettings | undefined} [settings]
-   * @param {LogLevel | undefined} [log_level]
-   */
-  constructor(settings?: ClientSettings, log_level?: LogLevel);
+  constructor(settings?: ClientSettings | null, log_level?: LogLevel | null);
   /**
    * Test method, echoes back the input
-   * @param {string} msg
-   * @returns {string}
    */
   echo(msg: string): string;
-  /**
-   * @returns {string}
-   */
   version(): string;
-  /**
-   * @param {string} msg
-   * @returns {Promise<void>}
-   */
-  throw(msg: string): Promise<void>;
+  throw(msg: string): void;
   /**
    * Test method, calls http endpoint
-   * @param {string} url
-   * @returns {Promise<string>}
    */
   http_get(url: string): Promise<string>;
+  crypto(): CryptoClient;
+  vault(): VaultClient;
+}
+export class ClientFolders {
+  private constructor();
+  free(): void;
   /**
-   * @returns {ClientCrypto}
+   * Decrypt folder
    */
-  crypto(): ClientCrypto;
+  decrypt(folder: Folder): FolderView;
+}
+export class ClientTotp {
+  private constructor();
+  free(): void;
   /**
-   * @returns {ClientVault}
+   * Generates a TOTP code from a provided key
+   *
+   * # Arguments
+   * - `key` - Can be:
+   *     - A base32 encoded string
+   *     - OTP Auth URI
+   *     - Steam URI
+   * - `time_ms` - Optional timestamp in milliseconds
+   *
+   * # Returns
+   * - `Ok(TotpResponse)` containing the generated code and period
+   * - `Err(TotpError)` if code generation fails
    */
-  vault(): ClientVault;
+  generate_totp(key: string, time_ms?: number | null): TotpResponse;
 }
-export class ClientCrypto {
+export class CryptoClient {
+  private constructor();
   free(): void;
   /**
    * Initialization method for the user crypto. Needs to be called before any other crypto
    * operations.
-   * @param {InitUserCryptoRequest} req
-   * @returns {Promise<void>}
    */
   initialize_user_crypto(req: InitUserCryptoRequest): Promise<void>;
   /**
    * Initialization method for the organization crypto. Needs to be called after
    * `initialize_user_crypto` but before any other crypto operations.
-   * @param {InitOrgCryptoRequest} req
-   * @returns {Promise<void>}
    */
   initialize_org_crypto(req: InitOrgCryptoRequest): Promise<void>;
-}
-export class ClientFolders {
-  free(): void;
   /**
-   * Decrypt folder
-   * @param {Folder} folder
-   * @returns {FolderView}
+   * Generates a new key pair and encrypts the private key with the provided user key.
+   * Crypto initialization not required.
    */
-  decrypt(folder: Folder): FolderView;
-}
-export class ClientVault {
-  free(): void;
+  make_key_pair(user_key: string): MakeKeyPairResponse;
   /**
-   * @returns {ClientFolders}
+   * Verifies a user's asymmetric keys by decrypting the private key with the provided user
+   * key. Returns if the private key is decryptable and if it is a valid matching key.
+   * Crypto initialization not required.
    */
+  verify_asymmetric_keys(request: VerifyAsymmetricKeysRequest): VerifyAsymmetricKeysResponse;
+}
+export class VaultClient {
+  private constructor();
+  free(): void;
   folders(): ClientFolders;
+  totp(): ClientTotp;
 }