معرفی شرکت ها
flaskhmac-1.2.1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Provides easy integration of the HMAC signatures for your REST Flask Applications.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | flaskhmac-1.2.1 |
| نام | flaskhmac |
| نسخه کتابخانه | 1.2.1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | SOON_ |
| ایمیل نویسنده | dorks@thisissoon.com |
| آدرس صفحه اصلی | https://github.com/thisissoon/Flask-HMAC |
| آدرس اینترنتی | https://pypi.org/project/flaskhmac/ |
| مجوز | Public Domain |
Flask-HMAC
==========
|circle| |downloads| |version| |license|
This module provides an authentication to Flask routes. The intended use case
is for use with REST APIs. It's simply designed to check that a client is
entitled to access a particular route in a Flask application, based on the fact
that it must possess a copy of the secret key.
Usage
-----
Server
~~~~~~
.. sourcecode:: python
app = Flask(__name__)
app.config['HMAC_KEY'] = 's3cr3tk3y' # define the secret key in an app config
@app.route("/no_auth_view")
def no_auth_view():
return "no_auth_view"
@app.route("/hmac_auth_view")
@hmac.auth() # decorate view
def hmac_auth_view():
return "hmac_auth_view"
@app.route("/hmac_auth_view")
@hmac.auth(only=["foo"]) # decorate view, only allows foo client access
def hmac_auth_view():
return "hmac_auth_view"
Client
~~~~~~
**Call without payload**
.. sourcecode:: python
sig = hmac.make_hmac() # generate signature
response = requests.get(
'/hmac_auth_view',
headers={hmac.header: sig}
)
You can also use multiple keys between different applications. Secret keys are
stored in ``HMAC_KEYS`` in the app settings as a dictionary:
.. sourcecode:: python
app.config['HMAC_KEYS'] = {
'aservice': 'akey',
'bservice': 'bkey'
}
Then the secret key has to generated with `make_hmac_for` method.
.. sourcecode:: python
hmac.make_hmac_for('aservice', request_data) # data is optional
# signature validation for multiple keys
hmac.validate_service_signature(request)
**Call with payload**
Request payload has to be used as a data for HMAC generation.
.. sourcecode:: python
data = json.dumps({'foo': 'boo'})
sig = hmac.make_hmac(data) # generate signature
response = requests.post(
'/hmac_auth_view',
data=data,
headers={hmac.header: sig}
)
----
You can define custom errors overwriting ``abort`` method:
.. sourcecode:: python
class MyHmac(Hmac):
def abort(self):
message = {'status': '403', 'message': 'not authorized'}
response = jsonify(message)
response.status_code = 403
return response
For HMAC auth of all views you can use ``Flask``'s ``before_request``:
.. sourcecode:: python
@app.before_request
def before_request():
try:
hmac.validate_signature(request)
except HmacException:
return abort(400)
Generate signature for/from another application:
.. sourcecode:: python
sig = make_hmac(self, data, key=another_app_key)
.. |circle| image:: https://img.shields.io/circleci/project/thisissoon/flask-hmac.svg
:target: https://circleci.com/gh/thisissoon/flask-hmac
.. |downloads| image:: http://img.shields.io/pypi/dm/flaskhmac.svg
:target: https://pypi.python.org/pypi/flaskhmac
.. |version| image:: http://img.shields.io/pypi/v/flaskhmac.svg
:target: https://pypi.python.org/pypi/flaskhmac
.. |license| image:: http://img.shields.io/pypi/l/flaskhmac.svg
:target: https://pypi.python.org/pypi/flaskhmac
Change Log
----------
1.2.1
~~~~~
- New `HMAC_ERROR_CODE` configuration option to allow different HTTP Status code responses on failure
1.2
~~~~~
- BREAKING CHANGE: `@hmac.auth` decorator now needs to be called as `@hmac.auth()`
- New `only` argument for `@hmac.auth()` to only allow specific clients access
1.1.2
~~~~~
- Swaps `urlsafe_b64encode` for `b64encode`
1.1.1
~~~~~
- Support multiple keys
0.1.1
~~~~~~~~~
- Able to change secret key in `make_hmac` method
- Method `validate_signature` created which can be used outside of `Hmac` class
- Custom exceptions
0.0.1
~~~~~~~~~
- Initial release including the core feature set
نحوه نصب
نصب پکیج whl flaskhmac-1.2.1:
pip install flaskhmac-1.2.1.whl
نصب پکیج tar.gz flaskhmac-1.2.1:
pip install flaskhmac-1.2.1.tar.gz