Skip to main content

Extremely simple, "Good Enough" captcha implemention for flask forms. No server side sessions required.

Project description

Install

pip3 install flask-simple-captcha or if installing from source python3 setup.py install

How to use

This package is intended to assign a unique CSRF string per each form submit per user session, without requiring any backend session tracking. First, you'll want to set a variable CAPTCHA_CONFIG['SECRET_CSRF_KEY'] in your app config to a random, complex string. Example: CAPTCHA_CONFIG = {'SECRET_CSRF_KEY':'wMmeltW4mhwidorQRli6Oijuhygtfgybunxx9VPXldz'}

Second, add this to the top of your code.

from flask_simple_captcha import CAPTCHA
CAPTCHA = CAPTCHA(config=config.CAPTCHA_CONFIG)
app = CAPTCHA.init_app(app)

For each route you want captcha protected, add the following code:

@app.route('/example, methods=['GET','POST']
def example():
    if request.method == 'GET':
        captcha = CAPTCHA.create()
        render_template('example.html', captcha=captcha)
    if request.method == 'POST':
        c_hash = request.form.get('captcha-hash')
        c_text = request.form.get('captcha-text')
        if CAPTCHA.verify(c_text, c_hash):
            return 'success'
        else:
            return 'failed captcha'

In the HTML forms you want to generate a captcha: {{ captcha_html(captcha) }}

This will create something like this:

<input type="text" name="captcha-text">
<input type="hidden" name="captcha-hash" value="1o9ig...">

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for flask-simple-captcha, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size flask_simple_captcha-1.1.0-py3-none-any.whl (203.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size flask-simple-captcha-1.1.0.tar.gz (203.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page