Oauth2GenerateKeyForm.php in Simple OAuth (OAuth2) & OpenID Connect 8.4

Namespace

Drupal\simple_oauth\Entity\Form

File

src/Entity/Form/Oauth2GenerateKeyForm.php

<?php

namespace Drupal\simple_oauth\Entity\Form;

use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\CloseDialogCommand;
use Drupal\Core\Ajax\HtmlCommand;
use Drupal\Core\Ajax\InvokeCommand;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\simple_oauth\Service\KeyGeneratorService;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * @internal
 */
class Oauth2GenerateKeyForm extends FormBase {

  /**
   * @var \Drupal\simple_oauth\Service\KeyGeneratorService
   */
  private $keyGen;

  /**
   * Oauth2GenerateKeyForm constructor.
   *
   * @param \Drupal\simple_oauth\Service\KeyGeneratorService $key_generator_service
   */
  public function __construct(KeyGeneratorService $key_generator_service) {
    $this->keyGen = $key_generator_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('simple_oauth.key.generator'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'oauth2_generate_key';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $pubk_id = NULL, $pk_id = NULL) {

    // Hidden public key id.
    $form['key_settings']['pubk_id'] = [
      '#type' => 'hidden',
      '#required' => TRUE,
      '#value' => $pubk_id,
    ];

    // Hidden private key id.
    $form['key_settings']['pk_id'] = [
      '#type' => 'hidden',
      '#required' => TRUE,
      '#value' => $pk_id,
    ];

    // Error Messages container.
    $form['key_settings']['message'] = [
      '#markup' => '<div id="key-error-message" class="messages messages--error"></div>',
      '#hidden' => TRUE,
    ];
    $disclaimer = '<p>' . $this
      ->t('This is the directory where the public and private keys will be stored after generation. This <strong>SHOULD</strong> be located outside of your webroot to avoid making them public unintentionally.') . '</p><p>' . $this
      ->t('Any keys already present in this directory will be deleted.') . '</p>';

    // Private Key Path.
    $form['key_settings']['directory'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Directory for the keys'),
      '#description' => $disclaimer,
      '#required' => TRUE,
      '#attributes' => [
        'id' => "dir_path",
      ],
    ];

    // Submit.
    $form['key_settings']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Generate'),
      '#ajax' => [
        'callback' => '::generateKeys',
        'event' => 'click',
      ],
    ];
    return $form;
  }

  /**
   * Generate public and private keys.
   *
   * @param $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   */
  public function generateKeys(&$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();

    // Get all the values.
    $values = $form_state
      ->getValues();

    // Get Private key path.
    $dir_path = $values['directory'];
    if (!isset($dir_path)) {
      $response
        ->addCommand(new InvokeCommand('#key-error-message', 'show'));
      return $response
        ->addCommand(new HtmlCommand('#key-error-message', $this
        ->t('The directory is required.')));
    }
    try {

      // Generate keys.
      $this->keyGen
        ->generateKeys($dir_path);
    } catch (\Exception $exception) {

      // If exception log it and return an error message.
      watchdog_exception('simple_oauth', $exception);
      $response
        ->addCommand(new InvokeCommand('#key-error-message', 'show'));
      return $response
        ->addCommand(new HtmlCommand('#key-error-message', $exception
        ->getMessage()));
    }

    // Close dialog.
    $response
      ->addCommand(new CloseDialogCommand());

    // Update private key field if id was supplied on the build form.
    if (isset($values['pk_id'])) {
      $response
        ->addCommand(new InvokeCommand('#' . $values['pk_id'], 'val', [
        $dir_path . '/private.key',
      ]));
    }
    if (isset($values['pubk_id'])) {
      $response
        ->addCommand(new InvokeCommand('#' . $values['pubk_id'], 'val', [
        $dir_path . '/public.key',
      ]));
    }
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Do nothing.
  }

}

Classes

Name	Description
Oauth2GenerateKeyForm	@internal