aliens/SemanticScuttle
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix authentication docs and integrate them in index.rst

Browse source
This commit is contained in:
Christian Weiske 2011-05-26 21:37:06 +02:00
parent 324225f10b
commit 2ddbf1703f
2 changed files with 139 additions and 121 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

258
doc/authentication.txt
View file

@ -1,3 +1,4 @@
============================================
External authentication with SemanticScuttle External authentication with SemanticScuttle
============================================ ============================================
@ -12,8 +13,8 @@ active directory server.
Since version 0.96, SemanticScuttle supports user authentication against Since version 0.96, SemanticScuttle supports user authentication against
external systems. To provide a wide range of supported systems, we chose external systems. To provide a wide range of supported systems, we chose
to utilize PEAR's Authentication package [1]. to utilize PEAR's `Authentication package`__.
It does this by providing different "authentication containers" [2], It does this by providing different "`authentication containers`__",
for example Database, IMAP, LDAP, POP3, RADIUS, SAP and SOAP. for example Database, IMAP, LDAP, POP3, RADIUS, SAP and SOAP.
Please be aware of the fact that, after successful authentication, the user Please be aware of the fact that, after successful authentication, the user
@ -24,51 +25,58 @@ is offline - you won't, execpt you switch it off in the SemanticScuttle
configuration. configuration.
[1] http://pear.php.net/package/Auth __ http://pear.php.net/package/Auth
[2] http://pear.php.net/manual/en/package.authentication.auth.intro-storage.php __ http://pear.php.net/manual/en/package.authentication.auth.intro-storage.php
Basic configuration Basic configuration
=================== ===================
The default configuration file data/config.default.php has an own section The default configuration file ``data/config.default.php`` has an own section
on auth options and an explanation of the single entries. on auth options and an explanation of the single entries.
To utilize the external authentication, you need to install the To utilize the external authentication, you need to install the
PEAR Auth package: PEAR Auth package: ::
$ pear install auth
$ pear install auth
If you do not have a PEAR installation available, you can try to manually If you do not have a PEAR installation available, you can try to manually
install the files in the src/ directory. If you choose to do that, the install the files in the src/ directory. If you choose to do that, the
src/ directory should look similar to that: src/ directory should look similar to that: ::
src/ src/
Auth.php Auth.php
Auth/ Auth/
Anonymous.php Anonymous.php
Container.php Container.php
Container/ Container/
..
SemanticScuttle/
header.php
.. ..
SemanticScuttle/
header.php
..
After that, modify your data/config.php file. The most important change After that, modify your ``data/config.php`` file. The most important change
is to use is to use ::
$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
which tells SemanticScuttle to switch to the special authentication service. which tells SemanticScuttle to switch to the special authentication service.
Now that's done, you can configure the single auth options: Now that's done, you can configure the single auth options:
$authType = 'MDB2';
selects the authentication container.
$authOptions ``$authType = 'MDB2';``
is an array of options specific to the authentication container. Please selects the authentication container.
consult the PEAR Auth documentation for more information.
$authDebug = true; ``$authOptions``
should be used when setup fails, since it may give important hints is an array of options specific to the authentication container. Please
where it fails. Please note that login will seem to fail with consult the PEAR Auth documentation for more information.
debugging activated. Going back to the main page after that will
show that you are logged in. ``$authDebug = true;``
should be used when setup fails, since it may give important hints
where it fails.
Please note that login will seem to fail with
debugging activated. Going back to the main page after that will
show that you are logged in.
@ -77,53 +85,53 @@ Authentication examples
General database authentification General database authentification
--------------------------------- ---------------------------------
Here you also need the PEAR MDB2 package. Here you also need the PEAR `MDB2 package`_.
The "new_link" option is important! The "``new_link``" option is important!
config.php settings: ``config.php`` settings: ::
-8<------------------
$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser'; $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
$authType = 'MDB2'; $authType = 'MDB2';
$authOptions = array( $authOptions = array(
'dsn' => array( 'dsn' => array(
'phptype' => 'mysql', 'phptype' => 'mysql',
'hostspec' => 'FIXME', 'hostspec' => 'FIXME',
'username' => 'FIXME', 'username' => 'FIXME',
'password' => 'FIXME', 'password' => 'FIXME',
'database' => 'FIXME', 'database' => 'FIXME',
'new_link' => true, 'new_link' => true,
), ),
'table' => 'usersFIXME', 'table' => 'usersFIXME',
'usernamecol' => 'usernameFIXME', 'usernamecol' => 'usernameFIXME',
'passwordcol' => 'passwordFIXME', 'passwordcol' => 'passwordFIXME',
'cryptType' => 'md5', 'cryptType' => 'md5',
); );
-8<------------------
Mantis Bugtracker Mantis Bugtracker
----------------- -----------------
Here you also need the PEAR MDB2 package. Here you also need the PEAR `MDB2 package`_.
config.php settings: ``config.php`` settings: ::
-8<------------------
$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser'; $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
$authType = 'MDB2'; $authType = 'MDB2';
$authOptions = array( $authOptions = array(
'dsn' => array( 'dsn' => array(
'phptype' => 'mysql', 'phptype' => 'mysql',
'hostspec' => 'FIXME', 'hostspec' => 'FIXME',
'username' => 'FIXME', 'username' => 'FIXME',
'password' => 'FIXME', 'password' => 'FIXME',
'database' => 'FIXME', 'database' => 'FIXME',
'new_link' => true, 'new_link' => true,
), ),
'table' => 'mantis_user_table', 'table' => 'mantis_user_table',
'usernamecol' => 'username', 'usernamecol' => 'username',
'passwordcol' => 'password', 'passwordcol' => 'password',
'cryptType' => 'md5', 'cryptType' => 'md5',
); );
-8<------------------
.. _MDB2 package: http://pear.php.net/package/MDB2
MediaWiki MediaWiki
@ -132,66 +140,74 @@ Unfortunately, the password column does not contain a simple hashed
password - for good reasons as described on password - for good reasons as described on
http://www.mediawiki.org/wiki/Manual_talk:User_table#user_password_column http://www.mediawiki.org/wiki/Manual_talk:User_table#user_password_column
If you configure your mediawiki to use passwords without salt, you If you configure your MediaWiki_ to use passwords without salt, you
can make it work nevertheless: can make it work nevertheless:
MediaWiki LocalSettings.php: MediaWiki ``LocalSettings.php``: ::
$wgPasswordSalt = false;
- after that, users need to change/update their passwords to get them $wgPasswordSalt = false;
\- after that, users need to change/update their passwords to get them
unsalted in the database. You can verify if the passwords are unhashed unsalted in the database. You can verify if the passwords are unhashed
if you do if you do ::
SELECT CAST( user_password AS CHAR ) FROM user
on your MediaWiki database. Passwords prefixed with ":A:" can be used. SELECT CAST( user_password AS CHAR ) FROM user
on your MediaWiki database. Passwords prefixed with "``:A:``" can be used.
Another problem is that mediawiki user names begin with an uppercase letter. Another problem is that mediawiki user names begin with an uppercase letter.
You need to modify www/login.php and remove the "utf8_strtolower" function You need to modify ``www/login.php`` and remove the "``utf8_strtolower``" function
call: call: ::
$posteduser = trim(utf8_strtolower(POST_USERNAME));
becomes $posteduser = trim(utf8_strtolower(POST_USERNAME));
$posteduser = trim(POST_USERNAME);
becomes ::
$posteduser = trim(POST_USERNAME);
config.php settings: ``config.php`` settings: ::
-8<------------------
$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
$authType = 'MDB2';
$authOptions = array(
'dsn' => array(
'phptype' => 'mysql',
'hostspec' => 'FIXME',
'username' => 'FIXME',
'password' => 'FIXME',
'database' => 'FIXME',
'new_link' => true,
),
'table' => 'user',
'usernamecol' => 'user_name',
'passwordcol' => 'user_password',
'cryptType' => 'md5_mediawiki',
);
function md5_mediawiki($password) {
return ':A:' . md5($password);
}
-8<------------------
$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
$authType = 'MDB2';
$authOptions = array(
'dsn' => array(
'phptype' => 'mysql',
'hostspec' => 'FIXME',
'username' => 'FIXME',
'password' => 'FIXME',
'database' => 'FIXME',
'new_link' => true,
),
'table' => 'user',
'usernamecol' => 'user_name',
'passwordcol' => 'user_password',
'cryptType' => 'md5_mediawiki',
);
function md5_mediawiki($password) {
return ':A:' . md5($password);
}
.. _MediaWiki: http://www.mediawiki.org/wiki/MediaWiki
Active Directory / LDAP Active Directory / LDAP
----------------------- -----------------------
Here we authenticate against an active directory server. Here we authenticate against an active directory server.
config.php settings: ``config.php`` settings: ::
-8<------------------
$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser'; $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
$authType = 'LDAP'; $authType = 'LDAP';
$authOptions = array( $authOptions = array(
'host' => '192.168.1.4', 'host' => '192.168.1.4',
'version' => 3, 'version' => 3,
'basedn' => 'DC=EXAMPLE,DC=ORG', 'basedn' => 'DC=EXAMPLE,DC=ORG',
'binddn' => 'readuser', 'binddn' => 'readuser',
'bindpw' => 'readuser', 'bindpw' => 'readuser',
'userattr' => 'sAMAccountName', 'userattr' => 'sAMAccountName',
'userfilter' => '(objectClass=user)', 'userfilter' => '(objectClass=user)',
'attributes' => array(''), 'attributes' => array(''),
); );
$authEmailSuffix = '@example.org'; $authEmailSuffix = '@example.org';
-8<------------------

2
doc/index.rst
View file

@ -17,9 +17,11 @@ First reads
Features Features
======== ========
- `Custom user authentication`__
- `SSL Client certificates`__ - `SSL Client certificates`__
- Themes__ - Themes__
__ authentication.html
__ ssl-client-certificates.html __ ssl-client-certificates.html
__ themes.html __ themes.html