Skip to content

Commit 021edf7

Browse files
unnBalazs Dianiska
unn
authored and
Balazs Dianiska
committed
Remove form from module file, closes #1.
1 parent d4f2d9d commit 021edf7

File tree

2 files changed

+147
-150
lines changed

2 files changed

+147
-150
lines changed

‎simplesamlphp_auth.admin.inc

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
<?php
2+
3+
/**
4+
* Implements settings for the module.
5+
*/
6+
function simplesamlphp_auth_settings() {
7+
global $_simplesamlphp_auth_saml_version, $base_url;
8+
9+
if (!empty($_simplesamlphp_auth_saml_version )) {
10+
$ver = explode('.', $_simplesamlphp_auth_saml_version);
11+
if ( !($ver[0] >= 1 && $ver[1] >= 5) ) {
12+
drupal_set_message(t("Please upgrade SimpleSAMLphp. You are using %ssp_version", array('%ssp_version' => $_simplesamlphp_auth_saml_version)), 'warning');
13+
}
14+
}
15+
16+
$roles = user_roles(TRUE);
17+
18+
$form['simplesamlphp_auth_grp_setup'] = array(
19+
'#type' => 'fieldset',
20+
'#title' => t('Basic Setup'),
21+
'#collapsible' => FALSE,
22+
);
23+
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_activate'] = array(
24+
'#type' => 'checkbox',
25+
'#title' => t('Activate authentication via SimpleSAMLphp'),
26+
'#default_value' => variable_get('simplesamlphp_auth_activate', FALSE),
27+
'#description' => t('Checking this box before configuring the module could lock you out of Drupal.'),
28+
);
29+
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_installdir'] = array(
30+
'#type' => 'textfield',
31+
'#title' => t('Installation directory (default: /var/simplesamlphp)'),
32+
'#default_value' => variable_get('simplesamlphp_auth_installdir', '/var/simplesamlphp'),
33+
'#description' => t('The base directory of simpleSAMLphp. Absolute path with no trailing slash.'),
34+
);
35+
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_authsource'] = array(
36+
'#type' => 'textfield',
37+
'#title' => t('Autenticaton source for this SP (default: default-sp)'),
38+
'#default_value' => variable_get('simplesamlphp_auth_authsource', 'default-sp'),
39+
'#description' => t('The name of the source to use from /var/simplesamlphp/config/authsources.php'),
40+
);
41+
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_forcehttps'] = array(
42+
'#type' => 'checkbox',
43+
'#title' => t('Force https for login links'),
44+
'#default_value' => variable_get('simplesamlphp_auth_forcehttps', TRUE),
45+
'#description' => t('Should be enabled on production sites.'),
46+
);
47+
48+
$form['simplesamlphp_auth_grp_user'] = array(
49+
'#type' => 'fieldset',
50+
'#title' => t('User Info and Syncing'),
51+
'#collapsible' => FALSE,
52+
);
53+
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_user_name'] = array(
54+
'#type' => 'textfield',
55+
'#title' => t('Which attribute from simpleSAMLphp should be used as user\'s name'),
56+
'#default_value' => variable_get('simplesamlphp_auth_user_name', 'eduPersonPrincipalName'),
57+
'#description' => t('Example: <i>eduPersonPrincipalName</i> or <i>displayName</i><br />If the attribute is multivalued, the first value will be used.'),
58+
'#required' => TRUE,
59+
);
60+
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_unique_id'] = array(
61+
'#type' => 'textfield',
62+
'#title' => t('Which attribute from simpleSAMLphp should be used as unique identifier for the user'),
63+
'#default_value' => variable_get('simplesamlphp_auth_unique_id', 'eduPersonPrincipalName'),
64+
'#description' => t('Example: <i>eduPersonPrincipalName</i> or <i>eduPersonTargetedID</i><br />If the attribute is multivalued, the first value will be used.'),
65+
'#required' => TRUE,
66+
);
67+
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_mailattr'] = array(
68+
'#type' => 'textfield',
69+
'#title' => t('Which attribute from simpleSAMLphp should be used as user mail address'),
70+
'#default_value' => variable_get('simplesamlphp_auth_mailattr', 'mail'),
71+
'#description' => t('Example: <i>mail</i><br />If the user attribute is multivalued, the first value will be used.'),
72+
);
73+
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_rolepopulation'] = array(
74+
'#type' => 'textarea',
75+
'#title' => t('Automatic role population from simpleSAMLphp attributes'),
76+
'#default_value' => variable_get('simplesamlphp_auth_rolepopulation', ''),
77+
'#description' => t('A pipe separated list of rules.<br />Example: <i>roleid1:condition1|roleid2:contition2...</i> <br />For instance: <i>1:eduPersonPrincipalName,@=,uninett.no;affiliation,=,employee|2:mail,=,[email protected]</i>'),
78+
);
79+
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_roleevaleverytime'] = array(
80+
'#type' => 'checkbox',
81+
'#title' => t('Reevaluate roles every time the user logs in.'),
82+
'#default_value' => variable_get('simplesamlphp_auth_roleevaleverytime', 0),
83+
'#description' => t('NOTE: This means users could loose any roles that have been assigned manually in Drupal.'),
84+
);
85+
86+
$form['simplesamlphp_auth_grp_reg'] = array(
87+
'#type' => 'fieldset',
88+
'#title' => t('User Provisioning'),
89+
'#collapsible' => TRUE,
90+
'#collapsed' => TRUE,
91+
);
92+
$form['simplesamlphp_auth_grp_reg']['simplesamlphp_auth_registerusers'] = array(
93+
'#type' => 'checkbox',
94+
'#title' => t('Register users (i.e., auto-provisioning)'),
95+
'#default_value' => variable_get('simplesamlphp_auth_registerusers', TRUE),
96+
'#description' => t('Determines wether or not the module should automatically create/register new Drupal accounts for users that authenticate using SimpleSAMLphp. Unless you\'ve done some custom work to provision Drupal accounts with the necessary authmap entries you will want this checked.<br /><br />NOTE: If unchecked each user must already have been provisioned a Drupal account with an appropriate entry in the authmap table before logging in. Otherwise they will receive a notice and be denied access. Be aware that simply creating a Drupal account will not create the necessary entry in the authmap table.'),
97+
);
98+
99+
$form['simplesamlphp_auth_grp_auth'] = array(
100+
'#type' => 'fieldset',
101+
'#title' => t('Drupal Authentication'),
102+
'#collapsible' => TRUE,
103+
'#collapsed' => TRUE,
104+
);
105+
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowsetdrupalpwd'] = array(
106+
'#type' => 'checkbox',
107+
'#title' => t('Allow SAML users to set Drupal passwords.'),
108+
'#default_value' => variable_get('simplesamlphp_auth_allowsetdrupalpwd', FALSE),
109+
'#description' => t('Check this box if you want to let people set passwords for their local Drupal accounts. This will allow users to log in using either SAML or a local Drupal account. Disabling this removes the password change fields from the user profile form.<br/>NOTE: In order for them to login using their local Drupal password you must allow local logins with the settings below.'),
110+
);
111+
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowdefaultlogin'] = array(
112+
'#type' => 'checkbox',
113+
'#title' => t('Allow authentication with local Drupal accounts'),
114+
'#default_value' => variable_get('simplesamlphp_auth_allowdefaultlogin', TRUE),
115+
'#description' => t('Check this box if you want to let people log in with local Drupal accounts (without using simpleSAMLphp). If you want to restrict this privilege to certain users you can enter the Drupal user IDs in the field below.'),
116+
);
117+
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowdefaultloginroles'] = array(
118+
'#type' => 'select',
119+
'#size' => 3,
120+
'#options' => $roles,
121+
'#multiple' => TRUE,
122+
'#title' => t('Which ROLES should be allowed to login with local accounts?'),
123+
'#default_value' => variable_get('simplesamlphp_auth_allowdefaultloginroles', array()),
124+
'#description' => t('Roles that should be allowed to login without simpleSAMLphp. Examples are dev/admin roles or guest roles.'),
125+
);
126+
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowdefaultloginusers'] = array(
127+
'#type' => 'textfield',
128+
'#title' => t('Which users should be allowed to login with local accounts?'),
129+
'#default_value' => variable_get('simplesamlphp_auth_allowdefaultloginusers', ''),
130+
'#description' => t('Example: <i>1,2,3</i><br />A comma-separated list of user IDs that should be allowed to login without simpleSAMLphp. If left blank, all local accounts can login.'),
131+
);
132+
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_logoutgotourl'] = array(
133+
'#type' => 'textfield',
134+
'#title' => t('Optionally, specify a URL for users to go to after logging out'),
135+
'#default_value' => variable_get('simplesamlphp_auth_logoutgotourl', ''),
136+
'#description' => t('Example: ' . $base_url),
137+
);
138+
139+
return system_settings_form($form);
140+
}

‎simplesamlphp_auth.module

Lines changed: 7 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@ function simplesamlphp_auth_menu() {
4141
'page arguments' => array('simplesamlphp_auth_settings'),
4242
'access arguments' => array('administer simpleSAMLphp authentication'),
4343
'type' => MENU_LOCAL_TASK | MENU_NORMAL_ITEM,
44+
'file' => 'simplesamlphp_auth.admin.inc',
4445
);
46+
4547
$items['saml_login'] = array(
4648
'title' => 'Logon to the site',
4749
'description' => 'Provides a site login page',
@@ -53,13 +55,6 @@ function simplesamlphp_auth_menu() {
5355
return $items;
5456
}
5557

56-
/**
57-
* Implements hook_admin_paths().
58-
*/
59-
function simplesamlphp_auth_admin_paths() {
60-
return array('admin/config/people/simplesamlphp_auth' => TRUE);
61-
}
62-
6358
/**
6459
* Implements hook_help().
6560
*/
@@ -319,7 +314,7 @@ function simplesamlphp_auth_init() {
319314

320315
// If user IDs or roles are specified, we let them in, but everyone else gets logged out.
321316
if (drupal_strlen($strAllwDefLogUsers) || $arrAllwDefLogRoles) {
322-
317+
323318
// Convert the string into an array.
324319
// @todo Perform a test to make sure that only numbers, spaces, or commas are in the string.
325320
$arrAllwDefLogUsers = explode(',', $strAllwDefLogUsers);
@@ -343,9 +338,9 @@ function simplesamlphp_auth_init() {
343338
_simplesamlphp_auth_destroy_drupal_session();
344339
}
345340
}
346-
341+
347342
} // Test for specified users.
348-
343+
349344
} // End if $_simplesamlphp_auth_as->isAuthenticated().
350345
} // End test to see if we allow default logins.
351346
} // End if user->uid.
@@ -398,9 +393,9 @@ function simplesamlphp_auth_user_insert(&$edit, $account, $category = NULL) {
398393
->condition('uid', $account->uid)
399394
->execute();
400395
}
401-
396+
402397
if (module_exists('rules')) {
403-
rules_invoke_event('simplesamlphp_auth_rules_event_register', $account);
398+
rules_invoke_event('simplesamlphp_auth_rules_event_register', $account);
404399
}
405400

406401
_simplesaml_auth_debug(t('Updating mail [%mailaddr]', array('%mailaddr' => $mail_address)));
@@ -444,144 +439,6 @@ function simplesamlphp_auth_user_delete($account) {
444439
->execute();
445440
}
446441

447-
/**
448-
* Implements settings for the module.
449-
*/
450-
function simplesamlphp_auth_settings() {
451-
global $_simplesamlphp_auth_saml_version, $base_url;
452-
453-
if (!empty($_simplesamlphp_auth_saml_version )) {
454-
$ver = explode('.', $_simplesamlphp_auth_saml_version);
455-
if ( !($ver[0] >= 1 && $ver[1] >= 5) ) {
456-
drupal_set_message(t("Please upgrade SimpleSAMLphp. You are using %ssp_version", array('%ssp_version' => $_simplesamlphp_auth_saml_version)), 'warning');
457-
}
458-
}
459-
460-
$roles = user_roles(TRUE);
461-
462-
$form['simplesamlphp_auth_grp_setup'] = array(
463-
'#type' => 'fieldset',
464-
'#title' => t('Basic Setup'),
465-
'#collapsible' => FALSE,
466-
);
467-
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_activate'] = array(
468-
'#type' => 'checkbox',
469-
'#title' => t('Activate authentication via SimpleSAMLphp'),
470-
'#default_value' => variable_get('simplesamlphp_auth_activate', FALSE),
471-
'#description' => t('Checking this box before configuring the module could lock you out of Drupal.'),
472-
);
473-
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_installdir'] = array(
474-
'#type' => 'textfield',
475-
'#title' => t('Installation directory (default: /var/simplesamlphp)'),
476-
'#default_value' => variable_get('simplesamlphp_auth_installdir', '/var/simplesamlphp'),
477-
'#description' => t('The base directory of simpleSAMLphp. Absolute path with no trailing slash.'),
478-
);
479-
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_authsource'] = array(
480-
'#type' => 'textfield',
481-
'#title' => t('Autenticaton source for this SP (default: default-sp)'),
482-
'#default_value' => variable_get('simplesamlphp_auth_authsource', 'default-sp'),
483-
'#description' => t('The name of the source to use from /var/simplesamlphp/config/authsources.php'),
484-
);
485-
$form['simplesamlphp_auth_grp_setup']['simplesamlphp_auth_forcehttps'] = array(
486-
'#type' => 'checkbox',
487-
'#title' => t('Force https for login links'),
488-
'#default_value' => variable_get('simplesamlphp_auth_forcehttps', TRUE),
489-
'#description' => t('Should be enabled on production sites.'),
490-
);
491-
492-
$form['simplesamlphp_auth_grp_user'] = array(
493-
'#type' => 'fieldset',
494-
'#title' => t('User Info and Syncing'),
495-
'#collapsible' => FALSE,
496-
);
497-
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_user_name'] = array(
498-
'#type' => 'textfield',
499-
'#title' => t('Which attribute from simpleSAMLphp should be used as user\'s name'),
500-
'#default_value' => variable_get('simplesamlphp_auth_user_name', 'eduPersonPrincipalName'),
501-
'#description' => t('Example: <i>eduPersonPrincipalName</i> or <i>displayName</i><br />If the attribute is multivalued, the first value will be used.'),
502-
'#required' => TRUE,
503-
);
504-
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_unique_id'] = array(
505-
'#type' => 'textfield',
506-
'#title' => t('Which attribute from simpleSAMLphp should be used as unique identifier for the user'),
507-
'#default_value' => variable_get('simplesamlphp_auth_unique_id', 'eduPersonPrincipalName'),
508-
'#description' => t('Example: <i>eduPersonPrincipalName</i> or <i>eduPersonTargetedID</i><br />If the attribute is multivalued, the first value will be used.'),
509-
'#required' => TRUE,
510-
);
511-
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_mailattr'] = array(
512-
'#type' => 'textfield',
513-
'#title' => t('Which attribute from simpleSAMLphp should be used as user mail address'),
514-
'#default_value' => variable_get('simplesamlphp_auth_mailattr', 'mail'),
515-
'#description' => t('Example: <i>mail</i><br />If the user attribute is multivalued, the first value will be used.'),
516-
);
517-
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_rolepopulation'] = array(
518-
'#type' => 'textarea',
519-
'#title' => t('Automatic role population from simpleSAMLphp attributes'),
520-
'#default_value' => variable_get('simplesamlphp_auth_rolepopulation', ''),
521-
'#description' => t('A pipe separated list of rules.<br />Example: <i>roleid1:condition1|roleid2:contition2...</i> <br />For instance: <i>1:eduPersonPrincipalName,@=,uninett.no;affiliation,=,employee|2:mail,=,[email protected]</i>'),
522-
);
523-
$form['simplesamlphp_auth_grp_user']['simplesamlphp_auth_roleevaleverytime'] = array(
524-
'#type' => 'checkbox',
525-
'#title' => t('Reevaluate roles every time the user logs in.'),
526-
'#default_value' => variable_get('simplesamlphp_auth_roleevaleverytime', 0),
527-
'#description' => t('NOTE: This means users could loose any roles that have been assigned manually in Drupal.'),
528-
);
529-
530-
$form['simplesamlphp_auth_grp_reg'] = array(
531-
'#type' => 'fieldset',
532-
'#title' => t('User Provisioning'),
533-
'#collapsible' => TRUE,
534-
'#collapsed' => TRUE,
535-
);
536-
$form['simplesamlphp_auth_grp_reg']['simplesamlphp_auth_registerusers'] = array(
537-
'#type' => 'checkbox',
538-
'#title' => t('Register users (i.e., auto-provisioning)'),
539-
'#default_value' => variable_get('simplesamlphp_auth_registerusers', TRUE),
540-
'#description' => t('Determines wether or not the module should automatically create/register new Drupal accounts for users that authenticate using SimpleSAMLphp. Unless you\'ve done some custom work to provision Drupal accounts with the necessary authmap entries you will want this checked.<br /><br />NOTE: If unchecked each user must already have been provisioned a Drupal account with an appropriate entry in the authmap table before logging in. Otherwise they will receive a notice and be denied access. Be aware that simply creating a Drupal account will not create the necessary entry in the authmap table.'),
541-
);
542-
543-
$form['simplesamlphp_auth_grp_auth'] = array(
544-
'#type' => 'fieldset',
545-
'#title' => t('Drupal Authentication'),
546-
'#collapsible' => TRUE,
547-
'#collapsed' => TRUE,
548-
);
549-
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowsetdrupalpwd'] = array(
550-
'#type' => 'checkbox',
551-
'#title' => t('Allow SAML users to set Drupal passwords.'),
552-
'#default_value' => variable_get('simplesamlphp_auth_allowsetdrupalpwd', FALSE),
553-
'#description' => t('Check this box if you want to let people set passwords for their local Drupal accounts. This will allow users to log in using either SAML or a local Drupal account. Disabling this removes the password change fields from the user profile form.<br/>NOTE: In order for them to login using their local Drupal password you must allow local logins with the settings below.'),
554-
);
555-
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowdefaultlogin'] = array(
556-
'#type' => 'checkbox',
557-
'#title' => t('Allow authentication with local Drupal accounts'),
558-
'#default_value' => variable_get('simplesamlphp_auth_allowdefaultlogin', TRUE),
559-
'#description' => t('Check this box if you want to let people log in with local Drupal accounts (without using simpleSAMLphp). If you want to restrict this privilege to certain users you can enter the Drupal user IDs in the field below.'),
560-
);
561-
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowdefaultloginroles'] = array(
562-
'#type' => 'select',
563-
'#size' => 3,
564-
'#options' => $roles,
565-
'#multiple' => TRUE,
566-
'#title' => t('Which ROLES should be allowed to login with local accounts?'),
567-
'#default_value' => variable_get('simplesamlphp_auth_allowdefaultloginroles', array()),
568-
'#description' => t('Roles that should be allowed to login without simpleSAMLphp. Examples are dev/admin roles or guest roles.'),
569-
);
570-
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_allowdefaultloginusers'] = array(
571-
'#type' => 'textfield',
572-
'#title' => t('Which users should be allowed to login with local accounts?'),
573-
'#default_value' => variable_get('simplesamlphp_auth_allowdefaultloginusers', ''),
574-
'#description' => t('Example: <i>1,2,3</i><br />A comma-separated list of user IDs that should be allowed to login without simpleSAMLphp. If left blank, all local accounts can login.'),
575-
);
576-
$form['simplesamlphp_auth_grp_auth']['simplesamlphp_auth_logoutgotourl'] = array(
577-
'#type' => 'textfield',
578-
'#title' => t('Optionally, specify a URL for users to go to after logging out'),
579-
'#default_value' => variable_get('simplesamlphp_auth_logoutgotourl', ''),
580-
'#description' => t('Example: ' . $base_url),
581-
);
582-
583-
return system_settings_form($form);
584-
}
585442

586443
/**
587444
* Implements hook_form_alter().

0 commit comments

Comments
 (0)