Add support for specifying Hash algorithm to use

for phar generation (SHA-1, SHA-256, SHA-512)
theseer · Nov 10, 2015 · 2e27e20 · 2e27e20
1 parent 2696aac
commit 2e27e20
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 6 deletions.
diff --git a/src/Application.php b/src/Application.php
@@ -120,6 +120,9 @@ private function runSaver($code) {
             if ($aliasName = $this->config->getPharAliasName()) {
                 $pharBuilder->setAliasName($aliasName);
             }
+            if ($this->config->hasPharHashAlgorithm()) {
+                $pharBuilder->setSignatureType($this->config->getPharHashAlgorithm());
+            }
             $pharBuilder->build($output, $code);
             $this->logger->log("\nphar archive '{$output}' generated.\n\n");
             return CLI::RC_OK;

diff --git a/src/CLI.php b/src/CLI.php
@@ -168,6 +168,9 @@ private function configure(\ezcConsoleInput $input) {
                 $config->setVariable('PHAR',
                     $input->getOption('alias')->value ? $input->getOption('alias')->value : basename($output)
                 );
+                if ($hashAlgorithm = $input->getOption('hash')->value) {
+                    $config->setPharHashAlgorithm($hashAlgorithm);
+                }
             }
 
             if ($input->getOption('cache')->value) {
@@ -281,6 +284,7 @@ protected function showUsage() {
 
   -o, --output        Output file for generated code (default: STDOUT)
   -p, --phar          Create a phar archive (requires -o )
+      --hash          Force given hash algorithm (SHA-1, SHA-256 or SHA-512) (requires -p, conflicts with --key)
       --bzip2         Compress phar archive using bzip2 (requires -p) (bzip2 required)
       --gz            Compress phar archive using gzip (requires -p) (gzip required)
       --key           OpenSSL key file to use for signing phar archive (requires -p) (openssl required)
@@ -390,6 +394,14 @@ protected function setupInput() {
                 array( new \ezcConsoleOptionRule( $input->getOption( 'p' ) ) )
             ));
 
+            $this->outputOption = $input->registerOption( new \ezcConsoleOption(
+                '', 'hash', \ezcConsoleInput::TYPE_STRING, NULL, FALSE,
+                'Force given hash algorithm (SHA-1, SHA-256 or SHA-512) (requires -p)',
+                NULL,
+                array( new \ezcConsoleOptionRule( $input->getOption( 'p' ) ) ),
+                array( new \ezcConsoleOptionRule( $input->getOption( 'key' ) ) )
+            ));
+
             $input->registerOption( new \ezcConsoleOption(
                 'i', 'include', \ezcConsoleInput::TYPE_STRING, '*.php', TRUE,
                 'File pattern to include (default: *.php)'

diff --git a/src/Config.php b/src/Config.php
@@ -65,6 +65,7 @@ class Config {
         private $pharKey;
         private $pharAll = false;
         private $pharAliasName = '';
+        private $pharHashAlgorithm;
         private $followSymlinks = false;
         private $cacheFilename;
         private $prepend = false;
@@ -244,6 +245,29 @@ public function getPharAliasName() {
             return $this->pharAliasName;
         }
 
+        public function hasPharHashAlgorithm() {
+            return $this->pharHashAlgorithm !== null;
+        }
+
+        /**
+         * @return string
+         */
+        public function getPharHashAlgorithm() {
+            return $this->pharHashAlgorithm;
+        }
+
+        /**
+         * @param string $pharHashAlgorithm
+         */
+        public function setPharHashAlgorithm($pharHashAlgorithm) {
+            if (!in_array($pharHashAlgorithm, array('SHA-512','SHA-256','SHA-1'))) {
+                throw new \InvalidArgumentException(
+                    sprintf('Algorithm %s not supported', $pharHashAlgorithm)
+                );
+            }
+            $this->pharHashAlgorithm = $pharHashAlgorithm;
+        }
+
         public function setPhp($php) {
             $this->php = $php;
         }

diff --git a/src/PharBuilder.php b/src/PharBuilder.php
@@ -46,9 +46,16 @@ class PharBuilder {
         private $key;
         private $basedir;
         private $aliasName;
+        private $signatureType;
 
         private $directories = array();
 
+        private $supportedSignatureTypes = array(
+            'SHA-512' => \Phar::SHA512,
+            'SHA-256' => \Phar::SHA256,
+            'SHA-1' => \Phar::SHA1
+        );
+
         public function __construct(DirectoryScanner $scanner, $basedir) {
             $this->scanner = $scanner;
             $this->basedir = $basedir;
@@ -58,6 +65,15 @@ public function setCompressionMode($mode) {
             $this->compression = $mode;
         }
 
+        public function setSignatureType($type) {
+            if (!in_array($type, array_keys($this->supportedSignatureTypes))) {
+                throw new \InvalidArgumentException(
+                    sprintf('Signature type "%s" not known or not supported by this PHP installation.', $type)
+                );
+            }
+            $this->signatureType = $type;
+        }
+
         public function setSignatureKey($key) {
             $this->key = $key;
         }
@@ -99,13 +115,11 @@ public function build($filename, $stub) {
         }
 
         private function selectSignatureType(\Phar $phar) {
-            $map = array(
-                'SHA-512' => \Phar::SHA512,
-                'SHA-256' => \Phar::SHA256,
-                'SHA-1' => \Phar::SHA1
-            );
+            if ($this->signatureType !== NULL) {
+                return $this->supportedSignatureTypes[$this->signatureType];
+            }
             $supported = $phar->getSupportedSignatures();
-            foreach($map as $candidate => $type) {
+            foreach($this->supportedSignatureTypes as $candidate => $type) {
                 if (in_array($candidate, $supported)) {
                     return $type;
                 }