sag-py-auth 0.1.3

Keycloak authentication for python projects

sag_py_auth

This provides a way to secure your fastapi with keycloak jwt bearer authentication.

What it does

• Secure your api endpoints
• Verifies auth tokens: signature, expiration, issuer, audience
• Allows to set permissions by specifying roles and realm roles

How to use

Installation

pip install sag_py_auth

Secure your apis

First create the fast api dependency with the auth config:

from sag_py_auth import AuthConfig, JwtAuth, TokenRole
from fastapi import Depends

auth_config = AuthConfig("https://authserver.com/auth/realms/projectName", "myaudience")
required_roles = [TokenRole("clientname", "adminrole")]
required_realm_roles = ["additionalrealmrole"]
requires_admin = Depends(JwtAuth(auth_config, required_roles, required_realm_roles))

Afterwards you can use it in your route like that:

@app.post("/posts", dependencies=[requires_admin], tags=["posts"])
async def add_post(post: PostSchema) -> dict:

Or if you use sub routes, auth can also be enforced for the entire route like that:

router = APIRouter()
router.include_router(sub_router, tags=["my_api_tag"], prefix="/subroute",dependencies=[requires_admin])

Get user information

The Jwt call directly returns a token object that can be used to get additional information.

Furthermore you can access the context directly:

from sag_py_auth import get_token as get_token_from_context
token = get_token_from_context()

This works in async calls but not in sub threads (without additional changes).

See:

• https://docs.python.org/3/library/contextvars.html
• https://kobybass.medium.com/python-contextvars-and-multithreading-faa33dbe953d

Methods available on the token object

• get_field_value: to get the value of a claim field (or an empty string if not present)
• get_roles: Gets the roles of a specific client
• has_role: Verify if a spcific client has a role
• get_realm_roles: Get the realm roles
• has_realm_role: Check if the user has a specific realm role

Log user data

It is possible to log the preferred_username and the azp value (party that created the token) of the token by adding a filter.

import logging
from sag_py_auth import UserNameLoggingFilter

console_handler = logging.StreamHandler(sys.stdout)
console_handler.addFilter(UserNameLoggingFilter())

The filter provides the following two fields as soon as the user is authenticated: user_name, authorized_party

How to publish

• Update the version in setup.py and commit your change
• Create a tag with the same version number
• Let github do the rest