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

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