Changes between Version 9 and Version 10 of GuardPlugin

Timestamp:

2012-05-23T21:15:09Z (14 years ago)

Author:

Pan Luo

Comment:

--

GuardPlugin

@@ -7 +7 @@
 == Requirements ==
  * CakePHP 1.3+
+
+== Available Authentication Methods ==
+ * CakePHP internal
+ * Shibboleth
+ * LDAP
 
 == Download ==
@@ -97 +102 @@
 * loginError: The error message when user logged in successfully through Shibboleth but do not have an valid account or permission in the application. This is an example to override the [http://api13.cakephp.org/class/auth-component AuthComponent] properties. 
 
+=== LDAP Module ===
+LDAP module is used to authenticate against the existing LDAP server. 
+
+The configuration parameters for LDAP are:
+{{{
+#!php
+$config['Guard.AuthModule.Ldap'] = array(
+    'host' => 'ldaps://ldapcons.stg.id.ubc.ca/',
+    'port' => 636,
+    'serviceUsername' => 'uid=USERNAME, ou=Special Users, o=school.ca', // username to connect to LDAP
+    'servicePassword' => 'PASSWORD', // password to connect to LDAP
+    'baseDn' => 'ou=Campus Login, o=school.ca',
+    'usernameField' => 'username', // not used
+    'passwordField' => 'password', // not used
+);
+}}}
+* host: The LDAP server address
+* port: The LDAP server port
+* serviceUsername: The username used to connect to LDAP server
+* servicePassword: The password used to connect to LDAP server
+* baseDn: The base DN
+
 === Note ===
 Change the Security.level to low in core.php if using external authentication module