bitwarden/browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser synced 2026-02-10 21:50:15 +00:00
Code Issues Releases Wiki Activity

[BEEEP] Add deprecation notices to encstring encrypt API (#18811)

Browse Source 
* Add deprecation notices to encstring encrypt API

* Cleanup comment

* Run prettier
This commit is contained in:
Bernd Schoolmann
2026-02-10 00:29:45 +01:00
committed by GitHub
parent 9856902688
commit d37e173ee3
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
libs/common/src/key-management/crypto/abstractions/encrypt.service.ts
View File

@@ -5,12 +5,20 @@ import { EncString } from "../models/enc-string";
export abstract class EncryptService {
/**
* Encrypts a string to an EncString
*
* @deprecated NOTE: For new use-cases, prefer using the DataEnvelope inside the SDK instead. This
* is both safer and more maintainable.
*
* @param plainValue - The value to encrypt
* @param key - The key to encrypt the value with
*/
abstract encryptString(plainValue: string, key: SymmetricCryptoKey): Promise<EncString>;
/**
* Encrypts bytes to an EncString
*
* @deprecated NOTE: You probably do not want to encrypt raw bytes. Please contact the Key-Management team if you think
* you need to.
*
* @param plainValue - The value to encrypt
* @param key - The key to encrypt the value with
* @deprecated Bytes are not the right abstraction to encrypt in. Use e.g. key wrapping or file encryption instead
@@ -129,6 +137,9 @@ export abstract class EncryptService {
* Encapsulates a symmetric key with an asymmetric public key
* Note: This does not establish sender authenticity
* @see {@link https://en.wikipedia.org/wiki/Key_encapsulation_mechanism}
*
* @deprecated NOTE: You probably do not want to use this. Please contact the Key-Management team if you think you need to.
*
* @param sharedKey - The symmetric key that is to be shared
* @param encapsulationKey - The encapsulation key (public key) of the receiver that the key is shared with
*/