You are here

Home » API reference » Security.txt 8 » SecuritytxtConfigureForm.php

class SecuritytxtConfigureForm in Security.txt 8

Configure the security.txt file.

Hierarchy

Expanded class hierarchy of SecuritytxtConfigureForm

1 string reference to 'SecuritytxtConfigureForm'
securitytxt.routing.yml in ./securitytxt.routing.yml
securitytxt.routing.yml

File

src/Form/SecuritytxtConfigureForm.php, line 14

Namespace

Drupal\securitytxt\Form
View source 
class SecuritytxtConfigureForm extends ConfigFormBase {

  /**
   * A 'securitytxt.settings' config instance.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $settings;

  /**
   * Constructs a SecuritytxtConfigureForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    parent::__construct($config_factory);
    $this->settings = $config_factory
      ->getEditable('securitytxt.settings');
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'securitytxt.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable the security.txt file for your site'),
      '#default_value' => $this->settings
        ->get('enabled'),
      '#description' => $this
        ->t('When enabled the security.txt file will be accessible to all users with the "view securitytxt" permission, you will almost certinaly want to give this permission to everyone i.e. authenticated and anonymous users.'),
    ];
    $form['contact'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Contact'),
      '#open' => TRUE,
      '#description' => $this
        ->t('You must provide at least one means of contact: email, phone or contact page URL.'),
    ];
    $form['contact']['contact_email'] = [
      '#type' => 'email',
      '#title' => $this
        ->t('Email'),
      '#default_value' => $this->settings
        ->get('contact_email'),
      '#description' => $this
        ->t('Typically this would be of the form <kbd>security@example.com</kbd>. Leave it blank if you do not want to provide an email address.'),
    ];
    $form['contact']['contact_phone'] = [
      '#type' => 'tel',
      '#title' => $this
        ->t('Phone'),
      '#default_value' => $this->settings
        ->get('contact_phone'),
      '#description' => $this
        ->t('Use full international format e.g. <kbd>+1-201-555-0123</kbd>. Leave it blank if you do not want to provide a phone number.'),
    ];
    $form['contact']['contact_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('URL'),
      '#default_value' => $this->settings
        ->get('contact_url'),
      '#description' => $this
        ->t('The URL of a contact page which should be loaded over HTTPS. Leave it blank if you do not want to provide a contact page.'),
    ];
    $form['encryption'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Encryption'),
      '#open' => TRUE,
      '#description' => $this
        ->t('Allow people to send you encrypted messages by providing your public key.'),
    ];
    $form['encryption']['encryption_key_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Public key URL'),
      '#default_value' => $this->settings
        ->get('encryption_key_url'),
      '#description' => $this
        ->t('The URL of your public key file, or a page which contains your public key. This URL should use the HTTPS protocol.'),
    ];
    $form['policy'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Policy'),
      '#open' => TRUE,
      '#description' => $this
        ->t('A security and/or disclosure policy can help security researchers understand  how to work with you when reporting security vulnerabilities.'),
    ];
    $form['policy']['policy_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Security policy URL'),
      '#default_value' => $this->settings
        ->get('policy_url'),
      '#description' => $this
        ->t('The URL of a page which provides details of your security and/or disclosure policy. Leave it blank if you do not have such a page.'),
    ];
    $form['acknowledgement'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Acknowledgement'),
      '#open' => TRUE,
      '#description' => $this
        ->t('A security acknowldgements page should list the individuals or companies that have disclosed security vulnerabilities and worked with you to fix them.'),
    ];
    $form['acknowledgement']['acknowledgement_url'] = [
      '#type' => 'url',
      '#title' => $this
        ->t('Acknowledgements page URL'),
      '#default_value' => $this->settings
        ->get('acknowledgement_url'),
      '#description' => $this
        ->t('The URL of your security acknowledgements page. Leave it blank if you do not have such a page.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $enabled = $form_state
      ->getValue('enabled');
    $contact_email = $form_state
      ->getValue('contact_email');
    $contact_phone = $form_state
      ->getValue('contact_phone');
    $contact_url = $form_state
      ->getValue('contact_url');

    /* When enabled, check that at least one contact field is specified. */
    if ($enabled && $contact_email == '' && $contact_phone == '' && $contact_url == '') {
      $form_state
        ->setErrorByName('contact', $this
        ->t('You must specify at least one method of contact.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $enabled = $form_state
      ->getValue('enabled');
    $contact_email = $form_state
      ->getValue('contact_email');
    $contact_phone = $form_state
      ->getValue('contact_phone');
    $contact_url = $form_state
      ->getValue('contact_url');
    $encryption_key_url = $form_state
      ->getValue('encryption_key_url');
    $policy_url = $form_state
      ->getValue('policy_url');
    $acknowledgement_url = $form_state
      ->getValue('acknowledgement_url');

    /* Warn if contact URL is not loaded over HTTPS */
    if ($contact_url != '' && substr($contact_url, 0, 8) !== 'https://') {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Your contact URL should really be loaded over HTTPS.'));
    }

    /* Warn if encryption URL is not loaded over HTTPS */
    if ($encryption_key_url != '' && substr($encryption_key_url, 0, 8) !== 'https://') {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Your public key URL should really be loaded over HTTPS.'));
    }

    /* Message the user to proceed to the sign page if they have enabled security.txt */
    if ($enabled) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('You should now <a href=":sign">sign your security.txt file</a>.', [
        ':sign' => Url::fromRoute('securitytxt.sign')
          ->toString(),
      ]));
    }

    /* Save the configuration */
    $this->settings
      ->set('enabled', $enabled)
      ->set('contact_email', $contact_email)
      ->set('contact_phone', $contact_phone)
      ->set('contact_url', $contact_url)
      ->set('encryption_key_url', $encryption_key_url)
      ->set('policy_url', $policy_url)
      ->set('acknowledgement_url', $acknowledgement_url)
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SecuritytxtConfigureForm::$settings protected property A 'securitytxt.settings' config instance.
SecuritytxtConfigureForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SecuritytxtConfigureForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SecuritytxtConfigureForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SecuritytxtConfigureForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SecuritytxtConfigureForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SecuritytxtConfigureForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SecuritytxtConfigureForm::__construct public function Constructs a SecuritytxtConfigureForm object. Overrides ConfigFormBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.