HTTPDUserAdminContrib < Extensions

You are here: Foswiki>Extensions Web>HTTPDUserAdminContrib (09 Dec 2009, CrawfordCurrie) (raw view)

<!--
This topic is part of the documentation for HTTPDUserAdminContrib and is
automatically generated from Subversion. Do not edit it! Your edits
will be lost the next time the topic is uploaded!

If you want to report an error in the topic, please raise a report at
http://foswiki.org/view/Tasks/HTTPDUserAdminContrib
-->
---+!! !HTTPDUserAdminContrib
<!--
One line description, required for extensions repository catalog.
   * Set SHORTDESCRIPTION = A User and Password module supporting text or DBM format htpasswd files, and SQL using HTTPD::UserAdmin CPAN module 
-->
%SHORTDESCRIPTION%

---++ Usage
This Contrib adds [[http://httpd.apache.org/docs/2.2/mod/mod_authn_dbm.html][auth DBM]] 
and [[http://httpd.apache.org/docs/2.2/mod/mod_authn_dbd.html][auth SQL]] support to foswiki, 
though the [[http://search.cpan.org/~lds/HTTPD-User-Manage-1.66/lib/HTTPD/UserAdmin.pm][HTTPD::UserAdmin]] CPAN module.

You receive maximal performance benefit by using the =SQL= mode, and ensuring ={Register}{AllowLoginName}= is off (so that the %MAINWEB%.WikiUsers topic is not needed to convert login names to Wiki Names.

See the Extensions | HTTPDUserAdminContrib section of =configure= to set up the specific options.

If =$Foswiki::cfg{HTTPDUserAdminContrib}{GroupDB}= is left unset, or set to an empty string, HTTPDUserAdminContrib will use the Topic based group definition system. 
The type of the groupDB will be the same as that of the main DB.

---++ User administration User interface.
Additionally, !HTTPDUserAdminContrib contains a new =USERLIST= Macro which can be used by Admin users to list (with pagaing) all the registered users in the Foswiki.

The %SYSTEMWEB%.HTTPDUserAdmin topic can be used by an Admin to register new users, and to reset their passwords.
This is especially relevant to invite only Foswikis.

---+++ Text file user store (.htpassword)
If you are using the Text mode a once off converstion from an existing Foswiki htpasswd file must be done, due to differences in the way that email addresses are stored.

run =perl -pi~ -e "s/$([^:]*):([^:]*):(.*)^/$1:$2:emails=$3/g" foswiki/data/.htpasswd= to convert from Foswiki's native htpassword format.

From there you can use that file in the =Text= =DBType=, use =dbmmanage= to import it to a DBM file, or run a similar tool to import it into your database.
---+++ DBM mode
__Not tested for a while__

DBM files are supported by apache, and are much more scalable than the linear text file based Topic user mapping and htpassword file.

---+++ SQL mode (DBI)
This Contrib will not create the database setup for you, you will need to have an existing database, 
with appropriate database connection permissions, and a database table for with the required fields that is accessible by this user.

Note that the DB Schema name is set in the top section of the settings (defaults to the .htpasswd filename).

*Beware:* Do not use table names, or column names that are SQL keywords (such as group)

for a minimal, non-optimised mysql setup, run =mysql -p= and enter:
   * where =www-data= is the user that the foswiki scripts run as.
   * if using Strawberry perl on windows, its possible that the user will be called =ODBC=
<verbatim>
create database HTTPDUsers;
GRANT ALL PRIVILEGES ON *.* TO 'www-data'@'localhost' 
IDENTIFIED BY 'foswiki' WITH GRANT OPTION;
CREATE TABLE  `HTTPDUsers`.`usertable` (
  `name` tinytext NOT NULL,
  `wikiname` tinytext,
  `emails` tinytext,
  `password` tinytext NOT NULL,
  `idx` int(10) unsigned NOT NULL AUTO_INCREMENT,
  PRIMARY KEY (`idx`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=latin1;
CREATE TABLE  `HTTPDUsers`.`grouptable` (
  `name` tinytext NOT NULL,
  `username` tinytext NOT NULL,
  `idx` int(10) unsigned NOT NULL AUTO_INCREMENT,
  PRIMARY KEY (`idx`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=latin1;
</verbatim>

---+++ extra not yet documented functionality
This Contrib can also use group definitions in the same database. There is however no in-wiki user interface to create and maintain these groups for now.

you can for example use =mysql= to
<verbatim>
INSERT INTO grouptable (name, username) VALUES ('SuperGroup', 'testuser8') ;
</verbatim>

---++ Installation Instructions
   1 Install %TOPIC%
   2 select Foswiki::Users::HTTPDUserAdminContrib in the Security|Passwords|{PasswordManager} selector in Configure
   3 then set the appropriate settings in the Exensions|HTTPDUserAdminContrib section of Configure.

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in =configure=, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.


---++ Contrib Info

|  Contrib Author(s): | Foswiki:Main.SvenDowideit |
|  Copyright: | &copy; 2008-2009 SvenDowideit@fosiki.com |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Contrib Version: | 4512 (2009-07-20) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  Sep 2009 | add USERLIST tag to create a user administration userinterface, fix bug in Text and DBM types. |
|  Sep 2009 | testing with windows and strawberry perl, fix for group definitions using WikiName rather than login, and enable nested groups |
|  Jul 2009 | port to Foswiki |
|  March 2008 | version 2 - updated for the t(m)wiki 4.2.0 release, changes to allow registration, DB (MySQL in particular) and added group table |
|  July 2007 | version 1 - initial release |
|  Dependencies: | <table class="foswikiTable" border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">HTTPD::UserAdmin</td><td align="left">&gt;=1.66</td><td align="left">Required.</td></tr><tr><td align="left">HTTPD::GroupAdmin</td><td align="left">&gt;=1.66</td><td align="left">Required.</td></tr><tr><td align="left">HTTPD::Authen</td><td align="left">&gt;=1.66</td><td align="left">Required.</td></tr><tr><td align="left">DBD::mysql</td><td align="left">&gt;=2.0</td><td align="left">Optional. use if talking to MySQL</td></tr></table> |
|  Contrib Home: | http://foswiki.org/Extensions/HTTPDUserAdminContrib |

__Related Topics:__ [[%SYSTEMWEB%.Contribs][Contribs]], %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences

<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the feedback topic on twiki.org instead. -->

PackageForm edit

ExtensionClassification	Admin, Security
ExtensionType	ContribPackage
Compatibility	1.0
DemoUrl	http://
SupportUrl	HTTPDUserAdminContrib
DevelopedInSVN	Yes
ModificationPolicy	CoordinateWithAuthor

Topic attachments
I	Attachment	Action	Size	Date	Who
md5	HTTPDUserAdminContrib.md5	manage	0.2 K	27 Sep 2009 - 07:59	SvenDowideit
sha1	HTTPDUserAdminContrib.sha1	manage	0.2 K	27 Sep 2009 - 08:00	SvenDowideit
tgz	HTTPDUserAdminContrib.tgz	manage	16.6 K	27 Sep 2009 - 07:59	SvenDowideit
zip	HTTPDUserAdminContrib.zip	manage	21.7 K	27 Sep 2009 - 07:59	SvenDowideit
EXT	HTTPDUserAdminContrib_installer	manage	4.5 K	27 Sep 2009 - 07:59	SvenDowideit

Topic revision: r4 - 09 Dec 2009, CrawfordCurrie

Extensions

Quick Links

Tools

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement.