public function SamlSpConfig::buildForm in SAML Service Provider 3.x

Same name and namespace in other branches
8.3 src/Form/SamlSpConfig.php \Drupal\saml_sp\Form\SamlSpConfig::buildForm()
8.2 src/Form/SamlSpConfig.php \Drupal\saml_sp\Form\SamlSpConfig::buildForm()
4.x src/Form/SamlSpConfig.php \Drupal\saml_sp\Form\SamlSpConfig::buildForm()
Form constructor.
Parameters

array $form: An associative array containing the structure of the form.
\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.
Return value

array The form structure.
Overrides ConfigFormBase::buildForm
File

src/Form/SamlSpConfig.php, line 157
Class

SamlSpConfig: Provides the configuration form.
Namespace

Drupal\saml_sp\Form
Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $form['entity_id'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Entity ID'),
    '#description' => $this
      ->t('This is the unique name that the Identity Providers will know your site as. Defaults to the login page %login_url', [
      '%login_url' => Url::fromRoute('user.page', [], [
        'absolute' => TRUE,
      ])
        ->toString(),
    ]),
    '#default_value' => $this
      ->overriddenValue('entity_id'),
  ];
  $endpoint_url = Url::fromRoute('saml_sp.consume', [], [
    'absolute' => TRUE,
  ]);
  $form['assertion_urls'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('Assertion Urls'),
    '#description' => $this
      ->t('You can have multiple urls that the SAML AuthNRequest can have the user returned to. The default is "@default_url" but additional can be provided. This is especially useful if the same Drupal site is being used for multiple domains. One per line.', [
      '@default_url' => $endpoint_url
        ->toString(),
    ]),
    '#default_value' => $this
      ->overriddenValue('assertion_urls') ?: $endpoint_url
      ->toString(),
  ];
  $form['contact'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Contact Information'),
    '#description' => $this
      ->t('Information to be included in the federation metadata.'),
    '#tree' => TRUE,
  ];
  $form['contact']['technical'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Technical'),
  ];
  $form['contact']['technical']['name'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Name'),
    '#default_value' => $this
      ->overriddenValue('contact.technical.name'),
    '#disabled' => $this
      ->isOverridden('contact.technical.name'),
  ];
  $form['contact']['technical']['email'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Email'),
    '#default_value' => $this
      ->overriddenValue('contact.technical.email'),
    '#disabled' => $this
      ->isOverridden('contact.technical.email'),
  ];
  $form['contact']['support'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Support'),
  ];
  $form['contact']['support']['name'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Name'),
    '#default_value' => $this
      ->overriddenValue('contact.support.name'),
    '#disabled' => $this
      ->isOverridden('contact.support.name'),
  ];
  $form['contact']['support']['email'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Email'),
    '#default_value' => $this
      ->overriddenValue('contact.support.email'),
    '#disabled' => $this
      ->isOverridden('contact.support.email'),
  ];
  $form['organization'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Organization'),
    '#description' => $this
      ->t('Organization information for the federation metadata'),
    '#tree' => TRUE,
  ];
  $form['organization']['name'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Name'),
    '#description' => $this
      ->t('This is a short name for the organization'),
    '#default_value' => $this
      ->overriddenValue('organization.name'),
    '#disabled' => $this
      ->isOverridden('organization.name'),
  ];
  $form['organization']['display_name'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Display Name'),
    '#description' => $this
      ->t('This is a long name for the organization'),
    '#default_value' => $this
      ->overriddenValue('organization.display_name'),
    '#disabled' => $this
      ->isOverridden('organization.display_name'),
  ];
  $form['organization']['url'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('URL'),
    '#description' => $this
      ->t('This is a URL for the organization'),
    '#default_value' => $this
      ->overriddenValue('organization.url'),
    '#disabled' => $this
      ->isOverridden('organization.url'),
  ];
  $form['strict'] = [
    '#type' => 'checkbox',
    '#title' => t('Strict Protocol'),
    '#description' => t('SAML 2 Strict protocol will be used.'),
    '#default_value' => $this
      ->overriddenValue('strict'),
    '#disabled' => $this
      ->isOverridden('strict'),
  ];
  $form['security'] = [
    '#type' => 'fieldset',
    '#title' => $this
      ->t('Security'),
    '#tree' => TRUE,
  ];
  $form['security']['offered'] = [
    '#markup' => t('Signatures and Encryptions Offered:'),
  ];
  $form['security']['nameIdEncrypted'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('NameID Encrypted'),
    '#default_value' => $this
      ->overriddenValue('security.nameIdEncrypted'),
    '#disabled' => $this
      ->isOverridden('security.nameIdEncrypted'),
  ];
  $form['security']['authnRequestsSigned'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Authn Requests Signed'),
    '#default_value' => $this
      ->overriddenValue('security.authnRequestsSigned'),
    '#disabled' => $this
      ->isOverridden('security.authnRequestsSigned'),
  ];
  $form['security']['logoutRequestSigned'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Logout Requests Signed'),
    '#default_value' => $this
      ->overriddenValue('security.logoutRequestSigned'),
    '#disabled' => $this
      ->isOverridden('security.logoutRequestSigned'),
  ];
  $form['security']['logoutResponseSigned'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Logout Response Signed'),
    '#default_value' => $this
      ->overriddenValue('security.logoutResponseSigned'),
    '#disabled' => $this
      ->isOverridden('security.logoutResponseSigned'),
  ];
  $form['security']['required'] = [
    '#markup' => $this
      ->t('Signatures and Encryptions Required:'),
  ];
  $form['security']['wantMessagesSigned'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Want Messages Signed'),
    '#default_value' => $this
      ->overriddenValue('security.wantMessagesSigned'),
    '#disabled' => $this
      ->isOverridden('security.wantMessagesSigned'),
  ];
  $form['security']['wantAssertionsSigned'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Want Assertions Signed'),
    '#default_value' => $this
      ->overriddenValue('security.wantAssertionsSigned'),
    '#disabled' => $this
      ->isOverridden('security.wantAssertionsSigned'),
  ];
  $form['security']['wantNameIdEncrypted'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Want NameID Encrypted'),
    '#default_value' => $this
      ->overriddenValue('security.wantNameIdEncrypted'),
    '#disabled' => $this
      ->isOverridden('security.wantNameIdEncrypted'),
  ];
  $form['security']['metadata'] = [
    '#markup' => $this
      ->t('Metadata:'),
  ];
  $form['security']['signMetaData'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Sign Meta Data'),
    '#default_value' => $this
      ->overriddenValue('security.signMetaData'),
    '#disabled' => $this
      ->isOverridden('security.signMetaData'),
  ];
  $form['security']['signatureAlgorithm'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Signature Algorithm'),
    '#description' => $this
      ->t('What algorithm do you want used for messages signatures?'),
    '#options' => [
      /*
              XMLSecurityKey::DSA_SHA1 => 'DSA SHA-1',
              XMLSecurityKey::HMAC_SHA1 => 'HMAC SHA-1',
              /**/
      XMLSecurityKey::RSA_SHA1 => 'SHA-1',
      XMLSecurityKey::RSA_SHA256 => 'SHA-256',
      XMLSecurityKey::RSA_SHA384 => 'SHA-384',
      XMLSecurityKey::RSA_SHA512 => 'SHA-512',
    ],
    '#default_value' => $this
      ->overriddenValue('security.signatureAlgorithm'),
    '#disabled' => $this
      ->isOverridden('security.signatureAlgorithm'),
  ];
  $form['security']['lowercaseUrlencoding'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Lowercase Url Encoding'),
    /*
          '#description'    => $this->t(""),
          /**/
    '#default_value' => $this
      ->overriddenValue('security.lowercaseUrlencoding'),
    '#disabled' => $this
      ->isOverridden('security.lowercaseUrlencoding'),
  ];
  $form['cert_location'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Certificate Location'),
    '#description' => $this
      ->t('The location of the X.509 certificate file on the server. This must be a location that PHP can read.'),
    '#default_value' => $this
      ->overriddenValue('cert_location'),
    '#disabled' => $this
      ->isOverridden('cert_location'),
    '#states' => [
      'required' => [
        [
          'input[name="security[authnRequestsSigned]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[logoutRequestSigned]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[logoutResponseSigned]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[wantNameIdEncrypted]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[signMetaData]"' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ],
    '#suffix' => $this
      ->certInfo($this
      ->overriddenValue('cert_location')),
  ];
  $form['key_location'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Key Location'),
    '#description' => $this
      ->t('The location of the X.509 key file on the server. This must be a location that PHP can read.'),
    '#default_value' => $this
      ->overriddenValue('key_location'),
    '#disabled' => $this
      ->isOverridden('key_location'),
    '#states' => [
      'required' => [
        [
          'input[name="security[authnRequestsSigned]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[logoutRequestSigned]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[logoutResponseSigned]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[wantNameIdEncrypted]"' => [
            'checked' => TRUE,
          ],
        ],
        [
          'input[name="security[signMetaData]"' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ],
  ];
  $form['new_cert_location'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('New Certificate Location'),
    '#description' => $this
      ->t('The location of the x.509 certificate file on the server. If the certificate above is about to expire add your new certificate here after you have obtained it. This will add the new certificate to the metadata to let the IdP know of the new certificate. This must be a location that PHP can read.'),
    '#default_value' => $this
      ->overriddenValue('new_cert_location'),
    '#disabled' => $this
      ->isOverridden('new_cert_location'),
    '#suffix' => $this
      ->certInfo($this
      ->overriddenValue('new_cert_location')),
  ];
  $error = FALSE;
  try {
    $metadata = saml_sp__get_metadata(FALSE);
    if (is_array($metadata)) {
      if (isset($metadata[1])) {
        $errors = $metadata[1];
      }
      $metadata = $metadata[0];
    }
  } catch (Exception $e) {
    \Drupal::messenger()
      ->addMessage($this
      ->t('Attempt to create metadata failed: %message.', [
      '%message' => $e
        ->getMessage(),
    ]), MessengerInterface::TYPE_ERROR);
    $metadata = '';
    $error = $e;
  }
  if (empty($metadata) && $error) {
    $no_metadata = $this
      ->t('There is currently no metadata because of the following error: %error. Please resolve the error and return here for your metadata.', [
      '%error' => $error
        ->getMessage(),
    ]);
  }
  $form['metadata'] = [
    '#type' => 'fieldset',
    '#collapsed' => TRUE,
    '#collapsible' => TRUE,
    '#title' => $this
      ->t('Metadata'),
    '#description' => $this
      ->t('This is the Federation Metadata for this SP, please provide this to the IdP to create a Relying Party Trust (RPT)'),
  ];
  if ($metadata) {
    $form['metadata']['data'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('XML Metadata'),
      '#description' => $this
        ->t('This metadata can also be accessed <a href="@url" target="_blank">here</a>', [
        '@url' => Url::fromRoute('saml_sp.metadata')
          ->toString(),
      ]),
      '#disabled' => TRUE,
      '#rows' => 20,
      '#default_value' => trim($metadata),
    ];
  }
  else {
    $form['metadata']['none'] = [
      '#markup' => $no_metadata,
    ];
  }
  $form['debug'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Turn on debugging'),
    '#description' => $this
      ->t('Some debugging messages will be shown.'),
    '#default_value' => $this
      ->overriddenValue('debug'),
  ];
  return parent::buildForm($form, $form_state);
}
You are here
