Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mirzemehdi/KMPAuth
Kotlin Multiplatform Authentication Library targetting android and iOS
https://github.com/mirzemehdi/KMPAuth
android authentication google-auth-library google-authentication ios kotlin-multiplatform kotlin-multiplatform-library kotlin-multiplatform-mobile
Last synced: 3 months ago
JSON representation
Kotlin Multiplatform Authentication Library targetting android and iOS
- Host: GitHub
- URL: https://github.com/mirzemehdi/KMPAuth
- Owner: mirzemehdi
- License: apache-2.0
- Created: 2023-12-27T16:30:11.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T10:37:24.000Z (3 months ago)
- Last Synced: 2024-07-28T17:15:24.234Z (3 months ago)
- Topics: android, authentication, google-auth-library, google-authentication, ios, kotlin-multiplatform, kotlin-multiplatform-library, kotlin-multiplatform-mobile
- Language: Kotlin
- Homepage: https://mirzemehdi.com/KMPAuth/
- Size: 422 KB
- Stars: 144
- Watchers: 2
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- kmp-awesome - KMPAuth
README
# KMPAuth - Kotlin Multiplatform Authentication Library
[](https://github.com/mirzemehdi/KMPAuth/actions/workflows/build_and_publish.yml)
[](https://kotlinlang.org)
[](https://search.maven.org/search?q=g:io.github.mirzemehdi+kmpauth)
Simple and easy to use Kotlin Multiplatform Authentication library targeting iOS and Android. Supporting **Google**, **Apple**, **Github** authentication integrations using Firebase.
Because I am using KMPAuth in [FindTravelNow](https://github.com/mirzemehdi/FindTravelNow-KMM/) production KMP project, I'll support development of this library :).
Related blog post: [Integrating Google Sign-In into Kotlin Multiplatform](https://proandroiddev.com/integrating-google-sign-in-into-kotlin-multiplatform-8381c189a891)
You can check out [Documentation](https://mirzemehdi.github.io/KMPAuth) for full library api information.
## Sample App and Code
)
```kotlin
@Composable
fun AuthUiHelperButtonsAndFirebaseAuth(
modifier: Modifier = Modifier,
onFirebaseResult: (Result) -> Unit,
) {
Column(modifier = modifier,verticalArrangement = Arrangement.spacedBy(10.dp)) {
//Google Sign-In Button and authentication with Firebase
GoogleButtonUiContainerFirebase(onResult = onFirebaseResult) {
GoogleSignInButton(modifier = Modifier.fillMaxWidth()) { this.onClick() }
}
//Apple Sign-In Button and authentication with Firebase
AppleButtonUiContainer(onResult = onFirebaseResult) {
AppleSignInButton(modifier = Modifier.fillMaxWidth()) { this.onClick() }
}
//Github Sign-In with Custom Button and authentication with Firebase
GithubButtonUiContainer(onResult = onFirebaseResult) {
Button(onClick = { this.onClick() }) { Text("Github Sign-In (Custom Design)") }
}
}
}
```
You can check out more [sample codes](https://github.com/mirzemehdi/KMPAuth/blob/main/sampleApp/composeApp/src/commonMain/kotlin/com/mmk/kmpauth/sample/App.kt) here.
## Features
- ✅ Google One Tap Sign-In (without Firebase)
- ✅ [Google Sign-In with Firebase](#google-sign-in)
- ✅ [Apple Sign-In with Firebase](#apple-sign-in)
- ✅ [Github Sign-In with Firebase](#github-sign-in)
- ✅ Apple and Google "Sign in with " UiHelper buttons (according to each brand's guideline)
- 🚧 Facebook Sign-In (can be implemented in future)
- 📱 Multiplatform (android and iOS)
## Installation
KMPAuth is available on Maven Central. In your root project `build.gradle.kts` file (or `settings.gradle` file) add `mavenCentral()` to repositories.
```kotlin
repositories {
mavenCentral()
}
```
Then in your shared module add desired dependencies in `commonMain`. Latest version: [](https://search.maven.org/search?q=g:io.github.mirzemehdi+kmpauth).
```kotlin
sourceSets {
commonMain.dependencies {
implementation("io.github.mirzemehdi:kmpauth-google:") //Google One Tap Sign-In
implementation("io.github.mirzemehdi:kmpauth-firebase:") //Integrated Authentications with Firebase
implementation("io.github.mirzemehdi:kmpauth-uihelper:") //UiHelper SignIn buttons (AppleSignIn, GoogleSignInButton)
}
}
```
**_You will also need to include Google Sign-In and/or FirebaseAuth library to your ios app using Swift Package Manager or Cocoapods._**
**Note**: If in iOS you get `MissingResourceException`, I wrote solution in this [issue's comment section](https://github.com/mirzemehdi/KMPAuth/issues/2).
-----
### Google Sign-In
For Google Sign-In you can either use only one-tap sign in functionality, or also implementing firebase google authentication integration to that.
You need to set up OAuth 2.0 in Google Cloud Platform Console.
For steps you can follow this [link](https://support.google.com/cloud/answer/6158849). **_Pro Easy Tip:_** If you use Firebase and enable Google Sign-In authentication in Firebase
it will automatically generate OAuth client IDs for each platform,
and one will be **_Web Client ID_** which will be needed for identifying signed-in users in backend server.
#### Platform Setup
Create GoogleAuthProvider instance by providing _**Web Client Id**_ as a serverID on Application start.
```kotlin
GoogleAuthProvider.create(credentials = GoogleAuthCredentials(serverId = WebClientId))
```
Android
##### Android Setup
There is not any platform specific setup in Android side.
iOS
##### iOS Setup
Add clientID, and serverId to your `Info.plist` file as below:
```
GIDServerClientID
YOUR_SERVER_CLIENT_ID
GIDClientID
YOUR_IOS_CLIENT_ID
CFBundleURLTypes
CFBundleURLSchemes
YOUR_DOT_REVERSED_IOS_CLIENT_ID
```
And finally, you need the code below to implement application delegate function calls on the Swift side.
```swift
import SwiftUI
import shared
import GoogleSignIn
class AppDelegate: NSObject, UIApplicationDelegate {
func application(
_ app: UIApplication,
open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]
) -> Bool {
var handled: Bool
handled = GIDSignIn.sharedInstance.handle(url)
if handled {
return true
}
// Handle other custom URL types.
// If not handled by this app, return false.
return false
}
}
@main
struct iOSApp: App {
@UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
var body: some Scene {
WindowGroup {
ContentView().onOpenURL(perform: { url in
GIDSignIn.sharedInstance.handle(url)
})
}
}
}
```
#### Usage
After configuring above steps this is how you can use:
```kotlin
//Google Sign-In with Custom Button (only one tap sign-in functionality)
GoogleButtonUiContainer(onGoogleSignInResult = { googleUser ->
val idToken = googleUser?.idToken // Send this idToken to your backend to verify
}) {
Button(onClick = { this.onClick() }) { Text("Google Sign-In(Custom Design)") }
}
```
Google Sign-In Button and authentication with Firebase. You need to implement `kmpauth-uihelper` dependency
```kotlin
GoogleButtonUiContainerFirebase(onResult = onFirebaseResult) {
GoogleSignInButton(modifier = Modifier.fillMaxWidth()) { this.onClick() }
}
```
Google Sign-In IconOnly Button and authentication with Firebase. You need to implement `kmpauth-uihelper` dependency
```kotlin
GoogleButtonUiContainerFirebase(onResult = onFirebaseResult) {
GoogleSignInButtonIconOnly(onClick = { this.onClick() })
}
```
### Apple Sign-In
After enabling and configuring Apple Sign-In in Firebase, make sure you added "Sign In with Apple" capability in XCode. Then, you can use it as below in your @Composable function:
```kotlin
//Apple Sign-In with Custom Button and authentication with Firebase
AppleButtonUiContainer(onResult = onFirebaseResult) {
//Any View, you just need to delegate child view's click to this UI Container's click method
Button(onClick = { this.onClick() }) { Text("Apple Sign-In (Custom Design)") }
}
```
Apple Sign-In with AppleSignInButton. You need to implement `kmpauth-uihelper` dependency
```kotlin
AppleButtonUiContainer(onResult = onFirebaseResult) {
AppleSignInButton(modifier = Modifier.fillMaxWidth()) { this.onClick() }
}
```
Apple Sign-In IconOnly Button. You need to implement `kmpauth-uihelper` dependency
```kotlin
AppleButtonUiContainer(onResult = onFirebaseResult) {
AppleSignInButtonIconOnly(onClick = { this.onClick() })
}
```
### Github Sign-In
After enabling and configuring Github Sign-In in Firebase, you can use it as below in your @Composable function:
```kotlin
//Github Sign-In with Custom Button and authentication with Firebase
GithubButtonUiContainer(onResult = onFirebaseResult) {
//Any View, you just need to delegate child view's click to this UI Container's click method
Button(onClick = { this.onClick() }) { Text("Github Sign-In (Custom Design)") }
}
```