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

  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\Attribute\AsCommand;
  16. use Symfony\Component\Console\Command\Command;
  17. use Symfony\Component\Console\Completion\CompletionInput;
  18. use Symfony\Component\Console\Completion\CompletionSuggestions;
  19. use Symfony\Component\Console\Input\InputArgument;
  20. use Symfony\Component\Console\Input\InputInterface;
  21. use Symfony\Component\Console\Input\InputOption;
  22. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  23. use Symfony\Component\Console\Output\OutputInterface;
  24. use Symfony\Component\Console\Style\SymfonyStyle;
  26. /**
  27.  * @author Tobias Schultze <http://tobion.de>
  28.  * @author Jérémy Derussé <jeremy@derusse.com>
  29.  * @author Nicolas Grekas <p@tchwork.com>
  30.  *
  31.  * @internal
  32.  */
  33. #[AsCommand(name: 'secrets:set', description: 'Set a secret in the vault')]
  34. final class SecretsSetCommand extends Command
  35. {
  36.     private AbstractVault $vault;
  37.     private ?AbstractVault $localVault;
  39.     public function __construct(AbstractVault $vault, AbstractVault $localVault = null)
  40.     {
  41.         $this->vault = $vault;
  42.         $this->localVault = $localVault;
  44.         parent::__construct();
  45.     }
  47.     protected function configure()
  48.     {
  49.         $this
  50.             ->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
  51.             ->addArgument('file', InputArgument::OPTIONAL, 'A file where to read the secret from or "-" for reading from STDIN')
  52.             ->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
  53.             ->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generate a random value.', false)
  54.             ->setHelp(<<<'EOF'
  55. The <info>%command.name%</info> command stores a secret in the vault.
  57.     <info>%command.full_name% <name></info>
  59. To reference secrets in services.yaml or any other config
  60. files, use <info>"%env(<name>)%"</info>.
  62. By default, the secret value should be entered interactively.
  63. Alternatively, provide a file where to read the secret from:
  65.     <info>php %command.full_name% <name> filename</info>
  67. Use "-" as a file name to read from STDIN:
  69.     <info>cat filename | php %command.full_name% <name> -</info>
  71. Use <info>--local</info> to override secrets for local needs.
  72. EOF
  73.             )
  74.         ;
  75.     }
  77.     protected function execute(InputInterface $input, OutputInterface $output): int
  78.     {
  79.         $errOutput = $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output;
  80.         $io = new SymfonyStyle($input, $errOutput);
  81.         $name = $input->getArgument('name');
  82.         $vault = $input->getOption('local') ? $this->localVault : $this->vault;
  84.         if (null === $vault) {
  85.             $io->error('The local vault is disabled.');
  87.             return 1;
  88.         }
  90.         if ($this->localVault === $vault && !\array_key_exists($name, $this->vault->list())) {
  91.             $io->error(sprintf('Secret "%s" does not exist in the vault, you cannot override it locally.', $name));
  93.             return 1;
  94.         }
  96.         if (0 < $random = $input->getOption('random') ?? 16) {
  97.             $value = strtr(substr(base64_encode(random_bytes($random)), 0, $random), '+/', '-_');
  98.         } elseif (!$file = $input->getArgument('file')) {
  99.             $value = $io->askHidden('Please type the secret value');
  101.             if (null === $value) {
  102.                 $io->warning('No value provided: using empty string');
  103.                 $value = '';
  104.             }
  105.         } elseif ('-' === $file) {
  106.             $value = file_get_contents('php://stdin');
  107.         } elseif (is_file($file) && is_readable($file)) {
  108.             $value = file_get_contents($file);
  109.         } elseif (!is_file($file)) {
  110.             throw new \InvalidArgumentException(sprintf('File not found: "%s".', $file));
  111.         } elseif (!is_readable($file)) {
  112.             throw new \InvalidArgumentException(sprintf('File is not readable: "%s".', $file));
  113.         }
  115.         if ($vault->generateKeys()) {
  116.             $io->success($vault->getLastMessage());
  118.             if ($this->vault === $vault) {
  119.                 $io->caution('DO NOT COMMIT THE DECRYPTION KEY FOR THE PROD ENVIRONMENT⚠️');
  120.             }
  121.         }
  123.         $vault->seal($name, $value);
  125.         $io->success($vault->getLastMessage() ?? 'Secret was successfully stored in the vault.');
  127.         if (0 < $random) {
  128.             $errOutput->write(' // The generated random value is: <comment>');
  129.             $output->write($value);
  130.             $errOutput->writeln('</comment>');
  131.             $io->newLine();
  132.         }
  134.         if ($this->vault === $vault && null !== $this->localVault->reveal($name)) {
  135.             $io->comment('Note that this secret is overridden in the local vault.');
  136.         }
  138.         return 0;
  139.     }
  141.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  142.     {
  143.         if ($input->mustSuggestArgumentValuesFor('name')) {
  144.             $suggestions->suggestValues(array_keys($this->vault->list(false)));
  145.         }
  146.     }
  147. }