LeKoala\Encrypt\EncryptedDBFile

Complexity

Total Complexity

12

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	sendDecryptedFile()	0	23	5
A	encryptFileIfNeeded()	0	24	5
A	getEncryptedFileInstance()	0	5	1
A	isEncrypted()	0	5	1

<?php

namespace LeKoala\Encrypt;

use Exception;
use SilverStripe\Assets\File;
use SilverStripe\ORM\DataExtension;
use ParagonIE\CipherSweet\CipherSweet;
use ParagonIE\CipherSweet\EncryptedFile;

/**
 * Safe and encrypted content file
 * Also make sure that files are not public assets! => use htaccess
 * @property bool $Encrypted
 * @property File|EncryptedDBFile $owner
 */
class EncryptedDBFile extends DataExtension
{
    private static $db = [

The private property $db is not used, and could be removed.

        "Encrypted" => "Boolean",
    ];

    /**
     * @return EncryptedFile
     */
    protected function getEncryptedFileInstance()
    {
        $engine = EncryptHelper::getCipherSweet();
        $encFile = new EncryptedFile($engine);
        return $encFile;
    }

    /**
     * Check if the actual file on the filesystem is encrypted
     * You might also use the Encrypted field that should be accurate
     *
     * @return boolean
     */
    public function isEncrypted()
    {
        $encFile = $this->getEncryptedFileInstance();
        $stream = $this->owner->getStream();

The method getStream() does not exist on LeKoala\Encrypt\EncryptedDBFile.

        return $encFile->isStreamEncrypted($stream);
    }

    /**
     * Output file using regular php
     *
     * @throws Exception
     * @return void
     */
    public function sendDecryptedFile()
    {
        if (ob_get_level()) {
            ob_end_clean();
        }
        $stream = $this->owner->getStream();
        if ($this->owner->Encrypted) {
            $encFile = $this->getEncryptedFileInstance();
            $output = fopen('php://temp', 'w+b');

            // We need to decrypt stream
            if ($encFile->isStreamEncrypted($stream)) {
                $success = $encFile->decryptStream($stream, $output);

It seems like $output can also be of type false; however, parameter $outputFP of ParagonIE\CipherSweet\EncryptedFile::decryptStream() does only seem to accept resource, maybe add an additional type check?

                if (!$success) {
                    throw new Exception("Failed to decrypt stream");
                }

                // Rewind first
                rewind($output);

It seems like $output can also be of type false; however, parameter $handle of rewind() does only seem to accept resource, maybe add an additional type check?

                fpassthru($output);

It seems like $output can also be of type false; however, parameter $handle of fpassthru() does only seem to accept resource, maybe add an additional type check?

            }
        }
        fpassthru($stream);
    }

    /**
     * Files are not encrypted automatically
     * Calls this method to encrypt them
     *
     * @throws Exception
     * @return void
     */
    public function encryptFileIfNeeded()
    {
        $encFile = $this->getEncryptedFileInstance();
        $stream = $this->owner->getStream();

        if (!$encFile->isStreamEncrypted($stream)) {
            // php://temp is not a file path, it's a pseudo protocol that always creates a new random temp file when used.
            $output = fopen('php://temp', 'wb');
            // $success = fwrite($output, 'test');
            $success =  $encFile->encryptStream($stream, $output);

It seems like $output can also be of type false; however, parameter $outputFP of ParagonIE\CipherSweet\EncryptedFile::encryptStream() does only seem to accept resource, maybe add an additional type check?

            if (!$success) {
                throw new Exception("Failed to encrypt stream");
            }
            // dont forget to rewind the stream !
            rewind($output);

It seems like $output can also be of type false; however, parameter $handle of rewind() does only seem to accept resource, maybe add an additional type check?

            $this->owner->setFromStream($output, $this->owner->getFilename());

The method setFromStream() does not exist on LeKoala\Encrypt\EncryptedDBFile.

The method getFilename() does not exist on LeKoala\Encrypt\EncryptedDBFile.

            // Mark as encrypted in db
            $this->owner->Encrypted =  true;
            $this->owner->write();

The method write() does not exist on LeKoala\Encrypt\EncryptedDBFile.

        } elseif ($this->owner->Encrypted) {
            // Stream is not encrypted
            if ($this->owner->Encrypted) {
                $this->owner->Encrypted = false;
                $this->owner->write();
            }
        }
    }
}