================
py_auth_micro
================
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://pypi.org/project/black
.. image:: https://app.codacy.com/project/badge/Grade/199fd463ff1a487eb206a2afbfb25168
:target: https://app.codacy.com/gh/bad-microservices/py_auth_micro/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
.. image:: https://badge.fury.io/py/py-auth-micro.svg
:target: https://badge.fury.io/py/py-auth-micro
.. image:: https://github.com/bad-microservices/py_auth_micro/actions/workflows/documentation.yaml/badge.svg
:target: https://github.com/bad-microservices/py_auth_micro/actions?query=workflow:Docs
.. image:: https://github.com/bad-microservices/py_auth_micro/actions/workflows/pypi_upload.yaml/badge.svg
:target: https://github.com/bad-microservices/py_auth_micro/actions?query=workflow:pypi
Introduction
=============
`py_auth_micro` is a small identity provider library which can use an LDAP/AD as upstream Identity Provider and can also store Users Localy.
The Authentication and Authorization is done via `ID-Tokens` and `Access-Tokens`. The `ID-Tokens` are given out after a User successfully logged in.
With this `ID-Token` a User can request an `Access-Token` which he can send to other (Micro-)Services to gain access According to his Permissions.
The Tokens are `JWT` Tokens which can either be signed with an symetric `HMAC`-Secret or with an `RSA`-Key.
Documentation
==============
You can find the documentation `here <https://bad-microservices.github.io/py_auth_micro/>`_
Alternatively you can build it yourself by running :code:`make doc`
TODO
=====
There is still alot todo for the :code:`1.0.0` Release. The following list contains the most important stuff
- ☐ Reset-Password functionality
- ☐ Unit Tests
- ☐ WorkFlows
- ☑ :code:`GroupWorkflow`
- ☐ :code:`SessionWorkflow`
- ☐ :code:`UserWorkflow`
- ☐ Models
- ☐ :code:`Group`
- ☐ :code:`Token`
- ☐ :code:`User`
- ☐ LoginHandler
- ☐ :code:`LoginLDAP`
- ☐ :code:`LoginLocal`
- ☐ Core
- ☐ :code:`LDAPHelper`
- ☐ :code:`_ConnectionHandler`
- ☐ Documentation
- ☑ Api Reference
- ☑ Installation
- ☐ Example Code
Contributing
=============
Missing a Feature or found a bug? Create an Issue or make a Pull-Request ;)
If you have any Question regarding this library feel free to create an issue.
Raw data
{
"_id": null,
"home_page": "https://github.com/bad-microservices/py_auth_micro",
"name": "py-auth-micro",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "JWT",
"author": "Ole Hannemann",
"author_email": "cerberus885@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/14/3a/846433e870ddc4c188ead3964bad33ca41f316248098dcae82496e08ded5/py_auth_micro-0.2.4.tar.gz",
"platform": null,
"description": "================\npy_auth_micro\n================\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://pypi.org/project/black\n\n.. image:: https://app.codacy.com/project/badge/Grade/199fd463ff1a487eb206a2afbfb25168\n :target: https://app.codacy.com/gh/bad-microservices/py_auth_micro/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade\n\n.. image:: https://badge.fury.io/py/py-auth-micro.svg\n :target: https://badge.fury.io/py/py-auth-micro\n\n.. image:: https://github.com/bad-microservices/py_auth_micro/actions/workflows/documentation.yaml/badge.svg\n :target: https://github.com/bad-microservices/py_auth_micro/actions?query=workflow:Docs\n\n.. image:: https://github.com/bad-microservices/py_auth_micro/actions/workflows/pypi_upload.yaml/badge.svg\n :target: https://github.com/bad-microservices/py_auth_micro/actions?query=workflow:pypi\n\nIntroduction\n=============\n\n`py_auth_micro` is a small identity provider library which can use an LDAP/AD as upstream Identity Provider and can also store Users Localy.\n\nThe Authentication and Authorization is done via `ID-Tokens` and `Access-Tokens`. The `ID-Tokens` are given out after a User successfully logged in.\nWith this `ID-Token` a User can request an `Access-Token` which he can send to other (Micro-)Services to gain access According to his Permissions.\n\nThe Tokens are `JWT` Tokens which can either be signed with an symetric `HMAC`-Secret or with an `RSA`-Key.\n\nDocumentation\n==============\n\nYou can find the documentation `here <https://bad-microservices.github.io/py_auth_micro/>`_\n\nAlternatively you can build it yourself by running :code:`make doc`\n\nTODO\n=====\n\nThere is still alot todo for the :code:`1.0.0` Release. The following list contains the most important stuff\n\n- \u2610 Reset-Password functionality\n- \u2610 Unit Tests\n - \u2610 WorkFlows\n - \u2611 :code:`GroupWorkflow`\n - \u2610 :code:`SessionWorkflow`\n - \u2610 :code:`UserWorkflow` \n - \u2610 Models\n - \u2610 :code:`Group`\n - \u2610 :code:`Token` \n - \u2610 :code:`User`\n - \u2610 LoginHandler\n - \u2610 :code:`LoginLDAP`\n - \u2610 :code:`LoginLocal`\n - \u2610 Core\n - \u2610 :code:`LDAPHelper`\n - \u2610 :code:`_ConnectionHandler`\n- \u2610 Documentation \n - \u2611 Api Reference\n - \u2611 Installation\n - \u2610 Example Code \n\n\nContributing\n=============\n\nMissing a Feature or found a bug? Create an Issue or make a Pull-Request ;)\n\nIf you have any Question regarding this library feel free to create an issue.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A wrapper around pyjwt",
"version": "0.2.4",
"project_urls": {
"Homepage": "https://github.com/bad-microservices/py_auth_micro"
},
"split_keywords": [
"jwt"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c865c862d692d5eeec3490104eecd3ea8c38a80ea19f48c93b5d144e34d29b6d",
"md5": "60b9a48b55dd5662ef2b2ffc756209f6",
"sha256": "7b18c130b0a9d371948ae68dff2a3c3dfc1d395b7aa5103823948165c565210f"
},
"downloads": -1,
"filename": "py_auth_micro-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60b9a48b55dd5662ef2b2ffc756209f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 25240,
"upload_time": "2025-02-21T13:46:27",
"upload_time_iso_8601": "2025-02-21T13:46:27.558799Z",
"url": "https://files.pythonhosted.org/packages/c8/65/c862d692d5eeec3490104eecd3ea8c38a80ea19f48c93b5d144e34d29b6d/py_auth_micro-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "143a846433e870ddc4c188ead3964bad33ca41f316248098dcae82496e08ded5",
"md5": "4402986e544b4862d9b3e93a387faa6e",
"sha256": "5ce2c22ecd298be8ec55737cf94ea3088150547eb58d9d0ed3d7f18b92f1e778"
},
"downloads": -1,
"filename": "py_auth_micro-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "4402986e544b4862d9b3e93a387faa6e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18341,
"upload_time": "2025-02-21T13:46:29",
"upload_time_iso_8601": "2025-02-21T13:46:29.560089Z",
"url": "https://files.pythonhosted.org/packages/14/3a/846433e870ddc4c188ead3964bad33ca41f316248098dcae82496e08ded5/py_auth_micro-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-21 13:46:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bad-microservices",
"github_project": "py_auth_micro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "py-auth-micro"
}
JSON
