/usr/lib/python3/dist-packages/hug/authentication.py is in python3-hug 2.3.0-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | """hug/authentication.py
Provides the basic built-in authentication helper functions
Copyright (C) 2016 Timothy Edmund Crosley
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
"""
from __future__ import absolute_import
import base64
import binascii
from falcon import HTTPUnauthorized
def authenticator(function, challenges=()):
"""Wraps authentication logic, verify_user through to the authentication function.
The verify_user function passed in should accept an API key and return a user object to
store in the request context if authentication succeeded.
"""
challenges = challenges or ('{} realm="simple"'.format(function.__name__), )
def wrapper(verify_user):
def authenticate(request, response, **kwargs):
result = function(request, response, verify_user, **kwargs)
if result is None:
raise HTTPUnauthorized('Authentication Required',
'Please provide valid {0} credentials'.format(function.__doc__.splitlines()[0]),
challenges=challenges)
if result is False:
raise HTTPUnauthorized('Invalid Authentication',
'Provided {0} credentials were invalid'.format(function.__doc__.splitlines()[0]),
challenges=challenges)
request.context['user'] = result
return True
authenticate.__doc__ = function.__doc__
return authenticate
return wrapper
@authenticator
def basic(request, response, verify_user, realm='simple', **kwargs):
"""Basic HTTP Authentication"""
http_auth = request.auth
response.set_header('WWW-Authenticate', 'Basic')
if http_auth is None:
return
if isinstance(http_auth, bytes):
http_auth = http_auth.decode('utf8')
try:
auth_type, user_and_key = http_auth.split(' ', 1)
except ValueError:
raise HTTPUnauthorized('Authentication Error',
'Authentication header is improperly formed',
challenges=('Basic realm="{}"'.format(realm), ))
if auth_type.lower() == 'basic':
try:
user_id, key = base64.decodebytes(bytes(user_and_key.strip(), 'utf8')).decode('utf8').split(':', 1)
user = verify_user(user_id, key)
if user:
response.set_header('WWW-Authenticate', '')
return user
except (binascii.Error, ValueError):
raise HTTPUnauthorized('Authentication Error',
'Unable to determine user and password with provided encoding',
challenges=('Basic realm="{}"'.format(realm), ))
return False
@authenticator
def api_key(request, response, verify_user, **kwargs):
"""API Key Header Authentication
The verify_user function passed in to ths authenticator shall receive an
API key as input, and return a user object to store in the request context
if the request was successful.
"""
api_key = request.get_header('X-Api-Key')
if api_key:
user = verify_user(api_key)
if user:
return user
else:
return False
else:
return None
@authenticator
def token(request, response, verify_user, **kwargs):
"""Token verification
Checks for the Authorization header and verifies using the verify_user function
"""
token = request.get_header('Authorization')
if token:
verified_token = verify_user(token)
if verified_token:
return verified_token
else:
return False
return None
def verify(user, password):
"""Returns a simple verification callback that simply verifies that the users and password match that provided"""
def verify_user(user_name, user_password):
if user_name == user and user_password == password:
return user_name
return False
return verify_user
|