mirror of
https://github.com/bitwarden/browser
synced 2026-03-02 11:31:44 +00:00
391f540d1f
* [PM-22136] Update sdk cipher view map to support uknown uuid type * [PM-22136] Add key to CipherView for copying to SdkCipherView for encryption * [PM-22136] Add fromSdk* helpers to Cipher domain objects * [PM-22136] Add toSdk* helpers to Cipher View objects * [PM-22136] Add encrypt() to cipher encryption service * [PM-22136] Add feature flag * [PM-22136] Use new SDK encrypt method when feature flag is enabled * [PM-22136] Filter out null/empty URIs * [PM-22136] Change default value for cipher view arrays to []. See ADR-0014. * [PM-22136] Keep encrypted key value on attachment so that it is passed to the SDK * [PM-22136] Keep encrypted key value on CipherView so that it is passed to the SDK during encryption * [PM-22136] Update failing attachment test * [PM-22136] Update failing importer tests due to new default value for arrays * [PM-22136] Update CipherView.fromJson to handle the prototype of EncString for the cipher key * [PM-22136] Add tickets for followup work * [PM-22136] Use new set_fido2_credentials SDK method instead * [PM-22136] Fix missing prototype when decrypting Fido2Credentials * [PM-22136] Fix test after sdk change * [PM-22136] Update @bitwarden/sdk-internal version * [PM-22136] Fix some strict typing errors * [PM-23348] Migrate move cipher to org to SDK (#15567) * [PM-23348] Add moveToOrganization method to cipher-encryption.service.ts * [PM-23348] Use cipherEncryptionService.moveToOrganization in cipherService shareWithServer and shareManyWithServer methods * [PM-23348] Update cipherFormService to use the shareWithServer() method instead of encrypt() * [PM-23348] Fix typo * [PM-23348] Add missing docs * [PM-22136] Fix EncString import after merge with main
84 lines
3.2 KiB
TypeScript
84 lines
3.2 KiB
TypeScript
import { EncryptionContext } from "@bitwarden/common/vault/abstractions/cipher.service";
|
|
import { CipherListView } from "@bitwarden/sdk-internal";
|
|
|
|
import { UserId, OrganizationId } from "../../types/guid";
|
|
import { Cipher } from "../models/domain/cipher";
|
|
import { AttachmentView } from "../models/view/attachment.view";
|
|
import { CipherView } from "../models/view/cipher.view";
|
|
|
|
/**
|
|
* Service responsible for encrypting and decrypting ciphers.
|
|
*/
|
|
export abstract class CipherEncryptionService {
|
|
/**
|
|
* Encrypts a cipher using the SDK for the given userId.
|
|
* @param model The cipher view to encrypt
|
|
* @param userId The user ID to initialize the SDK client with
|
|
*
|
|
* @returns A promise that resolves to the encryption context, or undefined if encryption fails
|
|
*/
|
|
abstract encrypt(model: CipherView, userId: UserId): Promise<EncryptionContext | undefined>;
|
|
|
|
/**
|
|
* Move the cipher to the specified organization by re-encrypting its keys with the organization's key.
|
|
* The cipher.organizationId will be updated to the new organizationId.
|
|
* @param model The cipher view to move to the organization
|
|
* @param organizationId The ID of the organization to move the cipher to
|
|
* @param userId The user ID to initialize the SDK client with
|
|
*/
|
|
abstract moveToOrganization(
|
|
model: CipherView,
|
|
organizationId: OrganizationId,
|
|
userId: UserId,
|
|
): Promise<EncryptionContext | undefined>;
|
|
|
|
/**
|
|
* Decrypts a cipher using the SDK for the given userId.
|
|
*
|
|
* @param cipher The encrypted cipher object
|
|
* @param userId The user ID whose key will be used for decryption
|
|
*
|
|
* @returns A promise that resolves to the decrypted cipher view
|
|
*/
|
|
abstract decrypt(cipher: Cipher, userId: UserId): Promise<CipherView>;
|
|
/**
|
|
* Decrypts many ciphers using the SDK for the given userId.
|
|
*
|
|
* For bulk decryption, prefer using `decryptMany`, which returns a more efficient
|
|
* `CipherListView` object.
|
|
*
|
|
* @param ciphers The encrypted cipher objects
|
|
* @param userId The user ID whose key will be used for decryption
|
|
*
|
|
* @deprecated Use `decryptMany` for bulk decryption instead.
|
|
*
|
|
* @returns A promise that resolves to an array of decrypted cipher views
|
|
*/
|
|
abstract decryptManyLegacy(ciphers: Cipher[], userId: UserId): Promise<CipherView[]>;
|
|
/**
|
|
* Decrypts many ciphers using the SDK for the given userId.
|
|
*
|
|
* @param ciphers The encrypted cipher objects
|
|
* @param userId The user ID whose key will be used for decryption
|
|
*
|
|
* @returns A promise that resolves to an array of decrypted cipher list views
|
|
*/
|
|
abstract decryptMany(ciphers: Cipher[], userId: UserId): Promise<CipherListView[]>;
|
|
/**
|
|
* Decrypts an attachment's content from a response object.
|
|
*
|
|
* @param cipher The encrypted cipher object that owns the attachment
|
|
* @param attachment The attachment view object
|
|
* @param encryptedContent The encrypted content of the attachment
|
|
* @param userId The user ID whose key will be used for decryption
|
|
*
|
|
* @returns A promise that resolves to the decrypted content
|
|
*/
|
|
abstract decryptAttachmentContent(
|
|
cipher: Cipher,
|
|
attachment: AttachmentView,
|
|
encryptedContent: Uint8Array,
|
|
userId: UserId,
|
|
): Promise<Uint8Array>;
|
|
}
|