Skip to main content

Comprehensive OAuth 2.1 / FAPI + AuthZEN PDP + FIPS client library

Project description

EmpowerNow SDK – Python & React packages

EmpowerNow provides a secure‐by‐default toolkit for building apps on top of the EmpowerNow Platform. The SDK is split into two families:

Package Runtime Purpose
empowernow-common Python 3.10 – 3.12 Shared cryptography, OAuth helpers, AuthZEN PDP client, Redis/metrics utilities.
@empowernow/bff-auth-react React 18 Hooks & components for the Backend-for-Frontend (BFF) cookie-based auth model.
@empowernow/ui React 18 Headless UI-component library used by all EmpowerNow SPAs. (Depends on either @empowernow/bff-auth-react or the legacy shim @empowernow/react.)

Why no browser-side OAuth client? EmpowerNow moved to a BFF architecture to comply with FAPI 2.0 Baseline / Advanced and to keep tokens out of the browser. The legacy @empowernow/react library now acts as a thin re-export of @empowernow/bff-auth-react for backward compatibility. It no longer handles tokens.


Installation

Python (server-side services)

pip install "empowernow-common>=2.3,<3"

Optional extras:

  • empowernow-common[fips] – Use when running under an OpenSSL FIPS provider.
  • empowernow-common[redis], empowernow-common[kafka], etc. – Feature-scoped extras, see pyproject.toml.

React (front-end SPAs)

npm install @empowernow/bff-auth-react @empowernow/ui

If you still have code importing @empowernow/react, update it at your own pace – the alias re-exports the new package so nothing breaks at runtime.


Quick start

Using the Python OAuthClient

from empowernow_common.oauth import OAuthClient

oauth = OAuthClient(
    issuer="https://idp.example.com",
    client_id="python-client",
    client_secret="…",  # confidential client
    redirect_uri="https://bff.example.com/auth/callback",
    scopes=["openid", "profile"]
)

auth_url = oauth.create_authorization_url(state="xyz")
print("Open browser to", auth_url)

React – wrap your SPA in the AuthProvider

import { AuthProvider } from '@empowernow/bff-auth-react';
import { createRoot } from 'react-dom/client';
import App from './App';

createRoot(document.getElementById('root')!).render(
  <AuthProvider baseUrl={import.meta.env.VITE_BFF_BASE_URL}>
    <App />
  </AuthProvider>
);

useAuth() gives you isAuthenticated, user, session and convenience helpers like login() and logout(); apiClient is a fetch wrapper that automatically adds CSRF headers and credentials:"include".


Security & Compliance

  • FAPI 2.0 ready – private-key-JWT, PAR, JARM, DPoP and SameSite cookie model supported at the BFF layer.
  • FIPS option – When the host OpenSSL runs in FIPS 140-3 mode, empowernow-common can validate algorithms at start-up and periodically (opt-in via env FIPS_CONTINUOUS_VALIDATION=1).
  • No browser tokens – SPAs never see access- or refresh-tokens; they use HttpOnly cookies issued by the BFF.
  • Structured logging & Prometheus metrics built in.

Repository layout

client_sdk/empowernow-packages/
 ├── packages/
 │   ├── empowernow-common/            # Python package
 │   ├── @empowernow/bff-auth-react/   # React auth kit
 │   ├── @empowernow/ui/               # UI kit (optional peer)
 │   └── empowernow-react/             # Shim – re-exports BFF kit

Contributing

Pull requests are welcome. Please run pre-commit run -a and ensure pytest -q / pnpm test are green before opening a PR.


© 2025 EmpowerNow – Apache 2.0 licence.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

empowernow_sdk-3.4.11.tar.gz (361.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

empowernow_sdk-3.4.11-py3-none-any.whl (422.4 kB view details)

Uploaded Python 3

File details

Details for the file empowernow_sdk-3.4.11.tar.gz.

File metadata

  • Download URL: empowernow_sdk-3.4.11.tar.gz
  • Upload date:
  • Size: 361.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for empowernow_sdk-3.4.11.tar.gz
Algorithm Hash digest
SHA256 327328b609ef89fafdc8a64b24354e0080f66b64fa8817f46a91b9d68095c360
MD5 445e80be5f52938763694efc954745b4
BLAKE2b-256 29614026a62c1572aaf9598dd6df56f3bde7270ca5e693606c631e9b11e647b0

See more details on using hashes here.

File details

Details for the file empowernow_sdk-3.4.11-py3-none-any.whl.

File metadata

  • Download URL: empowernow_sdk-3.4.11-py3-none-any.whl
  • Upload date:
  • Size: 422.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for empowernow_sdk-3.4.11-py3-none-any.whl
Algorithm Hash digest
SHA256 6112da8a867e0b43f5ab1bd512ab44b334cfecc35141181187343778dfeaa224
MD5 6ce568c428084b9e3f9ec909d946ade3
BLAKE2b-256 30cc0d8f98de7b22a139cf2a3cb26598eb1e8769b7c7cba473baaa03c1b140a8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page