@deephaven-enterprise/auth-nodejs 1.20240723.107-alpha-auth-nodejs.23556 → 1.20240723.107-alpha-auth-nodejs.23562

package/dist/clientUtils.d.ts

@@ -0,0 +1,15 @@
+import type { EnterpriseDhType as DheType } from '@deephaven-enterprise/jsapi-types';
+import type { UnauthenticatedClient } from './types.js';
+/**
+ * Create a connected, unauthenticated DHE client.
+ * @param dhe DHE JsApi.
+ * @param serverUrl The DHE server URL.
+ * @returns A connected, unauthenticated DHE client.
+ */
+export declare function createClient(dhe: DheType, serverUrl: URL): Promise<UnauthenticatedClient>;
+/**
+ * Get the WebSocket URL for a DHE server URL.
+ * @param serverUrl The DHE server URL.
+ * @returns The WebSocket URL.
+ */
+export declare function getWsUrl(serverUrl: URL): URL;

package/dist/clientUtils.js

@@ -0,0 +1,30 @@
+/**
+ * Create a connected, unauthenticated DHE client.
+ * @param dhe DHE JsApi.
+ * @param serverUrl The DHE server URL.
+ * @returns A connected, unauthenticated DHE client.
+ */
+export async function createClient(dhe, serverUrl) {
+    const dheClient = new dhe.Client(getWsUrl(serverUrl).toString());
+    return new Promise(resolve => {
+        const unsubscribe = dheClient.addEventListener(dhe.Client.EVENT_CONNECT, () => {
+            unsubscribe();
+            resolve(dheClient);
+        });
+    });
+}
+/**
+ * Get the WebSocket URL for a DHE server URL.
+ * @param serverUrl The DHE server URL.
+ * @returns The WebSocket URL.
+ */
+export function getWsUrl(serverUrl) {
+    const url = new URL('/socket', serverUrl);
+    if (url.protocol === 'http:') {
+        url.protocol = 'ws:';
+    }
+    else {
+        url.protocol = 'wss:';
+    }
+    return url;
+}

package/dist/keyPairUtils.d.ts

@@ -1,18 +1,18 @@
-import type { Base64KeyPair, Base64Nonce, Base64PrivateKey, Base64PublicKey, Base64Signature, KeyPairType } from './types.js';
-import type { EnterpriseClient, LoginCredentials } from '@deephaven-enterprise/jsapi-types';
+import type { EnterpriseDhType as DheType } from '@deephaven-enterprise/jsapi-types';
+import type { Base64KeyPair, Base64Nonce, Base64PrivateKey, Base64PublicKey, Base64Signature, KeyPairType, PasswordCredentials } from './types.js';
 /**
  * Generate a base64 encoded asymmetric key pair using eliptic curve.
  * @returns The base64 encoded public and private keys.
  */
 export declare function generateBase64KeyPair(): Base64KeyPair;
 /**
- * Prepend a sentinal value to a public key based on the given type. The
+ * Prepend a sentinal value to a Base64 key based on the given type. The
  * sentinel is the uppercase type followed by a colon.
  * @param type Keypair type.
- * @param key Base64 encoded public key.
+ * @param key Base64 encoded key.
  * @returns The key with the sentinel prepended.
  */
-export declare function keyWithSentinel(type: KeyPairType, key: Base64PublicKey): string;
+export declare function keyWithSentinel(type: KeyPairType, key: Base64PublicKey | Base64PrivateKey): string;
 /**
  * Sign a nonce using a private key.
  * @param nonce Base64 encoded nonce.
@@ -20,12 +20,37 @@ export declare function keyWithSentinel(type: KeyPairType, key: Base64PublicKey)
  * @returns The base64 encoded signature.
  */
 export declare function signWithPrivateKey(nonce: Base64Nonce, privateKey: Base64PrivateKey): Base64Signature;
+/**
+ * Delete a list of public keys for a user.
+ * @param dhe The JsApi to use.
+ * @param serverUrl The DHE server URL.
+ * @param credentials The credentials to use for authentication.
+ * @param publicKeys The list of public keys to delete.
+ * @param type The algorithm type used to generate the key.
+ * @returns A promise that resolves when the keys have been deleted.
+ */
+export declare function deletePublicKeys({ dhe, serverUrl, credentials, publicKeys, type, }: {
+    dhe: DheType;
+    serverUrl: URL;
+    credentials: PasswordCredentials;
+    publicKeys: Base64PublicKey[];
+    type: KeyPairType;
+}): Promise<void>;
 /**
  * Upload a public key to a DHE server.
- * @param dheClient The DHE client to use.
- * @param dheCredentials The credentials to use for authentication.
+ * @param dhe The DHE Jsapi to use.
+ * @param serverUrl The DHE server URL.
+ * @param credentials The credentials to use for authentication.
  * @param publicKey The base64 encoded public key.
+ * @param comment A comment to associate with the key.
  * @param type The type of key pair.
  * @returns The response from the server.
  */
-export declare function uploadPublicKey(dheClient: EnterpriseClient, dheCredentials: LoginCredentials, publicKey: Base64PublicKey, type: KeyPairType): Promise<Response>;
+export declare function uploadPublicKey({ dhe, serverUrl, credentials, publicKey, comment, type, }: {
+    dhe: DheType;
+    serverUrl: URL;
+    credentials: PasswordCredentials;
+    comment: string;
+    publicKey: Base64PublicKey;
+    type: KeyPairType;
+}): Promise<Response>;

package/dist/keyPairUtils.js

@@ -1,4 +1,5 @@
 import { generateKeyPairSync, sign } from 'node:crypto';
+import { createClient } from './clientUtils.js';
 /*
  * Named curve to use for generating key pairs.
  * Note that 'prime256v1' is synonymous with 'secp256r1'.
@@ -20,10 +21,10 @@ export function generateBase64KeyPair() {
     return { type, publicKey, privateKey };
 }
 /**
- * Prepend a sentinal value to a public key based on the given type. The
+ * Prepend a sentinal value to a Base64 key based on the given type. The
  * sentinel is the uppercase type followed by a colon.
  * @param type Keypair type.
- * @param key Base64 encoded public key.
+ * @param key Base64 encoded key.
  * @returns The key with the sentinel prepended.
  */
 export function keyWithSentinel(type, key) {
@@ -55,30 +56,62 @@ export function signWithPrivateKey(nonce, privateKey) {
         type: 'pkcs8',
     }).toString('base64');
 }
+/**
+ * Delete a list of public keys for a user.
+ * @param dhe The JsApi to use.
+ * @param serverUrl The DHE server URL.
+ * @param credentials The credentials to use for authentication.
+ * @param publicKeys The list of public keys to delete.
+ * @param type The algorithm type used to generate the key.
+ * @returns A promise that resolves when the keys have been deleted.
+ */
+export async function deletePublicKeys({ dhe, serverUrl, credentials, publicKeys, type, }) {
+    const dheClient = await createClient(dhe, serverUrl);
+    await dheClient.login(credentials);
+    const { dbAclWriterHost, dbAclWriterPort } = await dheClient.getServerConfigValues();
+    const encodedAlgorithm = encodeURIComponent(type.toUpperCase());
+    const encodedUserName = encodeURIComponent(credentials.username);
+    const authToken = await dheClient.createAuthToken('DbAclWriteServer');
+    const apiUrl = `https://${dbAclWriterHost}:${dbAclWriterPort}/acl/publickey/${encodedUserName}`;
+    const deletePromises = publicKeys.map(publicKey => {
+        const encodedPublicKey = encodeURIComponent(publicKey);
+        const query = new URLSearchParams();
+        query.set('algorithm', encodedAlgorithm);
+        query.set('encodedStr', encodedPublicKey);
+        return fetch(`${apiUrl}?${query.toString()}`, {
+            method: 'DELETE',
+            headers: {
+                Authorization: authToken,
+            },
+        });
+    });
+    await Promise.all(deletePromises);
+}
 /**
  * Upload a public key to a DHE server.
- * @param dheClient The DHE client to use.
- * @param dheCredentials The credentials to use for authentication.
+ * @param dhe The DHE Jsapi to use.
+ * @param serverUrl The DHE server URL.
+ * @param credentials The credentials to use for authentication.
  * @param publicKey The base64 encoded public key.
+ * @param comment A comment to associate with the key.
  * @param type The type of key pair.
  * @returns The response from the server.
  */
-export async function uploadPublicKey(dheClient, dheCredentials, publicKey, type) {
-    await dheClient.login(dheCredentials);
+export async function uploadPublicKey({ dhe, serverUrl, credentials, publicKey, comment, type, }) {
+    const dheClient = await createClient(dhe, serverUrl);
+    await dheClient.login(credentials);
     const { dbAclWriterHost, dbAclWriterPort } = await dheClient.getServerConfigValues();
     const body = {
-        user: dheCredentials.username,
+        user: credentials.username,
         encodedStr: keyWithSentinel(type, publicKey),
         algorithm: type.toUpperCase(),
-        comment: `Generated by vscode extension ${new Date().toISOString()}`,
+        comment,
     };
     return fetch(`https://${dbAclWriterHost}:${dbAclWriterPort}/acl/publickey`, {
         method: 'POST',
         headers: {
-            /* eslint-disable @typescript-eslint/naming-convention */
             Authorization: await dheClient.createAuthToken('DbAclWriteServer'),
             'Content-Type': 'application/json',
-            /* eslint-enable @typescript-eslint/naming-convention */
         },
         body: JSON.stringify(body),
     });

package/dist/loginUtils.d.ts

@@ -1,18 +1,4 @@
-import type { EnterpriseDhType as DheType } from '@deephaven-enterprise/jsapi-types';
 import type { AuthenticatedClient, PasswordCredentials, KeyPairCredentials, UnauthenticatedClient } from './types.js';
-/**
- * Create a connected, unauthenticated DHE client.
- * @param dhe DHE JsApi.
- * @param serverUrl The DHE server URL.
- * @returns A connected, unauthenticated DHE client.
- */
-export declare function createClient(dhe: DheType, serverUrl: URL): Promise<UnauthenticatedClient>;
-/**
- * Get the WebSocket URL for a DHE server URL.
- * @param serverUrl The DHE server URL.
- * @returns The WebSocket URL.
- */
-export declare function getWsUrl(serverUrl: URL): URL;
 /**
  * Authenticate a given client with username and password. Return the
  * authenticated client.

package/dist/loginUtils.js

@@ -3,36 +3,6 @@
 import Log from '@deephaven/log/dist/Log.js';
 import { keyWithSentinel, signWithPrivateKey } from './keyPairUtils.js';
 const logger = Log.module('@deephaven-enterprise/auth-nodejs:loginUtils');
-/**
- * Create a connected, unauthenticated DHE client.
- * @param dhe DHE JsApi.
- * @param serverUrl The DHE server URL.
- * @returns A connected, unauthenticated DHE client.
- */
-export async function createClient(dhe, serverUrl) {
-    const dheClient = new dhe.Client(getWsUrl(serverUrl).toString());
-    return new Promise(resolve => {
-        const unsubscribe = dheClient.addEventListener(dhe.Client.EVENT_CONNECT, () => {
-            unsubscribe();
-            resolve(dheClient);
-        });
-    });
-}
-/**
- * Get the WebSocket URL for a DHE server URL.
- * @param serverUrl The DHE server URL.
- * @returns The WebSocket URL.
- */
-export function getWsUrl(serverUrl) {
-    const url = new URL('/socket', serverUrl);
-    if (url.protocol === 'http:') {
-        url.protocol = 'ws:';
-    }
-    else {
-        url.protocol = 'wss:';
-    }
-    return url;
-}
 /**
  * Authenticate a given client with username and password. Return the
  * authenticated client.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/auth-nodejs",
-  "version": "1.20240723.107-alpha-auth-nodejs.23556+266602a43e",
+  "version": "1.20240723.107-alpha-auth-nodejs.23562+acecb48948",
   "description": "Deephaven Enterprise Auth Utils for NodeJS",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -17,12 +17,12 @@
     "build": "tsc --build"
   },
   "dependencies": {
-    "@deephaven-enterprise/jsapi-types": "^1.20240723.107-alpha-auth-nodejs.23556+266602a43e",
+    "@deephaven-enterprise/jsapi-types": "^1.20240723.107-alpha-auth-nodejs.23562+acecb48948",
     "@deephaven/log": "^0.97.0",
     "@deephaven/utils": "^0.97.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "266602a43e7485bf3ef6a1664ceef589e9d5c215"
+  "gitHead": "acecb48948bd4556e8eeda5d6bc1f8f4fd978f5a"
 }