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

팁:

다음 데모는 Nuxt 3.10.2를 기반으로 구축되었습니다.
샘플 프로젝트는 GitHub 저장소에서 확인할 수 있습니다.
Logto Nuxt SDK는 서버 사이드 렌더링 (SSR)이 제대로 작동하기 위해 필요합니다. 단일 페이지 애플리케이션 (SPA)의 경우, 우리의 Vue SDK를 확인하세요.

사전 준비 사항

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

설치

선호하는 패키지 관리자를 통해 Logto SDK를 설치하세요:

npm
pnpm
Yarn

npm i @logto/nuxt

pnpm add @logto/nuxt

yarn add @logto/nuxt

통합

Logto 모듈 등록

Nuxt 구성 파일에서 Logto 모듈을 추가하고 구성하세요:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@logto/nuxt'],
  runtimeConfig: {
    logto: {
      endpoint: '<your-logto-endpoint>',
      appId: '<your-logto-app-id>',
      appSecret: '<your-logto-app-secret>',
      cookieEncryptionKey: '<a-random-string>',
    },
  },
  // ...other configurations
});

이 정보는 민감하므로 환경 변수 (.env)를 사용하는 것이 좋습니다:

.env
NUXT_LOGTO_ENDPOINT="<your-logto-endpoint>"
NUXT_LOGTO_APP_ID="<your-logto-app-id>"
NUXT_LOGTO_APP_SECRET="<your-logto-app-secret>"
NUXT_LOGTO_COOKIE_ENCRYPTION_KEY="<a-random-string>"

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

리디렉션 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/를 추가하세요.

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

콜백 처리

콜백 경로를 처리하기 위한 추가 설정은 필요하지 않습니다. @logto/nuxt 모듈을 등록하면 다음을 수행합니다:

로그인 (/sign-in), 로그아웃 (/sign-out), 콜백 (/callback)에 대한 세 가지 경로를 추가합니다.
두 가지 composable을 가져옵니다: useLogtoClient 및 useLogtoUser.

이 경로들은 모듈 옵션의 logto.pathnames를 통해 구성할 수 있습니다. 예를 들어:

nuxt.config.ts
export default defineNuxtConfig({
  logto: {
    pathnames: {
      signIn: '/login',
      signOut: '/logout',
      callback: '/auth/callback',
    },
  },
  // ...other configurations
});

@logto/nuxt 패키지의 type definition file을 확인하여 더 많은 정보를 얻으세요.

노트:

콜백 경로를 다른 경로로 구성하는 경우, Logto에서 리디렉션 URI를 해당 경로로 업데이트해야 합니다.

Nuxt 페이지는 초기 로드 후 단일 페이지 애플리케이션 (SPA)으로 변환되므로, 필요할 때 사용자를 로그인 또는 로그아웃 경로로 리디렉션해야 합니다. 이를 돕기 위해, 우리의 SDK는 서버 및 클라이언트 측에서 사용할 수 있는 useLogtoUser() composable을 제공합니다.

index.vue
<script setup lang="ts">
  import { useLogtoUser } from '#imports'; // 자동 가져오기가 비활성화된 경우 이 줄을 추가하세요
  const user = useLogtoUser();
</script>
<template>
  <!-- 로그인 및 로그아웃을 위한 간단한 버튼 -->
  <nuxt-link :to="`/sign-${ user ? 'out' : 'in' }`"> Sign {{ user ? 'out' : 'in' }} </nuxt-link>
</template>

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

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

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

사용자 정보 가져오기

사용자 정보 표시

사용자가 로그인하면, useLogtoUser()의 반환 값은 사용자의 정보를 포함하는 객체가 됩니다. 이 정보를 앱에서 표시할 수 있습니다:

index.vue
<script setup lang="ts">
  const user = useLogtoUser();
</script>
<template>
  <!-- 로그인 시 사용자 정보 표시 -->
  <ul v-if="Boolean(user)">
    <li v-for="(value, key) in user"><b>{{ key }}:</b> {{ value }}</li>
  </ul>
  <!-- 로그인 및 로그아웃을 위한 간단한 버튼 -->
  <nuxt-link :to="`/sign-${ user ? 'out' : 'in' }`"> Sign {{ user ? 'out' : 'in' }} </nuxt-link>
</template>

추가 클레임 (Claims) 요청

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

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

정보:

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

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

팁:

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

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

추가 스코프를 요청하려면, logto 모듈 옵션을 구성할 수 있습니다:

nuxt.config.ts
import { UserScope } from '@logto/nuxt';

export default defineNuxtConfig({
  logto: {
    scopes: [UserScope.Email, UserScope.Phone], // 필요에 따라 더 많은 스코프 추가
    // ...other configs
  },
});

그런 다음 user 객체에서 추가 클레임에 접근할 수 있습니다:

index.vue
<template>
  <div v-if="user">
    <p>Name: {{ user.name }}</p>
    <p>Email: {{ user.email }}</p>
    <p>Phone: {{ user.phone }}</p>
  </div>
</template>

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

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

nuxt.config.ts
export default defineNuxtConfig({
logto: {
  scopes: [UserScope.CustomData],
  fetchUserInfo: true,
},
// ...other configurations
});

fetchUserInfo을 구성하면, SDK는 사용자가 로그인한 후 userinfo 엔드포인트에 요청하여 사용자 정보를 가져오며, 요청이 완료되면 user.custom_data를 사용할 수 있게 됩니다.

사용자 정보 수동으로 가져오기

Logto 클라이언트가 제공하는 모든 메서드에 접근하려면, useLogtoClient() 컴포저블을 사용할 수 있습니다:

index.vue
const client = useLogtoClient();

경고:

Logto 클라이언트는 서버 사이드에서만 사용할 수 있습니다. 컴포저블은 클라이언트 사이드에서 undefined를 반환합니다.

Logto 메서드를 사용하여 프로그래밍 방식으로 사용자 정보를 검색할 수 있습니다:

client.getIdTokenClaims(): 로컬 ID 토큰을 디코딩하여 사용자 정보를 가져옵니다. 일부 클레임은 사용할 수 없을 수 있습니다.
client.fetchUserInfo(): userinfo 엔드포인트에 요청을 보내 사용자 정보를 가져옵니다.

사용자 정보 클레임은 사용자가 로그인할 때 사용한 스코프에 따라 검색할 수 있으며, 성능과 데이터 크기를 고려할 때 ID 토큰에 모든 사용자 클레임이 포함되지 않을 수 있습니다. 일부 사용자 클레임은 userinfo 엔드포인트에서만 사용할 수 있습니다 (아래 관련 목록 참조).

예를 들어, 사용자 정보를 수동으로 가져오려면:

index.vue
import { useLogtoClient, useState, callOnce } from '#imports';

const client = useLogtoClient();
const userInfo = useState(null);

// 클라이언트 사이드에서 실행되지 않도록 한 번만 호출
await callOnce(async () => {
  if (!client) {
    throw new Error('Logto 클라이언트를 사용할 수 없습니다');
  }

  if (!(await client.isAuthenticated())) {
    return;
  }

  try {
    userInfo.value = await client.fetchUserInfo();
  } catch (error) {
    console.error('사용자 정보를 가져오지 못했습니다:', error);
  }
});

스코프와 클레임

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를 구성할 때 이를 추가할 수 있습니다:

nuxt.config.ts
export default defineNuxtConfig({
  logto: {
    resources: ['https://shopping.your-app.com/api', 'https://store.your-app.com/api'], // API 리소스를 추가하세요
    // ...other configs
  },
});

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

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

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

nuxt.config.ts
export default defineNuxtConfig({
  logto: {
    scopes: ['shopping:read', 'shopping:write', 'store:read', 'store:write'],
    resources: ['https://shopping.your-app.com/api', 'https://store.your-app.com/api'],
    // ...other configs
  },
});

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

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

nuxt.config.ts
export default defineNuxtConfig({
  logto: {
    scopes: ['read', 'write'],
    resources: ['https://shopping.your-app.com/api', 'https://store.your-app.com/api'],
    // ...other configs
  },
});

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

노트:

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

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

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

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

index.vue
<script setup lang="ts">
  // Logto 클라이언트에 접근하기 위한 composable
  const client = useLogtoClient();
  // 토큰을 전역적으로 사용 가능하게 설정
  const accessToken = useState<string | undefined>('access-token');

  // 서버 측에서 한 번 호출
  await callOnce(async () => {
    if (!client) {
      throw new Error('Logto 클라이언트를 사용할 수 없습니다');
    }

    if (!(await client.isAuthenticated())) {
      return;
    }

    try {
      accessToken.value = await client.getAccessToken('https://shopping.your-app.com/api');
    } catch (error) {
      console.error('액세스 토큰을 가져오지 못했습니다', error);
    }
  });
</script>

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

조직 토큰 가져오기

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

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

nuxt.config.ts
import { UserScope } from '@logto/nuxt';

export default defineNuxtConfig({
  logto: {
    scopes: [UserScope.Organizations],
    // ...other configs
  },
});

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

index.vue
const token = await client.getOrganizationToken(organizationId);

조직 API 리소스

조직 내 API 리소스에 대한 액세스 토큰을 가져오려면, getAccessToken 메서드를 API 리소스와 조직 ID를 매개변수로 사용하여 호출할 수 있습니다:

index.vue
const accessToken = await client.getAccessToken(
  'https://shopping.your-app.com/api',
  organizationId
);

미들웨어 또는 API 경로에서 사용하기

컴포저블 useLogtoClient() 및 useLogtoUser()는 미들웨어 또는 API 경로에서 사용할 수 없습니다. Logto 클라이언트 및 기타 컨텍스트를 얻기 위해 logtoEventHandler() 함수를 사용할 수 있습니다:

api/auth/get-access-token.ts
import { logtoEventHandler } from '@logto/nuxt';

export default defineEventHandler(async (event) => {
  const config = useRuntimeConfig(event);
  await logtoEventHandler(event, config);
  const accessToken = await event.context.logtoClient.getAccessToken();
  return { accessToken };
});

추가 읽을거리

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

사전 준비 사항​

설치​

통합​

Logto 모듈 등록​

리디렉션 URI 구성​

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

리디렉션 URI 구성​

콜백 처리​

로그인 및 로그아웃 구현​

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

사용자 정보 가져오기​

사용자 정보 표시​

추가 클레임 (Claims) 요청​

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

사용자 정보 수동으로 가져오기​

스코프와 클레임​

API 리소스 및 조직​

Logto 클라이언트 구성하기​

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

조직 토큰 가져오기​

조직 API 리소스​

미들웨어 또는 API 경로에서 사용하기​

추가 읽을거리​

사전 준비 사항

설치

통합

Logto 모듈 등록

리디렉션 URI 구성

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

리디렉션 URI 구성

콜백 처리

로그인 및 로그아웃 구현

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

사용자 정보 가져오기

사용자 정보 표시

추가 클레임 (Claims) 요청

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

사용자 정보 수동으로 가져오기

스코프와 클레임

API 리소스 및 조직

Logto 클라이언트 구성하기

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

조직 토큰 가져오기

조직 API 리소스

미들웨어 또는 API 경로에서 사용하기

추가 읽을거리