Reauth SDK when desktop app is locked (#163)

When the SDK makes an invoke operation to the locked 1Password app, the user is prompted to re-authorize. Once that is made, the SDK will now override the existing SDK client with a new one that can perform the invoke operation.

Author: edif2008

client/src/client_builder.ts

@@ -22,10 +22,7 @@ export const createClientWithCore = async (
     core.setInner(new SharedLibCore(authConfig.accountName));
   }
   const clientId = await core.initClient(authConfig);
-  const inner: InnerClient = {
-    id: parseInt(clientId, 10),
-    core,
-  };
+  const inner = new InnerClient(parseInt(clientId, 10), core, authConfig);
   const client = new Client(inner);
   // Cleans up associated memory from core when client instance goes out of scope.
   finalizationRegistry.register(client, inner);

client/src/core.ts

@@ -6,7 +6,7 @@ import {
 } from "@1password/sdk-core";
 
 import { ReplacerFunc } from "./types";
-import { throwError } from "./errors";
+import { DesktopSessionExpiredError, throwError } from "./errors";
 
 // In empirical tests, we determined that maximum message size that can cross the FFI boundary
 // is ~64MB. Past this limit, the wasm-bingen FFI will throw an error and the program will crash.
@@ -123,11 +123,7 @@ export class SharedCore {
 
   public async initClient(config: ClientAuthConfig): Promise<string> {
     const serializedConfig = JSON.stringify(config);
-    try {
-      return await this.inner.initClient(serializedConfig);
-    } catch (e) {
-      throwError(e as string);
-    }
+    return this.inner.initClient(serializedConfig);
   }
 
   public async invoke(config: InvokeConfig): Promise<string> {
@@ -139,11 +135,7 @@ export class SharedCore {
         `message size exceeds the limit of ${messageLimit} bytes, please contact 1Password at support@1password.com or https://developer.1password.com/joinslack if you need help."`,
       );
     }
-    try {
-      return await this.inner.invoke(serializedConfig);
-    } catch (e) {
-      throwError(e as string);
-    }
+    return this.inner.invoke(serializedConfig);
   }
 
   public invoke_sync(config: InvokeConfig): string {
@@ -155,11 +147,7 @@ export class SharedCore {
         `message size exceeds the limit of ${messageLimit} bytes, please contact 1Password at support@1password.com or https://developer.1password.com/joinslack if you need help.`,
       );
     }
-    try {
-      return invoke_sync(serializedConfig);
-    } catch (e) {
-      throwError(e as string);
-    }
+    return invoke_sync(serializedConfig);
   }
 
   public releaseClient(clientId: number): void {
@@ -171,7 +159,24 @@ export class SharedCore {
 /**
  *  Represents the client instance on which a call is made.
  */
-export interface InnerClient {
-  id: number;
-  core: SharedCore;
+export class InnerClient {
+  public constructor(
+    public id: number,
+    public readonly core: SharedCore,
+    public config: ClientAuthConfig,
+  ) {}
+
+  public async invoke(config: InvokeConfig): Promise<string> {
+    try {
+      return await this.core.invoke(config);
+    } catch (err: unknown) {
+      if (err instanceof DesktopSessionExpiredError) {
+        const newId = await this.core.initClient(this.config);
+        this.id = parseInt(newId, 10);
+        config.invocation.clientId = this.id;
+        return await this.core.invoke(config);
+      }
+      throw err;
+    }
+  }
 }

client/src/errors.ts

@@ -1,5 +1,14 @@
 // Code generated by op-codegen - DO NOT EDIT MANUALLY
 
+export class DesktopSessionExpiredError extends Error {
+  public message: string;
+
+  public constructor(message: string) {
+    super();
+    this.message = message;
+  }
+}
+
 export class RateLimitExceededError extends Error {
   public message: string;
 
@@ -23,6 +32,8 @@ export const throwError = (errString: string) => {
   }
 
   switch (err.name) {
+    case "DesktopSessionExpired":
+      throw new DesktopSessionExpiredError(err.message);
     case "RateLimitExceeded":
       throw new RateLimitExceededError(err.message);
     default:

client/src/groups.ts

@@ -34,7 +34,7 @@ export class Groups implements GroupsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Group;
   }

client/src/items.ts

@@ -99,7 +99,7 @@ export class Items implements ItemsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Item;
   }
@@ -124,7 +124,7 @@ export class Items implements ItemsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as ItemsUpdateAllResponse;
   }
@@ -146,7 +146,7 @@ export class Items implements ItemsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Item;
   }
@@ -171,7 +171,7 @@ export class Items implements ItemsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as ItemsGetAllResponse;
   }
@@ -192,7 +192,7 @@ export class Items implements ItemsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Item;
   }
@@ -213,7 +213,7 @@ export class Items implements ItemsApi {
         },
       },
     };
-    await this.#inner.core.invoke(invocationConfig);
+    await this.#inner.invoke(invocationConfig);
   }
 
   /**
@@ -236,7 +236,7 @@ export class Items implements ItemsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as ItemsDeleteAllResponse;
   }
@@ -257,7 +257,7 @@ export class Items implements ItemsApi {
         },
       },
     };
-    await this.#inner.core.invoke(invocationConfig);
+    await this.#inner.invoke(invocationConfig);
   }
 
   /**
@@ -280,7 +280,7 @@ export class Items implements ItemsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as ItemOverview[];
   }

client/src/items_files.ts

@@ -59,7 +59,7 @@ export class ItemsFiles implements ItemsFilesApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Item;
   }
@@ -86,7 +86,7 @@ export class ItemsFiles implements ItemsFilesApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Uint8Array;
   }
@@ -113,7 +113,7 @@ export class ItemsFiles implements ItemsFilesApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Item;
   }
@@ -138,7 +138,7 @@ export class ItemsFiles implements ItemsFilesApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Item;
   }

client/src/items_shares.ts

@@ -63,7 +63,7 @@ export class ItemsShares implements ItemsSharesApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as ItemShareAccountPolicy;
   }
@@ -88,7 +88,7 @@ export class ItemsShares implements ItemsSharesApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as ValidRecipient[];
   }
@@ -115,7 +115,7 @@ export class ItemsShares implements ItemsSharesApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as string;
   }

client/src/secrets.ts

@@ -47,7 +47,7 @@ export class Secrets implements SecretsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as string;
   }
@@ -70,7 +70,7 @@ export class Secrets implements SecretsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as ResolveAllResponse;
   }

client/src/shared_lib_core.ts

@@ -3,6 +3,7 @@ import * as os from "os";
 import * as path from "path";
 
 import { Core } from "./core";
+import { throwError } from "./errors";
 
 /**
  * Find the 1Password shared lib path by asking an the wasm core synchronously.
@@ -142,34 +143,28 @@ export class SharedLibCore implements Core {
 
     const inputBuf = Buffer.from(JSON.stringify(req), "utf8");
 
-    try {
-      const nativeResponse = await this.lib.sendMessage(inputBuf);
+    const nativeResponse = await this.lib.sendMessage(inputBuf);
 
-      if (!(nativeResponse instanceof Uint8Array)) {
-        throw new Error(
-          `Native function returned an unexpected type. Expected Uint8Array, got ${typeof nativeResponse}`,
-        );
-      }
+    if (!(nativeResponse instanceof Uint8Array)) {
+      throw new Error(
+        `Native function returned an unexpected type. Expected Uint8Array, got ${typeof nativeResponse}`,
+      );
+    }
 
-      const respString = new TextDecoder().decode(nativeResponse);
-      const response = JSON.parse(respString) as SharedLibResponse;
+    const respString = new TextDecoder().decode(nativeResponse);
+    const response = JSON.parse(respString) as SharedLibResponse;
 
-      if (response.success) {
-        const decodedPayload = Buffer.from(response.payload).toString("utf8");
-        // On success, the payload is the actual result string
-        return decodedPayload;
-      } else {
-        // On failure, convert the error payload to a readable string and throw
-        const errorMessage = Array.isArray(response.payload)
-          ? String.fromCharCode(...response.payload)
-          : JSON.stringify(response.payload);
+    if (response.success) {
+      const decodedPayload = Buffer.from(response.payload).toString("utf8");
+      // On success, the payload is the actual result string
+      return decodedPayload;
+    } else {
+      // On failure, convert the error payload to a readable string and throw
+      const errorMessage = Array.isArray(response.payload)
+        ? String.fromCharCode(...response.payload)
+        : JSON.stringify(response.payload);
 
-        throw new Error(`Native library returned an error: ${errorMessage}`);
-      }
-    } catch (e) {
-      // Catch errors from the native call or from JSON parsing
-      console.error("An error occurred during the native library call:", e);
-      throw e;
+      throwError(errorMessage);
     }
   }
 

client/src/vaults.ts

@@ -54,7 +54,7 @@ export class Vaults implements VaultsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as VaultOverview[];
   }
@@ -72,7 +72,7 @@ export class Vaults implements VaultsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as VaultOverview;
   }
@@ -94,7 +94,7 @@ export class Vaults implements VaultsApi {
       },
     };
     return JSON.parse(
-      await this.#inner.core.invoke(invocationConfig),
+      await this.#inner.invoke(invocationConfig),
       ReviverFunc,
     ) as Vault;
   }
@@ -115,7 +115,7 @@ export class Vaults implements VaultsApi {
         },
       },
     };
-    await this.#inner.core.invoke(invocationConfig);
+    await this.#inner.invoke(invocationConfig);
   }
 
   public async updateGroupPermissions(
@@ -132,7 +132,7 @@ export class Vaults implements VaultsApi {
         },
       },
     };
-    await this.#inner.core.invoke(invocationConfig);
+    await this.#inner.invoke(invocationConfig);
   }
 
   public async revokeGroupPermissions(vaultId: string, groupId: string) {
@@ -148,6 +148,6 @@ export class Vaults implements VaultsApi {
         },
       },
     };
-    await this.#inner.core.invoke(invocationConfig);
+    await this.#inner.invoke(invocationConfig);
   }
 }