Plugin to make authentication with JWT.
Project description
Plugin que implementa autenticação com JWT para o aplicações Bottle.
Instalação.
É necessário instalar bottle (por se tratar de um plugin para aplicações com bottle) em seguida pode realizar a instalação do plugin.
$ pip install bottle
$ pip install jwt_token
Caso aconteça algum erro com relação a importação de módulo do python-jose ou pycrypto, pode instalar os pacotes abaixo também.
$ pip install python-jose
$ pip install pycrypto
Exemplo de uso simples:
import bottle
from jwt_bottle import JWTPlugin, auth_required, BaseAuth
from peewee import (SqliteDatabase, Model, CharField,
DateField, DoesNotExist) # aqui utilizei o peewee, mas a escolha é livre.
from passlib.hash import pbkdf2_sha512 as hsh # aqui utilizei o passlib, mas a escolha é livre.
from hashlib import md5
db = SqliteDatabase(":memory:")
class Users(Model):
"""Classe usuário.
"""
name = CharField(max_length=50)
last_name = CharField(max_length=50)
email = CharField(max_length=200)
password = CharField(max_length=300)
birthday = DateField()
def gen_hash(self):
_secret = md5("123456".encode()).hexdigest()
_password = md5(self.password.encode()).hexdigest()
self.password = hsh.hash(_secret+_password)
def verify(self, password):
_secret = md5("123456".encode()).hexdigest()
_password = md5(password.encode()).hexdigest()
return hsh.verify(_secret+_password, self.password)
class Meta:
database = db
class Auth(BaseAuth):
"""Classe para autenticação.
Precisa conter um método estático chamado authenticate e outro
chamado get_user. Também deve herdar de jwt_bottle.BaseAuth.
Os parametros de authenticate ficam a critério do método post.
O padrão é receber uma requisição POST enviando dados no formato JSON.
Esses dados são empacotados no argumento kwargs do método authenticate.
para identificar o usuário é necessário realizar a consulta utilizando
um ID.
"""
@staticmethod
def authenticate(*args, **kwargs):
"""Método para autenticação, aqui utilizei uma classe chamada
Users implementada com o ORM peewee e uma simples regra de
autenticação apresentada pelo Eduardo Mendes.
link: https://www.youtube.com/watch?v=ieGA91ExOH0
Returns:
Users: dicionário contendo id para gerar o token.
OBS: é necessário possuir um atributo "id" para gerar o token.
"""
try:
if "email" in kwargs and "password" in kwargs:
user = Users.get(Users.email==kwargs['email'])
if user.verify(kwargs['password']):
return user
return None
except DoesNotExist as err:
return {"erro": f"Usuário {kwargs['email']} não localizado"}
@staticmethod
def get_user(*args, **kwargs):
"""Classe para resgatar usuario autenticado
utilizando a decodificação de um token.
Args:
user_id ([int]): identificador do usuário.
Returns:
Users: retorna usuário autenticado pelo Token.
"""
try:
user = Users.get_by_id(kwargs["id"])
if user:
return user
return None
except DoesNotExist as err:
return {}
app = bottle.Bottle()
configs = [
{'model': Auth, 'endpoint': '/auth', 'auth_name': "auth", 'refresh_name': 'refresh'}
]
"""
Sobre configs:
Trata-se de uma lista de dicionários que contém informações para construção da rota e mecânica entre um request e uma autenticação.
É necessário conter:
model -> Objeto utilizado para autenticação, no nosso caso a classe Auth.
endpoint -> endereçamento da rota de autenticação.
auth_name -> trada-se do nome que será dado a função que lidará com processo de montagem e geração do token, caso utilize mais de 1 item dentro de config lembrar que auth name deve ser diferente para cada item.
refresh_name -> trada-se do nome que será dado a função que lidará com processo de atualização e geração de novo token, caso utilize mais de 1 item dentro de config lembrar que refresh name deve ser diferente para cada item.
"""
jwt = JWTPlugin("abcde", configs=configs, payload=['id', 'email', 'name'])
"""
Atributo payload:
uma lista de parametros na qual a classe de controle (neste exemplo, class User) possuirá e deverão ser inclusos no payload, lembre-se de nunca incluír dados sensíveis ou protegidos, como documentos ou senhas.
"""
app.install(jwt)
@auth_required
@app.get("/user")
def index(user):
return f"Usuario: {user.name}"
if __name__ == "__main__":
Users.create_table()
user = Users(name="Afonso", last_name="Medeiros", email="afonso@afonso.com", password="123456", birthday="2020-01-01")
user.gen_hash()
user.save()
app.run(debug=True, reloader=True)
Teste efetuado utilizando httpie, para instalar basta executar pip install httpie
# /auth é o endpoint padrão para autenticar.
$ http POST http://127.0.0.1:8080/auth email=afonso@afonso.com password=123456
HTTP/1.0 200 OK
Content-Length: 128
Content-Type: application/json
Date: Sun, 12 Jul 2020 03:59:19 GMT
Server: WSGIServer/0.2 CPython/3.8.2
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXhwIjoxNTk0NTI5OTU5fQ.1hmo_Fkg7-OKs0VDDil6dUnDv5FvmIkIYAjl6nzewwY"
}
$ http http://127.0.0.1:8080/user Authorization:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXhwIjoxNTk0NTI5OTU5fQ.1hmo_Fkg7-OKs0VDDil6dUnDv5FvmIkIYAjl6nzewwY
HTTP/1.0 200 OK
Content-Length: 15
Content-Type: text/html; charset=UTF-8
Date: Sun, 12 Jul 2020 04:01:09 GMT
Server: WSGIServer/0.2 CPython/3.8.2
Usuario: Afonso
É necessário implementar uma classe para a autenticação do usuário, essa classe vai carregar as regras de autenticação de cada aplicação, no caso do exemplo Criei uma classe Auth que seguindo a regra implementa dois métodos estáticos authenticate e get_user. Os métodos podem receber qualquer parametro para autenticação o que flexibiliza como realizar o POST com os dados do usuário e recuperar estes dados.
O método authenticate deve retornar um objeto que possua como atributos os itens passados como payloads, caso nenhum payload seja passado será feita a tentativa de utilizar o atributo id para gerar o token, caso a classe também não possua um atributo id uma exceção será levantada.
Com a mudança feita não é mais obrigatório o uso de uma classe peewee Model, agora pode utilizar o ORM que quiser e implementar sua própria forma de authenticar um usuário.
Exemplo com duas formas de autenticação:
import bottle
from jwt_bottle import JWTPlugin, auth_required, BaseAuth
from peewee import (SqliteDatabase, Model, CharField,
DateField, DoesNotExist) # aqui utilizei o peewee, mas a escolha é livre.
from passlib.hash import pbkdf2_sha512 as hsh # aqui utilizei o passlib, mas a escolha é livre.
from hashlib import md5
db = SqliteDatabase(":memory:")
class Users(Model):
"""Classe usuário.
"""
name = CharField(max_length=50)
last_name = CharField(max_length=50)
email = CharField(max_length=200)
password = CharField(max_length=300)
birthday = DateField()
def gen_hash(self):
_secret = md5("123456".encode()).hexdigest()
_password = md5(self.password.encode()).hexdigest()
self.password = hsh.hash(_secret+_password)
def verify(self, password):
_secret = md5("123456".encode()).hexdigest()
_password = md5(password.encode()).hexdigest()
return hsh.verify(_secret+_password, self.password)
class Meta:
database = db
class Auth(BaseAuth):
"""Classe para autenticação.
Precisa conter um método estático chamado authenticate e outro
chamado get_user.
Os parametros de authenticate ficam a critério do método post.
O padrão é receber uma requisição POST enviando dados no formato JSON.
Esses dados são empacotados no argumento kwargs do método authenticate.
para identificar o usuário é necessário realizar a consulta utilizando
um ID.
"""
@staticmethod
def authenticate(*args, **kwargs):
"""Método para autenticação, aqui utilizei uma classe chamada
Users implementada com o ORM peewee e uma simples regra de
autenticação apresentada pelo Eduardo Mendes.
link: https://www.youtube.com/watch?v=ieGA91ExOH0
Returns:
Users: dicionário contendo id para gerar o token.
OBS: é necessário possuir um atributo "id" para gerar o token.
"""
try:
if "email" in kwargs and "password" in kwargs:
user = Users.get(Users.email==kwargs['email'])
if user.verify(kwargs['password']):
return user
return None
except DoesNotExist as err:
return {"erro": f"Usuário {kwargs['email']} não localizado"}
@staticmethod
def get_user(*args, **kwargs):
"""Classe para resgatar usuario autenticado
utilizando a decodificação de um token.
Args:
user_id ([int]): identificador do usuário.
Returns:
Users: retorna usuário autenticado pelo Token.
"""
try:
user = Users.get_by_id(kwargs["id"])
if user:
return user
return None
except DoesNotExist as err:
return {}
class AdminAuth(BaseAuth):
"""Classe para autenticação.
Precisa conter um método estático chamado authenticate e outro
chamado get_user.
Os parametros de authenticate ficam a critério do método post.
O padrão é receber uma requisição POST enviando dados no formato JSON.
Esses dados são empacotados no argumento kwargs do método authenticate.
para identificar o usuário é necessário realizar a consulta utilizando
um ID.
"""
@staticmethod
def authenticate(*args, **kwargs):
"""Método para autenticação, aqui utilizei uma classe chamada
Users implementada com o ORM peewee e uma simples regra de
autenticação apresentada pelo Eduardo Mendes.
link: https://www.youtube.com/watch?v=ieGA91ExOH0
Returns:
Users: dicionário contendo id para gerar o token.
OBS: é necessário possuir um atributo "id" para gerar o token.
"""
try:
if "name" in kwargs:
user = Users.get(Users.name == kwargs['name'])
return user
return None
except DoesNotExist as err:
return {"erro": f"Usuário {kwargs['email']} não localizado"}
@staticmethod
def get_user(*args, **kwargs):
"""Classe para resgatar usuario autenticado
utilizando a decodificação de um token.
Args:
user_id ([int]): identificador do usuário.
Returns:
Users: retorna usuário autenticado pelo Token.
"""
try:
if "name" in kwargs:
user = Users.get(Users.name == kwargs['name'])
return user
return None
except DoesNotExist as err:
return {"erro": f"Usuário {kwargs['email']} não localizado"}
app = bottle.Bottle()
configs = [
{'model': Auth, 'endpoint': '/auth', 'auth_name': "auth", 'refresh_name': 'refresh'},
{'model': AdminAuth, 'endpoint': '/admin/auth', 'auth_name': 'admin_auth', 'refresh_name': 'refresh_admin'}
]
jwt = JWTPlugin("abcde", configs=configs, payload=['id', 'email', 'name'])
app.install(jwt)
@auth_required
@app.get("/user")
def index(user):
return f"Usuario: {user.name}"
if __name__ == "__main__":
Users.create_table()
user = Users(name="Afonso", last_name="Medeiros", email="afonso@afonso.com", password="123456", birthday="2020-01-01")
user.gen_hash()
user.save()
app.run(debug=True, reloader=True)
Testes usando httpie:
$ http POST http://127.0.0.1:8080/auth email=afonso@afonso.com password=123456HTTP/1.0 200 OKContent-Length: 768Content-Type: application/jsonDate: Wed, 31 Mar 2021 20:51:49 GMT
Server: WSGIServer/0.2 CPython/3.8.5
{
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZm9uc29AYWZvbnNvLmNvbSIsIm5hbWUiOiJBZm9uc28iLCJ0b2tlbiI6ImV5SmhiR2NpT2lKSVV6STFOaUlzSW5SNWNDSTZJa3BYVkNKOS5leUpwWkNJNk1Td2laVzFoYVd3aU9pSmhabTl1YzI5QVlXWnZibk52TG1OdmJTSXNJbTVoYldVaU9pSkJabTl1YzI4aWZRLjVHOUROZzZDSGR3dzlMVnE1S1B3Z2VBZkJxbi1FNUg3dndFVjczQ2RQbEkifQ.JK42DVJM4DVaNI5qmFzj92sAoUPC5Ir8Ya4H5L86aPU",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZm9uc29AYWZvbnNvLmNvbSIsIm5hbWUiOiJBZm9uc28iLCJ0b2tlbiI6ImV5SmhiR2NpT2lKSVV6STFOaUlzSW5SNWNDSTZJa3BYVkNKOS5leUpwWkNJNk1Td2laVzFoYVd3aU9pSmhabTl1YzI5QVlXWnZibk52TG1OdmJTSXNJbTVoYldVaU9pSkJabTl1YzI4aWZRLjVHOUROZzZDSGR3dzlMVnE1S1B3Z2VBZkJxbi1FNUg3dndFVjczQ2RQbEkifQ.JK42DVJM4DVaNI5qmFzj92sAoUPC5Ir8Ya4H5L86aPU"
}
$ http http://127.0.0.1:8080/user Authorization:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZm9uc29AYWZvbnNvLmNvbSIsIm5hbWUiOiJBZm9uc28iLCJ0b2tlbiI6ImV5SmhiR2NpT2lKSVV6STFOaUlzSW5SNWNDSTZJa3BYVkNKOS5leUpwWkNJNk1Td2laVzFoYVd3aU9pSmhabTl1YzI5QVlXWnZibk52TG1OdmJTSXNJbTVoYldVaU9pSkJabTl1YzI4aWZRLjVHOUROZzZDSGR3dzlMVnE1S1B3Z2VBZkJxbi1FNUg3dndFVjczQ2RQbEkifQ.JK42DVJM4DVaNI5qmFzj92sAoUPC5Ir8Ya4H5L86aPU
HTTP/1.0 200 OKContent-Length: 15
Content-Type: text/html; charset=UTF-8
Date: Wed, 31 Mar 2021 20:52:43 GMT
Server: WSGIServer/0.2 CPython/3.8.5
Usuario: Afonso
$ http POST http://127.0.0.1:8080/auth/refresh Refresh-Jwt:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZm9uc29AYWZvbnNvLmNvbSIsIm5hbWUiOiJBZm9uc28iLCJ0b2tlbiI6ImV5SmhiR2NpT2lKSVV6STFOaUlzSW5SNWNDSTZJa3BYVkNKOS5leUpwWkNJNk1Td2laVzFoYVd3aU9pSmhabTl1YzI5QVlXWnZibk52TG1OdmJTSXNJbTVoYldVaU9pSkJabTl1YzI4aWZRLjVHOUROZzZDSGR3dzlMVnE1S1B3Z2VBZkJxbi1FNUg3dndFVjczQ2RQbEkifQ.JK42DVJM4DVaNI5qmFzj92sAoUPC5Ir8Ya4H5L86aPU
HTTP/1.0 200 OK
Content-Length: 768
Content-Type: application/json
Date: Wed, 31 Mar 2021 21:02:49 GMT
Server: WSGIServer/0.2 CPython/3.8.5
{
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZm9uc29AYWZvbnNvLmNvbSIsIm5hbWUiOiJBZm9uc28iLCJ0b2tlbiI6ImV5SmhiR2NpT2lKSVV6STFOaUlzSW5SNWNDSTZJa3BYVkNKOS5leUpwWkNJNk1Td2laVzFoYVd3aU9pSmhabTl1YzI5QVlXWnZibk52TG1OdmJTSXNJbTVoYldVaU9pSkJabTl1YzI4aWZRLjVHOUROZzZDSGR3dzlMVnE1S1B3Z2VBZkJxbi1FNUg3dndFVjczQ2RQbEkifQ.JK42DVJM4DVaNI5qmFzj92sAoUPC5Ir8Ya4H5L86aPU",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJhZm9uc29AYWZvbnNvLmNvbSIsIm5hbWUiOiJBZm9uc28iLCJ0b2tlbiI6ImV5SmhiR2NpT2lKSVV6STFOaUlzSW5SNWNDSTZJa3BYVkNKOS5leUpwWkNJNk1Td2laVzFoYVd3aU9pSmhabTl1YzI5QVlXWnZibk52TG1OdmJTSXNJbTVoYldVaU9pSkJabTl1YzI4aWZRLjVHOUROZzZDSGR3dzlMVnE1S1B3Z2VBZkJxbi1FNUg3dndFVjczQ2RQbEkifQ.JK42DVJM4DVaNI5qmFzj92sAoUPC5Ir8Ya4H5L86aPU"
}
Código baseado na lib: https://github.com/agile4you/bottle-jwt
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
JWT-Bottle-2021.4.1.tar.gz
(7.9 kB
view hashes)
Built Distribution
Close
Hashes for JWT_Bottle-2021.4.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3830ace8ecd801b53c98f2396b9b9d6d0f3e175545da43398986a7ed64994bbc |
|
| MD5 | 9bdd880f11d14c39a9684dbbc656f2e8 |
|
| BLAKE2b-256 | c0304442d6ab25449efb9f1acd882593f582ee5bd2aaad862f8d5dcf04e74269 |
