Products.LoginLockout 0.4.0

Requires:

• PluggableAuthService and its dependencies

• (optional) PlonePAS and its dependencies

Features

• Configurable number of allowed incorrect attempts before lockout

• Account will be usable again after a configurable amount of time (the “reset period”) If the first login attempt after the reset period is invalid, the invalid login counter is set to 1.

• The user is presented with a message saying that the account was locked, and for how long. (It doesn’t show remaining time, just the total lockout time.)

Configuration

Go to the ZMI -> portal_properties -> loginlockout_properties, there you can changes these defaults:

• allowed incorrect attempts: 3

• reset period: 24 hours

Details

LoginLockout can be used as a Plone plugin or with zope and PAS alone. First we’ll show you how it works with Plone.

To Install

Install into Plone via Add/Remove Products

To Use

First login as manager:

>>> from Products.Five.testbrowser import Browser

Now we’ll open up a new browser and attempt to login:

>>> browser = Browser()
>>> browser.open(self.portal.absolute_url()+'/login_form')
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Password').value = 'user'
>>> browser.getControl('Log in').click()
>>> print browser.contents
<BLANKLINE>
...You are now logged in...

Let’s try again with another password:

>>> browser = Browser()
>>> browser.open(self.portal.absolute_url()+'/login_form')
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Password').value = 'notpassword1'
>>> browser.getControl('Log in').click()
>>> print browser.contents
<BLANKLINE>
...Login failed...

this incorrect attemp will show up in the log:

>>> admin = Browser()
>>> admin.open(self.portal.absolute_url()+'/login_form')
>>> admin.getControl('Login Name').value = 'admin'
>>> admin.getControl('Password').value = 'admin'
>>> admin.getControl('Log in').click()
>>> admin.getLink('Site Setup').click()

We’ve installed a Control panel to monitor the login attempts

>>> admin.getLink('LoginLockout').click()
>>> print admin.contents
<BLANKLINE>
...<span>user</span>...
...<span>1</span>...

If we try twice more we will be locked out:

>>> browser.open(self.portal.absolute_url()+'/login_form')
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Password').value = 'notpassword2'
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Log in').click()
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Password').value = 'notpassword3'
>>> browser.getControl('Log in').click()
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Password').value = 'notpassword4'
>>> browser.getControl('Log in').click()
>>> print browser.contents
<BLANKLINE>
...This account has now been locked for security purposes...

Now even the correct password won’t work:

>>> browser.open(self.portal.absolute_url()+'/login_form')
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Password').value = 'user'
>>> browser.getControl('Log in').click()
>>> print browser.contents
<BLANKLINE>
...This account has now been locked for security purposes...

The administrator can reset this persons account:

>>> admin.getLink('Site Setup').click()
>>> admin.getLink('LoginLockout Configuration Panel').click()
>>> print admin.contents
<BLANKLINE>
...<span>user</span>...
...<span>3</span>...
>>> admin.getControl(name='reset_ploneusers:list').value = ['user']
>>> admin.getControl('Reset selected accounts').click()
>>> print admin.contents
<BLANKLINE>
...Accounts were reset for these login names: user...

and now they can log in again:

>>> browser.open(self.portal.absolute_url()+'/login_form')
>>> browser.getControl('Login Name').value = 'user'
>>> browser.getControl('Password').value = 'user'
>>> browser.getControl('Log in').click()
>>> print browser.contents
<BLANKLINE>
...You are now logged in...

Manual Installation

This plugin needs to be installed in two places, the instance PAS where logins occur and the root acl_users.

1. Place the Product directory ‘LoginLockout’ in your ‘Products/’ directory. Restart Zope.

2. In your instance PAS ‘acl_users’, select ‘LoginLockout’ from the add list. Give it an id and title, and push the add button.

3. Enable the ‘Authentication’, ‘Challenge’ and the ‘Update Credentials’ plugin interfaces in the after-add screen.

4. Rearrange the order of your ‘Challenge plugins’ so that the ‘LoginLockout’ plugin is at the top.

5. Repeat the above for your root PAS but as a plugin to

   • Anonymoususerfactory

   • Update Credentials

and ensure LoginLockout is the first Anonymoususerfactory

Steps 2 through 5 below will be done for you by the Plone installer.

That’s it! Test it out.

Implementation

If the root anonymoususerfactory plugin is activated following an authentication plugin activation then this is an unsuccesful login attempt. If the password was different from the last unsuccessful attempt then we incriment a counter in data stored persistently in the root plugin.

If the instance plugin tries to authenticate a user that has been marked has having too many attempts then Unauthorised will be raised. This will activate the challenge plugin which will display a locked out message instead of another login form.

updateCredentials is called when the login was successful and in this case we reset the unsuccessful login count.

Troubleshooting

AttributeError: manage_addLoginLockout

If, while running test, you get AttributeError: manage_addLoginLockout, this is likely due to the fact that the initialize() method from __init__.py isn’t run during test setup.

To resolve, explicitly call:

z2.installProduct(portal, 'Products.LoginLockout')

Developing

It’s great that you want to help advance this add-on!

To start development:

git clone git@github.com:collective/Products.LoginLockout.git
cd Products.LoginLockout
virtualenv .
./bin/python bootstrap.py
./bin/buildout
./bin/test

Please observe the following:

• Only start work when tests are currently passing. If not, fix them, or ask someone (*) for help.

• Make your work in a branch and create a pull request for it on github. Ask for someone (*) to merge it.

• Please adhere to guidelines: pep8. We use plone.recipe.codeanalysis to enforce some of these.

(*) People that might be able to help you out:

khink, djay, ajung, macagua

Copyright, License, Author

Copyright (c) 2007, PretaWeb, Australia,

and the respective authors. All rights reserved.

Author: Dylan Jay <software pretaweb com>

License BSD-ish, see LICENSE.txt

Credits

Dylan Jay, original code.

Contributors:

• Kees Hink

• Andreas Jung

• Leonardo J. Caballero G.

• Wolfgang Thomas

• Peter Uittenbroek

• Ovidiu Miron

• Ludolf Takens

• Maarten Kling

Thanks to Daniel Nouri and BlueDynamics for their NoDuplicateLogin which served as the base for this.

0.4.0 (2015-11-25)

• Fix incorrect flake8 in skins template python script. [khink]

0.3.9 (2015-11-18)

• Don’t unicode error in portal message when resetting [maartenkling]

0.3.8 (2015-10-17)

• Include Travis build badge. Fixed test setup, make code-analysis work, update README with development info. (khink)

0.3.7 (2015-06-08)

• Reset counter after reset period. (ltakens)

0.3.6 (2015-04-08)

• Render the lockout message in the site layout. Show the reset period in the lockout message, so people don’t have to contact the site administrator again. (khink)

0.3.5 (2015-04-02)

• Make number of allowed attempts configurable through the ZMI (khink)

0.3.4 (2015-04-01)

• Make reset_period configurable through the ZMI (khink)

• Added more strings classifiers items for this packages. (macagua)

• Added plone_deprecated skins for gif icon. (macagua)

• Added support for Configlet with GenericSetup profile. (macagua)

• Added Spanish translation. (macagua)

• Added i18n support. (macagua)

• LoginLockout interface updated as follows (omiron):

  • group user lockouts separate from bogus info

  • links to users profile page

  • provide full user name and email to ease “find in page”

• Introduct ‘select all’ option in configlet (thepjot)

• Re-enable ‘reset_period’, after reset_period has expired, user gets another chance (thepjot)

0.3.3 (2013-11-20)

• check for fake_client_ip in a more defensive way (pysailor)

0.3.2 (2012-03-12)

• fixed deprecation warnings (Andreas Jung)

0.3.1 (2012-02-13)

• fixed some restructured text bugs in documentation (Andreas Jung)

0.3 (2011-03-04)

• internal cleanup

• using GenericSetup where possible

• added support for logging successful login attempts

• added support logging password changes

(Andreas Jung)

0.2 (2009-04-20)

• Eggified merged configlet version

• Started doctest

(Dylan Jay)

(2009-03-10)

• Added configlet for viewing failed attempts and resetting accounts from the plone control panel.

• Quite probably, dropped support for pure Zope usage.

(Kees Hink)

(2008-12-18)

• Added installer, using Extensions/Install.py. (Unfortunately, Generic Setup does not yet seem to support uninstalling, but the methods in setuphandlers.py and the import profile (profiles/default) are there for when you want to use them. Just uncomment the relevant zcml directives.)

(Kees Hink)

0.1 (unknown)

• Initial Version (Dylan Jay)