Flask 세션

keenauth.bff.flask는 Flask 2.3 이상 애플리케이션에 로그인 기능을 추가합니다. 서버가 OAuth 클라이언트가 되어 모든 토큰을 서버에 보관합니다. 브라우저는 암호화되고 HttpOnly 속성이 설정된 세션 쿠키만 받으며, 액세스 토큰, 리프레시 토큰, ID 토큰은 전혀 노출되지 않습니다. 이것은 BFF(backend-for-frontend) 패턴입니다. keenauth-python의 일부이며, 아직 PyPI에 게시되지 않았습니다.

Bearer 토큰을 받는 API를 보호하려면 API 보호하기를 참조하십시오.

설치

pip install "keenauth-python[flask]"

시작하기 전에

대시보드에서 환경에 웹 애플리케이션을 생성하십시오.
클라이언트 인증 방식을 선택하십시오: private_key_jwt(권장, PrivateKeyJwt) 또는 클라이언트 비밀 값(ClientSecretBasic).
리디렉션 URI https://app.acme.example/auth/callback과 로그아웃 후 리디렉션 URI https://app.acme.example/를 추가하십시오.
최소 32자 이상의 쿠키 비밀 값을 생성하십시오. 예를 들어 openssl rand -base64 32를 사용할 수 있습니다. 저장소가 아닌 비밀 값 저장소에 보관하십시오.

인스턴스 생성

import os
from keenauth.bff import BffOptions, ClientSecretBasic, KeenAuthBff

bff = KeenAuthBff(BffOptions(
    issuer="https://acme.eu.keenauth.app",  # your environment's issuer, exactly
    client_id="app_01j9zzzzzzzzzzzzzzzzzzzz",
    client_auth=ClientSecretBasic(os.environ["KEENAUTH_CLIENT_SECRET"]),
    app_base_url="https://app.acme.example",
    secret=os.environ["KEENAUTH_COOKIE_SECRET"],
))

app_base_url은 애플리케이션의 공개 주소입니다. SDK는 리디렉션 URI와 모든 리디렉션을 이 값으로 생성하며, 요청의 Host 또는 X-Forwarded-* 헤더에서는 값을 가져오지 않습니다. 일반 http는 localhost에서만 허용됩니다. 옵션은 KeenAuthBff를 생성할 때 검사하므로, 설정 오류가 있으면 시작 단계에서 애플리케이션이 중지됩니다.

private_key_jwt 사용

private_key_jwt를 사용하면 애플리케이션에 공유 비밀 값이 없습니다. PrivateKeyJwt에 개인 키를 전달하면, SDK가 토큰 엔드포인트로 보내는 요청마다 새 클라이언트 어서션(RFC 7523)을 서명합니다:

from keenauth.bff import PrivateKeyJwt

client_auth = PrivateKeyJwt(key=os.environ["KEENAUTH_PRIVATE_KEY"])  # unencrypted PEM

지원되는 키: EC P-256(ES256), EC P-384(ES384), Ed25519(EdDSA), 그리고 2048비트 이상의 RSA(기본값 PS256, RS256을 사용하려면 algorithm="RS256"을 전달하십시오).
각 어서션의 iss와 sub는 클라이언트 ID로, aud는 발급자로 설정됩니다. 또한 임의의 jti와 60초의 유효 기간을 가집니다. kid는 공개 키의 RFC 7638 썸프린트입니다.
공개 키를 애플리케이션에 등록하십시오. keenauth.m2m.load_private_key(pem).public_jwk()가 이를 JWK 형식으로 반환합니다.

자체 키 서비스(KMS 또는 HSM)로 서명하려면 대신 함수를 전달하십시오: PrivateKeyJwt(assertion=sign). sign()은 호출될 때마다 새로 서명된 어서션을 반환해야 합니다.

훅 등록

from flask import Flask, g
from keenauth.bff.flask import init_app, require_auth

app = Flask(__name__)
init_app(app, bff)

@app.get("/orders")
@require_auth(bff)
def orders():
    return f"Signed in as {g.keenauth.session.user.email}"

init_app은 아래 라우트를 제공하고, 그 밖의 모든 요청마다 세션을 읽어 g.keenauth에 넣습니다. 이 SDK는 Flask 자체의 session 쿠키를 사용하지 않습니다.

라우트

라우트	기능
`GET /auth/login`	로그인을 시작합니다. 선택적 쿼리 매개변수: `returnTo`(사용자가 이동할 위치)와 `organization`(조직에 로그인).
`GET /auth/callback`	로그인을 완료하고 세션 쿠키를 설정합니다.
`GET` 또는 `POST /auth/logout`	KeenAuth에서 로그아웃하고 애플리케이션으로 돌아갑니다.

로그인은 PKCE(S256)를 사용하는 인가 코드 흐름을 따릅니다. 환경에서 지원하는 경우 요청은 서버로 먼저 전송됩니다(PAR). 콜백에서 SDK는 state, iss, 그리고 nonce를 포함한 ID 토큰을 검사합니다. 로그인에 성공할 때마다 새 세션이 생성되며, 이전 세션은 폐기됩니다.

returnTo는 /orders?tab=open처럼 애플리케이션 자체의 경로여야 합니다. //evil.example이나 전체 URL 같은 다른 값은 무시되며, 사용자는 /로 이동합니다.

보호된 뷰

라우트 데코레이터 아래에 @require_auth(bff)를 붙여 뷰를 장식하십시오.

세션이 없는 경우:

페이지 요청(GET 또는 HEAD)은 returnTo와 함께 /auth/login으로 리디렉션됩니다.
/api/… 요청 또는 다른 메서드의 요청은 문제 문서와 함께 401을 받습니다. 모든 경로에서 401로 응답하려면 api=True를 전달하십시오.

POST, PUT, PATCH, DELETE 등 안전하지 않은 메서드의 경우, 브라우저는 요청이 애플리케이션에서 왔음을 알려야 합니다: Sec-Fetch-Site: same-origin이거나, 애플리케이션 출처와 같은 Origin 헤더가 있어야 합니다. 그 밖의 요청은 403을 받습니다. 이는 SameSite=Lax에 더해 사이트 간 요청 위조(CSRF)를 방지합니다.

세션 사용 및 API 호출

세션 컨텍스트에는 다음이 포함됩니다:

session: None 또는 로그인한 사용자. session.user에는 subject, email, name, org_id, org_roles 같은 타입이 지정된 ID 토큰 클레임이 있으며, 모든 클레임은 session.user.claims에 있습니다. 세션 객체에는 토큰이 전혀 포함되지 않습니다.
access_token: 서버 측 호출에 사용할 유효한 액세스 토큰 또는 None. 브라우저로 보내지 마십시오.

액세스 토큰이 60초 이내에 만료되면, SDK는 뷰가 실행되기 전에 토큰을 갱신합니다. 갱신할 때마다 리프레시 토큰이 교체되고 응답에 새 세션 쿠키가 설정됩니다. 서버가 리프레시 토큰을 거부하면 세션이 종료됩니다. 일시적인 서버 오류의 경우 세션은 그대로 유지됩니다. 한 프로세스에서 동시에 들어온 요청들은 하나의 갱신을 공유합니다.

조직 전환

bff.switch_organization_path("org_01j9…", "/dashboard")는 /auth/login으로 연결되는 링크를 반환하며, 이 링크는 사용자가 해당 조직에서 다시 로그인하도록 합니다. KeenAuth가 멤버십을 확인합니다. 로그인 후 session.user.org_id에 조직이 저장됩니다.

로그아웃

폼에서 /auth/logout으로 POST 요청을 보내십시오. SDK는 세션 쿠키(저장소를 사용하는 경우 저장된 세션도)를 삭제하고, 리프레시 토큰을 취소한 뒤, 브라우저를 환경의 로그아웃 엔드포인트로 보내 애플리케이션으로 돌아오게 합니다. 브라우저가 다른 사이트에서 왔다고 표시한 요청은 거부됩니다. Sec-Fetch-Site를 보내지 않는 브라우저는 자체 페이지에서 보낸 POST로만 로그아웃할 수 있습니다.

세션 저장소

기본적으로 전체 세션은 쿠키에 저장되며, secret에서 파생된 키를 사용하는 AES-256-GCM으로 암호화되고 인증됩니다. 변경되었거나 복사된 쿠키는 거부됩니다. 쿠키 이름은 __Host-keenauth_session.0이며, Secure, HttpOnly, SameSite=Lax, Path=/ 속성으로 설정됩니다. http://localhost에서는 __Host- 접두사와 Secure가 생략됩니다. 큰 세션은 최대 3개의 쿠키로 나뉩니다.

토큰을 서버에 보관하려면 get(id), set(id, session, ttl_seconds), delete(id) 메서드를 가진 객체를 store=로 전달하십시오(예: Redis 기반). 이 경우 쿠키에는 암호화된 임의의 세션 ID만 저장됩니다. 로그인할 때마다 새 ID가 생성되고 이전 레코드는 삭제됩니다. 저장소에는 토큰이 보관되므로 접근을 제한하십시오. MemorySessionStore는 개발 및 테스트 용도로만 사용하십시오.

세션의 최대 유효 기간은 7일(session_max_age)이며, 갱신해도 연장되지 않습니다. 비밀 값을 변경하려면 목록을 전달하십시오: secret=[new_secret, old_secret]. 이전 비밀 값은 session_max_age가 지난 후 제거하십시오.

현재 제한 사항

DPoP에 바인딩된 토큰과 백채널 로그아웃은 아직 처리되지 않습니다.
갱신 공유는 하나의 서버 프로세스 내에서만 이루어집니다. 여러 프로세스를 사용하는 경우, 애플리케이션 설정 refresh_reuse_interval_s(기본값 5초)를 통해 병렬 갱신이 성공하도록 할 수 있습니다. 이 값을 0으로 설정하면 두 번째 갱신이 세션을 종료합니다.