Slides\Connector\Auth\Sync\ImportsUsers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	import()	0	9	1
A	createDecryptionKey()	0	3	1
A	parseDump()	0	30	3
A	extractHeaders()	0	10	1
A	signature()	0	5	1

<?php

namespace Slides\Connector\Auth\Sync;

use Illuminate\Encryption\Encrypter;
use Illuminate\Support\Arr;

/**
 * Trait ImportsUsers
 *
 * @package Slides\Connector\Auth\Sync
 */
trait ImportsUsers
{
    /**
     * The import dump headers.
     *
     * @var array
     */
    protected $importHeaders;

    /**
     * Export local users to a file in the compressed GZIP format.
     *
     * @param string $path
     * @param string $sharedKey
     * @param bool $importModes Whether import modes from the dump.
     *
     * @return void
     */
    public function import(string $path, string $sharedKey, bool $importModes = true)
    {
        $difference = $this->parseDump($path, $sharedKey, $importModes);

        $foreigners = array_map(function (array $user) {
            return $this->createRemoteUserFromResponse($user);

It seems like createRemoteUserFromResponse() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }, $difference);

        $this->foreigners = collect($foreigners);

The property foreigners does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * Parse a dump and retrieve user entities in array representation.
     *
     * Steps:
     * 1. Read a file contents
     * 2. Decrypt using shared token and tenant credentials
     * 3. Decompress and decode from JSON to array
     *
     * @param string $filename
     * @param string $sharedKey
     * @param bool $importModes Whether import modes from the dump.
     *
     * @return array
     */
    private function parseDump(string $filename, string $sharedKey, bool $importModes): array
    {
        if(!file_exists($filename)) {
            throw new \InvalidArgumentException($filename . ' cannot be found');
        }

        // Retrieve dump contents, it's encrypted and gzipped
        // We should handle it firstly
        $payload = file_get_contents($filename);

        // Extract and parse headers which contain necessary information
        // Then delete from a dump so we can proceed with decryption
        $this->extractHeaders($payload);

        if($importModes) {
            $this->modes = Arr::get($this->importHeaders, 'modes', []);

The property modes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

        $encrypter = new Encrypter(
            $this->createDecryptionKey($sharedKey),
            $this->cipher
        );

        // Decrypt a payload. If successful, we retrieve compressed user entities
        $data = $encrypter->decrypt($payload);

        // Decompress users
        $data = gzdecode($data);

        return json_decode($data, true);
    }

    /**
     * Create a decryption key based on shared key and signature which authorizes tenant.
     *
     * @param string $sharedKey
     *
     * @return string
     */
    private function createDecryptionKey(string $sharedKey): string
    {
        return base64_decode($sharedKey) . ':' . $this->signature();
    }

    /**
     * Create a signature based on credentials.
     *
     * @return string
     */
    private function signature(): string
    {
        $sign = hash('sha256', $this->credential('public') . $this->credential('secret'));

It seems like credential() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return substr($sign, 0, 15);
    }

    /**
     * Extract and parse headers from the dump.
     *
     * @param string $payload
     *
     * @return array
     */
    private function extractHeaders(string &$payload): array
    {
        $headers = unserialize(
            base64_decode(strtok($payload, '/'))
        );

        // Remove header string from the payload
        $payload = ltrim(strstr($payload, '/'), '/');

        return $this->importHeaders = $headers;
    }
}