vendor/symfony/framework-bundle/Command/SecretsListCommand.php line 37

  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\Helper\Dumper;
  18. use Symfony\Component\Console\Input\InputInterface;
  19. use Symfony\Component\Console\Input\InputOption;
  20. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  21. use Symfony\Component\Console\Output\OutputInterface;
  22. use Symfony\Component\Console\Style\SymfonyStyle;
  24. /**
  25.  * @author Tobias Schultze <http://tobion.de>
  26.  * @author Jérémy Derussé <jeremy@derusse.com>
  27.  * @author Nicolas Grekas <p@tchwork.com>
  28.  *
  29.  * @internal
  30.  */
  31. #[AsCommand(name: 'secrets:list', description: 'List all secrets')]
  32. final class SecretsListCommand extends Command
  33. {
  34.     private AbstractVault $vault;
  35.     private ?AbstractVault $localVault;
  37.     public function __construct(AbstractVault $vault, AbstractVault $localVault = null)
  38.     {
  39.         $this->vault = $vault;
  40.         $this->localVault = $localVault;
  42.         parent::__construct();
  43.     }
  45.     protected function configure()
  46.     {
  47.         $this
  48.             ->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display decrypted values alongside names')
  49.             ->setHelp(<<<'EOF'
  50. The <info>%command.name%</info> command list all stored secrets.
  52.     <info>%command.full_name%</info>
  54. When the option <info>--reveal</info> is provided, the decrypted secrets are also displayed.
  56.     <info>%command.full_name% --reveal</info>
  57. EOF
  58.             )
  59.         ;
  60.     }
  62.     protected function execute(InputInterface $input, OutputInterface $output): int
  63.     {
  64.         $io = new SymfonyStyle($input, $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output);
  66.         $io->comment('Use <info>"%env(<name>)%"</info> to reference a secret in a config file.');
  68.         if (!$reveal = $input->getOption('reveal')) {
  69.             $io->comment(sprintf('To reveal the secrets run <info>php %s %s --reveal</info>', $_SERVER['PHP_SELF'], $this->getName()));
  70.         }
  72.         $secrets = $this->vault->list($reveal);
  73.         $localSecrets = $this->localVault?->list($reveal);
  75.         $rows = [];
  77.         $dump = new Dumper($output);
  78.         $dump = static function (?string $v) use ($dump) {
  79.             return null === $v ? '******' : $dump($v);
  80.         };
  82.         foreach ($secrets as $name => $value) {
  83.             $rows[$name] = [$name, $dump($value)];
  84.         }
  86.         if (null !== $message = $this->vault->getLastMessage()) {
  87.             $io->comment($message);
  88.         }
  90.         foreach ($localSecrets ?? [] as $name => $value) {
  91.             if (isset($rows[$name])) {
  92.                 $rows[$name][] = $dump($value);
  93.             }
  94.         }
  96.         if (null !== $this->localVault && null !== $message = $this->localVault->getLastMessage()) {
  97.             $io->comment($message);
  98.         }
  100.         (new SymfonyStyle($input, $output))
  101.             ->table(['Secret', 'Value'] + (null !== $localSecrets ? [2 => 'Local Value'] : []), $rows);
  103.         $io->comment("Local values override secret values.\nUse <info>secrets:set --local</info> to define them.");
  105.         return 0;
  106.     }
  107. }