LegalThings\DataEnricher\Processor\Transform

Complexity

Total Complexity

38

Size/Duplication

Total Lines	311
Duplicated Lines	12.22 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

91.53%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	resolveNodes()	0	7	2
A	generate_public_key()	0	14	2
A	private_encrypt()	19	19	3
A	public_encrypt()	0	12	2
A	generate_signature()	19	19	3
A	is_base64()	0	4	1
B	getDefaultFunctions()	0	24	1
F	applyToNode()	0	43	17
A	generate_private_key()	0	14	1
A	private_decrypt()	0	14	3
A	verify_signature()	0	8	2

<?php

namespace LegalThings\DataEnricher\Processor;

use LegalThings\DataEnricher\Node;
use LegalThings\DataEnricher\Processor;

/**
 * Transform processor, apply transformation functions on data
 */
class Transform implements Processor
{
    use Processor\Implementation;
    
    /**
     * Allowed transformation functions
     * @var array 
     */
    public $functions;
    
    
    /**
     * Class constructor
     * 
     * @param string $property  Property key with the processing instruction
     */
    public function __construct($property)
    {
        $this->property = $property;
        $this->functions = $this->getDefaultFunctions();
    }
    
    /**
     * Default transformation functions
     * @var array
     */
    public function getDefaultFunctions()
    {
        $class = 'LegalThings\DataEnricher\Processor\Transform';

        return [
            'hash' => 'hash',
            'hash_hmac' => 'hash_hmac',
            'base64_encode' => 'base64_encode',
            'base64_decode' => 'base64_decode',
            'json_encode' => 'json_encode',
            'json_decode' => 'json_decode',
            'serialize' => 'serialize',
            'unserialize' => 'unserialize',
            'strtotime' => 'strtotime',
            'date' => 'date',
            'public_encrypt' => "$class::public_encrypt",
            'private_encrypt' => "$class::private_encrypt",
            'private_decrypt' => "$class::private_decrypt",
            'generate_private_key' => "$class::generate_private_key",
            'generate_public_key' => "$class::generate_public_key",
            'generate_signature' => "$class::generate_signature",
            'verify_signature' => "$class::verify_signature"
        ];
    }
    
    
    /**
     * Apply processing to a single node
     * 
     * @param Node $node
     */
    public function applyToNode(Node $node)
    {
        $instruction = $node->getInstruction($this);
        $transformations = !is_array($instruction) ? [$instruction] : $instruction;
        
        if (isset($node->input)) {
            $input = $this->resolveNodes($node->input);
        }
        
        foreach ($transformations as $transformation) {
            if (is_string($transformation) && !isset($input)) {
                continue;
            }
            
            if (is_string($transformation)) {
                list($key, $args) = explode(':', $transformation) + [null, null];
            } elseif (is_object($transformation) || is_array($transformation)) {
                $transformation = (object)$transformation;
                $key = isset($transformation->function) ? $transformation->function : null;
                $args = isset($transformation->args) ? $transformation->args : [];
            }
            
            if (!isset($this->functions[$key])) {
                throw new \Exception("Unknown transformation '$key'");
            }
            
            if (isset($args)) {
                $args = $this->resolveNodes($args);
            }
            
            $fn = $this->functions[$key];

The variable $key does not seem to be defined for all execution paths leading up to this point.

            
            if (is_string($transformation)) {
                $result = isset($args) ? call_user_func($fn, $args, $input) : call_user_func($fn, $input);

The variable $input does not seem to be defined for all execution paths leading up to this point.

            } elseif (is_object($transformation)) {
                $result = call_user_func_array($fn, $args);

The variable $args does not seem to be defined for all execution paths leading up to this point.

            }
        }
        
        if (isset($result)) {
            $node->setResult($result);
        }
    }
    
    /**
     * Resolve instructions of nodes by getting their results
     * 
     * @param Node $node
     * 
     * @return mixed $result
     */
    protected function resolveNodes($node) {
        if (!$node instanceof Node) {
            return $node;
        }

        return $node->getResult();
    }
    
    
    /**
     * Generate a private key
     * 
     * @param array $options
     * @throws RuntimeException
     * @return string
     */
    public function generate_private_key($options = [])

Method name "Transform::generate_private_key" is not in camel caps format

    {
        $config = array(
            "digest_alg" => "sha512",
            "private_key_bits" => 2048,
            "private_key_type" => OPENSSL_KEYTYPE_RSA,
        );
        
        $input = $options + $config;
        $res = openssl_pkey_new($input);
        
        openssl_pkey_export($res, $key); 
        return $key;
    }
    
    /**
     * Generate a public based on existing private key
     * 
     * @param string $privateKey
     * @param string $passphrase
     * @throws \RuntimeException
     * @return string
     */
    public function generate_public_key($privateKey, $passphrase = null)

Method name "Transform::generate_public_key" is not in camel caps format

    {
        $privKey = openssl_get_privatekey($privateKey, $passphrase);
        
        if (!is_resource($privKey)) {
            $type = gettype($privKey);
            throw new \Exception("Expected private key to be resource, got: '$type'. Check if the given private key is in correct syntax.");
        }
        
        $pubKey = openssl_pkey_get_details($privKey);
        $key = $pubKey["key"];
        
        return $key;
    }
    
    /**
     * Encrypts data with private key
     * 
     * @link http://php.net/manual/en/function.openssl-private-encrypt.php
     * 
     * @param string $data
     * @param string $key          The private key
     * @param string $passphrase
     * @param int $padding
     * 
     * @return string
     */
    function private_encrypt($data, $key, $passphrase = null, $padding = OPENSSL_PKCS1_PADDING)

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

It is recommend to declare an explicit visibility for private_encrypt.

Method name "Transform::private_encrypt" is not in camel caps format

    {
        $privKey = openssl_get_privatekey($key, $passphrase);
        
        if (!is_resource($privKey)) {
            $type = gettype($privKey);
            throw new \Exception("Expected private key to be resource, got: '$type'. Check if the given private key is in correct syntax.");
        }
        
        openssl_private_encrypt($data, $result, $privKey, $padding);
        
        if (!is_string($result)) {
            throw new \Exception("Failed to encrypt data. Result: '$result'");
        }
        
        $base64 = base64_encode($result);
        
        return $base64;
    }
    
    /**
     * Decrypts data with public key, that was encrypted with private key
     * 
     * @link http://php.net/manual/en/function.openssl-private-decrypt.php
     * 
     * @param string $data
     * @param string $key          The public key
     * @param string $passphrase

There is no parameter named $passphrase. Was it maybe removed?

     * @param int $padding
     * 
     * @return string
     */
    function private_decrypt($data, $key, $padding = OPENSSL_PKCS1_PADDING)

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for private_decrypt.

Method name "Transform::private_decrypt" is not in camel caps format

    {
        if ($this->is_base64($data)) {
            $data = base64_decode($data);
        }
        
        openssl_public_decrypt($data, $result, $key, $padding);
        
        if (!is_string($result)) {
            throw new \Exception("Failed to decrypt data. Result: '$result'");
        }
        
        return $result;
    }
    
    /**
     * Encrypts data with public key
     * 
     * @link http://php.net/manual/en/function.openssl-public-encrypt.php
     * 
     * @param string $data
     * @param string $key    The public key
     * @param int $padding
     * 
     * @return string
     */
    function public_encrypt($data, $key, $padding = OPENSSL_PKCS1_PADDING)

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for public_encrypt.

Method name "Transform::public_encrypt" is not in camel caps format

    {
        openssl_public_encrypt($data, $result, $key, $padding);
        
        if (!is_string($result)) {
            throw new \Exception("Failed to encrypt data. Result: '$result'");
        }
        
        $base64 = base64_encode($result);
        
        return $base64;
    }
    
    /**
     * Generate signature based on private key
     * 
     * @link http://php.net/manual/en/function.openssl-sign.php
     * 
     * @param string $data
     * @param string $key         The private key
     * @param string $passphrase
     * @param int $signature_alg
     * 
     * @return string
     */
    function generate_signature($data, $key, $passphrase = null, $signature_alg = OPENSSL_ALGO_SHA1)

It is generally recommended to explicitly declare the visibility for methods.

This method seems to be duplicated in your project.

It is recommend to declare an explicit visibility for generate_signature.

Method name "Transform::generate_signature" is not in camel caps format

    {
        $privKey = openssl_get_privatekey($key, $passphrase);
        
        if (!is_resource($privKey)) {
            $type = gettype($privKey);
            throw new \Exception("Expected private key to be resource, got: '$type'. Check if the given private key is in correct syntax.");
        }
        
        openssl_sign($data, $result, $privKey, $signature_alg);
        
        if (!is_string($result)) {
            throw new \Exception("Failed to encrypt data. Result: '$result'");
        }
        
        $base64 = base64_encode($result);
        
        return $base64;
    }
    
    /**
     * Verify signature that was encrypted with private key through public key
     * 
     * @link http://php.net/manual/en/function.openssl-verify.php
     * 
     * @param string $data
     * @param string $signature
     * @param string $key         The public key
     * @param string $passphrase

There is no parameter named $passphrase. Was it maybe removed?

     * @param int $signature_alg
     * 
     * @return string
     */
    function verify_signature($data, $signature, $key, $signature_alg = OPENSSL_ALGO_SHA1)

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for verify_signature.

Method name "Transform::verify_signature" is not in camel caps format

    {
        if ($this->is_base64($signature)) {
            $signature = base64_decode($signature);
        }
        
        return openssl_verify($data, $signature, $key, $signature_alg);
    }
    
    /**
     * Check if input is valid base64
     * 
     * @param string $data
     * 
     * @return boolean
     */
    function is_base64($data)

It is generally recommended to explicitly declare the visibility for methods.

It is recommend to declare an explicit visibility for is_base64.

Method name "Transform::is_base64" is not in camel caps format

    {
        return base64_encode(base64_decode($data)) === $data;
    }
}