Added Base64Signature type (32)

deephaven · Oct 23, 2024 · 640290a · 640290a
1 parent cf7a5da
commit 640290a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/src/controllers/UserLoginController.ts b/src/controllers/UserLoginController.ts
@@ -21,8 +21,6 @@ import {
 } from '../util';
 import type {
   Base64Nonce,
-  Base64PrivateKey,
-  Base64PublicKey,
   IAsyncCacheService,
   Lazy,
   ServerState,

diff --git a/src/types/commonTypes.d.ts b/src/types/commonTypes.d.ts
@@ -44,6 +44,7 @@ export type OperateAsUsername = Brand<'OperateAsUsername', string>;
 export type Base64PrivateKey = Brand<'Base64PrivateKey', string>;
 export type Base64PublicKey = Brand<'Base64PublicKey', string>;
 export type Base64Nonce = Brand<'Base64Nonce', string>;
+export type Base64Signature = Brand<'Base64Signature', string>;
 export type DHPrivateKey = Brand<'DHPrivateKey', string>;
 export type DHPublicKey = Brand<'DHPublicKey', string>;
 export type ServerSecretKeys = Record<string, Base64PrivateKey>;

diff --git a/src/util/authUtils.ts b/src/util/authUtils.ts
@@ -3,6 +3,7 @@ import type {
   Base64Nonce,
   Base64PrivateKey,
   Base64PublicKey,
+  Base64Signature,
   DHPrivateKey,
   DHPublicKey,
 } from '../types';
@@ -58,16 +59,22 @@ export function formatDHPrivateKey(
   ].join('\n') as DHPrivateKey;
 }
 
+/**
+ * Sign a nonce using a private key.
+ * @param nonce
+ * @param privateKey
+ * @returns The base64 encoded signature.
+ */
 export function signWithPrivateKey(
   nonce: Base64Nonce,
   privateKey: Base64PrivateKey
-): string {
+): Base64Signature {
   const nonceBytes = Buffer.from(nonce, 'base64');
   const privateKeyBytes = Buffer.from(privateKey, 'base64');
 
   return sign('sha256', nonceBytes, {
     key: privateKeyBytes,
     format: 'der',
     type: 'pkcs8',
-  }).toString('base64');
+  }).toString('base64') as Base64Signature;
 }