https://github.com/n7ghtm4r3/biometrik
Biometrik allows to perform the bio-authentication on Compose Multiplatform applications leveraging the native APIs provided by each platform
https://github.com/n7ghtm4r3/biometrik
android authentication bioauth biometric-authentication biometricprompt compose compose-multiplatform ios linux localauthentication macos native polkit tecknobit web webauthn windows windows-hello
Last synced: 2 months ago
JSON representation
Biometrik allows to perform the bio-authentication on Compose Multiplatform applications leveraging the native APIs provided by each platform
- Host: GitHub
- URL: https://github.com/n7ghtm4r3/biometrik
- Owner: N7ghtm4r3
- License: apache-2.0
- Created: 2025-07-07T18:49:46.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-07-15T21:12:20.000Z (3 months ago)
- Last Synced: 2025-08-10T02:57:51.627Z (2 months ago)
- Topics: android, authentication, bioauth, biometric-authentication, biometricprompt, compose, compose-multiplatform, ios, linux, localauthentication, macos, native, polkit, tecknobit, web, webauthn, windows, windows-hello
- Language: Kotlin
- Homepage: https://n7ghtm4r3.github.io/Biometrik/
- Size: 452 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Biometrik
**v1.0.0beta-01**
**Biometrik** allows to perform the bio-authentication on Compose Multiplatform applications leveraging the native APIs
provided by each platform
## Architecture
- `Android` under the hood uses
the [BiometricPrompt](https://developer.android.com/reference/android/hardware/biometrics/BiometricPrompt) APIs
- `iOs` and native `macOs` under the hood uses
the [local authentication](https://developer.apple.com/documentation/localauthentication) APIs
- `JVM` under the hood uses the native APIs provided by the different OSs:
- On `Windows` uses the [Windows Hello](https://learn.microsoft.com/en-us/windows/apps/develop/security/windows-hello)
APIs
- On `Linux` uses the [Polkit](https://www.freedesktop.org/software/polkit/docs/latest/index.html) APIs
- On`MacOs` uses the [local authentication](https://developer.apple.com/documentation/localauthentication) APIs
- `Web` under the hood uses the [WebAuthn](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API) APIs
## Integration
### Implementation
#### Version catalog
```gradle
[versions]
biometrik = "1.0.0beta-01"
[libraries]
biometrik = { module = "io.github.n7ghtm4r3:Biometrik", version.ref = "biometrik" }
```
#### Gradle
- Add the dependency
```gradle
dependencies {
implementation 'io.github.n7ghtm4r3:Biometrik:1.0.0beta-01'
}
```
#### Gradle (Kotlin)
```gradle
dependencies {
implementation("io.github.n7ghtm4r3:Biometrik:1.0.0beta-01")
}
```
#### Gradle (version catalog)
```gradle
dependencies {
implementation(libs.biometrik)
}
```
## Setup
### Android
To correctly integrate **Biometrik** on the android target you need to following
these simple steps:
#### AppCompact integration
The native `BiometricPrompt` api requires that the activity which request the authentication must be an
`AppCompatActivity` activity, for this, you need to implement in your android's dependencies the following library:
```kotlin
sourceSets {
androidMain.dependencies {
...
implementation("androidx.appcompat:appcompat:1.7.1")
}
}
```
The next step is to adapt your `MainActivity` to extends the `AppCompatActivity` activity type:
```kotlin
// before it extended ComponentActivity instead
class MainActivity : AppCompatActivity() {
...
}
```
The latest step is to change the theme of the `MainActivity` from the `AndroidManifest` file:
```xml
```
In the example, the `@style/Theme.AppCompat.DayNight.NoActionBar` style has been used, but you can implement any theme
as
long as it is based on the `Theme.AppCompat` style
### Wasm
To correctly integrate **Biometrik** on the wasm target you need to enable the handling of the native exceptions thrown
by `JavaScript`. You can do this by adding the following compiler option:
```kotlin
compilerOptions {
freeCompilerArgs.add("-Xwasm-attach-js-exception")
}
```
This ensures that JavaScript exceptions are properly caught and propagated through Kotlin’s exception handling system
when targeting WebAssembly (WASM)
## Usage
In your `App.kt` file you can simply integrate the following component and customize the authentication flow as you
need:
``` kotlin
BiometrikAuthenticator(
appName = "MyApplication",
title = "Indicative title displayed if the native dialogs allow it",
reason = "An indicative reason why the user have to authenticate",
onSuccess = {
// non-UI action
println("User logged in!")
// UI action
WelcomeScreen()
},
onFailure = {
// non-UI action
println("User failed to login...")
// UI action
OpsScreen()
}
)
```
You can also allow the user to retry to authenticate using a custom `state`:
``` kotlin
// create the custom state
val state = rememberBiometrikState()
// attach it to the component
BiometrikAuthenticator(
state = state
appName = "MyApplication",
title = "Indicative title displayed if the native dialogs allow it",
reason = "An indicative reason why the user have to authenticate",
onSuccess = {
// non-UI action
println("User logged in!")
// UI action
WelcomeScreen()
},
onFailure = {
// non-UI action
state.reAuth()
// UI action
Button(
onClick = {
state.reAuth()
}
) {
Text(
text = "Retry"
)
}
}
)
```
## Native Fine-Tuning for JVM Platform
If you need to fine-tune native engines, follow the steps below depending on which engine you need to modify:
### Windows
If you need to change the Windows's engine you can find the [Visual Studio](https://visualstudio.microsoft.com)
documented
files project where you can apply your modification:
``` bash
nativeengines
├── windows
└── ... files ...
```
The requirements are:
- The minimum required version is `Standard C++ 17 ISO (/std:c++17)`
- Include the required `windowsapp.lib` library in the additional linker input dependencies
### Linux
Currently, authentication on Linux is supported via **Polkit**. Biometric support may be considered in future releases.
To modify the native engine you can find its file on:
``` bash
nativeengines
├── linux
└── PolkitEngine.c
```
After applied the modification you needed, you can compile it with the below command:
```bash
gcc -fPIC -shared -o LinuxPolkitEngine.so PolkitEngine.c $(pkg-config --cflags --libs polkit-gobject-1 gio-2.0 glib-2.0)
```
### MacOs
To modify the native engine you can find its file on:
``` bash
nativeengines
├── macos
└── LocalAuthenticationEngine.m
```
After applied the modification you needed, you can compile it with the below command:
```bash
clang -framework Foundation -framework LocalAuthentication -shared -o LocalAuthenticationEngine.dylib LocalAuthenticationEngine.m
```
### Place the dynamic libraries
Once compiled, place the dynamic libraries in the appropriate platform-specific directories
``` bash
resources
├── windows
│ └── WindowsHelloEngine.dll
├── linux
│ └── LinuxPolkitEngine.so
└── macos
└── LocalAuthenticationEngine.dylib
```
## Support
If you need help using the library or encounter any problems or bugs, please contact us via the
following links:
- Support via email
- Support via GitHub
Thank you for your help!
## Donations
If you want support project and developer
| Crypto | Address | Network |
|-----------------------------------------------------------------------------------------------------|--------------------------------------------------|----------|
|  | **3H3jyCzcRmnxroHthuXh22GXXSmizin2yp** | Bitcoin |
|  | **0x1b45bc41efeb3ed655b078f95086f25fc83345c4** | Ethereum |
|  | **AtPjUnxYFHw3a6Si9HinQtyPTqsdbfdKX3dJ1xiDjbrL** | Solana |
If you want support project and developer
with PayPal
Copyright © 2025 Tecknobit