You are here

Home » API reference » SAML SP 2.0 Single Sign On (SSO) - SAML Service Provider 8 » MiniornageAdvanceSettings.php

class MiniornageAdvanceSettings in SAML SP 2.0 Single Sign On (SSO) - SAML Service Provider 8

Hierarchy

Expanded class hierarchy of MiniornageAdvanceSettings

1 string reference to 'MiniornageAdvanceSettings'
miniorange_saml.routing.yml in ./miniorange_saml.routing.yml
miniorange_saml.routing.yml

File

src/Form/MiniornageAdvanceSettings.php, line 14
Contains \Drupal\miniorange_saml\Form\Export.

Namespace

Drupal\miniorange_saml\Form
View source 
class MiniornageAdvanceSettings extends FormBase {
  public function getFormId() {
    return 'miniorange_saml_export';
  }
  public function buildForm(array $form, FormStateInterface $form_state) {
    global $base_url;
    Utilities::visual_tour_start($form, $form_state);
    $form['miniorange_saml_markup_library'] = array(
      '#attached' => array(
        'library' => array(
          'miniorange_saml/miniorange_saml.admin',
        ),
      ),
    );
    $form['markup_top_1'] = array(
      '#markup' => t('<div class="mo_saml_sp_table_layout_1"><div class="mo_saml_table_layout mo_saml_sp_container">&nbsp;&nbsp;&nbsp;
                    <div class="mo_saml_font_for_heading">Advance Settings</div>  <a id="Restart_moTour" class="mo_btn mo_btn-primary mo_btn-sm mo_tour_button_float" onclick="Restart_moTour()">Take a Tour</a><p style="clear: both"></p><hr/>'),
    );

    /**
     * Create container to hold @moSAMLAdvanseSettings form elements.
     */
    $form['mo_saml_import_export_configurations'] = array(
      '#type' => 'details',
      '#title' => t('Import/Export configurations'),
      '#open' => TRUE,
      '#attributes' => array(
        'style' => 'padding:0% 2%; margin-bottom:2%',
      ),
    );
    $form['mo_saml_import_export_configurations']['markup_1'] = array(
      '#markup' => t('<hr><br><div class="mo_saml_highlight_background_note"><b>Note: </b>This tab will help you to transfer your module configurations when you change your Drupal instance.
                        <br>Example: When you switch from test environment to production. Follow these 3 simple steps to do that:<br>
                        <ol>
                            <li>Download module configuration file by clicking on the Download Configuration button given below.</li>
                            <li>Install the module on new Drupal instance.</li>
                            <li>Upload the configuration file in Import module Configurations section.</li>
                        </ol>
                        <br><strong>And just like that, all your module configurations will be transferred!</strong></div><br><br><div class="mo_saml_font_for_sub_heading">Export Configuration</div><hr/><p>
                        Click on the button below to download module configuration.</p>'),
    );
    $login_URL = \Drupal::config('miniorange_saml.settings')
      ->get('miniorange_saml_idp_login_url');
    $ACS_URL = \Drupal::config('miniorange_saml.settings')
      ->get('miniorange_saml_idp_issuer');
    $disableButton = FALSE;
    if ($login_URL == NULL || $ACS_URL == NULL) {
      $disableButton = TRUE;
      $form['mo_saml_import_export_configurations']['markup_note'] = array(
        '#markup' => t('<div class="mo_saml_configure_message">Please <a href="' . $base_url . '/admin/config/people/miniorange_saml/sp_setup">configure module </a> first to download configuration file.</div><br>'),
      );
    }
    $form['mo_saml_import_export_configurations']['miniorange_saml_imo_option_exists_export'] = array(
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => t('Download Module Configuration'),
      '#submit' => array(
        '::miniorange_import_export',
      ),
      '#disabled' => $disableButton,
      '#suffix' => '<br/><br/>',
    );
    $form['mo_saml_import_export_configurations']['markup_prem_plan'] = array(
      '#markup' => t('<br><br/><div class="mo_saml_font_for_sub_heading">Import Configuration</div><hr><br>
                        <div class="mo_saml_highlight_background_note_1"><b>Note: </b>Available in
                        <a href="' . $base_url . MiniorangeSAMLConstants::LICENSING_TAB_URL . '">Standard, Premium and Enterprise</a> versions of the module</div>'),
    );
    $form['mo_saml_import_export_configurations']['markup_import_note'] = array(
      '#markup' => t('<p>This tab will help you to<span style="font-weight: bold"> Import your module configurations</span> when you change your Drupal instance.</p>
               <p>choose <b>"json"</b> Extened module configuration file and upload by clicking on the button given below. </p>'),
    );
    $form['mo_saml_import_export_configurations']['import_Config_file'] = array(
      '#type' => 'file',
      '#disabled' => TRUE,
      '#prefix' => '<div class="container-inline">',
    );
    $form['mo_saml_import_export_configurations']['miniorange_saml_idp_import'] = array(
      '#type' => 'submit',
      '#value' => t('Upload'),
      '#disabled' => TRUE,
      '#suffix' => '<br><br><br><br>',
    );

    /**
     * Create container to hold @moSAMLCustomCertificate form elements.
     */
    $form['mo_saml_custom_certificate'] = array(
      '#type' => 'details',
      '#title' => t('Custom Certificate ( Add or Generate Custom Certificate ) ' . Utilities::mo_add_premium_tag('ENTERPRISE')),
      //'#open' => TRUE,
      '#attributes' => array(
        'style' => 'padding:0% 2%; margin-bottom:6%',
      ),
    );
    $form['mo_saml_custom_certificate']['markup_top'] = array(
      '#markup' => t('<br><div class="mo_saml_font_SP_setup_for_heading">You can add or generate custom certificate from here.</div><br><div class="mo_saml_font_for_sub_heading">Add Custom Certificate</div><hr><br>'),
    );
    $form['mo_saml_custom_certificate']['miniorange_saml_private_certificate'] = array(
      '#type' => 'textarea',
      '#title' => t('X.509 Private Certificate'),
      '#attributes' => array(
        'style' => 'width:80%; background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => t('Copy and Paste the content from the downloaded certificate or copy the content enclosed in X509Certificate tag (has parent tag KeyDescriptor use=signing) in IdP-Metadata XML file.'),
      ),
      '#disabled' => TRUE,
      '#description' => t('<strong>Note :</strong> Format of the Private key:<br /><strong>-----BEGIN PRIVATE KEY-----<br />
                  XXXXXXXXXXXXXXXXXXXXXXXXXXX<br />-----END PRIVATE KEY-----</strong><br /><br />'),
    );
    $form['mo_saml_custom_certificate']['miniorange_saml_publ_certificate'] = array(
      '#type' => 'textarea',
      '#title' => t('X.509 Public Certificate '),
      '#attributes' => array(
        'style' => 'width:80%; background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => t('Copy and Paste the content from the downloaded certificate or copy the content enclosed in X509Certificate tag (has parent tag KeyDescriptor use=signing) in IdP-Metadata XML file.'),
      ),
      '#disabled' => TRUE,
      '#description' => t('<strong>Note :</strong> Format of the certificate:<br><strong>-----BEGIN CERTIFICATE-----<br />
                  XXXXXXXXXXXXXXXXXXXXXXXXXXX<br />-----END CERTIFICATE-----</strong><br><br>'),
    );
    $form['mo_saml_custom_certificate']['save_config_elements'] = array(
      '#type' => 'submit',
      '#name' => 'submit',
      '#button_type' => 'primary',
      '#value' => t('Upload'),
      '#submit' => array(
        '::submitForm',
      ),
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['save_config_elements1'] = array(
      '#type' => 'submit',
      '#value' => t('Reset'),
      '#suffix' => '<br><br>',
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['generate_certificate_markup'] = array(
      '#markup' => t('<br><br><div class="mo_saml_font_for_sub_heading">Generate Custom Certificate</div><hr><br>'),
    );
    $form['mo_saml_custom_certificate']['mo_saml_country_code_text'] = array(
      '#type' => 'textfield',
      '#title' => t('Country Code:'),
      '#description' => t('<b>Note: </b>Check your country code <a>here</a>.'),
      '#attributes' => array(
        'style' => 'width:80%; background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => t('Enter Country code'),
      ),
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['mo_saml_certificate_state_name'] = array(
      '#type' => 'textfield',
      '#title' => t('State:'),
      '#attributes' => array(
        'style' => 'width:80%; margin-bottom:1.5%; background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => t('State Name'),
      ),
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['mo_saml_certificate_company_name'] = array(
      '#type' => 'textfield',
      '#title' => t('Company:'),
      '#attributes' => array(
        'style' => 'width:80%; margin-bottom:1.5%; background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => t('Company Name'),
      ),
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['miniorange_saml_unit_name'] = array(
      '#type' => 'textfield',
      '#title' => 'Unit:',
      '#attributes' => array(
        'style' => 'width:80%; margin-bottom:1.5%; background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => t('Unit name'),
      ),
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['mo_saml_certificate_common_name'] = array(
      '#type' => 'textfield',
      '#title' => t('Common:'),
      '#attributes' => array(
        'style' => 'width:80%; margin-bottom:1.5%; background-color: hsla(0,0%,0%,0.08) !important;',
        'placeholder' => t('Common Name'),
      ),
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['mo_saml_select_digest_algo'] = array(
      '#type' => 'select',
      '#title' => t('Digest Algorithm:'),
      '#options' => array(
        'sha512' => t('SHA512'),
        'sha384' => t('SHA384'),
        'sha256' => t('SHA256'),
        'sha1' => t('SHA1'),
      ),
      '#attributes' => array(
        'style' => 'width:80%; margin-bottom:1.5%;',
      ),
    );
    $form['mo_saml_custom_certificate']['mo_saml_select_private_key_bit'] = array(
      '#type' => 'select',
      '#title' => t('Bits to generate the private key:'),
      '#options' => array(
        '2048' => t('2048 bits'),
        '1024' => t('1024 bits'),
      ),
      '#attributes' => array(
        'style' => 'width:80%; margin-bottom:1.5%;',
      ),
    );
    $form['mo_saml_custom_certificate']['mo_saml_select_valid_days'] = array(
      '#type' => 'select',
      '#title' => t('Valid Days:'),
      '#options' => array(
        '365' => t('365 days'),
        '180' => t('180 days'),
        '90' => t('90 days'),
        '45' => t('45 days'),
        '30' => t('30 days'),
        '15' => t('15 days'),
        '7' => t('7 days'),
      ),
      '#attributes' => array(
        'style' => 'width:80%; margin-bottom:1.5%;',
      ),
    );
    $form['mo_saml_custom_certificate']['generate_config_elements'] = array(
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => t('Generate Self-Signed Certs'),
      '#prefix' => '<br><br>',
      '#disabled' => TRUE,
    );
    $form['mo_saml_custom_certificate']['clear_genrate_certificate_data'] = array(
      '#type' => 'submit',
      '#value' => t('Clear Data'),
      '#suffix' => '<br><br></div>',
      '#disabled' => TRUE,
    );
    Utilities::advertiseNetworkSecurity($form, $form_state, 'SCIM');
    return $form;
  }
  function miniorange_import_export() {
    $tab_class_name = array(
      'Service_Provider_Metadata' => 'mo_options_enum_identity_provider',
      'Identity_Provider_Setup' => 'mo_options_enum_service_provider',
    );
    $configuration_array = array();
    foreach ($tab_class_name as $key => $value) {
      $configuration_array[$key] = self::mo_get_configuration_array($value);
    }
    $configuration_array["Version_dependencies"] = self::mo_get_version_informations();
    header("Content-Disposition: attachment; filename = miniorange_saml_config.json");
    echo json_encode($configuration_array, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
    exit;
  }
  function mo_get_configuration_array($class_name) {
    $class_object = Utilities::getVariableArray($class_name);
    $mo_array = array();
    foreach ($class_object as $key => $value) {
      $mo_option_exists = \Drupal::config('miniorange_saml.settings')
        ->get($value);
      if ($mo_option_exists) {
        $mo_array[$key] = $mo_option_exists;
      }
    }
    return $mo_array;
  }
  function mo_get_version_informations() {
    $array_version = array();
    $array_version["PHP_version"] = phpversion();
    $array_version["Drupal_version"] = \DRUPAL::VERSION;
    $array_version["OPEN_SSL"] = self::mo_saml_is_openssl_installed();
    $array_version["CURL"] = self::mo_saml_is_curl_installed();
    $array_version["ICONV"] = self::mo_saml_is_iconv_installed();
    $array_version["DOM"] = self::mo_saml_is_dom_installed();
    return $array_version;
  }
  function mo_saml_is_openssl_installed() {
    if (in_array('openssl', get_loaded_extensions())) {
      return 1;
    }
    else {
      return 0;
    }
  }
  function mo_saml_is_curl_installed() {
    if (in_array('curl', get_loaded_extensions())) {
      return 1;
    }
    else {
      return 0;
    }
  }
  function mo_saml_is_iconv_installed() {
    if (in_array('iconv', get_loaded_extensions())) {
      return 1;
    }
    else {
      return 0;
    }
  }
  function mo_saml_is_dom_installed() {
    if (in_array('dom', get_loaded_extensions())) {
      return 1;
    }
    else {
      return 0;
    }
  }
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
MiniornageAdvanceSettings::buildForm public function Form constructor. Overrides FormInterface::buildForm
MiniornageAdvanceSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MiniornageAdvanceSettings::miniorange_import_export function
MiniornageAdvanceSettings::mo_get_configuration_array function
MiniornageAdvanceSettings::mo_get_version_informations function
MiniornageAdvanceSettings::mo_saml_is_curl_installed function
MiniornageAdvanceSettings::mo_saml_is_dom_installed function
MiniornageAdvanceSettings::mo_saml_is_iconv_installed function
MiniornageAdvanceSettings::mo_saml_is_openssl_installed function
MiniornageAdvanceSettings::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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.
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.