Nubs\PwMan\PasswordFile

Complexity

Total Complexity

15

Size/Duplication

Total Lines	126
Duplicated Lines	31.75 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getPasswords()	0	14	3
A	addDecryptKey()	20	20	4
A	addEncryptKey()	20	20	4
A	setPasswords()	0	12	3

<?php
namespace Nubs\PwMan;

use Exception;
use GnuPG;

/**
 * Manage the password file including encryption and encoding.
 */
class PasswordFile
{
    /** @type string The file path to the password file. */
    private $_passwordFile;

    /** @type \GnuPG The gpg resource. */
    private $_gpg;

    /**
     * Initialize the password file.
     *
     * @api
     * @param string $passwordFile The file path to the password file.
     * @param \GnuPG $gpg The gpg resource for interacting with the password file.
     */
    public function __construct($passwordFile, GnuPG $gpg)
    {
        $this->_passwordFile = $passwordFile;
        $this->_gpg = $gpg;
    }

    /**
     * Return all the application passwords out of the password file.
     *
     * This requires a decryption key to have been added.
     *
     * @api
     * @see addDecryptKey
     * @return array<array>|null The passwords in the file if the file could be
     *     loaded.
     */
    public function getPasswords()
    {
        $contents = file_get_contents($this->_passwordFile);
        if ($contents === false) {
            return null;
        }

        $decryptedContents = $this->_gpg->decrypt($contents);
        if ($decryptedContents === false) {
            return null;
        }

        return json_decode($decryptedContents, true);
    }

    /**
     * Add the given decryption key.
     *
     * @api
     * @param string $key The uid or fingerprint of the key to add.
     * @param string $passphrase The passphrase for the key.
     * @return void
     */
    public function addDecryptKey($key, $passphrase)

This method seems to be duplicated in your project.

    {
        $keyInfo = $this->_gpg->keyinfo($key);
        if (count($keyInfo) !== 1) {
            throw new Exception('Could not find a unique key');
        }

        if (!$keyInfo[0]['can_sign']) {
            throw new Exception('Key not a valid decryption key');
        }

        $isDecryptionKey = function($subKey) {
            return $subKey['can_sign'];
        };

        $decryptionKeys = array_values(array_filter($keyInfo[0]['subkeys'], $isDecryptionKey));
        if (!$this->_gpg->adddecryptkey($decryptionKeys[0]['fingerprint'], $passphrase)) {
            throw new Exception('Failed to add the decryption key');
        }
    }

    /**
     * Add the given encryption key.
     *
     * @api
     * @param string $key The uid or fingerprint of the key to add.
     * @return void
     */
    public function addEncryptKey($key)

This method seems to be duplicated in your project.

    {
        $keyInfo = $this->_gpg->keyinfo($key);
        if (count($keyInfo) !== 1) {
            throw new Exception('Could not find a unique key');
        }

        if (!$keyInfo[0]['can_encrypt']) {
            throw new Exception('Key not a valid encryption key');
        }

        $isEncryptionKey = function($subKey) {
            return $subKey['can_encrypt'];
        };

        $encryptionKeys = array_values(array_filter($keyInfo[0]['subkeys'], $isEncryptionKey));
        if (!$this->_gpg->addencryptkey($encryptionKeys[0]['fingerprint'])) {
            throw new Exception('Failed to add the encryption key');
        }
    }

    /**
     * Save the passwords to the password file.
     *
     * This requires an encryption key to have been added.
     *
     * @api
     * @see addEncryptKey
     * @param array<array> The passwords to save in the file.
     * @return void
     */
    public function setPasswords(array $passwords)
    {
        $encryptedContents = $this->_gpg->encrypt(json_encode($passwords, JSON_PRETTY_PRINT | JSON_FORCE_OBJECT));
        if ($encryptedContents === false) {
            throw new Exception($this->_gpg->geterror());
        }

        $successfullyWritten = file_put_contents($this->_passwordFile, $encryptedContents);
        if (!$successfullyWritten) {
            throw new Exception('Failed to write to the password file.');
        }
    }
}