{ "info": { "author": "R\u00e9my Hubscher", "author_email": "hubscher.remy@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: WSGI :: Application" ], "description": "Hawk authentication support for Kinto\n=====================================\n\n|travis| |master-coverage|\n\n.. |travis| image:: https://travis-ci.org/Kinto/kinto-hawk.svg?branch=master\n :target: https://travis-ci.org/Kinto/kinto-hawk\n\n.. |master-coverage| image::\n https://coveralls.io/repos/Kinto/kinto-hawk/badge.png?branch=master\n :alt: Coverage\n :target: https://coveralls.io/r/Kinto/kinto-hawk\n\n*Kinto-hawk* enables Hawk authentication for *Kinto* based applications.\n\nIt adds the Hawk authentication protocol to the Kinto Accounts plugins.\n\nYour users are handled the same way as usual\n`Kinto Accounts Users `_.\n\nThe main benefit of Hawk for Kinto is to prevent replay attacks (very\nuseful for score games) and to prevent sending the user and password\nover the network like with **Basic auth**.\n\nIt provides:\n\n* An authentication policy class;\n* Integration with *Kinto* cache backend for token verifications;\n* Some optional endpoints to perform to grab a new Hawk session.\n\n* `Kinto documentation `_\n* `Issue tracker `_\n\n\nInstallation\n------------\n\nInstall the Python package:\n\n::\n\n pip install kinto-hawk\n\n\nInclude the package in the project configuration:\n\n::\n\n # Enable plugin.\n kinto.includes = kinto_hawk\n\nAnd configure authentication policy using `pyramid_multiauth\n`_ formalism:\n\n::\n\n multiauth.policies = account\n\n # Enable Hawk authenticated policy and name it account\n multiauth.policy.account.use = kinto_hawk.authentication.HawkAuthenticationPolicy\n\nBy default, it will rely on the cache configured in *Kinto*.\n\n\nConfiguration\n-------------\n\nAs of today, there are no specific configuration for Hawk.\n\n\nIf necessary, override default values for authentication policy:\n\n::\n\n # multiauth.policy.account.realm = Realm\n # hawk.nonce_ttl_seconds = 60 # A minute\n # hawk.session_ttl_seconds = 2613600 # 2 months since last usage.\n\n\nHow to create a user?\n---------------------\n\nYou can use the kinto create-user command to create a user:\n\n::\n\n kinto create-user --ini config/kinto.ini -u admin\n\n\nLogin flow\n----------\n\nOnce you have a user and you have activated the ``kinto-hawk`` plugin,\nyou will be able to request an Hawk Session from a new endpoint using\n``Basic Auth`` or a previous ``Hawk Session``.\n\n.. note::\n\n This will only work with an account user. You cannot request an\n Hawk Session for an OAuth authenticated user for instance.\n\n\n::\n\n $ http POST https://kinto.dev.mozaws.net/v1/hawk-sessions -v --auth (userID):(password)\n POST /v1/hawk-sessions HTTP/1.1\n Host: kinto.dev.mozaws.net\n\n\n HTTP/1.1 201 Created\n Hawk-Session-Token: 47d5616e561443e79d0db605771db46234a984629a6e681059b76657f790583b\n\n\nChangelog\n=========\n\nThis document describes changes between each past release.\n\n0.1.0 (2018-04-26)\n------------------\n\n- Initial implementation.\n\n\nContributors\n============\n\n* Thomas Dressler \n* Mathieu Leplatre \n* R\u00e9my Hubscher ", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Kinto/kinto-hawk", "keywords": "web services", "license": "Apache License (2.0)", "maintainer": "", "maintainer_email": "", "name": "kinto-hawk", "package_url": "https://pypi.org/project/kinto-hawk/", "platform": "", "project_url": "https://pypi.org/project/kinto-hawk/", "project_urls": { "Homepage": "https://github.com/Kinto/kinto-hawk" }, "release_url": "https://pypi.org/project/kinto-hawk/0.1.0/", "requires_dist": null, "requires_python": "", "summary": "Hawk authentication support for Kinto", "version": "0.1.0" }, "last_serial": 3810439, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1aefc77c3bad5752b80bc4e4bc6e9703", "sha256": "33459887c8d3bede0867a457105455d13350d4b5d607cab4ef4327dd4f4ab486" }, "downloads": -1, "filename": "kinto_hawk-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1aefc77c3bad5752b80bc4e4bc6e9703", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10138, "upload_time": "2018-04-26T14:22:41", "url": "https://files.pythonhosted.org/packages/15/92/c4ca75e5631df4744ac437aefc1c8296a6489012f8cb8e17f43c6707a304/kinto_hawk-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "668ed66cad5a86dff1ff60ac9b41d9ac", "sha256": "12c925f094678b1d60cd8821b762a7a7dcc0ba9ebcd02e6c2340921565cd7457" }, "downloads": -1, "filename": "kinto-hawk-0.1.0.tar.gz", "has_sig": false, "md5_digest": "668ed66cad5a86dff1ff60ac9b41d9ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7553, "upload_time": "2018-04-26T14:22:40", "url": "https://files.pythonhosted.org/packages/80/83/a6eec435154bc5d49cede5b1e1085ff0310a39ef42e0c748ecee50b1a81f/kinto-hawk-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1aefc77c3bad5752b80bc4e4bc6e9703", "sha256": "33459887c8d3bede0867a457105455d13350d4b5d607cab4ef4327dd4f4ab486" }, "downloads": -1, "filename": "kinto_hawk-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1aefc77c3bad5752b80bc4e4bc6e9703", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10138, "upload_time": "2018-04-26T14:22:41", "url": "https://files.pythonhosted.org/packages/15/92/c4ca75e5631df4744ac437aefc1c8296a6489012f8cb8e17f43c6707a304/kinto_hawk-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "668ed66cad5a86dff1ff60ac9b41d9ac", "sha256": "12c925f094678b1d60cd8821b762a7a7dcc0ba9ebcd02e6c2340921565cd7457" }, "downloads": -1, "filename": "kinto-hawk-0.1.0.tar.gz", "has_sig": false, "md5_digest": "668ed66cad5a86dff1ff60ac9b41d9ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7553, "upload_time": "2018-04-26T14:22:40", "url": "https://files.pythonhosted.org/packages/80/83/a6eec435154bc5d49cede5b1e1085ff0310a39ef42e0c748ecee50b1a81f/kinto-hawk-0.1.0.tar.gz" } ] }