Skip to content

Commit 55ad39d

Browse files
olavmo-siktolavmo-sikt
committed
config-templates/authsources.php: Comment out most examples.
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@1886 44740490-163a-0410-bde0-09ae8108e29a
1 parent 3e5103d commit 55ad39d

1 file changed

Lines changed: 101 additions & 136 deletions

File tree

‎config-templates/authsources.php‎

Lines changed: 101 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -2,65 +2,54 @@
22

33
$config = array(
44

5-
/*
6-
* This is a authentication source which handles admin authentication.
7-
*/
5+
// This is a authentication source which handles admin authentication.
86
'admin' => array(
9-
/*
10-
* The default is to use core:AdminPassword, but it can be replaced with
11-
* any authentication source.
12-
*/
7+
// The default is to use core:AdminPassword, but it can be replaced with
8+
// any authentication source.
9+
1310
'core:AdminPassword',
1411
),
1512

1613

17-
/*
18-
* An authentication source which can authenticate against both SAML 2.0
19-
* and Shibboleth 1.3 IdPs.
20-
*/
14+
// An authentication source which can authenticate against both SAML 2.0
15+
// and Shibboleth 1.3 IdPs.
2116
'default-sp' => array(
2217
'saml:SP',
2318

24-
/*
25-
* The entity ID of this SP.
26-
* Can be NULL/unset, in which case an entity ID is generated based on the metadata URL.
27-
*/
19+
// The entity ID of this SP.
20+
// Can be NULL/unset, in which case an entity ID is generated based on the metadata URL.
2821
'entityID' => NULL,
2922

30-
/*
31-
* The entity ID of the IdP this should SP should contact.
32-
* Can be NULL/unset, in which case the user will be shown a list of available IdPs.
33-
*/
23+
// The entity ID of the IdP this should SP should contact.
24+
// Can be NULL/unset, in which case the user will be shown a list of available IdPs.
3425
'idp' => NULL,
3526

36-
/*
37-
* The URL to the discovery service.
38-
* Can be NULL/unset, in which case a builtin discovery service will be used.
39-
*/
27+
// The URL to the discovery service.
28+
// Can be NULL/unset, in which case a builtin discovery service will be used.
4029
'discoURL' => NULL,
4130
),
4231

4332

33+
/*
4434
'example-sql' => array(
4535
'sqlauth:SQL',
4636
'dsn' => 'pgsql:host=sql.example.org;port=5432;dbname=simplesaml',
4737
'username' => 'simplesaml',
4838
'password' => 'secretpassword',
4939
'query' => 'SELECT "username", "name", "email" FROM "users" WHERE "username" = :username AND "password" = :password',
5040
),
41+
*/
5142

43+
/*
5244
'example-static' => array(
5345
'exampleauth:Static',
5446
'uid' => array('testuser'),
5547
'eduPersonAffiliation' => array('member', 'employee'),
5648
'cn' => array('Test User'),
5749
),
58-
59-
// Requires you to enable the OpenID module.
60-
'openid' => array(
61-
'openid:OpenIDConsumer',
62-
),
50+
*/
6351

52+
/*
6453
'example-userpass' => array(
6554
'exampleauth:UserPass',
6655
'student:studentpass' => array(
@@ -72,179 +61,156 @@
7261
'eduPersonAffiliation' => array('member', 'employee'),
7362
),
7463
),
75-
64+
*/
65+
66+
/*
7667
'yubikey' => array(
7768
'authYubiKey:YubiKey',
7869
'id' => '000',
79-
// 'key' => '012345678',
70+
// 'key' => '012345678',
8071
),
81-
72+
*/
73+
74+
/*
8275
'openid' => array(
8376
'openid:OpenIDConsumer',
8477
'attributes.required' => array('nickname'),
8578
'attributes.optional' => array('fullname', 'email',),
8679
),
80+
*/
8781

88-
'feide' => array(
89-
'feide:Feide',
90-
),
91-
82+
/*
9283
'papi' => array(
9384
'authpapi:PAPI',
9485
),
86+
*/
9587

9688

97-
98-
89+
/*
9990
'facebook' => array(
10091
'authfacebook:Facebook',
10192
'api_key' => 'xxxxxxxxxxxxxxxx',
10293
'secret' => 'xxxxxxxxxxxxxxxx',
10394
),
95+
*/
10496

105-
/* Twitter OAuth Authentication API.
106-
* Register your application to get an API key here:
107-
* http://twitter.com/oauth_clients
108-
*/
97+
/*
98+
// Twitter OAuth Authentication API.
99+
// Register your application to get an API key here:
100+
// http://twitter.com/oauth_clients
109101
'twitter' => array(
110102
'authtwitter:Twitter',
111103
'key' => 'xxxxxxxxxxxxxxxx',
112104
'secret' => 'xxxxxxxxxxxxxxxx',
113105
),
114-
115-
/* Example of a LDAP authentication source. */
106+
*/
107+
108+
/*
109+
// Example of a LDAP authentication source.
116110
'example-ldap' => array(
117111
'ldap:LDAP',
118112
119-
/* The hostname of the LDAP server. */
113+
// The hostname of the LDAP server.
120114
'hostname' => 'ldap.example.org',
121115
122-
/* Whether SSL/TLS should be used when contacting the LDAP server. */
116+
// Whether SSL/TLS should be used when contacting the LDAP server.
123117
'enable_tls' => FALSE,
124118
125-
/*
126-
* Whether debug output from the LDAP library should be enabled.
127-
* Default is FALSE.
128-
*/
119+
// Whether debug output from the LDAP library should be enabled.
120+
// Default is FALSE.
129121
'debug' => FALSE,
130122
131-
/*
132-
* The timeout for accessing the LDAP server, in seconds.
133-
* The default is 0, which means no timeout.
134-
*/
123+
// The timeout for accessing the LDAP server, in seconds.
124+
// The default is 0, which means no timeout.
135125
'timeout' => 0,
136126
137-
/*
138-
* Which attributes should be retrieved from the LDAP server.
139-
* This can be an array of attribute names, or NULL, in which case
140-
* all attributes are fetched.
141-
*/
127+
// Which attributes should be retrieved from the LDAP server.
128+
// This can be an array of attribute names, or NULL, in which case
129+
// all attributes are fetched.
142130
'attributes' => NULL,
143131
144-
/*
145-
* The pattern which should be used to create the users DN given the username.
146-
* %username% in this pattern will be replaced with the users username.
147-
*
148-
* This option is not used if the search.enable option is set to TRUE.
149-
*/
132+
// The pattern which should be used to create the users DN given the username.
133+
// %username% in this pattern will be replaced with the users username.
134+
//
135+
// This option is not used if the search.enable option is set to TRUE.
150136
'dnpattern' => 'uid=%username%,ou=people,dc=example,dc=org',
151137
152-
/*
153-
* As an alternative to specifying a pattern for the users DN, it is possible to
154-
* search for the username in a set of attributes. This is enabled by this option.
155-
*/
138+
// As an alternative to specifying a pattern for the users DN, it is possible to
139+
// search for the username in a set of attributes. This is enabled by this option.
156140
'search.enable' => FALSE,
157141
158-
/*
159-
* The DN which will be used as a base for the search.
160-
* This can be a single string, in which case only that DN is searched, or an
161-
* array of strings, in which case they will be searched in the order given.
162-
*/
142+
// The DN which will be used as a base for the search.
143+
// This can be a single string, in which case only that DN is searched, or an
144+
// array of strings, in which case they will be searched in the order given.
163145
'search.base' => 'ou=people,dc=example,dc=org',
164146
165-
/*
166-
* The attribute(s) the username should match against.
167-
*
168-
* This is an array with one or more attribute names. Any of the attributes in
169-
* the array may match the value the username.
170-
*/
147+
// The attribute(s) the username should match against.
148+
//
149+
// This is an array with one or more attribute names. Any of the attributes in
150+
// the array may match the value the username.
171151
'search.attributes' => array('uid', 'mail'),
172152
173-
/*
174-
* The username & password the simpleSAMLphp should bind to before searching. If
175-
* this is left as NULL, no bind will be performed before searching.
176-
*/
153+
// The username & password the simpleSAMLphp should bind to before searching. If
154+
// this is left as NULL, no bind will be performed before searching.
177155
'search.username' => NULL,
178156
'search.password' => NULL,
179157
180-
/*
181-
* If the directory uses privilege separation,
182-
* the authenticated user may not be able to retrieve
183-
* all required attribures, a privileged entity is required
184-
* to get them. This is enabled with this option.
185-
*/
158+
// If the directory uses privilege separation,
159+
// the authenticated user may not be able to retrieve
160+
// all required attribures, a privileged entity is required
161+
// to get them. This is enabled with this option.
186162
'priv.read' => FALSE,
187163
188-
/*
189-
* The DN & password the simpleSAMLphp should bind to before
190-
* retrieving attributes. These options are required if
191-
* 'priv.read' is set to TRUE.
192-
*/
164+
// The DN & password the simpleSAMLphp should bind to before
165+
// retrieving attributes. These options are required if
166+
// 'priv.read' is set to TRUE.
193167
'priv.username' => NULL,
194168
'priv.password' => NULL,
195169
196170
),
171+
*/
197172

198-
/* Example of an LDAPMulti authentication source. */
173+
/*
174+
// Example of an LDAPMulti authentication source.
199175
'example-ldapmulti' => array(
200176
'ldap:LDAPMulti',
201177
202-
/*
203-
* The way the organization as part of the username should be handled.
204-
* Three possible values:
205-
* - 'none': No handling of the organization. Allows '@' to be part
206-
* of the username.
207-
* - 'allow': Will allow users to type 'username@organization'.
208-
* - 'force': Force users to type 'username@organization'. The dropdown
209-
* list will be hidden.
210-
*
211-
* The default is 'none'.
212-
*/
178+
// The way the organization as part of the username should be handled.
179+
// Three possible values:
180+
// - 'none': No handling of the organization. Allows '@' to be part
181+
// of the username.
182+
// - 'allow': Will allow users to type 'username@organization'.
183+
// - 'force': Force users to type 'username@organization'. The dropdown
184+
// list will be hidden.
185+
//
186+
// The default is 'none'.
213187
'username_organization_method' => 'none',
214188
215-
/*
216-
* Whether the organization should be included as part of the username
217-
* when authenticating. If this is set to TRUE, the username will be on
218-
* the form <username>@<organization identifier>. If this is FALSE, the
219-
* username will be used as the user enters it.
220-
*
221-
* The default is FALSE.
222-
*/
189+
// Whether the organization should be included as part of the username
190+
// when authenticating. If this is set to TRUE, the username will be on
191+
// the form <username>@<organization identifier>. If this is FALSE, the
192+
// username will be used as the user enters it.
193+
//
194+
// The default is FALSE.
223195
'include_organization_in_username' => FALSE,
224196
225-
/*
226-
* A list of available LDAP servers.
227-
*
228-
* The index is an identifier for the organization/group. When
229-
* 'username_organization_method' is set to something other than 'none',
230-
* the organization-part of the username is matched against the index.
231-
*
232-
* The value of each element is an array in the same format as an LDAP
233-
* authentication source.
234-
*/
197+
// A list of available LDAP servers.
198+
//
199+
// The index is an identifier for the organization/group. When
200+
// 'username_organization_method' is set to something other than 'none',
201+
// the organization-part of the username is matched against the index.
202+
//
203+
// The value of each element is an array in the same format as an LDAP
204+
// authentication source.
235205
'employees' => array(
236-
/*
237-
* A short name/description for this group. Will be shown in a dropdown list
238-
* when the user logs on.
239-
*
240-
* This option can be a string or an array with language => text mappings.
241-
*/
206+
// A short name/description for this group. Will be shown in a dropdown list
207+
// when the user logs on.
208+
//
209+
// This option can be a string or an array with language => text mappings.
242210
'description' => 'Employees',
243211
244-
/*
245-
* The rest of the options are the same as those available for
246-
* the LDAP authentication source.
247-
*/
212+
// The rest of the options are the same as those available for
213+
// the LDAP authentication source.
248214
'hostname' => 'ldap.employees.example.org',
249215
'dnpattern' => 'uid=%username%,ou=employees,dc=example,dc=org',
250216
),
@@ -257,7 +223,6 @@
257223
),
258224
259225
),
226+
*/
260227

261228
);
262-
263-
?>

0 commit comments

Comments
 (0)