Python 웹 애플리케이션에 인증 (Authentication)을 추가하세요

이 가이드는 Python 웹 애플리케이션에 Logto를 통합하는 방법을 보여줍니다.

팁:

이 예제는 Flask를 사용하지만, 개념은 다른 프레임워크에서도 동일합니다.
Python 샘플 프로젝트는 우리의 Python SDK 저장소에서 확인할 수 있습니다.
Logto SDK는 코루틴을 활용하므로, 비동기 함수를 호출할 때 await를 사용하는 것을 잊지 마세요.

사전 준비 사항

Logto Cloud 계정 또는 자체 호스팅 Logto.
Logto 전통적인 웹 애플리케이션 생성.

설치

프로젝트 루트 디렉토리에서 실행하세요:

pip install logto # 또는 `poetry add logto` 또는 사용하는 다른 방법

통합

LogtoClient 초기화

먼저, Logto 설정을 생성하세요:

client.py
from logto import LogtoClient, LogtoConfig

client = LogtoClient(
    LogtoConfig(
        endpoint="https://you-logto-endpoint.app",  # Logto 엔드포인트로 교체하세요
        appId="replace-with-your-app-id",
        appSecret="replace-with-your-app-secret",
    ),
)

팁:

"App Secret"은 Admin Console의 애플리케이션 세부 정보 페이지에서 찾고 복사할 수 있습니다:

또한 기본 메모리 저장소를 지속적인 저장소로 교체하세요. 예를 들어:

client.py
from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union

class SessionStorage(Storage):
    def get(self, key: str) -> Union[str, None]:
        return session.get(key, None)

    def set(self, key: str, value: Union[str, None]) -> None:
        session[key] = value

    def delete(self, key: str) -> None:
        session.pop(key, None)

client = LogtoClient(
    LogtoConfig(...),
    storage=SessionStorage(),
)

자세한 내용은 Storage 를 참조하세요.

리디렉션 URI 구성

세부 사항을 살펴보기 전에, 최종 사용자 경험에 대한 간단한 개요를 소개합니다. 로그인 과정은 다음과 같이 간소화될 수 있습니다:

귀하의 앱이 로그인 메서드를 호출합니다.
사용자는 Logto 로그인 페이지로 리디렉션됩니다. 네이티브 앱의 경우, 시스템 브라우저가 열립니다.
사용자가 로그인하고 귀하의 앱으로 다시 리디렉션됩니다 (리디렉션 URI로 구성됨).

이 인증 과정은 OpenID Connect (OIDC) 프로토콜을 따르며, Logto는 사용자 로그인을 보호하기 위해 엄격한 보안 조치를 시행합니다.
여러 앱이 있는 경우, 동일한 아이덴티티 제공자 (Logto)를 사용할 수 있습니다. 사용자가 한 앱에 로그인하면, Logto는 사용자가 다른 앱에 접근할 때 자동으로 로그인 과정을 완료합니다.

리디렉션 기반 로그인에 대한 이론적 배경과 이점에 대해 더 알고 싶다면, Logto 로그인 경험 설명을 참조하세요.

노트:

다음 코드 스니펫에서는, 여러분의 앱이 http://localhost:3000/ 에서 실행되고 있다고 가정합니다.

리디렉션 URI 구성

Logto Console의 애플리케이션 세부 정보 페이지로 이동합니다. 리디렉션 URI http://localhost:3000/callback를 추가하세요.

로그인과 마찬가지로, 사용자는 공유 세션에서 로그아웃하기 위해 Logto로 리디렉션되어야 합니다. 완료되면 사용자를 다시 웹사이트로 리디렉션하면 좋습니다. 예를 들어, 로그아웃 후 리디렉션 URI 섹션에 http://localhost:3000/를 추가하세요.

그런 다음 "저장"을 클릭하여 변경 사항을 저장하세요.

웹 애플리케이션에서 사용자의 로그인 요청을 적절히 처리하기 위해 경로를 추가하세요. /sign-in을 예로 들어 보겠습니다:

flask.py
@app.route("/sign-in")
async def sign_in():
  # 로그인 URL을 가져와 사용자에게 리디렉션합니다
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
  ))

이 애플리케이션에 대해 Logto Console에 설정한 콜백 URL로 http://localhost:3000/callback를 교체하세요.

첫 화면에 회원가입 페이지를 표시하려면 interactionMode를 signUp으로 설정할 수 있습니다:

flask.py
@app.route("/sign-in")
async def sign_in():
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
      interactionMode="signUp", # 첫 화면에 회원가입 페이지를 표시합니다
  ))

이제 사용자가 http://localhost:3000/sign-in을 방문할 때마다 새로운 로그인 시도가 시작되고 사용자는 Logto 로그인 페이지로 리디렉션됩니다.

참고 로그인 경로를 만드는 것이 로그인 시도를 시작하는 유일한 방법은 아닙니다. 항상 signIn 메서드를 사용하여 로그인 URL을 얻고 사용자에게 리디렉션할 수 있습니다.

사용자가 로그아웃 요청을 하면, Logto는 세션에서 모든 사용자 인증 정보를 지웁니다.

Python 세션과 Logto 세션을 정리하기 위해, 로그아웃 경로를 다음과 같이 구현할 수 있습니다:

flask.py
@app.route("/sign-out")
async def sign_out():
  return redirect(
      # 성공적인 로그아웃 후 사용자를 홈 페이지로 리디렉션합니다
      await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
  )

인증 상태 처리

Logto SDK 에서 client.isAuthenticated()를 사용하여 인증 상태를 확인할 수 있습니다. 사용자가 로그인되어 있으면 값은 true가 되고, 그렇지 않으면 값은 false가 됩니다.

여기서는 데모를 위해 간단한 홈 페이지를 구현합니다:

사용자가 로그인되어 있지 않으면, 로그인 버튼을 표시합니다.
사용자가 로그인되어 있으면, 로그아웃 버튼을 표시합니다.

@app.route("/")
async def home():
    if client.isAuthenticated() is False:
        return "인증되지 않음 <a href='/sign-in'>로그인</a>"
    return "인증됨 <a href='/sign-out'>로그아웃</a>"

체크포인트: 애플리케이션 테스트하기

이제 애플리케이션을 테스트할 수 있습니다:

애플리케이션을 실행하면 로그인 버튼이 표시됩니다.
로그인 버튼을 클릭하면 SDK가 로그인 프로세스를 초기화하고 Logto 로그인 페이지로 리디렉션됩니다.
로그인 후, 애플리케이션으로 다시 리디렉션되어 로그아웃 버튼이 표시됩니다.
로그아웃 버튼을 클릭하여 토큰 저장소를 지우고 로그아웃합니다.

사용자 정보 가져오기

사용자 정보 표시

사용자의 정보를 표시하려면 getIdTokenClaims 메서드 또는 fetchUserInfo 메서드를 사용하여 사용자 정보를 가져올 수 있습니다. getIdTokenClaims는 ID 토큰에 포함된 사용자 정보를 반환하는 반면, fetchUserInfo는 userinfo 엔드포인트에서 사용자 정보를 가져옵니다.

보시다시피, 우리는 @authenticated 데코레이터를 사용하여 Flask 애플리케이션 API에 사용자 정보 컨텍스트를 제공합니다.

authenticated.py
from functools import wraps
from flask import g, jsonify, redirect
from samples.client import client
def authenticated(shouldRedirect: bool = False, fetchUserInfo: bool = False):
  def decorator(func):
      @wraps(func)
      async def wrapper(*args, **kwargs):
          if client.isAuthenticated() is False:
              if shouldRedirect:
                  return redirect("/sign-in")
              return jsonify({"error": "Not authenticated"}), 401
          # 사용자 정보를 Flask 애플리케이션 컨텍스트에 저장
          g.user = (
              await client.fetchUserInfo()
              if fetchUserInfo
              else client.getIdTokenClaims()
          )
          return await func(*args, **kwargs)
      return wrapper
  return decorator

예를 들어, API에서 사용자의 정보를 표시하려면 다음 코드를 사용할 수 있습니다:

flask.py
@app.route("/protected/userinfo")
@authenticated(shouldRedirect=True, fetchUserInfo=True)
async def protectedUserinfo():
  try:
      return (
          "<h2>User info</h2>"
          + g.user.model_dump_json(indent=2, exclude_unset=True).replace("\n", "<br>")
          + navigationHtml
      )
  except LogtoException as e:
      return "<h2>Error</h2>" + str(e) + "<br>" + navigationHtml

우리의 데이터 모델은 pydantic을 기반으로 하므로 model_dump_json을 사용하여 데이터 모델을 JSON으로 덤프할 수 있습니다.

exclude_unset=True를 추가하면 JSON 출력에서 설정되지 않은 필드를 제외하여 출력을 더 정확하게 만듭니다.

예를 들어, 로그인할 때 email 스코프를 요청하지 않았다면, email 필드는 JSON 출력에서 제외됩니다. 그러나 email 스코프를 요청했지만 사용자가 이메일 주소를 가지고 있지 않다면, email 필드는 null 값으로 JSON 출력에 포함됩니다.

스코프와 클레임에 대해 더 알고 싶다면 사용자 정보 가져오기를 참조하세요.

추가 클레임 요청

client.getIdTokenClaims()에서 반환된 객체에 일부 사용자 정보가 누락된 것을 발견할 수 있습니다. 이는 OAuth 2.0 및 OpenID Connect (OIDC)가 최소 권한 원칙 (PoLP)을 따르도록 설계되었기 때문이며, Logto는 이러한 표준을 기반으로 구축되었습니다.

기본적으로 제한된 클레임 (Claim)만 반환됩니다. 더 많은 정보를 원하시면, 추가적인 스코프 (Scope)를 요청하여 더 많은 클레임에 접근할 수 있습니다.

정보:

"클레임 (Claim)"은 주체에 대해 주장하는 내용이며, "스코프 (Scope)"는 클레임의 그룹입니다. 현재의 경우, 클레임은 사용자에 대한 정보입니다.

다음은 스코프 - 클레임 관계의 비규범적 예시입니다:

팁:

"sub" 클레임은 "주체"를 의미하며, 이는 사용자의 고유 식별자 (즉, 사용자 ID)입니다.

Logto SDK는 항상 세 가지 스코프를 요청합니다: openid, profile, 그리고 offline_access.

추가 스코프를 요청하려면 LogtoConfig 객체에 스코프를 전달할 수 있습니다. 예를 들어:

client.py
from logto import UserInfoScope

client = LogtoClient(
    LogtoConfig(
        # ...other configurations
        scopes = [
            UserInfoScope.email,
            UserInfoScope.phone,
        ],
    ),
    storage=SessionStorage(),
)

그런 다음 client.getIdTokenClaims()의 반환 값에서 추가 클레임에 접근할 수 있습니다:

idTokenClaims = await client.getIdTokenClaims();

네트워크 요청이 필요한 클레임

ID 토큰의 비대화를 방지하기 위해, 일부 클레임은 네트워크 요청을 통해 가져와야 합니다. 예를 들어, custom_data 클레임은 스코프에서 요청되더라도 사용자 객체에 포함되지 않습니다. 이러한 클레임에 접근하려면, client.fetchUserInfo() 메서드를 사용할 수 있습니다:

flask.py
(await client.fetchUserInfo()).custom_data

이 메서드는 userinfo 엔드포인트에 요청하여 사용자 정보를 가져옵니다. 사용 가능한 스코프와 클레임에 대해 더 알고 싶다면, 스코프와 클레임 섹션을 참조하세요.

스코프와 클레임

Logto는 OIDC 스코프 및 클레임 규약을 사용하여 ID 토큰 및 OIDC userinfo 엔드포인트에서 사용자 정보를 가져오기 위한 스코프와 클레임을 정의합니다. "스코프"와 "클레임"은 OAuth 2.0 및 OpenID Connect (OIDC) 사양의 용어입니다.

지원되는 스코프와 해당 클레임 (Claims) 목록은 다음과 같습니다:

openid

클레임 이름	유형	설명	사용자 정보 필요 여부
sub	`string`	사용자의 고유 식별자	아니요

profile

클레임 이름	유형	설명	사용자 정보 필요 여부
name	`string`	사용자의 전체 이름	아니요
username	`string`	사용자의 사용자 이름	아니요
picture	`string`	최종 사용자의 프로필 사진 URL. 이 URL은 이미지 파일 (예: PNG, JPEG, 또는 GIF 이미지 파일)을 참조해야 하며, 이미지를 포함하는 웹 페이지를 참조해서는 안 됩니다. 이 URL은 최종 사용자를 설명할 때 표시하기 적합한 프로필 사진을 구체적으로 참조해야 하며, 최종 사용자가 찍은 임의의 사진을 참조해서는 안 됩니다.	아니요
created_at	`number`	최종 사용자가 생성된 시간. 시간은 유닉스 에포크 (1970-01-01T00:00:00Z) 이후 밀리초 수로 표현됩니다.	아니요
updated_at	`number`	최종 사용자의 정보가 마지막으로 업데이트된 시간. 시간은 유닉스 에포크 (1970-01-01T00:00:00Z) 이후 밀리초 수로 표현됩니다.	아니요

다른 표준 클레임인 family_name, given_name, middle_name, nickname, preferred_username, profile, website, gender, birthdate, zoneinfo, 및 locale도 사용자 정보 엔드포인트를 요청할 필요 없이 profile 스코프에 포함됩니다. 위의 클레임과의 차이점은 이러한 클레임은 값이 비어 있지 않을 때만 반환되며, 위의 클레임은 값이 비어 있을 경우 null을 반환한다는 점입니다.

노트:

표준 클레임과 달리, created_at 및 updated_at 클레임은 초 대신 밀리초를 사용합니다.

email

클레임 이름	유형	설명	사용자 정보 필요 여부
email	`string`	사용자의 이메일 주소	아니요
email_verified	`boolean`	이메일 주소가 검증되었는지 여부	아니요

phone

클레임 이름	유형	설명	사용자 정보 필요 여부
phone_number	`string`	사용자의 전화번호	아니요
phone_number_verified	`boolean`	전화번호가 검증되었는지 여부	아니요

address

주소 클레임의 세부 사항은 OpenID Connect Core 1.0을 참조하세요.

custom_data

클레임 이름	유형	설명	사용자 정보 필요 여부
custom_data	`object`	사용자의 사용자 정의 데이터	예

identities

클레임 이름	유형	설명	사용자 정보 필요 여부
identities	`object`	사용자의 연결된 아이덴티티	예
sso_identities	`array`	사용자의 연결된 SSO 아이덴티티	예

roles

클레임 이름	유형	설명	사용자 정보 필요 여부
roles	`string[]`	사용자의 역할	아니요

urn:logto:scope:organizations

클레임 이름	유형	설명	사용자 정보 필요 여부
organizations	`string[]`	사용자가 속한 조직 ID	아니요
organization_data	`object[]`	사용자가 속한 조직 데이터	예

urn:logto:scope:organization_roles

클레임 이름	유형	설명	사용자 정보 필요 여부
organization_roles	`string[]`	사용자가 속한 조직 역할, 형식은 `<organization_id>:<role_name>`	아니요

성능과 데이터 크기를 고려할 때, "사용자 정보 필요 여부"가 "예"인 경우, 해당 클레임은 ID 토큰에 나타나지 않으며, userinfo 엔드포인트 응답에서 반환됩니다.

API 리소스 및 조직

먼저 🔐 역할 기반 접근 제어 (RBAC)를 읽어 Logto RBAC의 기본 개념과 API 리소스를 적절히 설정하는 방법을 이해하는 것을 권장합니다.

Logto 클라이언트 구성

API 리소스를 설정한 후, 애플리케이션에서 Logto를 구성할 때 이를 추가할 수 있습니다:

client.py
client = LogtoClient(
    LogtoConfig(
        # ...other configs
        resources=["https://shopping.your-app.com/api", "https://store.your-app.com/api"], # API 리소스를 추가하세요
    ),
)

각 API 리소스는 자체 권한 (스코프)을 가지고 있습니다.

예를 들어, https://shopping.your-app.com/api 리소스는 shopping:read 및 shopping:write 권한을 가지고 있으며, https://store.your-app.com/api 리소스는 store:read 및 store:write 권한을 가지고 있습니다.

이러한 권한을 요청하려면, 애플리케이션에서 Logto를 구성할 때 추가할 수 있습니다:

client.py
client = LogtoClient(
    LogtoConfig(
        # ...other configs
        scopes=["shopping:read", "shopping:write", "store:read", "store:write"],
        resources=["https://shopping.your-app.com/api", "https://store.your-app.com/api"],
    ),
)

스코프가 API 리소스와 별도로 정의된 것을 알 수 있습니다. 이는 OAuth 2.0을 위한 리소스 지표가 요청의 최종 스코프가 모든 대상 서비스의 모든 스코프의 데카르트 곱이 될 것이라고 명시하기 때문입니다.

따라서 위의 경우, Logto에서 정의된 스코프를 단순화할 수 있으며, 두 API 리소스 모두 접두사 없이 read 및 write 스코프를 가질 수 있습니다. 그런 다음, Logto 구성에서:

client.py
client = LogtoClient(
    LogtoConfig(
        # ...other configs
        scopes=["read", "write"],
        resources=["https://shopping.your-app.com/api", "https://store.your-app.com/api"],
    ),
)

모든 API 리소스에 대해 read 및 write 스코프를 요청하게 됩니다.

노트:

API 리소스에 정의되지 않은 스코프를 요청해도 괜찮습니다. 예를 들어, API 리소스에 email 스코프가 없더라도 email 스코프를 요청할 수 있습니다. 사용 불가능한 스코프는 안전하게 무시됩니다.

성공적으로 로그인한 후, Logto는 사용자의 역할에 따라 API 리소스에 적절한 스코프를 발급합니다.

API 리소스를 위한 액세스 토큰 가져오기

특정 API 리소스에 대한 액세스 토큰을 가져오려면 GetAccessToken 메서드를 사용할 수 있습니다:

flask.py
accessToken = await client.getAccessToken("https://shopping.your-app.com/api")
# 또는
claims = await client.getAccessTokenClaims("https://shopping.your-app.com/api")

이 메서드는 사용자가 관련 권한을 가지고 있을 때 API 리소스에 접근할 수 있는 JWT 액세스 토큰을 반환합니다. 현재 캐시된 액세스 토큰이 만료된 경우, 이 메서드는 자동으로 리프레시 토큰을 사용하여 새로운 액세스 토큰을 얻으려고 시도합니다.

조직 토큰 가져오기

조직이 처음이라면, 시작하기 위해 🏢 조직 (다중 테넌시)을 읽어보세요.

Logto 클라이언트를 구성할 때 core.UserScopeOrganizations 스코프를 추가해야 합니다:

client.py
from logto import LogtoClient, LogtoConfig, UserInfoScope

client = LogtoClient(
    LogtoConfig(
        # ...other configs
        scopes=[UserInfoScope.organizations],
    ),
)

사용자가 로그인하면, 사용자에 대한 조직 토큰을 가져올 수 있습니다:

flask.py
# 매개변수를 유효한 조직 ID로 교체하세요.
# 사용자의 유효한 조직 ID는 ID 토큰 클레임 `organizations`에서 찾을 수 있습니다.
organizationToken = await client.getOrganizationToken(organization_id)
# 또는
organizationTokenClaims = await client.getOrganizationTokenClaims(organization_id)

추가 읽을거리

최종 사용자 흐름: 인증 흐름, 계정 흐름, 및 조직 흐름 커넥터 구성 API 보호

사전 준비 사항​

설치​

통합​

LogtoClient 초기화​

리디렉션 URI 구성​

리디렉션 기반 로그인에 관하여​

리디렉션 URI 구성​

로그인 및 로그아웃 경로 구현​

인증 상태 처리​

체크포인트: 애플리케이션 테스트하기​

사용자 정보 가져오기​

사용자 정보 표시​

추가 클레임 요청​

네트워크 요청이 필요한 클레임​

스코프와 클레임​

API 리소스 및 조직​

Logto 클라이언트 구성​

API 리소스를 위한 액세스 토큰 가져오기​

조직 토큰 가져오기​

추가 읽을거리​

사전 준비 사항

설치

통합

LogtoClient 초기화

리디렉션 URI 구성

리디렉션 기반 로그인에 관하여

리디렉션 URI 구성

로그인 및 로그아웃 경로 구현

인증 상태 처리

체크포인트: 애플리케이션 테스트하기

사용자 정보 가져오기

사용자 정보 표시

추가 클레임 요청

네트워크 요청이 필요한 클레임

스코프와 클레임

API 리소스 및 조직

Logto 클라이언트 구성

API 리소스를 위한 액세스 토큰 가져오기

조직 토큰 가져오기

추가 읽을거리