EVOLUTION-MANAGER

Edit File: flask_fas.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
 <title>FAS Flask Auth Plugin &mdash; python-fedora 0.10.0 documentation</title>
 
 <link rel="stylesheet" href="_static/default.css" type="text/css" />
 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
 <script type="text/javascript">
 var DOCUMENTATION_OPTIONS = {
 URL_ROOT: '',
 VERSION: '0.10.0',
 COLLAPSE_INDEX: false,
 FILE_SUFFIX: '.html',
 HAS_SOURCE: true
 };
 </script>
 <script type="text/javascript" src="_static/jquery.js"></script>
 <script type="text/javascript" src="_static/underscore.js"></script>
 <script type="text/javascript" src="_static/doctools.js"></script>
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within python-fedora 0.10.0 documentation"
 href="_static/opensearch.xml"/>
 <link rel="top" title="python-fedora 0.10.0 documentation" href="index.html" />
 <link rel="up" title="Authentication to FAS" href="auth.html" />
 <link rel="next" title="FAS Flask OpenID Auth Plugin" href="flask_fas_openid.html" />
 <link rel="prev" title="Fedora Django Authentication Backend" href="django.html" /> 
 </head>
 <body>
 <div class="related">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="flask_fas_openid.html" title="FAS Flask OpenID Auth Plugin"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="django.html" title="Fedora Django Authentication Backend"
 accesskey="P">previous</a> |</li>
 <li><a href="index.html">python-fedora 0.10.0 documentation</a> &raquo;</li>
 <li><a href="auth.html" accesskey="U">Authentication to FAS</a> &raquo;</li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body">
 
 <div class="section" id="fas-flask-auth-plugin">
<h1>FAS Flask Auth Plugin<a class="headerlink" href="#fas-flask-auth-plugin" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Authors:</th><td class="field-body">Toshio Kuratomi, Ian Weller</td>
</tr>
<tr class="field-even field"><th class="field-name">Date:</th><td class="field-body">29 October 2012</td>
</tr>
<tr class="field-odd field"><th class="field-name">For Version:</th><td class="field-body">0.3.x</td>
</tr>
</tbody>
</table>
The <a class="reference internal" href="existing.html#fedora-account-system">Fedora Account System</a> has a <a class="reference internal" href="glossary.html#term-json">JSON</a> interface that we make use
of to authenticate users in our web apps. For our <a class="reference internal" href="glossary.html#term-flask">Flask</a> applications
we have an identity provider that has <a class="reference internal" href="glossary.html#term-single-sign-on">single sign-on</a> with our
<a class="reference internal" href="glossary.html#term-turbogears">TurboGears</a> 1 and 2 applications. It does not protect against
<a class="reference internal" href="glossary.html#term-csrf">CSRF</a> attacks in the identity layer. The flask-wtf forms package
should be used to provide that.
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
The FAS auth plugin has several config values that can be used to control how
the auth plugin functions. You can set these in your application&#8217;s config
file.
<dl class="docutils">
<dt>FAS_BASE_URL</dt>
<dd>Set this to the URL of the FAS server you are authenticating against.
Default is &#8220;<a class="reference external" href="https://admin.fedoraproject.org/accounts/">https://admin.fedoraproject.org/accounts/</a>&#8220;</dd>
<dt>FAS_USER_AGENT</dt>
<dd>User agent string to be used when connecting to FAS. You can set this to
something specific to your application to aid in debugging a connection to
the FAS server as it will show up in the FAS server&#8217;s logs. Default is
&#8220;Flask-FAS/0.3&#8220;</dd>
<dt>FAS_CHECK_CERT</dt>
<dd>When set, this will check the SSL Certificate for the FAS server to make
sure that it is who it claims to be. This is useful to set to False when
testing against a local FAS server but should always be set to True in
production. Default: True</dd>
<dt>FAS_COOKIE_NAME</dt>
<dd>The name of the cookie used to store the session id across the Fedora
Applications that support <a class="reference internal" href="glossary.html#term-single-sign-on">single sign-on</a>. Default: &#8220;tg-visit&#8221;</dd>
<dt>FAS_FLASK_COOKIE_REQUIRES_HTTPS</dt>
<dd>When this is set to True, the session cookie will only be returned to the
server via ssl (https). If you connect to the server via plain http, the
cookie will not be sent. This prevents sniffing of the cookie contents.
This may be set to False when testing your application but should always
be set to True in production. Default is True.</dd>
</dl>
</div>
<div class="section" id="sample-application">
<h2>Sample Application<a class="headerlink" href="#sample-application" title="Permalink to this headline">¶</a></h2>
The following is a sample, minimal flask application that uses fas_flask for
authentication:
<div class="highlight-python"><div class="highlight"><pre>#!/usr/bin/python -tt
# Flask-FAS - A Flask extension for authorizing users with FAS
# Primary maintainer: Ian Weller &lt;ianweller@fedoraproject.org&gt;
#
# Copyright (c) 2012, Red Hat, Inc.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * Neither the name of the Red Hat, Inc. nor the names of its contributors may
# be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS &#39;&#39;AS IS&#39;&#39; AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This is a sample application. In addition to using Flask-FAS, it uses
# Flask-WTF (WTForms) to handle the login form. Use of Flask-WTF is highly
# recommended because of its CSRF checking.

import flask
from flask.ext import wtf
from flask.ext.fas import FAS, fas_login_required

# Set up Flask application
app = flask.Flask(__name__)
# Set up FAS extension
fas = FAS(app)

# Application configuration
# SECRET_KEY is necessary to CSRF in WTForms. It nees to be secret to
# make the csrf tokens unguessable but if you have multiple servers behind
# a load balancer, the key needs to be the same on each.
app.config[&#39;SECRET_KEY&#39;] = &#39;change me!&#39;
# Other configuration options for Flask-FAS:
# FAS_BASE_URL: the base URL for the accounts system
# (default https://admin.fedoraproject.org/accounts/)
# FAS_CHECK_CERT: check the SSL certificate of FAS (default True)
# FAS_FLASK_COOKIE_REQUIRES_HTTPS: send the &#39;secure&#39; option with
# the login cookie (default True)
# You should use these options&#39; defaults for production applications!
app.config[&#39;FAS_BASE_URL&#39;] = &#39;https://fakefas.fedoraproject.org/accounts/&#39;
app.config[&#39;FAS_CHECK_CERT&#39;] = False
app.config[&#39;FAS_FLASK_COOKIE_REQUIRES_HTTPS&#39;] = False

# A basic login form
class LoginForm(wtf.Form):
 username = wtf.TextField(&#39;Username&#39;, [wtf.validators.Required()])
 password = wtf.PasswordField(&#39;Password&#39;, [wtf.validators.Required()])

# Inline templates keep this test application all in one file. Don&#39;t do this in
# a real application. Please.
TEMPLATE_START = &quot;&quot;&quot;
&lt;h1&gt;Flask-FAS test app&lt;/h1&gt;
{% if g.fas_user %}
 &lt;p&gt;Hello, {{ g.fas_user.username }} &amp;mdash;
 &lt;a href=&quot;{{ url_for(&quot;logout&quot;) }}&quot;&gt;Log out&lt;/a&gt;
{% else %}
 &lt;p&gt;You are not logged in &amp;mdash;
 &lt;a href=&quot;{{ url_for(&quot;auth_login&quot;, next=request.url) + &#39;&#39; }}&quot;&gt;Log in&lt;/a&gt;
{% endif %}
&amp;mdash; &lt;a href=&quot;{{ url_for(&quot;index&quot;) }}&quot;&gt;Main page&lt;/a&gt;&lt;/p&gt;
&quot;&quot;&quot;

@app.route(&#39;/&#39;)
def index():
 data = TEMPLATE_START
 data += &#39;&lt;p&gt;&lt;a href=&quot;%s&quot;&gt;Check if you are cla+1&lt;/a&gt;&lt;/p&gt;&#39; % \
 flask.url_for(&#39;claplusone&#39;)
 data += &#39;&lt;p&gt;&lt;a href=&quot;%s&quot;&gt;See a secret message (requires login)&lt;/a&gt;&lt;/p&gt;&#39; % \
 flask.url_for(&#39;secret&#39;)
 return flask.render_template_string(data)

@app.route(&#39;/login&#39;, methods=[&#39;GET&#39;, &#39;POST&#39;])
def auth_login():
 # Your application should probably do some checking to make sure the URL
 # given in the next request argument is sane. (For example, having next set
 # to the login page will cause a redirect loop.) Some more information:
 # http://flask.pocoo.org/snippets/62/
 if &#39;next&#39; in flask.request.args:
 next_url = flask.request.args[&#39;next&#39;]
 else:
 next_url = flask.url_for(&#39;index&#39;)
 # If user is already logged in, return them to where they were last
 if flask.g.fas_user:
 return flask.redirect(next_url)
 # Init login form
 form = LoginForm()
 # Init template
 data = TEMPLATE_START
 data += (&#39;&lt;p&gt;Log into the &lt;a href=&quot;{{ config.FAS_BASE_URL }}&quot;&gt;&#39;
 &#39;Fedora Accounts System&lt;/a&gt;:&#39;)
 # If this is POST, process the form
 if form.validate_on_submit():
 if fas.login(form.username.data, form.password.data):
 # Login successful, return
 return flask.redirect(next_url)
 else:
 # Login unsuccessful
 data += &#39;&lt;p style=&quot;color:red&quot;&gt;Invalid login&lt;/p&gt;&#39;
 data += &quot;&quot;&quot;
&lt;form action=&quot;&quot; method=&quot;POST&quot;&gt;
{% for field in [form.username, form.password] %}
 &lt;p&gt;{{ field.label }}: {{ field|safe }}&lt;/p&gt;
 {% if field.errors %}
 &lt;ul style=&quot;color:red&quot;&gt;
 {% for error in field.errors %}
 &lt;li&gt;{{ error }}&lt;/li&gt;
 {% endfor %}
 &lt;/ul&gt;
 {% endif %}
{% endfor %}
&lt;input type=&quot;submit&quot; value=&quot;Log in&quot;&gt;
{{ form.csrf_token }}
&lt;/form&gt;&quot;&quot;&quot;
 return flask.render_template_string(data, form=form)

@app.route(&#39;/logout&#39;)
def logout():
 if flask.g.fas_user:
 fas.logout()
 return flask.redirect(flask.url_for(&#39;index&#39;))

# This demonstrates the use of the fas_login_required decorator. The
# secret message can only be viewed by those who are logged in.
@app.route(&#39;/secret&#39;)
@fas_login_required
def secret():
 data = TEMPLATE_START + &#39;&lt;p&gt;Be sure to drink your Ovaltine&lt;/p&gt;&#39;
 return flask.render_template_string(data)

# This demonstrates checking for group membership inside of a function.
# The flask_fas adapter also provides a cla_plus_one_required decorator that
# can restrict a url so that you can only access it from an account that has
# cla +1.
@app.route(&#39;/claplusone&#39;)
def claplusone():
 data = TEMPLATE_START
 if not flask.g.fas_user:
 # Not logged in
 return flask.render_template_string(data +
 &#39;&lt;p&gt;You must log in to check your cla +1 status&lt;/p&gt;&#39;)
 non_cla_groups = [x.name for x in flask.g.fas_user.approved_memberships
 if x.group_type != &#39;cla&#39;]
 if len(non_cla_groups) &gt; 0:
 data += &#39;&lt;p&gt;Your account is cla+1.&lt;/p&gt;&#39;
 else:
 data += &#39;&lt;p&gt;Your account is &lt;em&gt;not&lt;/em&gt; cla+1.&lt;/p&gt;&#39;
 return flask.render_template_string(data)

if __name__ == &#39;__main__&#39;:
 app.run(debug=True)
</pre></div>
</div>
</div>
</div>

</div>
 </div>
 </div>
 <div class="sphinxsidebar">
 <div class="sphinxsidebarwrapper">
 <h3><a href="index.html">Table Of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">FAS Flask Auth Plugin</a><ul>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
<li><a class="reference internal" href="#sample-application">Sample Application</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="django.html"
 title="previous chapter">Fedora Django Authentication Backend</a>
 <h4>Next topic</h4>
 <a href="flask_fas_openid.html"
 title="next chapter">FAS Flask OpenID Auth Plugin</a>
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="_sources/flask_fas.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
<div id="searchbox" style="display: none">
 <h3>Quick search</h3>
 <form class="search" action="search.html" method="get">
 <input type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 
 Enter search terms or a module, class or function name.
 
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="flask_fas_openid.html" title="FAS Flask OpenID Auth Plugin"
 >next</a> |</li>
 <li class="right" >
 <a href="django.html" title="Fedora Django Authentication Backend"
 >previous</a> |</li>
 <li><a href="index.html">python-fedora 0.10.0 documentation</a> &raquo;</li>
 <li><a href="auth.html" >Authentication to FAS</a> &raquo;</li> 
 </ul>
 </div>
 <div class="footer">
 &copy; Copyright 2007-2018 Red Hat, Inc..
 Last updated on Feb 01, 2018.
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
 </div>
 </body>
</html>