BackgroundAesGcm class

AesGcm that's optimized to use compute.

Mixed-in types

Constructors

BackgroundAesGcm({required int secretKeyLength, int nonceLength = AesGcm.defaultNonceLength, CryptographyChannelPolicy? channelPolicy, Random? random})
Constructs AesGcm that's optimized to use compute.
BackgroundAesGcm.with128bits({int nonceLength = AesGcm.defaultNonceLength})
BackgroundAesGcm.with192bits({int nonceLength = AesGcm.defaultNonceLength})
BackgroundAesGcm.with256bits({int nonceLength = AesGcm.defaultNonceLength})

Properties

channelPolicy → CryptographyChannelPolicy
final
fallback ↔ AesGcm
getter/setter pairoverride-getter
hashCode → int
The hash code for this object.
no setterinherited
macAlgorithm → MacAlgorithm
Message authentication code (MacAlgorithm) used by the cipher.
no setterinherited
nonceLength → int
Number of bytes in the nonce ("Initialization Vector", "IV", "salt").
final
random → Random?
Random number generator used by newSecretKey for generating secret keys.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretKeyLength → int
Number of bytes in the SecretKey.
final

Methods

checkParameters({int? length, required SecretKey secretKey, required int nonceLength, int aadLength = 0, int keyStreamIndex = 0}) → void
Checks parameters for encrypt / decrypt and throws ArgumentError if any is invalid.
inherited
cipherTextLength(int clearTextLength) → int
Calculates the length of the ciphertext given a clear text length.
inherited
decrypt(SecretBox secretBox, {required SecretKey secretKey, List<int> aad = const <int>[], int keyStreamIndex = 0, Uint8List? possibleBuffer}) → Future<List<int>>
Decrypts SecretBox and returns the bytes.
inherited
decryptStream(Stream<List<int>> stream, {required SecretKey secretKey, required List<int> nonce, required FutureOr<Mac> mac, List<int> aad = const [], bool allowUseSameBytes = false}) → Stream<List<int>>
Decrypts a Stream of bytes.
inherited
decryptString(SecretBox secretBox, {required SecretKey secretKey}) → Future<String>
Calls decrypt and then converts the bytes to a string by using utf8 codec.
inherited
dispatchBackgroundDecrypt(List args) → Future<List>
Uses compute to do decryption in the background.
override
dispatchBackgroundEncrypt(List args) → Future<List>
Uses compute to do encryption in the background.
override
encrypt(List<int> clearText, {required SecretKey secretKey, List<int>? nonce, List<int> aad = const <int>[], int keyStreamIndex = 0, Uint8List? possibleBuffer}) → Future<SecretBox>
Encrypts bytes and returns SecretBox.
inherited
encryptStream(Stream<List<int>> stream, {required SecretKey secretKey, required List<int> nonce, required void onMac(Mac mac), List<int> aad = const [], bool allowUseSameBytes = false}) → Stream<List<int>>
Encrypts a Stream of bytes.
inherited
encryptString(String clearText, {required SecretKey secretKey}) → Future<SecretBox>
Converts a string to bytes using utf8 codec and then calls encrypt.
inherited
newCipherWand() → Future<CipherWand>
Constructs a CipherWand that uses this implementation and a new random secret key (that can't be extracted).
inherited
newCipherWandFromSecretKey(SecretKey secretKey, {bool allowEncrypt = true, bool allowDecrypt = true}) → Future<CipherWand>
Constructs a CipherWand that uses this implementation and the given SecretKey.
inherited
newNonce() → List<int>
Generates a new nonce.
inherited
newSecretKey() → Future<SecretKey>
Generates a new SecretKey.
inherited
newSecretKeyFromBytes(List<int> bytes) → Future<SecretKey>
Constructs a new SecretKey from the bytes.
inherited
newState() → CipherState
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
toSync() → DartAesGcm
Returns a synchronous, pure Dart implementation of this cipher.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited