---
title: "Class **Phalcon\\Crypt**"
version: "3.4"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Class **Phalcon\Crypt**

*implements* [Phalcon\CryptInterface](/3.4/api/phalcon_crypt/)

<a href="https://github.com/phalcon/cphalcon/tree/v3.4.0/phalcon/crypt.zep" class="btn btn-default btn-sm">Source on GitHub</a>

Provides encryption facilities to phalcon applications

```php
<?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](/3.4/api/phalcon_crypt/)

```php
<?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](/3.4/api/phalcon_crypt/)

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

Encrypts a text

```php
<?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](https://secure.php.net/manual/en/function.hash-hmac.php).

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](/3.4/api/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](/3.4/api/phalcon_crypt/)

public **setHashAlgo** (*string* $hashAlgo): *[Phalcon\Crypt](/3.4/api/phalcon_crypt/)*

Set the name of hashing algorithm to calculate the message digest. Throws [Phalcon\Crypt\Exception](/3.4/api/phalcon_crypt/) if the algorithm is not supported by the system

public **setKey** (*mixed* $key): *[Phalcon\Crypt](/3.4/api/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`

See also: : [Phalcon\Security\Random](/3.4/api/phalcon_security/)

public **setPadding** (*mixed* $scheme): *[Phalcon\Crypt](/3.4/api/phalcon_crypt/)*

Changes the padding scheme used

public **useSigning** (*boolean* $useSigning): *[Phalcon\Crypt](/3.4/api/phalcon_crypt/)*

Sets if the calculating message digest must used (signing). **NOTE**: This feature will be enabled by default in Phalcon 4.0.0 or greater

### Protected
protected  **_cryptPadText** (*mixed* $text, *mixed* $mode, *mixed* $blockSize, *mixed* $paddingType)

Pads texts before encryption.

See: [https://www.di-mgt.com.au/cryptopad.html](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](/3.4/api/phalcon_crypt/)

protected **assertHashAlgorithmAvailable** (*string* $hashAlgo)

Assert the hash algorithm is available.

Throws [Phalcon\Crypt\Exception](/3.4/api/phalcon_crypt/)

protected **getIvLength** (*string* $cipher): *int*

Initialize available cipher algorithms.

Throws [Phalcon\Crypt\Exception](/3.4/api/phalcon_crypt/)

protected **initializeAvailableCiphers** ()

Initialize available cipher algorithms.

Throws [Phalcon\Crypt\Exception](/3.4/api/phalcon_crypt/)

<hr />

# Class **Phalcon\Crypt\Exception**

*extends* class [Phalcon\Exception](/3.4/api/phalcon_exception/)

*implements* [Throwable](https://php.net/manual/en/class.throwable.php)

<a href="https://github.com/phalcon/cphalcon/tree/v3.4.0/phalcon/crypt/exception.zep" class="btn btn-default btn-sm">Source on GitHub</a>

## Methods
final private [Exception](https://php.net/manual/en/class.exception.php) **__clone** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Clone the exception

public  **__construct** ([*mixed* $message], [*mixed* $code], [*mixed* $previous]) inherited from [Exception](https://php.net/manual/en/class.exception.php)

Exception constructor

public  **__wakeup** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

...

final public *string* **getMessage** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the Exception message

final public *int* **getCode** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the Exception code

final public *string* **getFile** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the file in which the exception occurred

final public *int* **getLine** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the line in which the exception occurred

final public *array* **getTrace** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the stack trace

final public [Exception](https://php.net/manual/en/class.exception.php) **getPrevious** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Returns previous Exception

final public [Exception](https://php.net/manual/en/class.exception.php) **getTraceAsString** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the stack trace as a string

public *string* **__toString** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

String representation of the exception

<hr />

# Class **Phalcon\Crypt\Mismatch**

*extends* class [Phalcon\Crypt\Exception](/3.4/api/phalcon_crypt/)

*implements* [Throwable](https://php.net/manual/en/class.throwable.php)

<a href="https://github.com/phalcon/cphalcon/tree/v3.4.0/phalcon/crypt/mismatch.zep" class="btn btn-default btn-sm">Source on GitHub</a>

## Methods
final private [Exception](https://php.net/manual/en/class.exception.php) **__clone** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Clone the exception

public  **__construct** ([*mixed* $message], [*mixed* $code], [*mixed* $previous]) inherited from [Exception](https://php.net/manual/en/class.exception.php)

Exception constructor

public  **__wakeup** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

...

final public *string* **getMessage** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the Exception message

final public *int* **getCode** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the Exception code

final public *string* **getFile** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the file in which the exception occurred

final public *int* **getLine** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the line in which the exception occurred

final public *array* **getTrace** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the stack trace

final public [Exception](https://php.net/manual/en/class.exception.php) **getPrevious** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Returns previous Exception

final public [Exception](https://php.net/manual/en/class.exception.php) **getTraceAsString** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

Gets the stack trace as a string

public *string* **__toString** () inherited from [Exception](https://php.net/manual/en/class.exception.php)

String representation of the exception

<hr />

# Interface **Phalcon\CryptInterface**

<a href="https://github.com/phalcon/cphalcon/tree/v3.4.0/phalcon/cryptinterface.zep" class="btn btn-default btn-sm">Source on GitHub</a>

## 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** ()

...

Source: https://docs.phalcon.io/3.4/api/phalcon_crypt/index.mdx