{"id":34525232,"url":"https://github.com/kiva/guardian-bio-auth","last_synced_at":"2026-05-27T01:02:59.121Z","repository":{"id":41988519,"uuid":"274506511","full_name":"kiva/guardian-bio-auth","owner":"kiva","description":"Plugin for using biometric fingerprint authentication with the aries-key-guardian","archived":false,"fork":false,"pushed_at":"2022-04-21T18:28:27.000Z","size":32035,"stargazers_count":1,"open_issues_count":9,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-12-25T16:29:24.567Z","etag":null,"topics":["protocol","protocol-backend"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kiva.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":"CODEOWNERS","security":"SECURITY.txt","support":null}},"created_at":"2020-06-23T20:51:47.000Z","updated_at":"2021-12-16T16:54:23.000Z","dependencies_parsed_at":"2022-08-12T01:31:28.296Z","dependency_job_id":null,"html_url":"https://github.com/kiva/guardian-bio-auth","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":"mac-arrap/sample-os-standard-repo","purl":"pkg:github/kiva/guardian-bio-auth","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fguardian-bio-auth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fguardian-bio-auth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fguardian-bio-auth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fguardian-bio-auth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kiva","download_url":"https://codeload.github.com/kiva/guardian-bio-auth/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiva%2Fguardian-bio-auth/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33545459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"ssl_error","status_checked_at":"2026-05-26T15:22:15.568Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["protocol","protocol-backend"],"created_at":"2025-12-24T05:07:49.135Z","updated_at":"2026-05-27T01:02:59.069Z","avatar_url":"https://github.com/kiva.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# guardian-bio-auth\n\nThis repo contains services and tools for using biometric fingerprint authentication with the aries-key-guardian.\nSpecifically, the main contents are a Bioanalyzer Service, Identity Service, Fingerprint Desktop Tool, and scripts for\nthe two databases that are used by Identity Service - `identity_intelligence_db` and `identity_template_db`.\n\n## Bioanalyzer Service\n\nThe job of this service is to perform common analyses on biometric images. At the moment, it only supports fingerprint\nimages. The main job it performs is to determine the quality of the image provided, returning a score from 0 to 100, as\ndefined by ISO/IEC 29794-1:2016.\n\nFor more information, please take a look at [Bioanalyzer Service's README](bioanalyzer_service/README.md). \n\n## Bio Auth Service\n\nThe job of this service is to manage access to generified biometric information. At the moment, that means fingerprint\ntemplates. Given a fingerprint image (or several images), Bio Auth Service will generate templates based on those images\nand store them in `identity_template_db`. If provided ANSI-378, ISO-19794-2, or SourceAFIS v3 templates, Bio Auth Service\nwill convert them into a SourceAFIS v3 template and store it in `identity_template_db`. Later, when presented with a\ncandidate fingerprint template, Bio Auth Service can verify that it does or does not match some fingerprint template that\nit has previously stored.\n\nFor more information, please take a look at [Identity Service's README](bio_auth_service/README.md).\n\n## Fingerprint Desktop Tool\n\nThe job of this tool is to provide a CLI for generating fingerprint templates based on a provided image.\n\nFor more information, please take a look at [Fingerprint Desktop Tool's README](fingerprint_desktop_tool/README.md).\n\n## Running Guardian Bio Auth Locally\n\n1. Make sure you have the Gradle installed. The easiest way to do this if you're on mac is to use homebrew:\n`brew install gradle`. But if homebrew isn't an option, or you'd just prefer an alternate approach, check out\n[their installation page](https://gradle.org/install/).\n\n2. Make sure you have docker-compose installed. If you're running on a Mac, it should already be installed. But for full\ninstallation instructions for all environments, see [Docker's documentation](https://docs.docker.com/compose/install/).\n\n3. Generate `.env` files for each repository. You can execute `./scripts/useDummyEnvFiles.sh` to use the default dummy\nvalues we provide, or manually create `.env` files with custom values. If you choose to take the manual approach, check\nout the `dummy.env` files in each sub-project for the list of required environment variables.\n\n4. Build Identity Service. From the identity_service directory, execute: `./gradlew build`\n\n5. Build Bioanalyzer Service. From the bioanalyzer_service directory, execute: `./gradlew build`\n\n6. Run the docker-compose. This will spin up a local network that the services and databases can communicate with each\nother on. From the top-level guardian-bio-auth directory, execute: `docker-compose up`.\n\n## Running Guardian Bio Auth Elsewhere\n\nBioanalyzer Service and Identity Service both have public images available in the kivaprotocol\n[Dockerhub account](https://hub.docker.com/orgs/kivaprotocol/repositories). They are called\n[bioanalyzer](https://hub.docker.com/repository/docker/kivaprotocol/bioanalyzer) and\n[identity](https://hub.docker.com/repository/docker/kivaprotocol/identity), respectively. Feel free to pull them down\nand use them in your own deployments as you see fit.\n\n## Running Tests\n\nAssuming you have gradle installed, running the tests is as simple as:\n\n    cd identity_service\n    ./gradlew test\n\nand\n\n    cd bioanalyzer_service\n    ./gradlew test\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiva%2Fguardian-bio-auth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkiva%2Fguardian-bio-auth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiva%2Fguardian-bio-auth/lists"}