Lokksmith

https://lokksmith.dev
Admin
Lokksmith is an opinionated, modern Kotlin Multiplatform library for implementing the OpenID Connect...
Tokens:3,142
Snippets:51
Trust Score:5.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get or Create Authentication Client

Source: https://lokksmith.dev/getting-started/usage

Use getOrCreate() to retrieve an existing client by its unique key or create a new one. This is useful for managing multiple authentication clients within your application.

```kotlin
val client = lokksmith.getOrCreate("my-key") {
    id = "my-client-id"
    discoveryUrl = "https://example.com/.well-known/openid-configuration"
}
```

--------------------------------

### Launch Auth Flow in Compose Multiplatform

Source: https://lokksmith.dev/getting-started/usage

Use AuthFlowLauncher to start the authentication flow from a Composable. The launch function accepts optional options to customize behavior, such as choosing between Custom Tab or Auth Tab on Android.

```kotlin
val uiState by viewModel.uiState.collectAsStateWithLifecycle() 
val authFlowLauncher = rememberAuthFlowLauncher()

LaunchedEffect(uiState.initiation) {
    uiState.initiation?.let { initiation ->
        authFlowLauncher.launch(initiation)    
    }
}
```

--------------------------------

### Prepare Authorization Code Flow

Source: https://lokksmith.dev/getting-started/usage

Initiate the Authorization Code Flow to obtain tokens. This involves preparing the flow with a redirect URI.

```kotlin
val authFlow = client.authorizationCodeFlow(
    AuthorizationCodeFlow.Request(
        redirectUri = "my-app://openid-response"
    )
)

val initiation = authFlow.prepare()
```

--------------------------------

### Add Lokksmith to Gradle Version Catalog

Source: https://lokksmith.dev/getting-started/installation

Define Lokksmith version and core library in your `gradle/libs.versions.toml` file.

```toml
[versions]
lokksmith = "0.13.0"

[libraries]
lokksmith-core = { module = "dev.lokksmith:lokksmith-core", version.ref = "lokksmith" }
```

--------------------------------

### Create Lokksmith Instance

Source: https://lokksmith.dev/getting-started/usage

Obtain an instance of the Lokksmith class using the platform-specific createLokksmith() function. An optional options argument can be used for behavior tweaking.

```kotlin
val lokksmith = createLokksmith()
```

--------------------------------

### Configure Snapshot Repository

Source: https://lokksmith.dev/getting-started/installation

Add Sonatype snapshot repository to your Gradle settings for using snapshot versions.

```gradle
maven {
    setUrl("https://central.sonatype.com/repository/maven-snapshots/")
    content { includeGroup("dev.lokksmith") }
}
```

--------------------------------

### Set Migration Tokens

Source: https://lokksmith.dev/migration

Use this snippet to set migration tokens for a client. Replace placeholder values with actual tokens and expiration timestamps from the source library. This process should only be performed once per client.

```kotlin
val lokksmith = createLokksmith()
val client = lokksmith.get("client-key")

// Replace values with actual tokens and expiration timestamps
// from other library.

lokksmith.migration.setTokens(
    client = client,
    accessToken = "ACCESS TOKEN",
    accessTokenExpiresAt = 1749471081,
    refreshToken = "REFRESH TOKEN",
    refreshTokenExpiresAt = 1752063081,
    idToken = "ID TOKEN",
)

```

--------------------------------

### Launch Auth Flow on iOS

Source: https://lokksmith.dev/getting-started/usage

Launch an authentication flow from the iOS platform code of a Kotlin Multiplatform application using lokksmith.launchAuthFlow().

```kotlin
lokksmith.launchAuthFlow(initiation)
```

--------------------------------

### Set Singleton Lokksmith Provider

Source: https://lokksmith.dev/getting-started/usage

Provide a singleton Lokksmith instance during application startup using SingletonLokksmithProvider.set(). This ensures platform-specific response handling can retrieve the Lokksmith instance.

```kotlin
SingletonLokksmithProvider.set(
    lokksmith = createLokksmith(),
    coroutineScope = MainScope(),
)
```

--------------------------------

### Configure AndroidManifest.xml for App Links

Source: https://lokksmith.dev/getting-started/installation

Manually update your `AndroidManifest.xml` to use verified App Links for handling OIDC redirects securely.

```xml
<activity
        android:name="dev.lokksmith.android.LokksmithRedirectActivity"
        android:exported="true">
    <intent-filter tools:node="removeAll" /> 
    <intent-filter android:autoVerify="true">
        <action android:name="android.intent.action.VIEW" />

        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />

        <data 
            android:scheme="https"
            android:host="example.com"
            android:path="/redirect" /> 
    </intent-filter>
</activity>
```

--------------------------------

### Specify Lokksmith Redirect Scheme for Android

Source: https://lokksmith.dev/getting-started/installation

Configure your Android app's `build.gradle.kts` to specify the redirect scheme for Lokksmith's Activity.

```kotlin
android {
    defaultConfig {
        addManifestPlaceholders(
            mapOf("lokksmithRedirectScheme" to "my-app") 
        )
    }
}
```

--------------------------------

### Add Lokksmith Core Dependency to Project

Source: https://lokksmith.dev/getting-started/installation

Include the Lokksmith core library in your project's `build.gradle.kts` file.

```kotlin
kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation(libs.lokksmith.core)
        }
    }
}
```

--------------------------------

### Add Lokksmith Compose Artifact to Version Catalog

Source: https://lokksmith.dev/getting-started/installation

Define the `lokksmith-compose` artifact in your `gradle/libs.versions.toml`.

```toml
[libraries]
lokksmith-compose = { module = "dev.lokksmith:lokksmith-compose", version.ref = "lokksmith" }
```

--------------------------------

### Handle Authorization Response

Source: https://lokksmith.dev/getting-started/usage

After preparing the authorization flow, call the request URL and pass the returned response to the auth flow's onResponse() method.

```kotlin
// Open system browser with initiation.requestUrl, pass response to auth flow

authFlow.onResponse(response)
```

--------------------------------

### Add Lokksmith Compose Dependency to Source Set

Source: https://lokksmith.dev/getting-started/installation

Include the Lokksmith Compose library in your project's `build.gradle.kts`.

```kotlin
commonMain.dependencies {
    implementation(libs.lokksmith.compose)
}
```

--------------------------------

### Set Migration Tokens from AppAuth

Source: https://lokksmith.dev/migration

This snippet demonstrates setting migration tokens specifically when migrating from AppAuth. Note that AppAuth does not provide a refresh token expiration; use the access token's expiration time for `refreshTokenExpiresAt` and immediately perform a token refresh.

```kotlin
lokksmith.migration.setTokens(
    client = client,
    accessToken = appAuthState.accessToken!!,
    accessTokenExpiresAt = appAuthState.accessTokenExpirationTime,
    refreshToken = appAuthState.refreshToken,
    refreshTokenExpiresAt = appAuthState.accessTokenExpirationTime, // access token refresh
    idToken = appAuthState.idToken!!,
)

client.refresh() // perform token refresh

```

--------------------------------

### Detect Motorola Devices

Source: https://lokksmith.dev/faq

Use this code to identify if a device is a Motorola device, which may have issues with Auth Tab authentication.

```kotlin
val isMotorolaDevice = Build.MANUFACTURER.lowercase() == "motorola"
```
Tokens:
Raw