vendor/symfony/framework-bundle/Command/SecretsSetCommand.php line 40

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Command;
  14. use Symfony\Bundle\FrameworkBundle\Secrets\AbstractVault;
  15. use Symfony\Component\Console\Command\Command;
  16. use Symfony\Component\Console\Completion\CompletionInput;
  17. use Symfony\Component\Console\Completion\CompletionSuggestions;
  18. use Symfony\Component\Console\Input\InputArgument;
  19. use Symfony\Component\Console\Input\InputInterface;
  20. use Symfony\Component\Console\Input\InputOption;
  21. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  22. use Symfony\Component\Console\Output\OutputInterface;
  23. use Symfony\Component\Console\Style\SymfonyStyle;
  25. /**
  26.  * @author Tobias Schultze <http://tobion.de>
  27.  * @author Jérémy Derussé <jeremy@derusse.com>
  28.  * @author Nicolas Grekas <p@tchwork.com>
  29.  *
  30.  * @internal
  31.  */
  32. final class SecretsSetCommand extends Command
  33. {
  34.     protected static $defaultName = 'secrets:set';
  35.     protected static $defaultDescription = 'Set a secret in the vault';
  37.     private $vault;
  38.     private $localVault;
  40.     public function __construct(AbstractVault $vault, AbstractVault $localVault = null)
  41.     {
  42.         $this->vault = $vault;
  43.         $this->localVault = $localVault;
  45.         parent::__construct();
  46.     }
  48.     protected function configure()
  49.     {
  50.         $this
  51.             ->setDescription(self::$defaultDescription)
  52.             ->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
  53.             ->addArgument('file', InputArgument::OPTIONAL, 'A file where to read the secret from or "-" for reading from STDIN')
  54.             ->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
  55.             ->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generate a random value.', false)
  56.             ->setHelp(<<<'EOF'
  57. The <info>%command.name%</info> command stores a secret in the vault.
  59.     <info>%command.full_name% <name></info>
  61. To reference secrets in services.yaml or any other config
  62. files, use <info>"%env(<name>)%"</info>.
  64. By default, the secret value should be entered interactively.
  65. Alternatively, provide a file where to read the secret from:
  67.     <info>php %command.full_name% <name> filename</info>
  69. Use "-" as a file name to read from STDIN:
  71.     <info>cat filename | php %command.full_name% <name> -</info>
  73. Use <info>--local</info> to override secrets for local needs.
  74. EOF
  75.             )
  76.         ;
  77.     }
  79.     protected function execute(InputInterface $input, OutputInterface $output): int
  80.     {
  81.         $errOutput = $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output;
  82.         $io = new SymfonyStyle($input, $errOutput);
  83.         $name = $input->getArgument('name');
  84.         $vault = $input->getOption('local') ? $this->localVault : $this->vault;
  86.         if (null === $vault) {
  87.             $io->error('The local vault is disabled.');
  89.             return 1;
  90.         }
  92.         if ($this->localVault === $vault && !\array_key_exists($name, $this->vault->list())) {
  93.             $io->error(sprintf('Secret "%s" does not exist in the vault, you cannot override it locally.', $name));
  95.             return 1;
  96.         }
  98.         if (0 < $random = $input->getOption('random') ?? 16) {
  99.             $value = strtr(substr(base64_encode(random_bytes($random)), 0, $random), '+/', '-_');
  100.         } elseif (!$file = $input->getArgument('file')) {
  101.             $value = $io->askHidden('Please type the secret value');
  103.             if (null === $value) {
  104.                 $io->warning('No value provided: using empty string');
  105.                 $value = '';
  106.             }
  107.         } elseif ('-' === $file) {
  108.             $value = file_get_contents('php://stdin');
  109.         } elseif (is_file($file) && is_readable($file)) {
  110.             $value = file_get_contents($file);
  111.         } elseif (!is_file($file)) {
  112.             throw new \InvalidArgumentException(sprintf('File not found: "%s".', $file));
  113.         } elseif (!is_readable($file)) {
  114.             throw new \InvalidArgumentException(sprintf('File is not readable: "%s".', $file));
  115.         }
  117.         if ($vault->generateKeys()) {
  118.             $io->success($vault->getLastMessage());
  120.             if ($this->vault === $vault) {
  121.                 $io->caution('DO NOT COMMIT THE DECRYPTION KEY FOR THE PROD ENVIRONMENT⚠️');
  122.             }
  123.         }
  125.         $vault->seal($name, $value);
  127.         $io->success($vault->getLastMessage() ?? 'Secret was successfully stored in the vault.');
  129.         if (0 < $random) {
  130.             $errOutput->write(' // The generated random value is: <comment>');
  131.             $output->write($value);
  132.             $errOutput->writeln('</comment>');
  133.             $io->newLine();
  134.         }
  136.         if ($this->vault === $vault && null !== $this->localVault->reveal($name)) {
  137.             $io->comment('Note that this secret is overridden in the local vault.');
  138.         }
  140.         return 0;
  141.     }
  143.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  144.     {
  145.         if ($input->mustSuggestArgumentValuesFor('name')) {
  146.             $suggestions->suggestValues(array_keys($this->vault->list(false)));
  147.         }
  148.     }
  149. }