Class: Toybox.Cryptography.Cipher

Inherits:

Toybox.Lang.Object

show all

Overview

A Cipher object.

Instance Method Summary collapse

decrypt(ciphertext as Lang.ByteArray) as Lang.ByteArray

Decrypt data with the key, depending on how the cipher was initialized.
encrypt(plaintext as Lang.ByteArray) as Lang.ByteArray

Encrypt data with the key, depending on how the cipher was initialized.
initialize(options as { :algorithm as Cryptography.CipherAlgorithm, :mode as Cryptography.EncryptionMode, :key as Lang.ByteArray, :iv as Lang.ByteArray })

Constructor.

Instance Method Details

decrypt(ciphertext as Lang.ByteArray) as Lang.ByteArray

Decrypt data with the key, depending on how the cipher was initialized.

Decryption can be broken up into two or more calls to decrypt(). For MODE_CBC, the ciphertext length (in bytes) must be a multiple of the block size.

Parameters:

ciphertext — (Lang.ByteArray) —

The piece of data to decrypt

Returns:

Lang.ByteArray —

The decrypted data

Since:

API Level 3.0.0

Throws:

(Lang.UnexpectedTypeException) —

Thrown if a type other than ByteArray is provided
(Cryptography.InvalidBlockSizeException) —

Thrown if ciphertext is not a valid size for the selected encryption type

encrypt(plaintext as Lang.ByteArray) as Lang.ByteArray

Encrypt data with the key, depending on how the cipher was initialized.

Encryption can be broken up into two or more calls to encrypt. For MODE_CBC, the plaintext length (in bytes) must be a multiple of the block size.

Parameters:

plaintext — (Lang.ByteArray) —

The piece of data to encrypt

Returns:

Lang.ByteArray —

The encrypted data

Since:

API Level 3.0.0

Throws:

(Lang.UnexpectedTypeException) —

Thrown if a type other than ByteArray is provided
(Cryptography.InvalidBlockSizeException) —

Thrown if plaintext is not a valid size for the selected encryption type

initialize(options as { :algorithm as Cryptography.CipherAlgorithm, :mode as Cryptography.EncryptionMode, :key as Lang.ByteArray, :iv as Lang.ByteArray })

Constructor

Parameters:

options — (Lang.Dictionary) —

A Dictionary of options
- :algorithm — (Lang.Number) —
  
  The encryption type this cipher object will use from the CIPHER_* enumeration (required)
- :mode — (Lang.Number) —
  
  The encryption mode this cipher object will use from the MODE_* enumeration (required)
- :key — (Lang.ByteArray) —
  
  The secret key to use in the cipher. The key must be of the appropriate length for the encryption type selected (required)
- :iv — (Lang.ByteArray) —
  
  The initialization vector to use for encryption or decryption. This will be generated by the system using secure random bytes for algorithms that require it if it is not provided (optional)

Since:

API Level 3.0.0

Throws:

(Lang.UnexpectedTypeException) —

Thrown if a type other than ByteArray is provided for the :key and :iv options
(Lang.InvalidOptionsException) —

Thrown if a required option is not provided, the :algorithm and :mode options are not initialized with a valid enumeration, an invalid key size is provided for the selected algorithm, or an invalid initialization vector size is provided for the selected algorithm

Generated Apr 17, 2024 9:40:37 AM

Class: Toybox.Cryptography.Cipher

Overview

See Also:

Instance Method Summary collapse

Instance Method Details

decrypt(ciphertext as Lang.ByteArray) as Lang.ByteArray

encrypt(plaintext as Lang.ByteArray) as Lang.ByteArray

initialize(options as { :algorithm as Cryptography.CipherAlgorithm, :mode as Cryptography.EncryptionMode, :key as Lang.ByteArray, :iv as Lang.ByteArray })