anzar 0.4.5

Anzar is a lightweight authentication and authorization framework that runs as a separate microservice

Anzar SDK Documentation

Server

from flask import g
from flask import Flask, jsonify
from anzar.server import require_auth, require_role, AnzarAuth
from anzar.types import Role

app = Flask(__name__)

requireAuth = AnzarAuth(
    secret = process.env.SECRET,
    audience = process.env.AUDIENCE
    issuerBaseURL = process.env.ISSUER
)

@app.route("/protected")
@require_auth(requireAuth)
def me():
    return jsonify(g.user_id)


@app.route("/admin")
@require_role(requireAuth, role=Role.ADMIN)
def admin():
    return jsonify(f"admin panel, {g.user_id}")


if __name__ == "__main__":
    app.run(debug=True)

---

Client

Install The Python SDK

In a python project run the following command to install the anzar package.

uv

$ uv add anzar

pip

# in a virtual env run
$ pip install anzar

Create Anzar Auth Instance

in your main entry file (main.py for example), import anzar.yml and parse it as a YAML file

def load_config(path: str) -> AnzarConfig:
    import yaml

    try:
        with open(path, "r") as f:
            data = yaml.safe_load(f)
        return AnzarConfig(**data)
    except Exception as e:
        import sys

        sys.exit("check your configuration file: anzar.yml")

import Anzar Auth and create your auth instance

# Initialize once at application startup
# The SDK will communicate with your Anzar container at the configured api_url
from anzar import Anzar

config = load_config("anzar.yml")
anzar = Anzar(config, options=None)

Note "Configuring Token Persistence" To keep users logged in across restarts, choose a token storage adapter.

```python
from anzar.adapters import RedisStorage
from anzar.types import SdkOptions 

anzar = Anzar(config, SdkOptions(storage=RedisStorage()))
```

---

Basic Usage

Anzar provides authentication support for email and password.

📝 Note: Other methods of authentication will be implemented later

Sign Up

To sign up a user you need to call the method register with the user's information.

from anzar.types import ApiException, AuthResponse, ErrorCode

try:
    data: AuthResponse = anzar.Auth.register({
      "username": "username",
      "email": "[e-mail]",
      "password": "password"
    })
except ApiException as e:
    if e.data is None:
        return

    if e.data.code == ErrorCode.InvalidCredentials:
        show_error("Invalid email or password.")
    elif e.data.code == ErrorCode.AccountNotVerified:
        show_error("Please verify your email before logging in.")

📝 Note: By default, the users are automatically signed in after they successfully sign up. Disabling this behavior will be implemented later

Sign In

To sign in a user you need to call the method login.

from anzar.types import ApiException, AuthResponse, ErrorCode

try:
    data: AuthResponse = anzar.Auth.login({
      "email": "[e-mail]",
      "password": "password"
    })
except ApiException as e:
    if e.data is None:
        return

    if e.data.code == ErrorCode.InvalidCredentials:
        show_error("Invalid email or password.")
    elif e.data.code == ErrorCode.AccountNotVerified:
        show_error("Please verify your email before logging in.")