Class Phalcon\Crypt¶

Provides encryption facilities to phalcon applications

<?php

$crypt = new \Phalcon\Crypt();

$key  = "le password";
$text = "This is a secret text";

$encrypted = $crypt->encrypt($text, $key);

echo $crypt->decrypt($encrypted, $key);

Constants¶

integer PADDING_ANSI_X_923

integer PADDING_DEFAULT

integer PADDING_ISO_10126

integer PADDING_ISO_IEC_7816_4

integer PADDING_PKCS7

integer PADDING_SPACE

integer PADDING_ZERO

Properties¶

Protected¶

string $_key;

integer $_padding = 0;

string $_cipher = "aes-256-cfb";

array $availableCiphers;

Available cipher methods.

integer $ivLength = 16; The cipher iv length.

string $hashAlgo = "sha256";

The name of hashing algorithm.

boolean $useSigning = false; Whether calculating message digest enabled or not NOTE: This feature will be enabled by default in Phalcon 4.0.0

Methods¶

Public¶

public __construct(string $cipher = "aes-256-cfb", boolean $useSigning = false)

Class constructor. Allows the user to set the algorithm used to calculate a digest of the message (signing) and to force signing or not.

public decrypt (mixed $text [, mixed $key = null]): string

Decrypts an encrypted text

Throws Phalcon\Crypt\Mismatch

<?php

$encrypted = $crypt->decrypt(
    $encrypted,
    "T4\xb1\x8d\xa9\x98\x05\\x8c\xbe\x1d\x07&[\x99\x18\xa4~Lc1\xbeW\xb3"
);

public decryptBase64 (string $text [,mixed $key = null [,boolean $safe = false]]): string

Decrypt a text that is coded as a base64 string

Throws Phalcon\Crypt\Mismatch

public encrypt (mixed $text [, mixed $key = null]): string

Encrypts a text

<?php

$encrypted = $crypt->encrypt(
    "Top secret",
    "T4\xb1\x8d\xa9\x98\x05\\x8c\xbe\x1d\x07&[\x99\x18\xa4~Lc1\xbeW\xb3"
);

public encryptBase64 (string $text [,mixed $key = null [,boolean $safe = false]]): string

Encrypts a text returning the result as a base64 string

public getAvailableCiphers (): array

Returns a list of available ciphers

public getAvailableHashAlgos (): array

Return a list of registered hashing algorithms suitable for hash_hmac.

public getCipher ()

Returns the current cipher

public getHashAlgo (): string

Return the name of hashing algorithm.

public getKey (): string

Returns the encryption key

public setCipher (mixed $cipher): Phalcon\Crypt

Sets the cipher algorithm for data encryption and decryption. The aes-256-gcm is the preferable cipher, but it is not usable until the openssl library is upgraded, which is available in PHP 7.1. The aes-256-ctr is arguably the best choice for cipher algorithm for current openssl library version.

Throws: Phalcon\Crypt\Exception

public setHashAlgo (string $hashAlgo): Phalcon\Crypt

Set the name of hashing algorithm to calculate the message digest. Throws Phalcon\Crypt\Exception if the algorithm is not supported by the system

public setKey (mixed $key): Phalcon\Crypt

Sets the encryption key. The $key should have been previously generated in a cryptographically safe way.

Bad key: le password

Better (but still unsafe): #1dj8$=dp?.ak//j1V$~%*0X

Good key: T4\xb1\x8d\xa9\x98\x05\\x8c\xbe\x1d\x07&[\x99\x18\xa4~Lc1\xbeW\xb3

Protected¶

protected _cryptPadText (mixed $text, mixed $mode, mixed $blockSize, mixed $paddingType)

Pads texts before encryption.

See: https://www.di-mgt.com.au/cryptopad.html

protected _cryptUnpadText (mixed $text, mixed $mode, mixed $blockSize, mixed $paddingType)

Removes a padding from a text. If the function detects that the text was not padded, it will return it unmodified

Type	Name	Description
string	$text	Message to be unpadded
string	$mode	Encryption mode; unpadding is applied only in CBC or ECB mode
int	$blockSize	Cipher block size
int	$paddingType	Padding scheme

protected assertCipherIsAvailable (string $cipher)

Assert the cipher is available.

Throws Phalcon\Crypt\Exception

protected assertHashAlgorithmAvailable (string $hashAlgo)

Assert the hash algorithm is available.

Throws Phalcon\Crypt\Exception

protected getIvLength (string $cipher): int

Initialize available cipher algorithms.

Throws Phalcon\Crypt\Exception

protected initializeAvailableCiphers ()

Initialize available cipher algorithms.

Throws Phalcon\Crypt\Exception

Class Phalcon\Crypt\Exception¶

extends class Phalcon\Exception

implements Throwable

Source on GitHub

Methods¶

final private Exception __clone () inherited from Exception

Clone the exception

public __construct ([mixed $message], [mixed $code], [mixed $previous]) inherited from Exception

Exception constructor

public __wakeup () inherited from Exception

...

final public string getMessage () inherited from Exception

Gets the Exception message

final public int getCode () inherited from Exception

Gets the Exception code

final public string getFile () inherited from Exception

Gets the file in which the exception occurred

final public int getLine () inherited from Exception

Gets the line in which the exception occurred

final public array getTrace () inherited from Exception

Gets the stack trace

final public Exception getPrevious () inherited from Exception

Returns previous Exception

final public Exception getTraceAsString () inherited from Exception

Gets the stack trace as a string

public string __toString () inherited from Exception

String representation of the exception

Class Phalcon\Crypt\Mismatch¶

extends class Phalcon\Crypt\Exception

implements Throwable

Source on GitHub

Methods¶

final private Exception __clone () inherited from Exception

Clone the exception

public __construct ([mixed $message], [mixed $code], [mixed $previous]) inherited from Exception

Exception constructor

public __wakeup () inherited from Exception

...

final public string getMessage () inherited from Exception

Gets the Exception message

final public int getCode () inherited from Exception

Gets the Exception code

final public string getFile () inherited from Exception

Gets the file in which the exception occurred

final public int getLine () inherited from Exception

Gets the line in which the exception occurred

final public array getTrace () inherited from Exception

Gets the stack trace

final public Exception getPrevious () inherited from Exception

Returns previous Exception

final public Exception getTraceAsString () inherited from Exception

Gets the stack trace as a string

public string __toString () inherited from Exception

String representation of the exception

Interface Phalcon\CryptInterface¶

Source on GitHub

Methods¶

abstract public setCipher (mixed $cipher)

...

abstract public getCipher ()

...

abstract public setKey (mixed $key)

...

abstract public getKey ()

...

abstract public encrypt (mixed $text, [mixed $key])

...

abstract public decrypt (mixed $text, [mixed $key])

...

abstract public encryptBase64 (mixed $text, [mixed $key])

...

abstract public decryptBase64 (mixed $text, [mixed $key])

...

abstract public getAvailableCiphers ()

...