{"id":14968245,"url":"https://github.com/oscoreio/maui.biometric","last_synced_at":"2025-10-26T02:31:06.493Z","repository":{"id":218944670,"uuid":"747179725","full_name":"oscoreio/Maui.Biometric","owner":"oscoreio","description":"Provides a cross-platform implementation of biometric authentication. Continuation of the abandoned Plugin.Fingerprint in the MAUI ecosystem.","archived":false,"fork":false,"pushed_at":"2025-02-02T19:11:38.000Z","size":91151,"stargazers_count":36,"open_issues_count":3,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-10T18:59:56.358Z","etag":null,"topics":["android","authentication","biometric","cross-platform","csharp","dotnet","face-recognition","faceid","fingerprint","ios","iris","maccatalyst","macos","maui","oscore","windows","winui","xamarin"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oscoreio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-23T12:31:39.000Z","updated_at":"2025-02-07T20:49:03.000Z","dependencies_parsed_at":"2025-01-25T22:32:11.818Z","dependency_job_id":"f1351723-d2ab-42b5-b9c1-76e3a4a5fe19","html_url":"https://github.com/oscoreio/Maui.Biometric","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"ce2c6645bb3f5b40354fd3ad60abba670770a887"},"previous_names":["oscoreio/maui.biometric"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oscoreio%2FMaui.Biometric","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oscoreio%2FMaui.Biometric/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oscoreio%2FMaui.Biometric/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oscoreio%2FMaui.Biometric/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oscoreio","download_url":"https://codeload.github.com/oscoreio/Maui.Biometric/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238247940,"owners_count":19440879,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","authentication","biometric","cross-platform","csharp","dotnet","face-recognition","faceid","fingerprint","ios","iris","maccatalyst","macos","maui","oscore","windows","winui","xamarin"],"created_at":"2024-09-24T13:39:35.175Z","updated_at":"2025-10-26T02:31:01.127Z","avatar_url":"https://github.com/oscoreio.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Maui.Biometric\n\n[![Nuget package](https://img.shields.io/nuget/vpre/Oscore.Maui.Biometric)](https://www.nuget.org/packages/Oscore.Maui.Biometric/)\n[![CI/CD](https://github.com/oscoreio/Maui.Biometric/actions/workflows/dotnet.yml/badge.svg?branch=main)](https://github.com/oscoreio/Maui.Biometric/actions/workflows/dotnet.yml)\n[![License: MIT](https://img.shields.io/github/license/oscoreio/Maui.Biometric)](https://github.com/oscoreio/Maui.Biometric/blob/main/LICENSE)\n\nProvides a cross-platform implementation of biometric authentication.  \nSupports iOS, macOS, Android and Windows.  \nThis repository has been rewritten taking into account the API of the xamarin-fingerprint and Plugin.Maui.Biometric libraries\n\n### Supported Platforms\n| Platform | Minimum Version Supported             |\n|----------|---------------------------------------|\n| iOS      | 12.2+                                 |\n| macOS    | 15+                                   |\n| Android  | 5.0 (API 21)                          |\n| Windows  | 11 and 10 version 1809+ (build 17763) |\n\n## Usage\n- Add NuGet package to your project:\n```xml\n\u003cPackageReference Include=\"Oscore.Maui.Biometric\" Version=\"2.0.0\" /\u003e\n```\n\n- iOS - Add `NSFaceIDUsageDescription` to your Info.plist to describe the reason your app uses Face ID. \n(see [Documentation](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW75)). \nOtherwise the App will crash when you start a Face ID authentication on iOS 11.3+.\n```xml\n\t\u003ckey\u003eNSFaceIDUsageDescription\u003c/key\u003e\n\t\u003cstring\u003eThis app requires Face ID for secure authentication and to provide a personalized experience.\u003c/string\u003e\n```\n\n- Android - Request the permission in `AndroidManifest.xml`\n```xml\n\u003cuses-permission android:name=\"android.permission.USE_FINGERPRINT\" android:maxSdkVersion=\"27\" /\u003e\n\u003cuses-permission android:name=\"android.permission.USE_BIOMETRIC\" android:minSdkVersion=\"28\" /\u003e\n```\n\n- Add the following to your `MauiProgram.cs` `CreateMauiApp` method:\n```diff\nbuilder\n    .UseMauiApp\u003cApp\u003e()\n+   .UseBiometricAuthentication()\n    .ConfigureFonts(fonts =\u003e\n    {\n        fonts.AddFont(\"OpenSans-Regular.ttf\", \"OpenSansRegular\");\n        fonts.AddFont(\"OpenSans-Sed:nammibold.ttf\", \"OpenSansSemibold\");\n    });\n```\n\n- Use through `BiometricAuthentication.Current` or using `IBiometricAuthentication` from DI:\n```csharp\n// You don't need to check if the device supports biometric authentication, the plugin does it for you\nvar result = await BiometricAuthentication.Current.AuthenticateAsync(\n    new AuthenticationRequest(\n        title: \"Authenticate\",\n        reason: \"Please authenticate to proceed\"));\nif (result.IsSuccessful)\n{\n    // User authenticated\n}\n```\n\n## Testing on Simulators\n\n### iOS\n\n![Controlling the sensor on the iOS Simulator](assets/ios_simulator.png \"Controlling the sensor on the iOS Simulator\")\n\nWith the Hardware menu you can\n\n- Toggle the enrollment status\n- Trigger valid (\u003ckbd\u003e⌘\u003c/kbd\u003e \u003ckbd\u003e⌥\u003c/kbd\u003e \u003ckbd\u003eM\u003c/kbd\u003e) and invalid (\u003ckbd\u003e⌘\u003c/kbd\u003e \u003ckbd\u003e⌥\u003c/kbd\u003e \u003ckbd\u003eN\u003c/kbd\u003e) fingerprint sensor events\n\n### Android\n\n- start the emulator (Android \u003e= 6.0)\n- open the settings\n- go to Security \u003e Fingerprint, then follow the enrollment instructions\n- when it asks for touch\n- open the Emulator Settings\n- go to Fingerprint menu\n\n## Links\n- https://github.com/smstuebe/xamarin-fingerprint\n- https://github.com/FreakyAli/Plugin.Maui.Biometric","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foscoreio%2Fmaui.biometric","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foscoreio%2Fmaui.biometric","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foscoreio%2Fmaui.biometric/lists"}