-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature #108 Generate keys commands (fbourigault)
This PR was squashed before being merged into the 0.4-dev branch. Discussion ---------- Generate keys commands Here is my proposal to implement #106. The first commit is an import of the command and the test from `LexikJWTAuthenticationBundle` to make review of change easier. # To do - [x] Make `$algorithm` a command option as `LeagueOAuth2ServerBundle` doesn't have such configuration option. - [x] Register the command as a service. Commits ------- 79141d2 Generate keys commands
- Loading branch information
Showing
6 changed files
with
467 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace League\Bundle\OAuth2ServerBundle\Command; | ||
|
|
||
| use Symfony\Component\Console\Attribute\AsCommand; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Console\Style\SymfonyStyle; | ||
| use Symfony\Component\Filesystem\Filesystem; | ||
|
|
||
| /** | ||
| * @author Beno!t POLASZEK <[email protected]> | ||
| */ | ||
| #[AsCommand(name: 'league:oauth2-server:generate-keypair', description: 'Generate public/private keys for use in your application.')] | ||
| final class GenerateKeyPairCommand extends Command | ||
| { | ||
| private const ACCEPTED_ALGORITHMS = [ | ||
| 'RS256', | ||
| 'RS384', | ||
| 'RS512', | ||
| 'HS256', | ||
| 'HS384', | ||
| 'HS512', | ||
| 'ES256', | ||
| 'ES384', | ||
| 'ES512', | ||
| ]; | ||
|
|
||
| /** | ||
| * @deprecated | ||
| */ | ||
| protected static $defaultName = 'league:oauth2-server:generate-keypair'; | ||
|
|
||
| private Filesystem $filesystem; | ||
|
|
||
| private string $secretKey; | ||
|
|
||
| private string $publicKey; | ||
|
|
||
| private ?string $passphrase; | ||
|
|
||
| private string $algorithm; | ||
|
|
||
| public function __construct(Filesystem $filesystem, string $secretKey, string $publicKey, ?string $passphrase, string $algorithm) | ||
| { | ||
| parent::__construct(); | ||
| $this->filesystem = $filesystem; | ||
| $this->secretKey = $secretKey; | ||
| $this->publicKey = $publicKey; | ||
| $this->passphrase = $passphrase; | ||
| $this->algorithm = $algorithm; | ||
| } | ||
|
|
||
| protected function configure(): void | ||
| { | ||
| $this->setDescription('Generate public/private keys for use in your application.'); | ||
| $this->addOption('dry-run', null, InputOption::VALUE_NONE, 'Do not update key files.'); | ||
| $this->addOption('skip-if-exists', null, InputOption::VALUE_NONE, 'Do not update key files if they already exist.'); | ||
| $this->addOption('overwrite', null, InputOption::VALUE_NONE, 'Overwrite key files if they already exist.'); | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int | ||
| { | ||
| $io = new SymfonyStyle($input, $output); | ||
|
|
||
| if (!\in_array($this->algorithm, self::ACCEPTED_ALGORITHMS, true)) { | ||
| $io->error(sprintf('Cannot generate key pair with the provided algorithm `%s`.', $this->algorithm)); | ||
|
|
||
| return Command::FAILURE; | ||
| } | ||
|
|
||
| [$secretKey, $publicKey] = $this->generateKeyPair($this->passphrase); | ||
|
|
||
| if ($input->getOption('dry-run')) { | ||
| $io->success('Your keys have been generated!'); | ||
| $io->newLine(); | ||
| $io->writeln(sprintf('Update your private key in <info>%s</info>:', $this->secretKey)); | ||
| $io->writeln($secretKey); | ||
| $io->newLine(); | ||
| $io->writeln(sprintf('Update your public key in <info>%s</info>:', $this->publicKey)); | ||
| $io->writeln($publicKey); | ||
|
|
||
| return Command::SUCCESS; | ||
| } | ||
|
|
||
| $alreadyExists = $this->filesystem->exists($this->secretKey) || $this->filesystem->exists($this->publicKey); | ||
|
|
||
| if ($alreadyExists) { | ||
| try { | ||
| $this->handleExistingKeys($input); | ||
| } catch (\RuntimeException $e) { | ||
| if (0 === $e->getCode()) { | ||
| $io->comment($e->getMessage()); | ||
|
|
||
| return Command::SUCCESS; | ||
| } | ||
|
|
||
| $io->error($e->getMessage()); | ||
|
|
||
| return Command::FAILURE; | ||
| } | ||
|
|
||
| if (!$io->confirm('You are about to replace your existing keys. Are you sure you wish to continue?')) { | ||
| $io->comment('Your action was canceled.'); | ||
|
|
||
| return Command::SUCCESS; | ||
| } | ||
| } | ||
|
|
||
| $this->filesystem->dumpFile($this->secretKey, $secretKey); | ||
| $this->filesystem->dumpFile($this->publicKey, $publicKey); | ||
|
|
||
| $io->success('Done!'); | ||
|
|
||
| return Command::SUCCESS; | ||
| } | ||
|
|
||
| private function handleExistingKeys(InputInterface $input): void | ||
| { | ||
| if ($input->getOption('skip-if-exists') && $input->getOption('overwrite')) { | ||
| throw new \RuntimeException('Both options `--skip-if-exists` and `--overwrite` cannot be combined.', 1); | ||
| } | ||
|
|
||
| if ($input->getOption('skip-if-exists')) { | ||
| throw new \RuntimeException('Your key files already exist, they won\'t be overridden.', 0); | ||
| } | ||
|
|
||
| if (!$input->getOption('overwrite')) { | ||
| throw new \RuntimeException('Your keys already exist. Use the `--overwrite` option to force regeneration.', 1); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return array{0: string, 1: string} | ||
| */ | ||
| private function generateKeyPair(?string $passphrase): array | ||
| { | ||
| $config = $this->buildOpenSSLConfiguration(); | ||
|
|
||
| $resource = openssl_pkey_new($config); | ||
| if (false === $resource) { | ||
| throw new \RuntimeException(openssl_error_string()); | ||
| } | ||
|
|
||
| $success = openssl_pkey_export($resource, $privateKey, $passphrase); | ||
|
|
||
| if (false === $success) { | ||
| throw new \RuntimeException(openssl_error_string()); | ||
| } | ||
|
|
||
| $publicKeyData = openssl_pkey_get_details($resource); | ||
|
|
||
| if (!\is_array($publicKeyData)) { | ||
| throw new \RuntimeException(openssl_error_string()); | ||
| } | ||
|
|
||
| if (!\array_key_exists('key', $publicKeyData) || !\is_string($publicKeyData['key'])) { | ||
| throw new \RuntimeException('Invalid public key type.'); | ||
| } | ||
|
|
||
| return [$privateKey, $publicKeyData['key']]; | ||
| } | ||
|
|
||
| private function buildOpenSSLConfiguration(): array | ||
| { | ||
| $digestAlgorithms = [ | ||
| 'RS256' => 'sha256', | ||
| 'RS384' => 'sha384', | ||
| 'RS512' => 'sha512', | ||
| 'HS256' => 'sha256', | ||
| 'HS384' => 'sha384', | ||
| 'HS512' => 'sha512', | ||
| 'ES256' => 'sha256', | ||
| 'ES384' => 'sha384', | ||
| 'ES512' => 'sha512', | ||
| ]; | ||
| $privateKeyBits = [ | ||
| 'RS256' => 2048, | ||
| 'RS384' => 2048, | ||
| 'RS512' => 4096, | ||
| 'HS256' => 512, | ||
| 'HS384' => 512, | ||
| 'HS512' => 512, | ||
| 'ES256' => 384, | ||
| 'ES384' => 512, | ||
| 'ES512' => 1024, | ||
| ]; | ||
| $privateKeyTypes = [ | ||
| 'RS256' => \OPENSSL_KEYTYPE_RSA, | ||
| 'RS384' => \OPENSSL_KEYTYPE_RSA, | ||
| 'RS512' => \OPENSSL_KEYTYPE_RSA, | ||
| 'HS256' => \OPENSSL_KEYTYPE_DH, | ||
| 'HS384' => \OPENSSL_KEYTYPE_DH, | ||
| 'HS512' => \OPENSSL_KEYTYPE_DH, | ||
| 'ES256' => \OPENSSL_KEYTYPE_EC, | ||
| 'ES384' => \OPENSSL_KEYTYPE_EC, | ||
| 'ES512' => \OPENSSL_KEYTYPE_EC, | ||
| ]; | ||
|
|
||
| $curves = [ | ||
| 'ES256' => 'secp256k1', | ||
| 'ES384' => 'secp384r1', | ||
| 'ES512' => 'secp521r1', | ||
| ]; | ||
|
|
||
| $config = [ | ||
| 'digest_alg' => $digestAlgorithms[$this->algorithm], | ||
| 'private_key_type' => $privateKeyTypes[$this->algorithm], | ||
| 'private_key_bits' => $privateKeyBits[$this->algorithm], | ||
| ]; | ||
|
|
||
| if (isset($curves[$this->algorithm])) { | ||
| $config['curve_name'] = $curves[$this->algorithm]; | ||
| } | ||
|
|
||
| return $config; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.