https://github.com/mjpieters/collective.captcha

Stateless captcha generation and verification
https://github.com/mjpieters/collective.captcha

Last synced: 20 days ago
JSON representation

Stateless captcha generation and verification

• Host: GitHub
• URL: https://github.com/mjpieters/collective.captcha
• Owner: mjpieters
• License: other
• Created: 2012-02-25T15:54:30.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-02-27T21:03:05.000Z (almost 13 years ago)
• Last Synced: 2024-10-17T15:41:17.506Z (3 months ago)
• Language: Python
• Homepage:
• Size: 2.2 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.txt
  • License: LICENSE.GPL

Awesome Lists containing this project

README

        
-----------------------------

Captchas without server state

-----------------------------

A view to generate a captcha image and/or wav file, and to verify user input

against it.

A cookie is used to transfer state from one request to the next. The state is

used, together with a server-side secret, to create a random string of

characters, which in turn is displayed as a captcha image, or transformed to

an audio file. Verification happens case-insensitively.

Note that the captcha 'word' is only usable for 5-10 minutes, after which the

view will not accept it any more. Moreover, a different word will be generated

for a given session key every 5 minutes.

This makes these captchas replayable for up to 10 minutes if a determined

user keeps sending the same session id. Because of the server-secret though,

captchas are not transferrable between sites.

Installing

----------

This package requires Plone 2.5 or later, and plone.keyring 1.1 or later.

Installing without buildout

~~~~~~~~~~~~~~~~~~~~~~~~~~~

Install this package in either your system path packages or in the lib/python

directory of your Zope instance. You can do this using either easy_install or

via the setup.py script. You'll also need to install plone.keyring in the same

fashion.

After installing the package it needs to be registered in your Zope instance.

This can be done by putting a collective.captcha-configure.zcml file in the

etc/package-includes directory with this content::

  

or, alternatively, you can add that line to the configure.zcml in a package or

Product that is already registered.

Installing with buildout

~~~~~~~~~~~~~~~~~~~~~~~~

If you are using `buildout`_ to manage your instance installing

collective.captcha is even simpler. You can install collective.captcha by

adding it to the eggs line for your instance::

  [instance]

  eggs = collective.captcha

  zcml = collective.captcha

The last line tells buildout to generate a zcml snippet that tells Zope

to configure collective.captcha.

If another package depends on the collective.captcha egg or includes its zcml

directly you do not need to specify anything in the buildout configuration:

buildout will detect this automatically.

After updating the configuration you need to run the ''bin/buildout'', which

will take care of updating your system, including installing the plone.keyring

dependency.

.. _buildout: http://pypi.python.org/pypi/zc.buildout

Registering plone.keyring KeyManager

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

On any Plone version prior to 3.1, you'll need to make sure that the plone.keyring KeyManager utility has been registered. In the Zope ZMI, use the portal_setup tool to run the plone.keyring KeyManager registration profile.

Using the view

--------------

See the captcha.txt doctest in the collective.captcha.browser package, as well

as captcha.txt in collective.captcha.form.

Copyright and credits

----------------------

collective.captcha is copyright 2007 by `Jarn`_ (formerly known as Plone

Solutions), and is licensed under the GPL. See LICENSE.txt for details.

It was written by Martijn Pieters.

.. _Jarn: http://www.jarn.com/