PHP Mini Documentation

Crypto
in package

Encryption, Decription and Hashing

PHP Mini Framework

Tags
copyright

busarm.com

license

https://github.com/Busarm/php-mini/blob/master/LICENSE (MIT License)

Table of Contents

$HMAC_HASH_ALGO  : string
Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..). Default: sha1.
$KEY_HASH_ALGO  : string
Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..). Default: md5.
$KEY_HASH_ITERATIONS  : string
Number of key hash iterations.
$KEY_HASH_LENGTH  : string
Length of key hash.
$KEY_IV_LENGTH  : string
Length of key iv.
$KEY_SALT_LENGTH  : string
Length of key salt.
$METHOD  : string
For a list of available cipher methods. Default: AES-256-CBC.
decrypt()  : string|bool
Decrypt Data from client
digest()  : string|bool
Generate hmac signature for data
encrypt()  : mixed
Encrypt Data for client

Properties

$HMAC_HASH_ALGO

Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..). Default: sha1.

public static string $HMAC_HASH_ALGO = "sha1"

@see \hash_algos for a list of supported algorithms

Tags

$KEY_HASH_ALGO

Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..). Default: md5.

public static string $KEY_HASH_ALGO = "md5"

@see \hash_algos for a list of supported algorithms

Tags

$KEY_HASH_ITERATIONS

Number of key hash iterations.

public static string $KEY_HASH_ITERATIONS = 8

@see \hash_pbkdf2. Default: 8.

Tags

$KEY_HASH_LENGTH

Length of key hash.

public static string $KEY_HASH_LENGTH = 16

@see \hash_pbkdf2. Default: 16.

Tags

$KEY_IV_LENGTH

Length of key iv.

public static string $KEY_IV_LENGTH = 16

@see \openssl_random_pseudo_bytes. Default: 16.

Tags

$KEY_SALT_LENGTH

Length of key salt.

public static string $KEY_SALT_LENGTH = 8

@see \openssl_random_pseudo_bytes. Default: 8.

Tags

$METHOD

For a list of available cipher methods. Default: AES-256-CBC.

public static string $METHOD = "AES-256-CBC"

@see \openssl_get_cipher_methods for list of supported methods

Tags

Methods

decrypt()

Decrypt Data from client

public static decrypt(string|null $passphrase, string $cipher[, array<string|int, mixed> $configs = [] ]) : string|bool
Parameters
$passphrase : string|null
$cipher : string

Data to decrypt

$configs : array<string|int, mixed> = []

Encryption configs

  • METHOD - Default: AES-256-CBC. @see \openssl_get_cipher_methods
  • KEY_HASH_ALGO - Default: md5. @see \hash_algos
  • HMAC_HASH_ALGO - Default: sha1. @see \hash_algos
  • KEY_HASH_ITERATIONS - Default: 8. @see \hash_pbkdf2
  • KEY_HASH_LENGTH - Default: 16. @see \hash_pbkdf2
Tags
Return values
string|bool —

digest()

Generate hmac signature for data

public static digest(string $data, string $key[, string $algo = NULL ]) : string|bool
Parameters
$data : string

String Data

$key : string

hmac key

$algo : string = NULL

hmac algo. @see \hash_algos

Tags
Return values
string|bool —

encrypt()

Encrypt Data for client

public static encrypt(string|null $passphrase, string $plain[, array<string|int, mixed> $configs = [] ]) : mixed
Parameters
$passphrase : string|null
$plain : string

Data to encrypt

$configs : array<string|int, mixed> = []

Encryption configs

  • METHOD - Default: AES-256-CBC. @see \openssl_get_cipher_methods
  • KEY_HASH_ALGO - Default: md5. @see \hash_algos
  • HMAC_HASH_ALGO - Default: sha1. @see \hash_algos
  • KEY_HASH_ITERATIONS - Default: 8. @see \hash_pbkdf2
  • KEY_HASH_LENGTH - Default: 16. @see \hash_pbkdf2
  • KEY_SALT_LENGTH - Default: 8. @see \openssl_random_pseudo_bytes
  • KEY_IV_LENGTH - Default: 16. @see \openssl_random_pseudo_bytes
Tags
Return values
mixed —

Base64 encoded result of encrypted data


        

        
    




    

    

                

    

        

            
Search results