174 lines
5.8 KiB
PHP
174 lines
5.8 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Simple example of using the openssl encrypt/decrypt functions that
|
|
* are inadequately documented in the PHP manual.
|
|
*
|
|
* Available under the MIT License
|
|
*
|
|
* The MIT License (MIT)
|
|
* Copyright (c) 2016 ionCube Ltd.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of
|
|
* the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
|
|
* THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
|
|
* OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
|
|
* OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
namespace ioncube\phpOpensslCryptor;
|
|
|
|
class Cryptor {
|
|
|
|
private $cipher_algo;
|
|
private $hash_algo;
|
|
private $iv_num_bytes;
|
|
private $format;
|
|
|
|
const FORMAT_RAW = 0;
|
|
const FORMAT_B64 = 1;
|
|
const FORMAT_HEX = 2;
|
|
|
|
/**
|
|
* Construct a Cryptor, using aes256 encryption, sha256 key hashing and base64 encoding.
|
|
* @param string $cipher_algo The cipher algorithm.
|
|
* @param string $hash_algo Key hashing algorithm.
|
|
* @param [type] $fmt Format of the encrypted data.
|
|
*/
|
|
public function __construct( $cipher_algo = 'aes-256-ctr', $hash_algo = 'sha256', $fmt = Cryptor::FORMAT_B64 ) {
|
|
$this->cipher_algo = $cipher_algo;
|
|
$this->hash_algo = $hash_algo;
|
|
$this->format = $fmt;
|
|
|
|
if ( ! in_array( $cipher_algo, openssl_get_cipher_methods( true ) ) ) {
|
|
throw new \Exception( "Cryptor:: - unknown cipher algo {$cipher_algo}" );
|
|
}
|
|
|
|
if ( ! in_array( $hash_algo, openssl_get_md_methods( true ) ) ) {
|
|
throw new \Exception( "Cryptor:: - unknown hash algo {$hash_algo}" );
|
|
}
|
|
|
|
$this->iv_num_bytes = openssl_cipher_iv_length( $cipher_algo );
|
|
}
|
|
|
|
/**
|
|
* Encrypt a string.
|
|
* @param string $in String to encrypt.
|
|
* @param string $key Encryption key.
|
|
* @param int $fmt Optional override for the output encoding. One of FORMAT_RAW, FORMAT_B64 or FORMAT_HEX.
|
|
* @return string The encrypted string.
|
|
*/
|
|
public function encryptString( $in, $key, $fmt = null ) {
|
|
if ( $fmt === null ) {
|
|
$fmt = $this->format;
|
|
}
|
|
|
|
// Build an initialisation vector
|
|
$iv = openssl_random_pseudo_bytes( $this->iv_num_bytes, $isStrongCrypto );
|
|
if ( ! $isStrongCrypto ) {
|
|
throw new \Exception( "Cryptor::encryptString() - Not a strong key" );
|
|
}
|
|
|
|
// Hash the key
|
|
$keyhash = openssl_digest( $key, $this->hash_algo, true );
|
|
|
|
// and encrypt
|
|
$opts = OPENSSL_RAW_DATA;
|
|
$encrypted = openssl_encrypt( $in, $this->cipher_algo, $keyhash, $opts, $iv );
|
|
|
|
if ( $encrypted === false ) {
|
|
throw new \Exception( 'Cryptor::encryptString() - Encryption failed: ' . openssl_error_string() );
|
|
}
|
|
|
|
// The result comprises the IV and encrypted data
|
|
$res = $iv . $encrypted;
|
|
|
|
// and format the result if required.
|
|
if ( $fmt == Cryptor::FORMAT_B64 ) {
|
|
$res = base64_encode( $res );
|
|
} else if ( $fmt == Cryptor::FORMAT_HEX ) {
|
|
$unp = unpack( 'H*', $res );
|
|
$res = $unp[ 1 ];
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Decrypt a string.
|
|
* @param string $in String to decrypt.
|
|
* @param string $key Decryption key.
|
|
* @param int $fmt Optional override for the input encoding. One of FORMAT_RAW, FORMAT_B64 or FORMAT_HEX.
|
|
* @return string The decrypted string.
|
|
*/
|
|
public function decryptString( $in, $key, $fmt = null ) {
|
|
if ( $fmt === null ) {
|
|
$fmt = $this->format;
|
|
}
|
|
|
|
$raw = $in;
|
|
|
|
// Restore the encrypted data if encoded
|
|
if ( $fmt == Cryptor::FORMAT_B64 ) {
|
|
$raw = base64_decode( $in );
|
|
} else if ( $fmt == Cryptor::FORMAT_HEX ) {
|
|
$raw = pack( 'H*', $in );
|
|
}
|
|
|
|
// and do an integrity check on the size.
|
|
if ( strlen( $raw ) < $this->iv_num_bytes ) {
|
|
throw new \Exception( 'Cryptor::decryptString() - ' .
|
|
'data length ' . strlen( $raw ) . " is less than iv length {$this->iv_num_bytes}" );
|
|
}
|
|
|
|
// Extract the initialisation vector and encrypted data
|
|
$iv = substr( $raw, 0, $this->iv_num_bytes );
|
|
$raw = substr( $raw, $this->iv_num_bytes );
|
|
|
|
// Hash the key
|
|
$keyhash = openssl_digest( $key, $this->hash_algo, true );
|
|
|
|
// and decrypt.
|
|
$opts = OPENSSL_RAW_DATA;
|
|
$res = openssl_decrypt( $raw, $this->cipher_algo, $keyhash, $opts, $iv );
|
|
|
|
if ( $res === false ) {
|
|
throw new \Exception( 'Cryptor::decryptString - decryption failed: ' . openssl_error_string() );
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
/**
|
|
* Static convenience method for encrypting.
|
|
* @param string $in String to encrypt.
|
|
* @param string $key Encryption key.
|
|
* @param int $fmt Optional override for the output encoding. One of FORMAT_RAW, FORMAT_B64 or FORMAT_HEX.
|
|
* @return string The encrypted string.
|
|
*/
|
|
public static function Encrypt( $in, $key, $fmt = null ) {
|
|
$c = new Cryptor();
|
|
return $c->encryptString( $in, $key, $fmt );
|
|
}
|
|
|
|
/**
|
|
* Static convenience method for decrypting.
|
|
* @param string $in String to decrypt.
|
|
* @param string $key Decryption key.
|
|
* @param int $fmt Optional override for the input encoding. One of FORMAT_RAW, FORMAT_B64 or FORMAT_HEX.
|
|
* @return string The decrypted string.
|
|
*/
|
|
public static function Decrypt( $in, $key, $fmt = null ) {
|
|
$c = new Cryptor();
|
|
return $c->decryptString( $in, $key, $fmt );
|
|
}
|
|
|
|
}
|