Keycloak

설치

개요

Keycloak은 내장된 일반 OAuth2 제공자를 통해 작동합니다. Keycloak에 대한 새로운 네이티브 제공자가 필요하지 않습니다. Keycloak 클라이언트를 OpenID Connect 클라이언트로 구성하고 provider: 'oauth2' 안정적인 providerId예를 들어 keycloak.

Keycloak 클라이언트 설정

Keycloak 영역에서 앱 Capacitor이 사용하는 클라이언트를 생성하거나 열어주세요:

인증 code 흐름을 사용하세요.
앱 구성에서 PKCE를 활성화하세요.
앱이 사용하는 모든 리다이렉트 URI를 등록하세요. 예를 들어 myapp://oauth/keycloak 모바일용으로 및 HTTPS callback URL을 프로덕션 웹용으로.
사용할 수 있는 범위는 openid profile email. 추가할 때만 offline_access refresh 토큰을 발급할 수 있는 realm과 client가 구성되어 있을 때만.

issuer URL은 배포에 따라 달라집니다. 현재 Keycloak 배포에서는 일반적으로 realm 메타데이터를 https://keycloak.example.com/realms/my-realm/.well-known/openid-configuration,에 공개합니다. 하지만 일부 배포에서는 추가 base path를 포함할 수 있습니다. realm의 OpenID Endpoint Configuration에서 issuer URL을 표시하는 것을 사용하세요.

OIDC discovery 예시

prefer issuerUrl realm 메타데이터에서 authorization, token, logout endpoint를 발견할 수 있도록 플러그인을 도와주세요:

import { SocialLogin } from '@capgo/capacitor-social-login';

const keycloakIssuer = 'https://keycloak.example.com/realms/my-realm';

await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      appId: 'your-keycloak-client-id',
      issuerUrl: keycloakIssuer,
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email',
      pkceEnabled: true,
      resourceUrl: `${keycloakIssuer}/protocol/openid-connect/userinfo`,
    },
  },
});

const result = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'keycloak',
  },
});

console.log(result.result.idToken);
console.log(result.result.accessToken?.token);
console.log(result.result.resourceData);

refresh 토큰을 요청할 때 offline_access 만약 Keycloak의 도메인과 클라이언트가 이 앱에 대한 리프레시 토큰을 허용한다면:

await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      appId: 'your-keycloak-client-id',
      issuerUrl: keycloakIssuer,
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
    },
  },
});

수동 엔드포인트 fallback

OIDC 디스커버리가 차단되거나 배포가 앱에 메타데이터를 공개하지 않는 경우, 엔드포인트를 직접 구성합니다. Base URL은 Keycloak 배포가 공개하는 것과 정확히 같습니다:

const keycloakRealmUrl = 'https://keycloak.example.com/realms/my-realm';

await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      appId: 'your-keycloak-client-id',
      authorizationBaseUrl: `${keycloakRealmUrl}/protocol/openid-connect/auth`,
      accessTokenEndpoint: `${keycloakRealmUrl}/protocol/openid-connect/token`,
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email',
      pkceEnabled: true,
      resourceUrl: `${keycloakRealmUrl}/protocol/openid-connect/userinfo`,
      logoutUrl: `${keycloakRealmUrl}/protocol/openid-connect/logout`,
    },
  },
});

인증 연결 호환성

Keycloak은 인증 연결의 미리 정의된 제공자 ID 중 하나가 아닙니다. 이미 SocialLoginAuthConnect를 사용하고 있다면, oauth2 를 초기화하고 provider: 'oauth2' 와 로그인할 수 있습니다. providerId: 'keycloak'.

See the Keycloak OpenID Connect endpoint reference for discovery and endpoint paths.

Keycloak에서 계속 진행

Keycloak을 사용 중이라면 Keycloak 인증 및 계정 흐름을 계획하고 연결하려면 @capgo/capacitor-social-login을 사용하여 @capgo/capacitor-social-login의 원시 기능을 사용하여 @capgo/capacitor-social-login @capgo/capacitor-social-login의 구현 세부 정보를 위해 @capgo/capacitor-passkey @capgo/capacitor-passkey의 구현 세부 정보를 위해 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric의 구현 세부 정보를 위해, 두 단계 인증 두 단계 인증의 구현 세부 정보를 위해