Fix typo

jderusse · jderusse · commit a17c1656a8f4 · 2019-04-14T11:23:42.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+ * Added secrets management.
+
 4.3.0
 -----
 
@@ -32,7 +37,6 @@ CHANGELOG
  * Added a `InMemoryTransport` to Messenger. Use it with a DSN starting with `in-memory://`.
  * Added `framework.property_access.throw_exception_on_invalid_property_path` config option.
  * Added `cache:pool:list` command to list all available cache pools.
- * Added secrets management.
 
 4.2.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsAddCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsAddCommand.php
@@ -54,7 +54,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         try {
             $this->secretsStorage->putSecret($key, $secret);
         } catch (EncryptionKeyNotFoundException $e) {
-            throw new \LogicException(sprintf('No encryption key found. You should call the command "%s"', SecretsGenerateKeyCommand::getDefaultName()));
+            throw new \LogicException(sprintf('No encryption keys found. You should call the "%s" command.', SecretsGenerateKeyCommand::getDefaultName()));
         }
     }
 
@@ -66,7 +66,7 @@ protected function interact(InputInterface $input, OutputInterface $output)
         while (empty($key)) {
             $key = $io->askQuestion(new Question('Key of the secret'));
             if (empty($key)) {
-                $io->warning('The "key" should not be empty.');
+                $io->warning('The "key" cannot be empty.');
             }
         }
         $input->setArgument('key', $key);
@@ -75,7 +75,7 @@ protected function interact(InputInterface $input, OutputInterface $output)
         if (empty($secret)) {
             $question = new Question('Plaintext secret value', $input->getArgument('secret'));
             $question->setHidden(true);
-            $secret = $io->askQuestion((new Question('Plaintext secret value'))->setHidden(true));
+            $secret = $io->askQuestion($question);
             $input->setArgument('secret', (string) $secret);
         }
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsGenerateKeyCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsGenerateKeyCommand.php
@@ -41,7 +41,7 @@ protected function configure()
     {
         $this
             ->setDescription('Generate a new secret key.')
-            ->addOption('force', 'f', InputOption::VALUE_NONE, 'override previous key.');
+            ->addOption('force', 'f', InputOption::VALUE_NONE, 'Override previous key.');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsListCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsListCommand.php
@@ -27,9 +27,6 @@ final class SecretsListCommand extends Command
 {
     protected static $defaultName = 'secrets:list';
 
-    /**
-     * @var SecretStorageInterface
-     */
     private $secretStorage;
 
     public function __construct(SecretStorageInterface $secretStorage)
@@ -43,7 +40,7 @@ protected function configure()
     {
         $this
             ->setDescription('Lists all secrets.')
-            ->addOption('reveal', 'r', InputOption::VALUE_NONE, 'display plain text value alongside keys');
+            ->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display plain text value along side keys');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Exception/SecretNotFoundException.php b/src/Symfony/Bundle/FrameworkBundle/Exception/SecretNotFoundException.php
@@ -18,7 +18,7 @@ class SecretNotFoundException extends \RuntimeException
     public function __construct(string $name)
     {
         $this->name = $name;
-        parent::__construct(\sprintf('The secret "%s" does not exists', $name));
+        parent::__construct(\sprintf('The secret "%s" does not exist.', $name));
     }
 
     public function getName(): string
diff --git a/src/Symfony/Bundle/FrameworkBundle/Secret/FilesSecretStorage.php b/src/Symfony/Bundle/FrameworkBundle/Secret/FilesSecretStorage.php
@@ -29,7 +29,7 @@ class FilesSecretStorage implements MutableSecretStorageInterface
 
     public function __construct(string $secretsFolder, EncoderInterface $encoder)
     {
-        $this->secretsFolder = rtrim($secretsFolder, \DIRECTORY_SEPARATOR);
+        $this->secretsFolder = rtrim($secretsFolder, '\\/');
         $this->encoder = $encoder;
         $this->filesystem = new Filesystem();
     }
@@ -40,7 +40,7 @@ public function __construct(string $secretsFolder, EncoderInterface $encoder)
     public function listSecrets(bool $reveal = false): iterable
     {
         if (!$this->filesystem->exists($this->secretsFolder)) {
-            return;
+            return [];
         }
 
         foreach ((new Finder())->in($this->secretsFolder)->depth(0)->name('*'.self::FILE_SUFFIX)->files() as $file) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Secret/SecretStorageInterface.php b/src/Symfony/Bundle/FrameworkBundle/Secret/SecretStorageInterface.php
@@ -21,13 +21,22 @@
 interface SecretStorageInterface
 {
     /**
-     * @param string $name
+     * Retrieves a plain text secret from the storage.
+     *
+     * @param string $name name of the secret
      *
      * @return string
      *
      * @throws SecretNotFoundException
      */
     public function getSecret(string $name): string;
 
+    /**
+     * Returns a list of all secrets indexed by their name.
+     *
+     * @param bool $reveal when true, returns the plain text secret, null otherwise.
+     *
+     * @return iterable
+     */
     public function listSecrets(bool $reveal = false): iterable;
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Secret/SodiumEncoder.php b/src/Symfony/Bundle/FrameworkBundle/Secret/SodiumEncoder.php
@@ -39,7 +39,7 @@ public function generateKeys(bool $override = false): array
     {
         $path = $this->getKeyPath();
         if (!$override && \is_file($path)) {
-            throw new \LogicException('A key already exist in '.$path);
+            throw new \LogicException(sprintf('A key already exist in "%s".', $path));
         }
 
         $this->encryptionKey = null;
@@ -69,9 +69,7 @@ public function encrypt(string $message): string
     private function getKeyPath(): ?string
     {
         if (null === @\is_file($this->encryptionKeyOrPath)) {
-            throw new \InvalidArgumentException(
-                'The path to the encryption key is not valid. Did you configured the framework with the content of key instead of it location?'
-            );
+            throw new \InvalidArgumentException('The path to the encryption key is not valid. Did you configured the framework with the content of key instead of its location?');
         }
 
         return $this->encryptionKeyOrPath;
@@ -89,7 +87,7 @@ private function getKey(): string
         if (true === $isFile) {
             return $this->encryptionKey = \file_get_contents($this->encryptionKeyOrPath);
         }
-        // if `encryptionKeyOrPath` is a valid string with the exact length of a KEY, and the file does not exists, we presume it's the key itself
+        // if `encryptionKeyOrPath` is a valid string with the exact length of a KEY, and the file does not exist, we presume it's the key itself
         if (\SODIUM_CRYPTO_STREAM_KEYBYTES === \strlen($this->encryptionKeyOrPath)) {
             return $this->encryptionKey = $this->encryptionKeyOrPath;
         }
@@ -119,7 +117,7 @@ public function decrypt(string $encryptedText): string
     private function decode(string $message): array
     {
         if (\strlen($message) < \SODIUM_CRYPTO_STREAM_NONCEBYTES) {
-            throw new \UnexpectedValueException(sprintf('Invalid encryptedText. Message should nbe at lease %d char long.', \SODIUM_CRYPTO_STREAM_NONCEBYTES));
+            throw new \UnexpectedValueException(sprintf('Invalid encrypted text, message should be at least %s chars long.', \SODIUM_CRYPTO_STREAM_NONCEBYTES));
         }
 
         $nonce = substr($message, 0, \SODIUM_CRYPTO_STREAM_NONCEBYTES);

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`54`	`54`	`try {`
`55`	`55`	`$this->secretsStorage->putSecret($key, $secret);`
`56`	`56`	`} catch (EncryptionKeyNotFoundException $e) {`
`57`		`- throw new \LogicException(sprintf('No encryption key found. You should call the command "%s"', SecretsGenerateKeyCommand::getDefaultName()));`
	`57`	`+ throw new \LogicException(sprintf('No encryption keys found. You should call the "%s" command.', SecretsGenerateKeyCommand::getDefaultName()));`
`58`	`58`	`}`
`59`	`59`	`}`
`60`	`60`
`@@ -66,7 +66,7 @@ protected function interact(InputInterface $input, OutputInterface $output)`
`66`	`66`	`while (empty($key)) {`
`67`	`67`	`$key = $io->askQuestion(new Question('Key of the secret'));`
`68`	`68`	`if (empty($key)) {`
`69`		`- $io->warning('The "key" should not be empty.');`
	`69`	`+ $io->warning('The "key" cannot be empty.');`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`	`$input->setArgument('key', $key);`
`@@ -75,7 +75,7 @@ protected function interact(InputInterface $input, OutputInterface $output)`
`75`	`75`	`if (empty($secret)) {`
`76`	`76`	`$question = new Question('Plaintext secret value', $input->getArgument('secret'));`
`77`	`77`	`$question->setHidden(true);`
`78`		`- $secret = $io->askQuestion((new Question('Plaintext secret value'))->setHidden(true));`
	`78`	`+ $secret = $io->askQuestion($question);`
`79`	`79`	`$input->setArgument('secret', (string) $secret);`
`80`	`80`	`}`
`81`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ protected function configure()`
`41`	`41`	`{`
`42`	`42`	`$this`
`43`	`43`	`->setDescription('Generate a new secret key.')`
`44`		`- ->addOption('force', 'f', InputOption::VALUE_NONE, 'override previous key.');`
	`44`	`+ ->addOption('force', 'f', InputOption::VALUE_NONE, 'Override previous key.');`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`protected function execute(InputInterface $input, OutputInterface $output)`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,6 @@ final class SecretsListCommand extends Command`
`27`	`27`	`{`
`28`	`28`	`protected static $defaultName = 'secrets:list';`
`29`	`29`
`30`		`- /**`
`31`		`- * @var SecretStorageInterface`
`32`		`- */`
`33`	`30`	`private $secretStorage;`
`34`	`31`
`35`	`32`	`public function __construct(SecretStorageInterface $secretStorage)`
`@@ -43,7 +40,7 @@ protected function configure()`
`43`	`40`	`{`
`44`	`41`	`$this`
`45`	`42`	`->setDescription('Lists all secrets.')`
`46`		`- ->addOption('reveal', 'r', InputOption::VALUE_NONE, 'display plain text value alongside keys');`
	`43`	`+ ->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display plain text value along side keys');`
`47`	`44`	`}`
`48`	`45`
`49`	`46`	`protected function execute(InputInterface $input, OutputInterface $output)`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class SecretNotFoundException extends \RuntimeException`
`18`	`18`	`public function __construct(string $name)`
`19`	`19`	`{`
`20`	`20`	`$this->name = $name;`
`21`		`- parent::__construct(\sprintf('The secret "%s" does not exists', $name));`
	`21`	`+ parent::__construct(\sprintf('The secret "%s" does not exist.', $name));`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`public function getName(): string`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class FilesSecretStorage implements MutableSecretStorageInterface`
`29`	`29`
`30`	`30`	`public function __construct(string $secretsFolder, EncoderInterface $encoder)`
`31`	`31`	`{`
`32`		`- $this->secretsFolder = rtrim($secretsFolder, \DIRECTORY_SEPARATOR);`
	`32`	`+ $this->secretsFolder = rtrim($secretsFolder, '\\/');`
`33`	`33`	`$this->encoder = $encoder;`
`34`	`34`	`$this->filesystem = new Filesystem();`
`35`	`35`	`}`
`@@ -40,7 +40,7 @@ public function __construct(string $secretsFolder, EncoderInterface $encoder)`
`40`	`40`	`public function listSecrets(bool $reveal = false): iterable`
`41`	`41`	`{`
`42`	`42`	`if (!$this->filesystem->exists($this->secretsFolder)) {`
`43`		`- return;`
	`43`	`+ return [];`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`foreach ((new Finder())->in($this->secretsFolder)->depth(0)->name('*'.self::FILE_SUFFIX)->files() as $file) {`
Original file line number	Diff line number	Diff line change
`@@ -21,13 +21,22 @@`
`21`	`21`	`interface SecretStorageInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * @param string $name`
	`24`	`+ * Retrieves a plain text secret from the storage.`
	`25`	`+ *`
	`26`	`+ * @param string $name name of the secret`
`25`	`27`	`*`
`26`	`28`	`* @return string`
`27`	`29`	`*`
`28`	`30`	`* @throws SecretNotFoundException`
`29`	`31`	`*/`
`30`	`32`	`public function getSecret(string $name): string;`
`31`	`33`
	`34`	`+ /**`
	`35`	`+ * Returns a list of all secrets indexed by their name.`
	`36`	`+ *`
	`37`	`+ * @param bool $reveal when true, returns the plain text secret, null otherwise.`
	`38`	`+ *`
	`39`	`+ * @return iterable`
	`40`	`+ */`
`32`	`41`	`public function listSecrets(bool $reveal = false): iterable;`
`33`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function generateKeys(bool $override = false): array`
`39`	`39`	`{`
`40`	`40`	`$path = $this->getKeyPath();`
`41`	`41`	`if (!$override && \is_file($path)) {`
`42`		`- throw new \LogicException('A key already exist in '.$path);`
	`42`	`+ throw new \LogicException(sprintf('A key already exist in "%s".', $path));`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`$this->encryptionKey = null;`
`@@ -69,9 +69,7 @@ public function encrypt(string $message): string`
`69`	`69`	`private function getKeyPath(): ?string`
`70`	`70`	`{`
`71`	`71`	`if (null === @\is_file($this->encryptionKeyOrPath)) {`
`72`		`- throw new \InvalidArgumentException(`
`73`		`- 'The path to the encryption key is not valid. Did you configured the framework with the content of key instead of it location?'`
`74`		`- );`
	`72`	`+ throw new \InvalidArgumentException('The path to the encryption key is not valid. Did you configured the framework with the content of key instead of its location?');`
`75`	`73`	`}`
`76`	`74`
`77`	`75`	`return $this->encryptionKeyOrPath;`
`@@ -89,7 +87,7 @@ private function getKey(): string`
`89`	`87`	`if (true === $isFile) {`
`90`	`88`	`return $this->encryptionKey = \file_get_contents($this->encryptionKeyOrPath);`
`91`	`89`	`}`
`92`		- // if `encryptionKeyOrPath` is a valid string with the exact length of a KEY, and the file does not exists, we presume it's the key itself
	`90`	+ // if `encryptionKeyOrPath` is a valid string with the exact length of a KEY, and the file does not exist, we presume it's the key itself
`93`	`91`	`if (\SODIUM_CRYPTO_STREAM_KEYBYTES === \strlen($this->encryptionKeyOrPath)) {`
`94`	`92`	`return $this->encryptionKey = $this->encryptionKeyOrPath;`
`95`	`93`	`}`
`@@ -119,7 +117,7 @@ public function decrypt(string $encryptedText): string`
`119`	`117`	`private function decode(string $message): array`
`120`	`118`	`{`
`121`	`119`	`if (\strlen($message) < \SODIUM_CRYPTO_STREAM_NONCEBYTES) {`
`122`		`- throw new \UnexpectedValueException(sprintf('Invalid encryptedText. Message should nbe at lease %d char long.', \SODIUM_CRYPTO_STREAM_NONCEBYTES));`
	`120`	`+ throw new \UnexpectedValueException(sprintf('Invalid encrypted text, message should be at least %s chars long.', \SODIUM_CRYPTO_STREAM_NONCEBYTES));`
`123`	`121`	`}`
`124`	`122`
`125`	`123`	`$nonce = substr($message, 0, \SODIUM_CRYPTO_STREAM_NONCEBYTES);`