---
title: "Phalcon Crypt"
version: "4.2"
---

> 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.

# Phalcon Crypt

:::info[NOTE]
All classes are prefixed with `Phalcon`
:::

## Crypt 

[Source on GitHub](https://github.com/phalcon/cphalcon/blob/4.2.x/phalcon/Crypt.zep)

-   __Namespace__

    - `Phalcon`

-   __Uses__

    - `Phalcon\Crypt\CryptInterface`
    - `Phalcon\Crypt\Exception\Exception`
    - `Phalcon\Crypt\Exception\Mismatch`
    - `Phalcon\Crypt\PadFactory`

-   __Extends__

-   __Implements__

    - `CryptInterface`

Provides encryption capabilities to Phalcon applications.

```php
use Phalcon\Crypt;

$crypt = new Crypt();

$crypt->setCipher('aes-256-ctr');

$key  = "T4\xb1\x8d\xa9\x98\x05\\\x8c\xbe\x1d\x07&[\x99\x18\xa4~Lc1\xbeW\xb3";
$text = "The message to be encrypted";

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

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

### Constants
```php
const PADDING_ANSI_X_923 = 1;
const PADDING_DEFAULT = 0;
const PADDING_ISO_10126 = 3;
const PADDING_ISO_IEC_7816_4 = 4;
const PADDING_PKCS7 = 2;
const PADDING_SPACE = 6;
const PADDING_ZERO = 5;
```

### Properties
```php
/**
 * @var string
 */
protected $authTag;

/**
 * @var string
 */
protected $authData = '';

/**
 * @var int
 */
protected $authTagLength = 16;

/**
 * @var string
 */
protected $key = ;

/**
 * @var int
 */
protected $padding = 0;

/**
 * @var string
 */
protected $cipher = 'aes-256-cfb';

/**
 * Available cipher methods.
 * @var array
 */
protected $availableCiphers;

/**
 * The cipher iv length.
 * @var int
 */
protected $ivLength = 16;

/**
 * The name of hashing algorithm.
 * @var string
 */
protected $hashAlgo = 'sha256';

/**
 * Whether calculating message digest enabled or not.
 *
 * @var bool
 */
protected $useSigning = true;

```

## Methods

```php
public function __construct( string $cipher = string, bool $useSigning = bool );
```
Phalcon\Crypt constructor.

```php
public function decrypt( string $text, string $key = null ): string;
```
Decrypts an encrypted text.

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

```php
public function decryptBase64( string $text, mixed $key = null, bool $safe = bool ): string;
```
Decrypt a text that is coded as a base64 string.

```php
public function encrypt( string $text, string $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"
);
```

```php
public function encryptBase64( string $text, mixed $key = null, bool $safe = bool ): string;
```
Encrypts a text returning the result as a base64 string.

```php
public function getAuthData(): string;
```
Returns the auth data

```php
public function getAuthTag(): string;
```
Returns the auth tag

```php
public function getAuthTagLength(): int;
```
Returns the auth tag length

```php
public function getAvailableCiphers(): array;
```
Returns a list of available ciphers.

```php
public function getAvailableHashAlgos(): array;
```
Return a list of registered hashing algorithms suitable for hash_hmac.

```php
public function getCipher(): string;
```
Returns the current cipher

```php
public function getHashAlgo(): string;
```
Get the name of hashing algorithm.

```php
public function getKey(): string;
```
Returns the encryption key

```php
public function setAuthData( string $data ): CryptInterface;
```

```php
public function setAuthTag( string $tag ): CryptInterface;
```

```php
public function setAuthTagLength( int $length ): CryptInterface;
```

```php
public function setCipher( string $cipher ): CryptInterface;
```
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.

```php
public function setHashAlgo( string $hashAlgo ): CryptInterface;
```
Set the name of hashing algorithm.

```php
public function setKey( string $key ): CryptInterface;
```
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"

```php
public function setPadding( int $scheme ): CryptInterface;
```
Changes the padding scheme used.

```php
public function useSigning( bool $useSigning ): CryptInterface;
```
Sets if the calculating message digest must used.

```php
protected function assertCipherIsAvailable( string $cipher ): void;
```
Assert the cipher is available.

```php
protected function assertHashAlgorithmAvailable( string $hashAlgo ): void;
```
Assert the hash algorithm is available.

```php
protected function cryptPadText( string $text, string $mode, int $blockSize, int $paddingType ): string;
```
Pads texts before encryption. See [cryptopad](https://www.di-mgt.com.au/cryptopad.html)

```php
protected function cryptUnpadText( string $text, string $mode, int $blockSize, int $paddingType );
```
Removes a padding from a text.

If the function detects that the text was not padded, it will return it
unmodified.

```php
protected function getIvLength( string $cipher ): int;
```
Initialize available cipher algorithms.

```php
protected function initializeAvailableCiphers(): void;
```
Initialize available cipher algorithms.

## Crypt\CryptInterface ![Interface](/assets/images/interface-blue.svg) 

[Source on GitHub](https://github.com/phalcon/cphalcon/blob/4.2.x/phalcon/Crypt/CryptInterface.zep)

-   __Namespace__

    - `Phalcon\Crypt`

-   __Uses__

-   __Extends__

-   __Implements__

Interface for Phalcon\Crypt

### Methods

```php
public function decrypt( string $text, string $key = null ): string;
```
Decrypts a text

```php
public function decryptBase64( string $text, mixed $key = null ): string;
```
Decrypt a text that is coded as a base64 string

```php
public function encrypt( string $text, string $key = null ): string;
```
Encrypts a text

```php
public function encryptBase64( string $text, mixed $key = null ): string;
```
Encrypts a text returning the result as a base64 string

```php
public function getAuthData(): string;
```
Returns authentication data

```php
public function getAuthTag(): string;
```
Returns the authentication tag

```php
public function getAuthTagLength(): int;
```
Returns the authentication tag length

```php
public function getAvailableCiphers(): array;
```
Returns a list of available cyphers

```php
public function getCipher(): string;
```
Returns the current cipher

```php
public function getKey(): string;
```
Returns the encryption key

```php
public function setAuthData( string $data ): CryptInterface;
```
Sets authentication data

```php
public function setAuthTag( string $tag ): CryptInterface;
```
Sets the authentication tag

```php
public function setAuthTagLength( int $length ): CryptInterface;
```
Sets the authentication tag length

```php
public function setCipher( string $cipher ): CryptInterface;
```
Sets the cipher algorithm

```php
public function setKey( string $key ): CryptInterface;
```
Sets the encryption key

```php
public function setPadding( int $scheme ): CryptInterface;
```
Changes the padding scheme used.

## Crypt\Exception\Exception 

[Source on GitHub](https://github.com/phalcon/cphalcon/blob/4.2.x/phalcon/Crypt/Exception/Exception.zep)

-   __Namespace__

    - `Phalcon\Crypt\Exception`

-   __Uses__

-   __Extends__

    `\Exception`

-   __Implements__

Exceptions thrown in Phalcon\Crypt use this class

## Crypt\Exception\Mismatch 

[Source on GitHub](https://github.com/phalcon/cphalcon/blob/4.2.x/phalcon/Crypt/Exception/Mismatch.zep)

-   __Namespace__

    - `Phalcon\Crypt\Exception`

-   __Uses__

-   __Extends__

    `Exception`

-   __Implements__

Exceptions thrown in Phalcon\Crypt will use this class.

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