How To Setup SQLPASPlugin to Authenticate Against A PostgreSQL Database
Site Configuration Details:Here is some information on the site that I set this up on:
Plone Version: 2.5
Zope Version: 2.9.3
Python Version: 2.4.3
Server OS: Debian GNU/Linux 3.1
A Note About Site With Existing UsersIf you setup SQLPASPlugin on a site that already has users, there is no provision to preserve existing passwords. Users will have to reset their passwords to access the site. Also, if you want to encrypt passwords, ensure that you enable encryption before asking users to reset their passwords.
Creation of Database
SQLPASPlugin may be used to authenticate against any SQL Database for which there is a Zope connector available. For the purpose of this how to, we will use PostgreSQL. Assuming you have PostgreSQL installed, the first step is to create a new database and postgres user for SQLPASPlugin to use. You may also use an existing user if you prefer.
If you wish to create a new postgres user and database, you can use this script.
To use this script, execute the following command as the postgres user:
psql template1 -f sqlpas_db.sql
If no errors are returned, your database is ready to accept users!
Installation of PsycopgTo connect to the Postgres database, Plone needs to use a database connector object which needs to be installed. To do this, download the latest version of pyscopg from this site.
After the download is finished, change to the directory you downloaded to, and do the following:
- Extract the archive
tar xvzf psycopg2-latest.tar.gz
- Change to the extracted directory
- To build psycopg, you will also need libpq-fe.h which is a part of the
posgres development package. If you are on Debian or Ubuntu, you can apt-get install it.
sudo apt-get install libpq-dev
- Build the product using the python that your Plone instance uses. If you are using installed Plone using the Unified installer, your python home is /opt/Plone-2.5/Python-2.4.3.
/opt/Plone-2.5/Python-2.4.3/bin/python setup.py build
- Install the product into your python site-packages
sudo /opt/Plone-2.5/Python-2.4.3/bin/python setup.py install
- Copy the ZPsycopgDA directory to your instance Products folder
sudo cp -R ZPsycopgDA /opt/Plone-2.5/instances/client1/Products
- Restart Zope
If installation was sucessful, you should now see Z Psycopg 2 Database Connection as addable in the ZMI.
Setting Up The DB Connection in the ZMI
Once Zope has restarted, add a Z Psycopg 2 Database Connection to the root of your Plone site. You may name it anything you want, so long as you remember what you called it. Use the following configuration parameters for the Connection String field (or whatever you changed them to in the script):
dbname=sqlpasdb user=sqlpas password=sqlpas!password
Once you have filled in the required fields, click Save Changes. Zope should now tell you that the database connection is open. You cannot continue if the connection is not open.
Installation of SQLPASPlugin
- Get the latest version of SQLPASPlugin
svn export https://svn.plone.org/svn/collective/PASPlugins/SQLPASPlugin/trunk SQLPASPlugin
- Make sure that the Product is owned by the plone user on your system
sudo chown -R plone:users
- Restart Zope
- In Portal Quick Installer (Add/Remove Programs in the Plone Control Panel) install SQLPASPlugin
Configuring SQLPASPlugin (select connection, select encryption scheme)It is now time to put it all together. In the Plone Control Panel you should see SQL Authentication under Add On Product Configuration near the bottom of the navigation menu. Click on it and select the database connection you just setup.
- Use the link in the SQL Authentication Control Panel to go to the source_properties configuration screen. In col_mapping enter the following:
- Save the changes. Your site will now authenticate against the newly created PostgreSQL database.
By default, SQLPASPlugin currently stored passwords as plain text. You may configure it to use MD5 or SHA encryption algorithms.
- In the root of your Plone site in the ZMI, go to the acl_users folder (note: the acl_users folder at the root of your plone site, NOT your Zope root).
- Go to the source_users folder.
- Select the properties tab.
- In default_encryption enter sha or md5.