Platforms to show: All Mac Windows Linux Cross-Platform
CCCryptorMBS class
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Encryption and Hash | MBS MacOSX Plugin | 11.3 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This interface provides access to a number of symmetric encryption algorithms. Symmetric encryption algorithms come in two "flavors" - block ciphers, and stream ciphers. Block ciphers process data (while both encrypting and decrypting) in discrete chunks of data called blocks; stream ciphers operate on arbitrary sized data.
The object declared in this interface, CCCryptorMBS, provides access to both block ciphers and stream ciphers with the same API; however some options are available for block ciphers that do not apply to stream ciphers.
The general operation of a CCCryptor is: initialize it with raw key data and other optional fields with Constructor(); process input data via one or more calls to Update(), each of which may result in output data being written to caller-supplied memory; and obtain possible remaining output data with Final(). The CCCryptor is disposed of via Destructor(), or it can be reused (with the same key data as provided to Constructor()) by calling Reset().
One option for block ciphers is padding, as defined in PKCS7; when padding is enabled, the total amount of data encrypted does not have to be an even multiple of the block size, and the actual length of plaintext is calculated during decryption.
Another option for block ciphers is Cipher Block Chaining, known as CBC mode. When using CBC mode, an Initialization Vector (IV) is provided along with the key when starting an encrypt or decrypt operation. If CBC mode is selected and no IV is provided, an IV of all zeroes will be used.
CCCryptorMBS also implements block bufferring, so that individual calls to Update() do not have to provide data whose length is aligned to the block size. (If padding is disabled, encrypting with block ciphers does require that the *total* length of data input to Update() call(s) be aligned to the block size.)
A given CCCryptorMBS can only be used by one thread at a time; multiple threads can use safely different CCCryptors at the same time. |
This class uses the CommonCrypto interface which is available on Mac OS X 10.5 or newer and also on iOS. So you can use it to get the same results on both operation systems. Also as you simply use Apple provided encryption, you don't need to apply for an export license for this classes here.
- 2 properties
- 7 methods
- method Constructor(operation as Integer, Algorithm as Integer, options as Integer, key as Ptr, keyLength as UInt64, iv as Ptr = nil)
- method Constructor(operation as Integer, Algorithm as Integer, options as Integer, key as String, iv as Ptr = nil)
- method Final(DataOut as Ptr, dataOutAvailable as UInt64, byref dataOutMoved as UInt64)
- method GetOutputLength(inputLength as UInt64, Final as Boolean = true) as UInt64
- method Reset(iv as Ptr = nil)
- method Update(dataIn as Ptr, dataInLength as UInt64, dataOut as Ptr, dataOutAvailable as UInt64, byref dataOutMoved as UInt64)
- method Update(dataIn as String, dataOut as Ptr, dataOutAvailable as UInt64, byref dataOutMoved as UInt64)
- 3 shared methods
- shared method Crypt(Operation as Integer, Algorithm as Integer, Options as Integer, key as Ptr, KeyLength as UInt64, IV as Ptr, DataIn as Ptr, DataInLength as UInt64, DataOut as Ptr, DataOutAvailable as UInt64, byref DataOutMoved as UInt64) as Integer
- shared method Crypt(Operation as Integer, Algorithm as Integer, Options as Integer, key as string, IV as Ptr, DataIn as string, byref DataOut as string) as Integer
- shared method RandomGenerateBytes(data as MemoryBlock) as integer
- 44 constants
Encryption Algorithms Constants.
Constant | Value | Description |
---|---|---|
kCCAlgorithm3DES | 2 |
Triple-DES, three key, EDE configuration |
kCCAlgorithmAES128 | 0 |
Advanced Encryption Standard, 128-bit block. Key length 128 to 256 bits. |
kCCAlgorithmBlowfish | 6 |
Blowfish encryption. |
kCCAlgorithmCAST | 3 |
CAST |
kCCAlgorithmDES | 1 |
Data Encryption Standard |
kCCAlgorithmRC2 | 5 |
RC2 stream cipher |
kCCAlgorithmRC4 | 4 |
RC4 stream cipher |
Error codes.
Constant | Value | Description |
---|---|---|
kCCAlignmentError | -4303 |
Input size was not aligned properly. |
kCCBufferTooSmall | -4301 |
Insufficent buffer provided for specified operation. |
kCCCallSequenceError | -4309 |
Functions called in wrong order. |
kCCDecodeError | -4304 |
Input data did not decode or decrypt properly. |
kCCInvalidKey | -4311 |
Key is not valid. |
kCCKeySizeError | -4310 |
The key size is incorrect. |
kCCMemoryFailure | -4302 |
Memory allocation failure. |
kCCOverflow | -4306 |
Buffer overflow. |
kCCParamError | -4300 |
Illegal parameter value. |
kCCRNGFailure | -4307 |
Random number generator failed. |
kCCSuccess | 0 |
Operation completed normally. |
kCCUnimplemented | -4305 |
Function not implemented for the current algorithm. |
kCCUnspecifiedError | -4308 |
An error occurred, but not matching one of the other error codes. |
Block Size Constants.
Constant | Value | Description |
---|---|---|
kCCBlockSize3DES | 8 |
Triple DES block size. |
kCCBlockSizeAES128 | 16 |
AES block size (currently, only 128-bit blocks are supported). |
kCCBlockSizeBlowfish | 8 |
Blowfish block size. |
kCCBlockSizeCAST | 8 |
CAST block size. |
kCCBlockSizeDES | 8 |
DES block size. |
kCCBlockSizeRC2 | 8 |
RC2 block size. |
Operation Modes
Constant | Value | Description |
---|---|---|
kCCDecrypt | 1 |
Symmetric decryption. |
kCCEncrypt | 0 |
Symmetric encryption. |
Key Size Constants
Constant | Value | Description |
---|---|---|
kCCKeySize3DES | 24 |
Triple DES key size. DES and TripleDES have fixed key sizes. |
kCCKeySizeAES128 | 16 |
128 bit AES key size. AES has three discrete key sizes. |
kCCKeySizeAES192 | 24 |
192 bit AES key size. AES has three discrete key sizes. |
kCCKeySizeAES256 | 32 |
256 bit AES key size. AES has three discrete key sizes. |
kCCKeySizeDES | 8 |
DES key size. DES and TripleDES have fixed key sizes. |
kCCKeySizeMaxBlowfish | 56 |
Maximum key size for blowfish. You may better do a hash on the key and use the hash. |
kCCKeySizeMaxCAST | 16 |
CAST maximum key size. CAST and RC4 have variable key sizes. |
kCCKeySizeMaxRC2 | 128 |
RC2 maximum key size. CAST and RC4 have variable key sizes. |
kCCKeySizeMaxRC4 | 512 |
RC4 maximum key size. CAST and RC4 have variable key sizes. |
kCCKeySizeMinBlowfish | 8 |
Minimum key size for blowfish. |
kCCKeySizeMinCAST | 5 |
CAST minimum key size. CAST and RC4 have variable key sizes. |
kCCKeySizeMinRC2 | 1 |
RC2 minimum key size. CAST and RC4 have variable key sizes. |
kCCKeySizeMinRC4 | 1 |
RC4 minimum key size. CAST and RC4 have variable key sizes. |
Option Constants
Constant | Value | Description |
---|---|---|
kCCOptionCBCMode | 0 |
Cipher Block Chaining Mode. Default is CBC. |
kCCOptionECBMode | 2 |
Electronic Code Book Mode. Default is CBC. Stream ciphers currently have no options |
kCCOptionPKCS7Padding | 1 |
Perform PKCS7 padding. Stream ciphers currently have no options Example |
This class has no sub classes.
Blog Entries
- News from the MBS Xojo Plugins Version 21.4
- Xojo News
- MBS Xojo Plugins, version 21.4pr2
- MBS Real Studio Plugins, version 11.3pr5
Release notes
- Version 21.4
- Added more constants for CCCryptorMBS class.
- Added RandomGenerateBytes method to CCCryptorMBS class.
The items on this page are in the following plugins: MBS MacOSX Plugin.