APIを作成するには、flask-restfulを使用します。 JWT
に基づく認証を有効にするためにflask-jwt
を使用しました。次に、承認を行う必要があります。
承認デコレータを配置しようとしました。
test.py(/ test api)
from flask_restful import Resource
from flask_jwt import jwt_required
from authorization_helper import authorized_api_user_type
class Test(Resource):
decorators = [jwt_required(), authorized_api_user_type()]
def get(self):
return 'GET OK'
def post(self):
return 'POST OK'
基本的に基本認証を処理するには、current_identity
にアクセスし、そのタイプを確認する必要があります。次に、そのタイプに基づいて、ユーザーがapi /リソースへのアクセスを許可されているかどうかを判断します。
ただし、current_identity
は、そのデコレータではempty
に見えます。そのため、間接的に取得するには、jwt_handler
のコードを確認し、そこで実行する必要がありました。
authorization_helper.py
from functools import wraps
from flask_jwt import _jwt, JWTError
import jwt
from models import Teacher, Student
def authorized_api_user_type(realm=None, user_type='teacher'):
def wrapper(fn):
@wraps(fn)
def decorator(*args, **kwargs):
token = _jwt.request_callback()
if token is None:
raise JWTError('Authorization Required', 'Request does not contain an access token',
headers={'WWW-Authenticate': 'JWT realm="%s"' % realm})
try:
payload = _jwt.jwt_decode_callback(token)
except jwt.InvalidTokenError as e:
raise JWTError('Invalid token', str(e))
identity = _jwt.identity_callback(payload)
if user_type == 'student' and isinstance(identity, Student):
return fn(*args, **kwargs)
Elif user_type == 'teacher' and isinstance(identity, Teacher):
return fn(*args, **kwargs)
# NOTE - By default JWTError throws 401. We needed 404. Hence status_code=404
raise JWTError('Unauthorized',
'You are unauthorized to request the api or access the resource',
status_code=404)
return decorator
return wrapper
current_identity
デコレータでauthorized_api_user_type
にアクセスできないのはなぜですか?フラスコレスフルで承認を行う正しい方法は何ですか?
Flask-JWT
とFlask-Restful
の両方のクイックスタートの組み合わせを次に示します。
from flask import Flask
from flask_restful import Resource, Api, abort
from functools import wraps
app = Flask(__name__)
api = Api(app)
from flask_jwt import JWT, jwt_required, current_identity
from werkzeug.security import safe_str_cmp
class User(object):
def __init__(self, id, username, password):
self.id = id
self.username = username
self.password = password
def __str__(self):
return "User(id='%s')" % self.id
users = [
User(1, 'user1', 'abcxyz'),
User(2, 'user2', 'abcxyz'),
]
username_table = {u.username: u for u in users}
userid_table = {u.id: u for u in users}
def authenticate(username, password):
user = username_table.get(username, None)
if user and safe_str_cmp(user.password.encode('utf-8'), password.encode('utf-8')):
return user
def identity(payload):
user_id = payload['identity']
return userid_table.get(user_id, None)
app.config['SECRET_KEY'] = 'super-secret'
jwt = JWT(app, authenticate, identity)
def checkuser(func):
@wraps(func)
def wrapper(*args, **kwargs):
if current_identity.username == 'user1':
return func(*args, **kwargs)
return abort(401)
return wrapper
class HelloWorld(Resource):
decorators = [checkuser, jwt_required()]
def get(self):
return {'hello': current_identity.username}
api.add_resource(HelloWorld, '/')
if __name__ == '__main__':
app.run(debug=True)
POST
{
"username": "user1",
"password": "abcxyz"
}
localhost:5000/auth
に応答し、access_token
を取得します。
次に、GET localhost:5000/
ヘッダー付き
Authorization: JWT `the access_token value above`
あなたは得るだろう
{
"hello": "user1"
}
user2のJWTトークンでlocalhost:5000/
にアクセスしようとすると、401
を取得します。
デコレータは次のようにラップされます。
for decorator in self.decorators:
resource_func = decorator(resource_func)
https://github.com/flask-restful/flask-restful/blob/master/flask_restful/init.py#L445
したがって、decorators配列の後半の方が早く実行されます。
詳細については:
https://github.com/rchampa/timetable/blob/master/restful/users.py
私の現在のソリューションは次のようになります。
@app.before_request
def detect_something():
header = request.headers.get('Authorization')
if header:
_, token = header.split()
request.identity = identity(jwt.decode(token,
app.config['SECRET_KEY']))
その後、request.identity
を介してデコレータのIDにアクセスできます。そして、current_identity
をコードからすべて削除しました。それはまだ厄介な方法です。
これを使って:
from flask_jwt import current_identity
@jwt_required()
def get(self):
return {'current_identity': current_identity.json()}