Class FOFEncryptAes

A simple implementation of AES-128, AES-192 and AES-256 encryption using the high performance mcrypt library.

Package: FrameworkOnFramework\encrypt
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.0
Located at fof/encrypt/aes.php

Methods summary

`public`	# `__construct( string $key, integer $strength = 128, string $mode = 'cbc', FOFUtilsPhpfunc $phpfunc = null, string $priority = 'openssl' )` Initialise the AES encryption object. Initialise the AES encryption object. Note: If the key is not 16 bytes this class will do a stupid key expansion for legacy reasons (produce the SHA-256 of the key string and throw away half of it). Parameters `$key` `string` - $key The encryption key (password). It can be a raw key (16 bytes) or a passphrase. `$strength` `integer` - $strength Bit strength (128, 192 or 256) – ALWAYS USE 128 BITS. THIS PARAMETER IS DEPRECATED. `$mode` `string` - $mode Encryption mode. Can be ebc or cbc. We recommend using cbc. `$phpfunc` `FOFUtilsPhpfunc` - $phpfunc For testing `$priority` `string` - $priority Priority which adapter we should try first
`public`	# `setPassword( string $password, boolean $legacyMode = false )` Sets the password for this instance. Sets the password for this instance. WARNING: Do not use the legacy mode, it's insecure Parameters `$password` `string` - $password The password (either user-provided password or binary encryption key) to use `$legacyMode` `boolean` - $legacyMode True to use the legacy key expansion. We recommend against using it.
`public string`	# `encryptString( string $stringToEncrypt, boolean $base64encoded = true )` Encrypts a string using AES Encrypts a string using AES Parameters `$stringToEncrypt` `string` - $stringToEncrypt The plaintext to encrypt `$base64encoded` `boolean` - $base64encoded Should I Base64-encode the result? Returns `string` - The cryptotext. Please note that the first 16 bytes of the raw string is the IV (initialisation vector) which is necessary for decoding the string.
`public string`	# `decryptString( string $stringToDecrypt, boolean $base64encoded = true )` Decrypts a ciphertext into a plaintext string using AES Decrypts a ciphertext into a plaintext string using AES Parameters `$stringToDecrypt` `string` - $stringToDecrypt The ciphertext to decrypt. The first 16 bytes of the raw string must contain the IV (initialisation vector). `$base64encoded` `boolean` - $base64encoded Should I Base64-decode the data before decryption? Returns `string` - The plain text string
`public static boolean`	# `isSupported( FOFUtilsPhpfunc $phpfunc = null )` Is AES encryption supported by this PHP installation? Is AES encryption supported by this PHP installation? Parameters `$phpfunc` `FOFUtilsPhpfunc` - $phpfunc Returns `boolean`
`public string`	# `getExpandedKey( mixed $blockSize, mixed $iv )` Parameters `$blockSize` `mixed` - $blockSize `$iv` `mixed` - $iv Returns `string`

Magic methods summary

Properties summary

`protected string`	`$key`	# The cipher key. The cipher key.
`protected FOFEncryptAesInterface`	`$adapter`	# The AES encryption adapter in use. The AES encryption adapter in use.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFEncryptAes

Methods summary

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary

Properties summary