-
-
Notifications
You must be signed in to change notification settings - Fork 388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added JWT authentication. #537
base: develop
Are you sure you want to change the base?
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -82,3 +82,49 @@ def token_gen_call(username, password): | |
if mockpassword == password and mockusername == username: # This is an example. Don't do that. | ||
return {"token" : jwt.encode({'user': username, 'data': 'mydata'}, secret_key, algorithm='HS256')} | ||
return 'Invalid username and/or password for user: {0}'.format(username) | ||
|
||
# JWT AUTH EXAMPLE # | ||
replace_this = False # Replace this placeholder in your implementation. | ||
config = { | ||
'jwt_secret': 'super-secret-key-please-change', | ||
# Token will expire in 3600 seconds if it is not refreshed and the user will be required to log in again. | ||
'token_expiration_seconds': 3600, | ||
# If a request is made at a time less than 1000 seconds before expiry, a new jwt is sent in the response header. | ||
'token_refresh_seconds': 1000 | ||
} | ||
# Enable authenticated endpoints, example @authenticated.get('/users/me'). | ||
authenticated = hug.http(requires=hug.authentication.json_web_token(hug.authentication.verify_jwt, config['jwt_secret'])) | ||
|
||
# Check the token and issue a new one if it is about to expire (within token_refresh_seconds from expiry). | ||
@hug.response_middleware() | ||
def refresh_jwt(request, response, resource): | ||
authorization = request.get_header('Authorization') | ||
if authorization: | ||
token = hug.authentication.refresh_jwt(authorization, config['token_refresh_seconds'], | ||
config['token_expiration_seconds'], config['jwt_secret']) | ||
if token: | ||
response.set_header('token', token) | ||
|
||
@hug.post('/login') | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ☝️ |
||
def login(request, response, | ||
email: fields.Email(), | ||
password: fields.String() | ||
): | ||
response.status = falcon.HTTP_400 | ||
|
||
user = replace_this # store.get_user_by_email(email) | ||
if not user: | ||
return {'errors': {'Issue': "User not found."}} | ||
elif 'password_hash' in user: | ||
if replace_this: # if bcrypt.checkpw(password.encode('utf8'), user.password_hash): | ||
response.status = falcon.HTTP_201 | ||
token = hug.authentication.new_jwt( | ||
str(user['_id']), | ||
config['token_expiration_seconds'], | ||
config['jwt_secret']) | ||
response.set_header('token', token) | ||
else: | ||
return {'errors': {'Issue': "Password hash mismatch."}} | ||
else: | ||
return {'errors': {'Issue': "Please check your email to complete registration."}} | ||
# END - JWT AUTH EXAMPLE # |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,10 +21,12 @@ | |
""" | ||
from __future__ import absolute_import | ||
|
||
import jwt | ||
import base64 | ||
import binascii | ||
|
||
from falcon import HTTPUnauthorized | ||
from datetime import datetime, timedelta | ||
|
||
|
||
def authenticator(function, challenges=()): | ||
|
@@ -138,3 +140,82 @@ def verify_user(user_name, user_password): | |
return user_name | ||
return False | ||
return verify_user | ||
|
||
# JWT AUTH # | ||
def jwt_authenticator(function, challenges=()): | ||
"""Wraps authentication logic, verify_token through to the authentication function. | ||
|
||
The verify_token function passed in should accept the authorization header and the jwt secret | ||
and return a user id to store in the request context if authentication succeeded. | ||
""" | ||
challenges = challenges or ('{} realm="simple"'.format(function.__name__), ) | ||
|
||
def wrapper(verify_token, jwt_secret): | ||
def authenticate(request, response, **kwargs): | ||
result = function(request, response, verify_token, jwt_secret) | ||
|
||
def jwt_authenticator_name(): | ||
try: | ||
return function.__doc__.splitlines()[0] | ||
except AttributeError: | ||
return function.__name__ | ||
|
||
if result is None: | ||
raise HTTPUnauthorized('Authentication Required', | ||
'Please provide valid {0} credentials'.format(jwt_authenticator_name()), | ||
challenges=challenges) | ||
|
||
if result is False: | ||
raise HTTPUnauthorized('Invalid Authentication', | ||
'Provided {0} credentials were invalid'.format(jwt_authenticator_name()), | ||
challenges=challenges) | ||
|
||
request.context['user_id'] = result | ||
return True | ||
|
||
authenticate.__doc__ = function.__doc__ | ||
return authenticate | ||
|
||
return wrapper | ||
|
||
@jwt_authenticator | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ☝️ 2 new lines between functions |
||
def json_web_token(request, response, verify_token, jwt_secret): | ||
"""JWT verification | ||
|
||
Checks for the Authorization header and verifies it using the verify_token function. | ||
""" | ||
authorization = request.get_header('Authorization') | ||
if authorization: | ||
verified_token = verify_token(authorization, response, jwt_secret) | ||
if verified_token: | ||
return verified_token | ||
else: | ||
return False | ||
return None | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ☝️ |
||
def verify_jwt(authorization, response, jwt_secret): | ||
try: | ||
token = authorization.split(' ')[1] | ||
decoding = jwt.decode(token, jwt_secret, algorithm='HS256') | ||
return decoding['user_id'] | ||
except: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are you catching all exceptions ? 😮 Wouldn't this make things hard to debug ? Isn't there a specific exception that can be caught ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes it would, I'll go figure out which one/s I'm expecting to catch when the token is no longer valid. Thanks. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @OGKevin If an exception is thrown that isn't caught here what happens to the server? Does it continue running and print and error message, or does it break? Where is the code that handles the exceptions that get bubbled up? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @dsmurrell The individual request will die, but the server itself will keep running, if you have an @hug.exception handler you can manage how that exception is handled |
||
return False | ||
|
||
def new_jwt(user_id, token_expiration_seconds, jwt_secret): | ||
return jwt.encode({'user_id': user_id, | ||
'exp': datetime.utcnow() + timedelta(seconds=token_expiration_seconds)}, | ||
jwt_secret, algorithm='HS256').decode("utf-8") | ||
|
||
def refresh_jwt(authorization, token_refresh_seconds, token_expiration_seconds, jwt_secret): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ☝️ |
||
try: | ||
token = authorization.split(' ')[1] | ||
decoding = jwt.decode(token, jwt_secret, algorithm='HS256') | ||
exp = decoding['exp'] | ||
|
||
if datetime.utcnow() > (datetime.utcfromtimestamp(exp) - timedelta(seconds=token_refresh_seconds)): | ||
return jwt.encode({'user_id': decoding['user_id'], | ||
'exp': datetime.utcnow() + timedelta(seconds=token_expiration_seconds)}, | ||
jwt_secret, algorithm='HS256').decode("utf-8") | ||
except: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same as above ☝️ |
||
return None | ||
# END - JWT AUTH # |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Normally there will be 2 new lines between function and classes and one new line between class methods. Please add a new line.