[PM-24079] Switch EncryptedString to SDK type (#15796)

* Update usages of sdk to type-safe SDK type

* Update sdk version

* Update to "toSdk"

libs/common/src/key-management/crypto/models/enc-string.ts

@@ -1,6 +1,8 @@
 // FIXME: Update this file to be type safe and remove this and next line
 // @ts-strict-ignore
-import { Jsonify, Opaque } from "type-fest";
+import { Jsonify } from "type-fest";
+
+import { EncString as SdkEncString } from "@bitwarden/sdk-internal";
 
 import { EncryptionType, EXPECTED_NUM_PARTS_BY_ENCRYPTION_TYPE } from "../../../platform/enums";
 import { Encrypted } from "../../../platform/interfaces/encrypted";
@@ -10,7 +12,7 @@ import { SymmetricCryptoKey } from "../../../platform/models/domain/symmetric-cr
 export const DECRYPT_ERROR = "[error: cannot decrypt]";
 
 export class EncString implements Encrypted {
-  encryptedString?: EncryptedString;
+  encryptedString?: SdkEncString;
   encryptionType?: EncryptionType;
   decryptedValue?: string;
   data?: string;
@@ -42,7 +44,11 @@ export class EncString implements Encrypted {
     return this.data == null ? null : Utils.fromB64ToArray(this.data);
   }
 
-  toJSON() {
+  toSdk(): SdkEncString {
+    return this.encryptedString;
+  }
+
+  toJSON(): string {
     return this.encryptedString as string;
   }
 
@@ -56,14 +62,14 @@ export class EncString implements Encrypted {
 
   private initFromData(encType: EncryptionType, data: string, iv: string, mac: string) {
     if (iv != null) {
-      this.encryptedString = (encType + "." + iv + "|" + data) as EncryptedString;
+      this.encryptedString = (encType + "." + iv + "|" + data) as SdkEncString;
     } else {
-      this.encryptedString = (encType + "." + data) as EncryptedString;
+      this.encryptedString = (encType + "." + data) as SdkEncString;
     }
 
     // mac
     if (mac != null) {
-      this.encryptedString = (this.encryptedString + "|" + mac) as EncryptedString;
+      this.encryptedString = (this.encryptedString + "|" + mac) as SdkEncString;
     }
 
     this.encryptionType = encType;
@@ -73,7 +79,7 @@ export class EncString implements Encrypted {
   }
 
   private initFromEncryptedString(encryptedString: string) {
-    this.encryptedString = encryptedString as EncryptedString;
+    this.encryptedString = encryptedString as SdkEncString;
     if (!this.encryptedString) {
       return;
     }
@@ -191,4 +197,8 @@ export class EncString implements Encrypted {
   }
 }
 
-export type EncryptedString = Opaque<string, "EncString">;
+/**
+ * Temporary type mapping until consumers are moved over.
+ * @deprecated - Use SdkEncString directly
+ */
+export type EncryptedString = SdkEncString;

libs/common/src/platform/services/sdk/default-sdk.service.ts

@@ -22,6 +22,7 @@ import {
   ClientSettings,
   DeviceType as SdkDeviceType,
   TokenProvider,
+  UnsignedSharedKey,
 } from "@bitwarden/sdk-internal";
 
 import { EncryptedOrganizationKeyData } from "../../../admin-console/models/data/encrypted-organization-key.data";
@@ -237,7 +238,7 @@ export class DefaultSdkService implements SdkService {
       organizationKeys: new Map(
         Object.entries(orgKeys ?? {})
           .filter(([_, v]) => v.type === "organization")
-          .map(([k, v]) => [k, v.key]),
+          .map(([k, v]) => [k, v.key as UnsignedSharedKey]),
       ),
     });
   }

libs/common/src/vault/models/domain/attachment.ts

@@ -128,8 +128,8 @@ export class Attachment extends Domain {
       url: this.url,
       size: this.size,
       sizeName: this.sizeName,
-      fileName: this.fileName?.toJSON(),
+      fileName: this.fileName?.toSdk(),
-      key: this.key?.toJSON(),
+      key: this.key?.toSdk(),
     };
   }
 

libs/common/src/vault/models/domain/card.ts

@@ -95,12 +95,12 @@ export class Card extends Domain {
    */
   toSdkCard(): SdkCard {
     return {
-      cardholderName: this.cardholderName?.toJSON(),
+      cardholderName: this.cardholderName?.toSdk(),
-      brand: this.brand?.toJSON(),
+      brand: this.brand?.toSdk(),
-      number: this.number?.toJSON(),
+      number: this.number?.toSdk(),
-      expMonth: this.expMonth?.toJSON(),
+      expMonth: this.expMonth?.toSdk(),
-      expYear: this.expYear?.toJSON(),
+      expYear: this.expYear?.toSdk(),
-      code: this.code?.toJSON(),
+      code: this.code?.toSdk(),
     };
   }
 

libs/common/src/vault/models/domain/cipher.spec.ts

@@ -11,6 +11,7 @@ import {
   CipherRepromptType as SdkCipherRepromptType,
   LoginLinkedIdType,
   Cipher as SdkCipher,
+  EncString as SdkEncString,
 } from "@bitwarden/sdk-internal";
 
 import { makeStaticByteArray, mockEnc, mockFromJson } from "../../../../spec/utils";
@@ -1010,22 +1011,22 @@ describe("Cipher DTO", () => {
         organizationId: "orgId",
         folderId: "folderId",
         collectionIds: [],
-        key: "EncryptedString",
+        key: "EncryptedString" as SdkEncString,
-        name: "EncryptedString",
+        name: "EncryptedString" as SdkEncString,
-        notes: "EncryptedString",
+        notes: "EncryptedString" as SdkEncString,
         type: SdkCipherType.Login,
         login: {
-          username: "EncryptedString",
+          username: "EncryptedString" as SdkEncString,
-          password: "EncryptedString",
+          password: "EncryptedString" as SdkEncString,
           passwordRevisionDate: "2022-01-31T12:00:00.000Z",
           uris: [
             {
-              uri: "EncryptedString",
+              uri: "EncryptedString" as SdkEncString,
-              uriChecksum: "EncryptedString",
+              uriChecksum: "EncryptedString" as SdkEncString,
               match: UriMatchType.Domain,
             },
           ],
-          totp: "EncryptedString",
+          totp: "EncryptedString" as SdkEncString,
           autofillOnPageLoad: false,
           fido2Credentials: undefined,
         },
@@ -1049,35 +1050,35 @@ describe("Cipher DTO", () => {
             url: "url",
             size: "1100",
             sizeName: "1.1 KB",
-            fileName: "file",
+            fileName: "file" as SdkEncString,
-            key: "EncKey",
+            key: "EncKey" as SdkEncString,
           },
           {
             id: "a2",
             url: "url",
             size: "1100",
             sizeName: "1.1 KB",
-            fileName: "file",
+            fileName: "file" as SdkEncString,
-            key: "EncKey",
+            key: "EncKey" as SdkEncString,
           },
         ],
         fields: [
           {
-            name: "EncryptedString",
+            name: "EncryptedString" as SdkEncString,
-            value: "EncryptedString",
+            value: "EncryptedString" as SdkEncString,
             type: FieldType.Linked,
             linkedId: LoginLinkedIdType.Username,
           },
           {
-            name: "EncryptedString",
+            name: "EncryptedString" as SdkEncString,
-            value: "EncryptedString",
+            value: "EncryptedString" as SdkEncString,
             type: FieldType.Linked,
             linkedId: LoginLinkedIdType.Password,
           },
         ],
         passwordHistory: [
           {
-            password: "EncryptedString",
+            password: "EncryptedString" as SdkEncString,
             lastUsedDate: "2022-01-31T12:00:00.000Z",
           },
         ],

libs/common/src/vault/models/domain/cipher.ts

@@ -348,9 +348,9 @@ export class Cipher extends Domain implements Decryptable<CipherView> {
       organizationId: this.organizationId ?? undefined,
       folderId: this.folderId ?? undefined,
       collectionIds: this.collectionIds ?? [],
-      key: this.key?.toJSON(),
+      key: this.key?.toSdk(),
-      name: this.name.toJSON(),
+      name: this.name.toSdk(),
-      notes: this.notes?.toJSON(),
+      notes: this.notes?.toSdk(),
       type: this.type,
       favorite: this.favorite ?? false,
       organizationUseTotp: this.organizationUseTotp ?? false,

libs/common/src/vault/models/domain/fido2-credential.ts

@@ -158,18 +158,18 @@ export class Fido2Credential extends Domain {
    */
   toSdkFido2Credential(): SdkFido2Credential {
     return {
-      credentialId: this.credentialId?.toJSON(),
+      credentialId: this.credentialId?.toSdk(),
-      keyType: this.keyType.toJSON(),
+      keyType: this.keyType.toSdk(),
-      keyAlgorithm: this.keyAlgorithm.toJSON(),
+      keyAlgorithm: this.keyAlgorithm.toSdk(),
-      keyCurve: this.keyCurve.toJSON(),
+      keyCurve: this.keyCurve.toSdk(),
-      keyValue: this.keyValue.toJSON(),
+      keyValue: this.keyValue.toSdk(),
-      rpId: this.rpId.toJSON(),
+      rpId: this.rpId.toSdk(),
-      userHandle: this.userHandle?.toJSON(),
+      userHandle: this.userHandle?.toSdk(),
-      userName: this.userName?.toJSON(),
+      userName: this.userName?.toSdk(),
-      counter: this.counter.toJSON(),
+      counter: this.counter.toSdk(),
-      rpName: this.rpName?.toJSON(),
+      rpName: this.rpName?.toSdk(),
-      userDisplayName: this.userDisplayName?.toJSON(),
+      userDisplayName: this.userDisplayName?.toSdk(),
-      discoverable: this.discoverable?.toJSON(),
+      discoverable: this.discoverable?.toSdk(),
       creationDate: this.creationDate.toISOString(),
     };
   }

libs/common/src/vault/models/domain/field.ts

@@ -83,8 +83,8 @@ export class Field extends Domain {
    */
   toSdkField(): SdkField {
     return {
-      name: this.name?.toJSON(),
+      name: this.name?.toSdk(),
-      value: this.value?.toJSON(),
+      value: this.value?.toSdk(),
       type: this.type,
       // Safe type cast: client and SDK LinkedIdType enums have identical values
       linkedId: this.linkedId as unknown as SdkLinkedIdType,

libs/common/src/vault/models/domain/identity.ts

@@ -175,24 +175,24 @@ export class Identity extends Domain {
    */
   toSdkIdentity(): SdkIdentity {
     return {
-      title: this.title?.toJSON(),
+      title: this.title?.toSdk(),
-      firstName: this.firstName?.toJSON(),
+      firstName: this.firstName?.toSdk(),
-      middleName: this.middleName?.toJSON(),
+      middleName: this.middleName?.toSdk(),
-      lastName: this.lastName?.toJSON(),
+      lastName: this.lastName?.toSdk(),
-      address1: this.address1?.toJSON(),
+      address1: this.address1?.toSdk(),
-      address2: this.address2?.toJSON(),
+      address2: this.address2?.toSdk(),
-      address3: this.address3?.toJSON(),
+      address3: this.address3?.toSdk(),
-      city: this.city?.toJSON(),
+      city: this.city?.toSdk(),
-      state: this.state?.toJSON(),
+      state: this.state?.toSdk(),
-      postalCode: this.postalCode?.toJSON(),
+      postalCode: this.postalCode?.toSdk(),
-      country: this.country?.toJSON(),
+      country: this.country?.toSdk(),
-      company: this.company?.toJSON(),
+      company: this.company?.toSdk(),
-      email: this.email?.toJSON(),
+      email: this.email?.toSdk(),
-      phone: this.phone?.toJSON(),
+      phone: this.phone?.toSdk(),
-      ssn: this.ssn?.toJSON(),
+      ssn: this.ssn?.toSdk(),
-      username: this.username?.toJSON(),
+      username: this.username?.toSdk(),
-      passportNumber: this.passportNumber?.toJSON(),
+      passportNumber: this.passportNumber?.toSdk(),
-      licenseNumber: this.licenseNumber?.toJSON(),
+      licenseNumber: this.licenseNumber?.toSdk(),
     };
   }
 

libs/common/src/vault/models/domain/login-uri.ts

@@ -97,8 +97,8 @@ export class LoginUri extends Domain {
    */
   toSdkLoginUri(): SdkLoginUri {
     return {
-      uri: this.uri?.toJSON(),
+      uri: this.uri?.toSdk(),
-      uriChecksum: this.uriChecksum?.toJSON(),
+      uriChecksum: this.uriChecksum?.toSdk(),
       match: this.match,
     };
   }

libs/common/src/vault/models/domain/login.ts

@@ -155,10 +155,10 @@ export class Login extends Domain {
   toSdkLogin(): SdkLogin {
     return {
       uris: this.uris?.map((u) => u.toSdkLoginUri()),
-      username: this.username?.toJSON(),
+      username: this.username?.toSdk(),
-      password: this.password?.toJSON(),
+      password: this.password?.toSdk(),
       passwordRevisionDate: this.passwordRevisionDate?.toISOString(),
-      totp: this.totp?.toJSON(),
+      totp: this.totp?.toSdk(),
       autofillOnPageLoad: this.autofillOnPageLoad ?? undefined,
       fido2Credentials: this.fido2Credentials?.map((f) => f.toSdkFido2Credential()),
     };

libs/common/src/vault/models/domain/password.ts

@@ -67,7 +67,7 @@ export class Password extends Domain {
    */
   toSdkPasswordHistory(): PasswordHistory {
     return {
-      password: this.password.toJSON(),
+      password: this.password.toSdk(),
       lastUsedDate: this.lastUsedDate.toISOString(),
     };
   }

libs/common/src/vault/models/domain/ssh-key.ts

@@ -80,9 +80,9 @@ export class SshKey extends Domain {
    */
   toSdkSshKey(): SdkSshKey {
     return {
-      privateKey: this.privateKey.toJSON(),
+      privateKey: this.privateKey.toSdk(),
-      publicKey: this.publicKey.toJSON(),
+      publicKey: this.publicKey.toSdk(),
-      fingerprint: this.keyFingerprint.toJSON(),
+      fingerprint: this.keyFingerprint.toSdk(),
     };
   }
 

libs/common/src/vault/models/view/attachment.view.ts

@@ -69,7 +69,7 @@ export class AttachmentView implements View {
       size: this.size,
       sizeName: this.sizeName,
       fileName: this.fileName,
-      key: this.encryptedKey?.toJSON(),
+      key: this.encryptedKey?.toSdk(),
       // TODO: PM-23005 - Temporary field, should be removed when encrypted migration is complete
       decryptedKey: this.key ? this.key.toBase64() : null,
     };

libs/common/src/vault/models/view/cipher.view.ts

@@ -331,7 +331,7 @@ export class CipherView implements View, InitializerMetadata {
       creationDate: (this.creationDate ?? new Date()).toISOString(),
       deletedDate: this.deletedDate?.toISOString(),
       reprompt: this.reprompt ?? CipherRepromptType.None,
-      key: this.key?.toJSON(),
+      key: this.key?.toSdk(),
       // Cipher type specific properties are set in the switch statement below
       // CipherView initializes each with default constructors (undefined values)
       // The SDK does not expect those undefined values and will throw exceptions

libs/key-management/src/user-asymmetric-key-regeneration/services/default-user-asymmetric-key-regeneration.service.spec.ts

@@ -15,7 +15,7 @@ import { UserId } from "@bitwarden/common/types/guid";
 import { UserKey } from "@bitwarden/common/types/key";
 import { CipherService } from "@bitwarden/common/vault/abstractions/cipher.service";
 import { Cipher } from "@bitwarden/common/vault/models/domain/cipher";
-import { VerifyAsymmetricKeysResponse } from "@bitwarden/sdk-internal";
+import { VerifyAsymmetricKeysResponse, EncString as SdkEncString } from "@bitwarden/sdk-internal";
 
 import { KeyService } from "../../abstractions/key.service";
 import { UserAsymmetricKeysRegenerationApiService } from "../abstractions/user-asymmetric-key-regeneration-api.service";
@@ -28,7 +28,7 @@ function setupVerificationResponse(
 ) {
   const mockKeyPairResponse = {
     userPublicKey: "userPublicKey",
-    userKeyEncryptedPrivateKey: "userKeyEncryptedPrivateKey",
+    userKeyEncryptedPrivateKey: "userKeyEncryptedPrivateKey" as SdkEncString,
   };
 
   sdkService.client.crypto

package-lock.json

@@ -23,7 +23,7 @@
         "@angular/platform-browser": "19.2.14",
         "@angular/platform-browser-dynamic": "19.2.14",
         "@angular/router": "19.2.14",
-        "@bitwarden/sdk-internal": "0.2.0-main.237",
+        "@bitwarden/sdk-internal": "0.2.0-main.239",
         "@electron/fuses": "1.8.0",
         "@emotion/css": "11.13.5",
         "@koa/multer": "4.0.0",
@@ -4622,9 +4622,9 @@
       "link": true
     },
     "node_modules/@bitwarden/sdk-internal": {
-      "version": "0.2.0-main.237",
+      "version": "0.2.0-main.239",
-      "resolved": "https://registry.npmjs.org/@bitwarden/sdk-internal/-/sdk-internal-0.2.0-main.237.tgz",
+      "resolved": "https://registry.npmjs.org/@bitwarden/sdk-internal/-/sdk-internal-0.2.0-main.239.tgz",
-      "integrity": "sha512-1psCagsmUo2QeIw/xFW/OCfSInl6Gu+LYldbdLuv1z26FurrgmAv8BejDaPRx006BRn0z0hn6TlZtteaZS762w==",
+      "integrity": "sha512-nX1aaoXGWdZVJKLnlewxw3kibgIjukVj/1JD0Dl1OevAVM694MnD/LQTRbyme8rvUxnUhxFjQi6NpwbUJdJPCA==",
       "license": "GPL-3.0",
       "dependencies": {
         "type-fest": "^4.41.0"

package.json

@@ -158,7 +158,7 @@
     "@angular/platform-browser": "19.2.14",
     "@angular/platform-browser-dynamic": "19.2.14",
     "@angular/router": "19.2.14",
-    "@bitwarden/sdk-internal": "0.2.0-main.237",
+    "@bitwarden/sdk-internal": "0.2.0-main.239",
     "@electron/fuses": "1.8.0",
     "@emotion/css": "11.13.5",
     "@koa/multer": "4.0.0",