Titanium SDK # Modules.Crypto
Add-on Crypto module
4.0.0
4.0.0# Overview
This module provides access to various encryption and decryption algorithms, and string encodings.
# Getting Started
View the Using Titanium Modules (opens new window) document for instructions on getting started with using this module in your application. You can download the module from https://github.com/tidev/ti.crypto/releases
# Accessing the crypto Module
To access this module from JavaScript, you would do the following:
var crypto = require("ti.crypto");
The crypto variable is a reference to the Module object.
# Properties
# apiName READONLY
4.0.0 4.0.0The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button
returns Ti.UI.Button.
# lifecycleContainer
4.0.0The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
# Methods
# applyProperties
4.0.0 4.0.0Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
Parameters
| Name | Type | Description |
|---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# decodeData
4.0.0 4.0.0Decodes a source buffer into a string using the specified data type. This is a codec method used for converting data from a source buffer into a displayable string.
Parameters
| Name | Type | Description |
|---|---|---|
dictionary | DecodeDataDict | a dictionary with keys |
Returns
Returns the decoded string
- Type
- String
# encodeData
4.0.0 4.0.0Encodes the source into the destination buffer using the specified data type. This is a codec method used for converting data to a destination buffer.
Parameters
| Name | Type | Description |
|---|---|---|
dictionary | EncodeDataDict | a dictionary with keys |
Returns
Returns the position after the encoded data inside the destination.
- Type
- Number
# Constants
# ALGORITHM_3DES
4.0.0 4.0.0Set on the algorithm property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used.
See Triple_DES for more details.
# ALGORITHM_AES128
4.0.0 4.0.0Set on the algorithm property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used.
See Advanced_Encryption_Standard for more details.
# ALGORITHM_CAST
4.0.0 4.0.0Set on the algorithm property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used.
See CAST-128 for more details.
# ALGORITHM_DES
4.0.0 4.0.0Set on the algorithm property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used.
See Data_Encryption_Standard for more details.
# ALGORITHM_RC2
4.0.0 4.0.0Set on the algorithm property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used. See RC2 for more details.
# ALGORITHM_RC4
4.0.0 4.0.0Set on the algorithm property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used. See RC4 for more details.
Note that while defined on Android, this algorithm is unimplemented.
# BLOCKSIZE_3DES
4.0.0 4.0.0Number of bytes for blocks of the related algorithm.
# BLOCKSIZE_AES128
4.0.0 4.0.0Number of bytes for blocks of the related algorithm.
# BLOCKSIZE_CAST
4.0.0 4.0.0Number of bytes for blocks of the related algorithm.
# BLOCKSIZE_DES
4.0.0 4.0.0Number of bytes for blocks of the related algorithm.
# BLOCKSIZE_RC2
4.0.0 4.0.0Number of bytes for blocks of the related algorithm.
# DECRYPT
4.0.0 4.0.0Set on the operation property. Used in the update and finish methods to indicate the operation should be to decrypt data.
# ENCRYPT
4.0.0 4.0.0Set on the operation property. Used in the update and finish methods to indicate the operation should be to encrypt data.
# KEYSIZE_3DES
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_AES128
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_AES192
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_AES256
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_DES
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_MAXCAST
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_MAXRC2
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_MAXRC4
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_MINCAST
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_MINRC2
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# KEYSIZE_MINRC4
4.0.0 4.0.0Number of bytes used to hold a key of the given type. Useful for creating instances of Titanium.Buffer to generate a key for the key property used in the encrypt, decrypt, update and finish methods.
# OPTION_ECBMODE
4.0.0 4.0.0Set on the options property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used. See Wikipedia for more details.
# OPTION_PKCS7PADDING
4.0.0 4.0.0Set on the options property. Used in the encrypt, decrypt, update and finish methods to indicate the algorithm used. See Wikipedia for more details.
# STATUS_ALIGNMENTERROR
4.0.0 4.0.0Used in the encodeData and Modules.Crypto.Cryptor methods to report an error. This means that the data you are passing is not correctly padded (specifically that the entire data length including padding is not a multiple of the block size). The most likely cause is that you are truncating your encrypted data somewhere, possibly outside of this routine.
Only reported by iOS (though the constant is still defined on Android).
# STATUS_BUFFERTOOSMALL
4.0.0 4.0.0Used in the encodeData and Modules.Crypto.Cryptor methods to report an error when the buffer is not long enough to contain the result.
# STATUS_DECODEERROR
4.0.0 4.0.0Used in the encodeData and Modules.Crypto.Cryptor methods to report an error. Input data did not decode or decrypt properly.
Only reported by iOS (though the constant is still defined on Android).
# STATUS_ERROR
4.0.0 4.0.0Used in the Modules.Crypto.Cryptor methods to report a generic error for an operation.
# STATUS_MEMORYFAILURE
4.0.0 4.0.0Used in the encodeData and Modules.Crypto.Cryptor methods to report an error with allocating memory.
Only reported by iOS (though the constant is still defined on Android).
# STATUS_PARAMERROR
4.0.0 4.0.0Used in the encodeData and Modules.Crypto.Cryptor methods to report an error with the supplied parameters or properties.
# STATUS_SUCCESS
4.0.0 4.0.0Used in the reset and release methods to report success for the operation.
# STATUS_UNIMPLEMENTED
4.0.0 4.0.0Used in the getOutputLength and various Modules.Crypto.Cryptor methods to report an error. Typically used to indicate the given algorithm/mode is not implemented in this OS version.
Android will report this status only on getOutputLength. Otherwise this status is only reported by iOS for the methods performing operations.
# TYPE_BASE64STRING
4.0.0 4.0.0Used in the encodeData and decodeData methods to specify expected string format. A Base64 encoded string.
# TYPE_BLOB
4.0.0 4.0.0Used in the encodeData method to specify expected input is a Ti.Blob instance.
# TYPE_HEXSTRING
4.0.0 4.0.0Used in the encodeData and decodeData methods to specify expected string format. A hexadecimal formatted string. Each byte is represented by 2 hexadecimal numbers.