K-Auth

한국 앱을 위한 소셜 로그인 SDK

카카오, 네이버, 구글, 애플 로그인을 하나의 통합 API로

설치 • 빠른 시작 • Features • API • 플랫폼 설정

Features #

설치 #

flutter pub add k_auth

빠른 시작 #

1. 초기화 #

import 'package:k_auth/k_auth.dart';

final kAuth = KAuth(
  config: KAuthConfig(
    kakao: KakaoConfig(appKey: 'YOUR_APP_KEY'),
    naver: NaverConfig(
      clientId: 'YOUR_CLIENT_ID',
      clientSecret: 'YOUR_CLIENT_SECRET',
      appName: 'Your App',
    ),
    google: GoogleConfig(),
    apple: AppleConfig(),
  ),
);

await kAuth.initialize();

2. 로그인 #

final result = await kAuth.signIn(AuthProvider.kakao);

result.fold(
  onSuccess: (user) => print('환영합니다, ${user.displayName}!'),
  onFailure: (error) => print('로그인 실패: $error'),
);

3. UI 버튼 #

// 개별 버튼
KakaoLoginButton(onPressed: () => kAuth.signIn(AuthProvider.kakao))

// 버튼 그룹
LoginButtonGroup(
  providers: [AuthProvider.kakao, AuthProvider.naver, AuthProvider.google],
  onPressed: (provider) => kAuth.signIn(provider),
)

API #

함수형 결과 처리 #

// fold: 성공/실패 분기
result.fold(
  onSuccess: (user) => navigateToHome(user),
  onFailure: (error) => showError(error),
);

// when: 성공/취소/실패 세분화
result.when(
  success: (user) => navigateToHome(user),
  cancelled: () => showToast('취소됨'),
  failure: (code, msg) => showError(msg),
);

// 체이닝
result
  .onSuccess((user) => saveUser(user))
  .onFailure((code, msg) => logError(msg));

자동 로그인 #

final kAuth = KAuth(
  config: config,
  storage: SecureSessionStorage(), // 직접 구현
);

await kAuth.initialize(autoRestore: true);

if (kAuth.isSignedIn) {
  print('자동 로그인: ${kAuth.currentUser?.displayName}');
}

백엔드 연동 #

final kAuth = KAuth(
  config: config,
  onSignIn: (provider, tokens, user) async {
    final jwt = await myApi.socialLogin(
      provider: provider.name,
      accessToken: tokens.accessToken,
    );
    return jwt; // serverToken에 저장됨
  },
);

토큰 갱신 #

final result = await kAuth.refreshToken();

Apple은 토큰 갱신을 지원하지 않습니다.

Provider별 지원 #

KAuth 메서드 #

KAuthUser #

플랫폼 설정 #

<!-- 카카오 -->
<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>kakao{YOUR_APP_KEY}</string>
    </array>
  </dict>
</array>
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>kakaokompassauth</string>
  <string>kakaolink</string>
  <string>kakaotalk</string>
</array>

<!-- 네이버 -->
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>naversearchapp</string>
  <string>naversearchthirdlogin</string>
</array>

<!-- 애플: Xcode > Signing & Capabilities > Sign in with Apple -->

<!-- 카카오 -->
<activity
    android:name="com.kakao.sdk.flutter.AuthCodeCustomTabsActivity"
    android:exported="true">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:host="oauth"
              android:scheme="kakao{YOUR_APP_KEY}" />
    </intent-filter>
</activity>

설정 진단 #

final result = await KAuthDiagnostic.run(kAuth.config);

if (result.hasErrors) {
  print(result.prettyPrint());
}

에러 처리 #

모든 에러는 한글 메시지와 해결 힌트를 포함합니다:

result.when(
  success: (user) => ...,
  cancelled: () => showToast('취소됨'),
  failure: (code, message) {
    // code: USER_CANCELLED, NETWORK_ERROR, PROVIDER_NOT_CONFIGURED 등
    showError(message);
  },
);

Contributing #

이슈와 PR을 환영합니다! CONTRIBUTING.md를 참고해주세요.

License #

MIT License - 자세한 내용은 LICENSE 파일을 참고하세요.

Made with ❤️ for Korean developers