Simple authentication, authorization and parameters for Flask, emphasizing configurability
Project description
Flask Simple Auth
Simple authentication, authorization, parameter checks and utils
for Flask, controled from
Flask configuration and the extended route
decorator.
Example
The application code below performs authentication, authorization and
parameter type checks triggered by the extended route
decorator,
or per-method shortcut decorators (get
, patch
, post
…).
There is no clue in the source about what kind of authentication is used,
which is the point: authentication is managed in the configuration,
not in the application code.
The authorization rule is declared explicitely on each function with the
mandatory authorize
parameter.
Path and HTTP/JSON parameters are type checked and converted automatically
based on type annotations.
Basically, you just have to implement a type-annotated Python function and
most of the crust is managed by Flask and FlaskSimpleAuth.
from FlaskSimpleAuth import Flask
app = Flask("demo")
app.config.from_envvar("DEMO_CONFIG")
# users belonging to the "patcher" group can patch "whatever/*"
# the function gets 3 typed parameters: one integer coming from the path (id)
# and the remaining two ("some", "stuff") are coming from HTTP or JSON request
# parameters. "some" is mandatory, "stuff" is optional because it has a default.
# the declared parameter typing is inforced.
@app.patch("/whatever/<id>", authorize="patcher")
def patch_whatever(id: int, some: int, stuff: str = "wow"):
# ok to do it, with parameters "id", "some" & "stuff"
return "", 204
Authentication is manage from the application flask configuration
with FSA_*
(Flask simple authentication) directives:
FSA_AUTH = "httpd" # inherit web-serveur authentication
# or others schemes such as: basic, digest, token (eg jwt), param…
# hooks must be provided for retrieving user's passwords and
# checking whether a user belongs to a group, if these features are used.
If the authorize
argument is not supplied, the security first approach
results in the route to be forbidden (403).
Various aspects of the implemented schemes can be configured with other directives, with reasonable defaults provided so that not much is really needed beyond choosing the authentication scheme.
Look at the demo application for a simple full-featured application.
Documentation
This module helps managing authentication, authorizations and parameters in a Flask REST application back-end.
Features
The module provides a wrapper around the Flask
class which
extends its capabilities for managing authentication, authorization and
parameters.
This is intended for a REST API implementation serving a remote client application through HTTP methods called on a path, with HTTP or JSON parameters passed in and a JSON result is returned: this help implement an authenticated function call over HTTP.
Note that web-oriented flask authentication modules are not really relevant in the REST API context, where the server does not care about presenting login forms for instance. However, some provisions are made so that it can also be used for a web application: CORS, login page redirection…
Authentication is available through the get_user
function.
It is performed on demand when the function is called, automatically when
checking for permissions in a per-role authorization model, or possibly
forced for all/most paths.
The module implements inheriting the web-server authentication,
password authentication (HTTP Basic, or HTTP/JSON parameters),
authentication tokens (custom or JWT passed in headers or as a
parameter), and a fake authentication scheme useful for local application
testing.
It allows to have a login route to generate authentication tokens.
For registration, support functions allow to hash new passwords consistently
with password checks.
Authorizations are managed by declaring permissions
on a route (eg a role name, or an object access), and relies on a supplied
functions to check whether a user has this role or can access an object.
An additional feature is that the application aborts requests on routes
for which there is no explicit authorization declarations, allowing to
catch forgotten requirements (see FSA_CHECK
below).
Parameters expected in the request can be declared, their
presence and type checked, and they are added automatically as named parameters
to route functions, skipping the burden of checking them in typical REST functions.
In practice, importing Flask's request
global variable is not necessary anymore.
Utils include the convenient Reference
class which allows to
share for import an unitialized variable and CORS handling.
Install
Use pip install FlaskSimpleAuth
to install the module, or whatever
other installation method you prefer.
Depending on options, the following modules should be installed:
- passlib for password management.
- cachetools and CacheToolsUtils for caching.
- bcrypt for password hashing (default algorithm).
- PyJWT for JSON Web Token (JWT).
- cryptography for pubkey-signed JWT.
- Flask HTTPAuth for
http-*
authentication options. - Flask CORS for CORS handling.
Initialization
The module is simply initialize by calling its Flask
constructor
and providing a configuration through FSA_*
directives, or possibly
by calling some methods to register helper functions.
- a function to retrieve the password hash from the user name.
- a function which tells whether a user is in a group or role.
from FlaskSimpleAuth import Flask
app = Flask("acme")
app.config.from_envvar("ACME_CONFIG")
# register some hooks
# return password hash if any (see with FSA_GET_USER_PASS)
@app.get_user_pass
def get_user_pass(user):
return …
# return whether user is in group (see with FSA_USER_IN_GROUP)
@app.user_in_group
def user_in_group(user, group):
return …
Once initialized app
is a standard Flask object with some additions:
route
decorator, an extended version of Flask's own with anauthorize
parameter and transparent management of request parameters.- per-method shortcut decorators
post
,get
,put
,patch
anddelete
which support the same extensions. user_in_group
andget_user_pass
methods/decorators to register helper functions.get_user
to extract the authenticated user or raise anFSAException
.current_user
to get the authenticated user if any, orNone
.hash_password
andcheck_password
to hash or check a password.create_token
to compute a new authentication token for the current user.clear_caches
to clear internal process caches.register_object_perms
function to register a per-object permission helper function. or theobject_perms
decorator.
Alternatively, it is possible but not recommended to use the flask extensions
model, in which case the FlaskSimpleAuth
object must be instanciated and
routes must be created using this object:
from flask import Flask
app = Flask("demo")
app.config.from_envvar("DEMO_CONFIG")
from FlaskSimpleAuth import FlaskSimpleAuth
fsa = FlaskSimpleAuth(app)
# imaginary blueprint registration on the fsa object:
from DemoAdmin import abp
fsa.register_blueprint(abp, url_path="/admin")
# define a route with an optional paramater "flt"
@fsa.get("/what", authorize="ALL")
def get_what(flt: str = None):
…
Authentication
Three directives impact how and when authentication is performed.
The main configuration directive is FSA_AUTH
which governs authentication
methods used by the get_user
function, as described in the following sections.
-
FSA_AUTH
governs the how:none
,httpd
,basic
,param
,password
,token
… as described in details in the next sections. Default ishttpd
.If a non-token single scheme is provided, authentication will be
token
followed by the provided scheme, i.e.token
are tried first anyway.To take full control of authentication scheme, provide an ordered list. Note that it does not always make much sense to mix some schemes, e.g. basic and digest password storage assumptions are distinct and should not be merged. Also, only one HTTPAuth-based scheme can be active at a time.
-
FSA_MODE
tells when to attempt authentication.-
With
always
, authentication is performed in a before request hook. Once in a route function,get_user
will always return the authenticated user and cannot fail. -
With
lazy
, it is performed lazily when needed by an authorization or when calling theget_user
function. -
With
all
, it is always performed in the hook, which may skip some path because ofFSA_SKIP_PATH
, and may be re-attempted lazily for path that were skipped.
On authentication failures 401 is returned. Default is
lazy
. -
-
FSA_SKIP_PATH
is a list of regular expression patterns which are matched against the request path for skipping systematic authentication when inalways
mode. Default is empty, i.e. authentication is applied for all paths.
The authentication scheme attempted on a route can be altered with the
auth
parameter added to the route
decorator.
This may be used to restrict the authentication scheme to a subset
if those configured globally, and may or may not work otherwise
depending on module internals.
This feature is best avoided but in very particular cases because
it counters a goal of this module which is to remove authentication
considerations from the code and put them in the configuration only.
Authentication Schemes
The available authentication schemes are:
-
none
Use to disactivate authentication.
-
httpd
Inherit web server supplied authentication through
request.remote_user
. This is the default.There are plenty authentication schemes available in a web server such as Apache or Nginx, all of which probably more efficiently implemented than this python code, so it should be the preferred option. However, it could require significant configuration effort compared to the application-side approach.
-
basic
HTTP Basic password authentication, which rely on the
Authorization
HTTP header in the request. DirectiveFSA_REALM
provides the authentication realm.See also Password Management below for how the password is retrieved and checked.
-
http-basic
Same as previous based on flask-HTTPAuth.
Directive
FSA_REALM
provides the authentication realm. DirectiveFSA_HTTP_AUTH_OPTS
allow to pass additional options to the HTTPAuth authentication class. -
param
HTTP or JSON parameter for password authentication. User name and password are passed as request parameters.
The following configuration directives are available:
FSA_PARAM_USER
parameter name for the user name. Default isUSER
.FSA_PARAM_PASS
parameter name for the password. Default isPASS
.
See also Password Management below for the password is retrieved and checked.
-
password
Tries
basic
thenparam
authentication. -
http-digest
ordigest
HTTP Digest authentication based on flask-HTTPAuth.
Note that the implementation relies on sessions, which may require the
SECRET_KEY
option to be set to something. The documentation states that server-side sessions are needed because otherwise the nonce and opaque parameters could be reused, which may be a security issue under some conditions. I'm unsure about that, but I agree that client-side cookie sessions are strange things best avoided if possible.Directive
FSA_REALM
provides the authentication realm. DirectiveFSA_HTTP_AUTH_OPTS
allow to pass additional options to the HTTPAuth authentication class, such asuse_ha1_pw
, as a dictionary.See also Password Management below for how the password is retrieved and checked. Note that password management is different for digest authentication because the simple hash of the password or the password itself is needed for the verification.
-
token
Only rely on signed tokens for authentication. A token certifies that a user is authenticated in a realm up to some time limit. The token is authenticated by a signature which is usually the hash of the payload (realm, user and limit) and a secret hold by the server.
There are two token types chosen with the
FSA_TOKEN_TYPE
configuration directive:fsa
is a simple compact readable custom format, andjwt
RFC 7519 standard based on PyJWT implementation.The
fsa
token syntax is:<realm>:<user>:<limit>:<signature>
, for instance:comics:calvin:20380119031407:4ee89cd4cc7afe0a86b26bdce6d11126
. The time limit is a simple UTC timestamp YYYYMMDDHHmmSS that can be checked easily by the application client. Compared tojwt
tokens, they are easy to interpret and compare manually, no decoding is involved.The following configuration directives are available:
FSA_TOKEN_TYPE
type of token, either fsa, jwt orNone
to disable. Default is fsa.FSA_TOKEN_CARRIER
how to transport the token: bearer (Authorization
HTTP header), param, cookie or header. Default is bearer.FKA_TOKEN_NAME
name of parameter or cookie holding the token, or bearer scheme, or header name. Default isauth
for param and cookie carrier,Bearer
for HTTP Authentication header (bearer carrier),Auth
for header carrier.FSA_REALM
realm of authentication for token, basic or digest. Default is the simplified lower case application name. For jwt, this is translated as the audience.FSA_TOKEN_SECRET
secret string used for validating tokens. Default is a system-generated random string containing 256 bits. This default will only work with itself, as it is not shared across server instances or processes.FSA_TOKEN_SIGN
secret string used for signing tokens, if different from previous secret. This is only relevant for public-key jwt schemes (R…
,E…
,P…
). Default is to use the previous secret.FSA_TOKEN_DELAY
number of minutes of token validity. Default is 60 minutes.FSA_TOKEN_GRACE
number of minutes of grace time for token validity. Default is 0 minutes.FSA_TOKEN_ALGO
algorithm used to sign the token. Default isblake2s
forfsa
andHS256
for jwt.FSA_TOKEN_LENGTH
number of hash bytes kept for token signature. Default is 16 forfsa
. The directive is ignored forjwt
.
Function
create_token(user)
creates a token for the user depending on the current scheme. Ifuser
is not given, the current user is taken.Token authentication is always attempted unless the secret is empty. Setting
FSA_AUTH
totoken
results in only token authentication to be used.Token authentication is usually much faster than password verification because password checks are designed to be slow so as to hinder password cracking, whereas token authentication relies on simple hashing for its security. Another benefit of token is that it avoids sending passwords over and over. The rational option is to use a password scheme to retrieve a token and then to use it till it expires.
Token expiration can be understood as a kind of automatic logout, which suggests to choose the delay with some care depending on the use case.
When the token is carried as a cookie, it is automatically updated when 25% of the delay remains, if possible.
Internally jwt token checks are cached so that even with slow public-key schemes the performance impact should be low.
-
http-token
Token scheme based on flask-HTTPAuth. Carrier is bearer or header.
Directive
FSA_HTTP_AUTH_OPTS
allow to pass additional options to the HTTPAuth authentication class, such asheader
, as a dictionary. -
fake
Trust a parameter for authentication claims. Only for local tests, obviously. This is enforced.
FSA_FAKE_LOGIN
name of parameter holding the user name. Default isLOGIN
.
Password Management
Password authentication is performed for the following authentication
schemes: param
, basic
, http-basic
, http-digest
, digest
, password
.
For checking passwords the password (salted hash) must be retrieved through
get_user_pass(user)
.
This function must be provided by the application when the module is initialized.
Because this function is cached by default, caches must be reset when users
are changed by calling clear_caches
.
The following configuration directives are available to configure
passlib
password checks:
FSA_PASSWORD_SCHEME
password scheme to use for passwords. Default isbcrypt
. See passlib documentation for available options. Set toNone
to disable password checking.FSA_PASSWORD_OPTS
relevant options (forpasslib.CryptContext
). Default is{'bcrypt__default_rounds': 4, 'bcrypt__default_ident': '2y'}
.
Beware that modern password checking is often pretty expensive in order to thwart password cracking if the hashed passwords are leaked, so that you do not want to have to use that on every request in real life (eg hundreds milliseconds for passlib bcrypt 12 rounds). The above defaults result in manageable password checks of a few milliseconds. Consider using tokens to reduce the authentication load on each request.
For digest
authentication, the password must be either in plaintext or a
simple MD5 hash (RFC 2617).
The authentication setup must be consistent (set use_ha1_pw
as True for the
later).
As retrieving the stored information is enough to steal the password (plaintext)
or at least impersonate a user (hash), consider avoiding digest
altogether.
HTTP Digest Authentication only makes sense for unencrypted connexions, which
are a bad practice anyway.
It is just provided here for completeness.
Function hash_password(pass)
computes the password salted digest compatible
with the current configuration, and may be used for setting or resetting
passwords. An opened route for user registration with mandatory parameters
could look like that:
@app.post("/register", authorize="ANY")
def post_register(user: str, password: str):
if user_already_exists(user):
return f"cannot create {user}", 409
add_new_user_with_hashed_pass(user, app.hash_password(password))
return "", 201
Because password checks are usually expensive, it is advisable to switch
to token
authentication. A token can be created on a path authenticated
by a password method:
# token creation route for all registered users
@app.get("/login", authorize="ALL")
def get_login():
return jsonify(app.create_token()), 200
The client application will return the token as a parameter or in headers for authenticating later requests, till it expires.
Authorization
Authorizations are declared with the authorize
parameter to
the route
decorator (and its per-method shortcuts).
The modules supports two permission model:
- a group-oriented model
- an object-oriented model
The parameter accepts a list of str
and int
for groups, and of
tuple
for object permissions. If a scalar is provided, it is assumed
to be equivalent to a list of one element.
When multiple authorizations are provided they are cumulative.
Group Authorizations
A group or role is identified as an integer or a string.
The user_in_group(user, group)
function is called to check whether the
authenticated user belongs to a given group.
Because this function is cached by default, caches should be reset when roles
are changed by calling clear_caches
.
@app.get("/admin-only", authorize="ADMIN")
def get_admin_only():
# only authenticated "ADMIN" users can get here!
…
There are three special values that can be passed to the authorize
decorator:
ANY
declares that no authentication is needed on that route.ALL
declares that all authenticated user can access this route, without group checks.NONE
returns a 403 on all access. It can be used to close a route temporarily. This is the default.
@app.get("/closed", authorize=NONE)
def get_closed():
# nobody can get here
@app.get("/authenticated", authorize=ALL)
def get_authenticated():
# ALL authenticated users can get here
@app.get("/opened", authorize=ANY)
def get_opened():
# ANYone can get here, no authentication is required
Note that this simplistic model does is not enough for non-trivial applications, where permissions on objects often depend on the object owner. For those, careful per-object and pre-operation authorization will still be needed.
Object Authorizations
Non trivial application have access permissions which depend on the data stored by the application. For instance, a user may alter a data because they own it, or access a data because they are friends of the owner.
In order to implement this model, the authorize
decorator parameter can
hold a tuple (domain, variable, mode)
which designates a permission domain
(eg a table or object or concept name in the application), the name
a variable in the request (path or HTTP or JSON parameters), and the
operation or level of access necessary to access this route.
@app.get("/message/<mid>", authorize=("msg", "mid", "read"))
def get_message_mid(mid: int):
return …
The system will check whether the current user can access the mid message in read mode by calling a per-domain user-supplied function:
@app.object_perms("msg")
def can_access_message(user: str, mid: int, mode: str) -> bool:
# does user can access message mid for operation mode?
# None: 404, False: 403, True: access is granted
return …
# also: app.register_object_perms("msg", can_access_message)
If variable
is not supplied, the first parameter of the route function
is taken.
If mode
is not supplied, None is passed to the check function.
Parameters
Request parameters (HTTP or JSON) are translated automatically to named function parameters, by relying on function type annotations. The decorator guesses whether parameters are mandatory based on provided default values, i.e. they are optional when a default is provided.
@app.get("/something/<id>", authorize=…)
def get_something_id(id: int, when: date, what: str = "nothing"):
# `id` is an integer path-parameter
# `when` is a mandatory date HTTP or JSON parameter
# `what` is an optional string HTTP or JSON parameter
return …
Request parameter string values are actually converted to the target type.
For int
, base syntax is accepted for HTTP/JSON parameters, i.e. 0x11
,
0o21
, 0b10001
and 17
all mean decimal 17.
For bool
, False is an empty string, 0
, False
or F
, otherwise
the value is True.
Type path
is a special str
type which allow to trigger accepting
any path on a route.
If one parameter is a dict of keyword arguments, all request parameters are provided into it, as shown below:
@app.put("/awesome", authorize="ALL")
def put_awesome(**kwargs):
…
Custom classes can be used as path and HTTP parameter types, provided that the constructor accepts a string to convert the parameter value to the expected type.
class EmailAddr:
def __init__(self, addr: str):
self._addr = addr
@app.get("/mail/<addr>", authorize="ALL")
def get_mail_addr(addr: EmailAddr):
…
If the constructor does not match, a custom function can be provided
with the register_cast
function or the cast
decorator and will be
called automatically to convert parameters:
class House:
…
@app.cast(House)
def strToHouse(s: str) -> House:
return …
# or: app.register_cast(House, strToHouse)
@app.get("/house/<h>", authorize="ANY")
def get_house_h(h: House)
…
Finally, python parameter names can be prepended with a _
,
which is ignored when translating HTTP parameters.
This allows to use python keywords as parameter names, such
as pass
or def
.
@app.put("/user/<pass>", authorize="ALL")
def put_user_pass(_pass: str, _def: str, _import: str):
…
Utils
Utilities include the Reference
generic object wrapper class and
miscellaneous configuration directives which cover security,
caching and CORS.
Reference
Object Wrapper
This class implements a generic share-able global variable which can be
used by modules (eg app, blueprints…) with its initialization differed.
Under the hood, most methods calls are forwarded to the object stored
inside the wrapper, so that the Reference object mostly behaves like
the wrapped object. The wrapped object can be reset at will with set
.
The set
method name can be changed with the set_name
initialization
parameter.
# file Shared.py
from FlaskSimpleAuth import Reference
stuff = Reference()
def init_app(**conf):
stuff.set(…)
Then in a blueprint:
# file SubStuff.py
from FlaskSimpleAuth import Blueprint
from Shared import stuff
sub = Blueprint(…)
@sub.get("/stuff", authorize="ALL"):
def get_stuff():
return str(stuff), 200
Then in the app itself:
# file App.py
from FlaskSimpleAuth import Flask
app = Flask(__name__)
from SubStuff import sub
app.register_blueprint(sub, url_prefix="/sub")
# deferred "stuff" initialization
import Shared
Shared.init_app(…)
…
Miscellaneous Configuration Directives
Some directives govern various details for this extension internal working.
-
FSA_SECURE
only allows secured requests on non-local connections. Default is True -
FSA_CHECK
tells whether to generate a 500 internal error if a route is missing an explicit authorization check. Default is True. -
FSA_SERVER_ERROR
controls the status code returned on the module internal errors, to help distinguish these from other internal errors which may occur. Default is 500. -
FSA_NOT_FOUND_ERROR
controls the status code returned when a permission checks returns None. Default is 404. -
FSA_DEBUG
set module in debug mode, generating excessive traces… Default is False. -
FSA_LOGGING_LEVEL
adjust module internal logging level. Default is None.
Some control is available about caching features used for user authentication (user password access and token validations) and authorization (group and per-object permissions):
-
FSA_CACHE
controls the type of cache to use, set to None to disallow caches. Values for standardcachetools
cache classes arettl
,lru
,lfu
,mru
,fifo
,rr
plusdict
. MemCached is supported by setting it tomemcached
, and Redis withredis
. -
FSA_CACHE_OPTS
sets internal cache options with a dictionary. This must contain the expected connection parameters forpymemcache.Client
and forredis.Redis
redis, for instance. Forredis
andttl
, an expiration ttl of 10 minutes is used and can be overwritten by providing attl
parameter. -
FSA_CACHE_SIZE
controls size of internalcachetools
caches. Default is 262144. None means unbounded, more or less.
Web-application oriented features:
-
FSA_401_REDIRECT
url to redirect to on 401. Default is None. This can be used for a web application login page. -
FSA_URL_NAME
name of parameter for the target URL after a successful login. Default isURL
if redirect is activated, else None. Currently, the login page should use this parameter to redirect to when ok. -
FSA_CORS
andFSA_CORS_OPTS
control CORS (Cross Origin Resource Sharing) settings.CORS is a security feature implemented by web browsers to check whether a server accepts requests from a given origin (i.e. from JavaScript code provided by some domain).
CORS request handling is enabled by setting
FSA_CORS
to True which allows requests from any origin. Default is False. Additional options are controled withFSA_CORS_OPTS
. The implementation is delegated to theflask_cors
Flask extension which must be available if the feature is enabled.
License
This software is public domain. All software has bug, this is software, hence… Beware that you may lose your hairs or your friends because of it. If you like it, feel free to send a postcard to the author.
Versions
Sources are available on GitHub and packaged on PyPI. Software license is public domain.
5.2.0 in 2022-01-31
Add convenient cast
decorator to register a cast directly.
Add FSA_DEBUG
and FSA_NOT_FOUND_ERROR
configuration directives.
5.1.0 on 2022-01-30
Add default variable name to object permission checks.
Add convenient object_perms
decorator.
Return 404 when checking perm on an unknown object.
Warn on overriden hooks.
Improve tests.
5.0.0 on 2022-01-29
Add a per-object permission scheme to the authorize
decorator parameter.
Add support for Redis and MemCached
distributed caches.
Move cache support to CacheToolsUtils.
4.7.1 on 2022-01-16
Bump version in doc.
4.7.0 on 2022-01-16
Add FSA_SERVER_ERROR
configuration directive to control the server internal
error status code.
Add FSA_SECURE
to check for secure requests, on by default (sorry!).
Drop allparams
and required
route parameters: they are implicit with a dict
of keyword arguments and default values.
Improve documentation.
4.6.3 on 2022-01-12
Improve error messages on internal errors in user functions such as
get_user_pass
, user_in_group
or path functions.
4.6.2 on 2021-12-26
Put back version auto extraction after aiosql
update to 3.4.0.
4.6.1 on 2021-12-24
Minor cleanup.
4.6.0 on 2021-12-19
Fix timezone issues by putting everything explicitely in UTC.
Rework caching: remove CacheOK
class, add FSA_CACHE
and FSA_CACHE_OPTS
to
give more ability to control the type of cache and its behavior.
Use a TTL cache set to 10 minutes by default.
Rename *_OPTIONS
to _OPTS
for consistency and concision.
4.5.1 on 2021-12-12
Ensure that FSA internal exceptions are always translated into HTTP responses.
4.5.0 on 2021-12-12
Add FSA_PASSWORD_LEN
and FSA_PASSWORD_RE
directives to check
for password quality when hashing.
Remove VERSION
and VERSION\_NUM
, replaced with __version__
,
although not from the package resources because of some obscure issue…
4.4.0 on 2021-12-11
Add support for CORS with directives FSA_CORS
and FSA_CORS_OPTIONS
.
4.3.1 on 2021-12-05
Add FSA_TOKEN_RENEWAL
directive to manage automatic renewal of cookie-based
authentication tokens.
Fix version in module.
4.3.0 on 2021-10-14
Rename FSA_TOKEN_REALM
as FSA_REALM
, because it is not token specific.
Make demo work with psycopg 3.
4.2.0 on 2021-09-14
Add register_cast
to provide a cast function for custom types, if the type
itself would not work.
Add VERSION
as a string and VERSION_NUM
as an integer tuple.
Improve documentation.
Allow to use Python keywords as HTTP parameters by prepending the
parameter with a _
.
4.1.0 on 2021-06-12
Add support for per-method decorator shortcuts to Flask
wrapper class.
Add FSA_LOGGING_LEVEL
directive.
Make current_user
attempt an authentication, but not fail on errors.
Check configuration directive names to warn about possible typos or errors.
Warn about some unused directives.
Check get_user_pass
and user_in_group
returned types.
Update documentation.
Add a demo application.
4.0.0 on 2021-06-01
Port to Flask 2.0, working around a regression on request.values
handling.
Add support for Flask 2.0 per-method decorator shortcuts get
, post
, put
,
delete
and patch
.
Rework documentation.
Minor style improvements.
Fix all
authentication mode.
3.1.1 on 2021-05-31
Tell setup that Flask 2.0 is not yet supported.
3.1.0 on 2021-04-17
Defer password manager setup till it is actually needed, so as to avoid
importing passlib
for nothing.
Do not attempt to re-create a token if it is not possible, i.e. when
relying on a third party token provider.
Allow to fully control the list of authentication schemes.
Allow to control the authentication scheme on a route.
Improve test code coverage.
3.0.0 on 2021-04-07
Add FSA_CACHE_SIZE
to control caches.
Merge FSA_ALWAYS
and FSA_LAZY
in a single FSA_MODE
directive
with 3 values: always
, lazy
and all
.
Make ANY
, ALL
and NONE
special groups simple strings as well.
Package as a one file module (again), and add more files to packaging.
2.5.0 on 2021-04-04
Add header carrier for authentication tokens.
Make it work both with internal and HTTPAuth implementations.
Force HTTPAuth implementation on http-token
.
2.4.1 on 2021-03-29
Fix packaging issue… the python file was missing.
Add digest
as a synonymous for http-digest
.
Improve documentation.
2.4.0 on 2021-03-29
Add http-basic
, http-digest
and http-token
authentication schemes based on flask-HTTPAuth.
Add coverage report on tests.
Distribute as a one file python module.
Only simplify realm for fsa tokens.
Renew cookies when they are closing expiration.
2.3.0 on 2021-03-27
Use a fully dynamic method for set
in Reference
.
Add a string
type.
Add caching of get_user_pass
and user_in_group
helpers.
Add clear_caches
method.
Warn on missing authorize
on a route declaration.
Add FSA_TOKEN_CARRIER
to specify how token auth is transfered,
including a new cookie option.
Rename FSA_TYPE
to FSA_AUTH
.
Make create_token
argument optional.
Add WWW-Authenticate
headers when appropriate.
Set Content-Type
to text/plain
on generated responses.
2.2.1 on 2021-03-22
Partial fix for method renaming in Reference
.
2.2.0 on 2021-03-22
Rename _setobj
to set
in Reference
, with an option to rename the method
if needed.
Shorten Reference
class implementation.
Add current_user
to FlaskSimpleAuth
as well.
Add python documentation on class and methods.
Fix Reference
issue when using several references.
2.1.0 on 2021-03-21
Add Reference
any object wrapper class.
Add CacheOK
positive caching decorator.
Add current_user
function.
Add none
authentication type.
Add path
parameter type.
Add more tests.
2.0.0 on 2021-03-16
Make the module as an extension and a full Flask
wrapper.
Advertise only the extended route
decorator in the documentation
(though others are still used internally).
Change passlib bcrypt version to be compatible with Apache httpd.
Allow disabling password checking.
Rename FSA_TOKEN_HASH
as FSA_TOKEN_ALGO
.
Disable tokens by setting their type to None
.
Import Flask session
, redirect
, url_for
, make_response
,
abort
, render_template
, current_app
objects.
Add parameter support for date
, time
and datetime
in iso format.
Allow to use any type as path parameters, not just Flask predefined ones.
Make blueprints work.
Add special path
type for parameters taken from the path.
1.9.0 on 2021-03-10
Add bearer authorization for tokens and make it the default.
Add JWT tokens, both hmac and pubkey variants.
Add 500 generation if a route is missing an authorization declaration.
Add convenient route
decorator.
Add type inference for HTTP/JSON parameters based on default value, when provided.
Add type inference for root path parameters based on function declaration.
1.8.1 on 2021-03-02
Fix typo in distribution configuration file.
1.8.0 on 2021-03-02
Merge autoparams
and parameters
decorators into a single parameters
decorator.
Make it guess optional parameters based on default values.
Fix conversion issues with boolean type parameters.
Enhance integer type to accept other base syntaxes.
Improve documentation to advertise the simple and elegant approach.
Implement decorator with functions instead of a class.
1.7.0 on 2021-03-01
Simplify code.
Add FSA_ALWAYS
configuration directive and move the authentication before request
hook logic inside the module.
Add FSA_SKIP_PATH
to skip authentication for some paths.
Update documentation to reflect this simplified model.
Switch all decorators to functions.
1.6.0 on 2021-02-28
Add autoparams
decorator with required or optional parameters.
Add typed parameters to parameters
decorator.
Make parameters
pass request parameters as named function parameters.
Simplify authorize
decorator syntax and implementation.
Advise authorize
then parameters
or autoparams
decorator order.
Improved documentation.
1.5.0 on 2021-02-27
Flask internal tests with a good coverage.
Switch to setup.cfg
configuration.
Add convenient parameters
decorator.
1.4.0 on 2021-02-23
Add FSA_LAZY
configuration directive.
Simplify code.
Improve warning on short secrets.
Repackage…
1.3.0 on 2021-02-23
Improved documentation. Reduce default token signature length and default token secret. Warn on random or short token secrets.
1.2.0 on 2021-02-22
Add grace time for auth token validity. Some code refactoring.
1.1.0 on 2021-02-22
Add after request module cleanup.
1.0.0 on 2021-02-21
Add authorize
decorator.
Add password
authentication scheme.
Improved documentation.
0.9.0 on 2021-02-21
Initial release in beta.
TODO
- doc advise token + one route basic ; generate 401 Bearer? ok?
- drop
FSA_MODE
andFSA_SKIP_MODE
, implicitely on/empty? - test
FSA_HTTP_AUTH_OPTS
? - add
any
token scheme? - add app.log?
- should cachetools and cachetoolsutils be required?
- multi login? access to other login data (uid, email)?
- debug mode with traces on Resp and Exceptions
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for FlaskSimpleAuth-5.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 953fe2241bcd23738391c3db10d1f1235d468c8fd2cc90a2d5b3322eecafac77 |
|
MD5 | dcfb898cb0695a27ac80490763c2c47f |
|
BLAKE2b-256 | b3fb03a804c887436ac1b0548c445b068186d8391e34bf501cb03745464789f2 |