{"id":20259439,"url":"https://github.com/defguard/yubikey-provision","last_synced_at":"2025-04-11T01:24:08.736Z","repository":{"id":195850632,"uuid":"687877000","full_name":"DefGuard/YubiKey-Provision","owner":"DefGuard","description":"YubiKey provisioning tool used by defguard security platform","archived":false,"fork":false,"pushed_at":"2024-04-05T16:22:49.000Z","size":122,"stargazers_count":3,"open_issues_count":4,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-24T22:40:00.910Z","etag":null,"topics":["grpc","security","yubico","yubico-otp","yubikey"],"latest_commit_sha":null,"homepage":"https://github.com/defguard/defguard","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DefGuard.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}},"created_at":"2023-09-06T07:34:52.000Z","updated_at":"2025-01-28T16:52:12.000Z","dependencies_parsed_at":"2024-01-23T22:27:36.455Z","dependency_job_id":"2ce68d77-e120-4e59-ae5c-2e4c28775584","html_url":"https://github.com/DefGuard/YubiKey-Provision","commit_stats":null,"previous_names":["defguard/yubikey-provision"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefGuard%2FYubiKey-Provision","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefGuard%2FYubiKey-Provision/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefGuard%2FYubiKey-Provision/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DefGuard%2FYubiKey-Provision/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DefGuard","download_url":"https://codeload.github.com/DefGuard/YubiKey-Provision/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248323582,"owners_count":21084536,"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":["grpc","security","yubico","yubico-otp","yubikey"],"created_at":"2024-11-14T11:14:42.772Z","updated_at":"2025-04-11T01:24:08.721Z","avatar_url":"https://github.com/DefGuard.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":" \u003cp align=\"center\"\u003e\n    \u003cimg src=\"docs/header.png\" alt=\"defguard\"\u003e\n \u003c/p\u003e\n\n[Defguard](https://github.com/DefGuard/defguard) provisioning client for Yubikeys module.\n\n\n## Supported platforms\n\n- Linux\n- Windows\n- MacOS\n\n## Prerequisites\nMachine using this service needs to have proper drivers/tools to detect and operate on smartcard's.\nWhile macOS and Windows should work without installing additional software, on Linux make sure your distribution has all the necessary tools to detect, read, and write on smartcard's.\n\nAlso, the following tools are **required**:\n- [ykman](https://developers.yubico.com/yubikey-manager/)\n- gpg version 2\n\n## Configuration\nThe following information is **required** in order to launch client, these can be configured by supplying correct arguments or setting corresponding environment variables. For additional configuration options check **--help**.\n\n| Name                 | Description                                                                            | Environment variable | Argument |\n|----------------------|----------------------------------------------------------------------------------------|----------------------|----------|\n|          ID          |                   Used to identify client, this is showed in main UI.                  |        **ID**        |   --id   |\n|   GRPC endpoint URL  |                   This needs to point to active Defguard GRPC server.                  |     **GRPC_URL**     |  --grpc  |\n| Authentication token | Token to authorize client, this can be found in provisioners page in main Defguard UI. |       **TOKEN**      |  --token |\n\n## Docker\nThis tool can also be used from a docker image like so:\n```bash\ndocker run --privileged ghcr.io/defguard/yubikey-provision:main -t \u003cTOKEN\u003e --id \u003cID\u003e --grpc \u003cDEFGUARD_GRPC_URL\u003e\n```\nNote that image is using elevated privileges to access host's USB by default but you can also try to configure it with **--device**.\n\n## macOS\n\n```\ngit submodule init\ngit submodule update\nbrew install rust ykman gpg2 protobuf\ncargo build\n./target/debug/yubikey-provision --id \u003cid\u003e --token \u003ctoken_from_defguard\u003e --grpc \"defguard-grpc.host.name\"\n```\n\n## Documentation\n\nSee the [documentation](https://defguard.gitbook.io) for more information.\n\n## Community and Support\n\nFind us on Matrix: [#defguard:teonite.com](https://matrix.to/#/#defguard:teonite.com)\n\n## Contribution\n\nPlease review the [Contributing guide](https://defguard.gitbook.io/defguard/for-developers/contributing) for information on how to get started contributing to the project. You might also find our [environment setup guide](https://defguard.gitbook.io/defguard/for-developers/dev-env-setup) handy.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefguard%2Fyubikey-provision","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefguard%2Fyubikey-provision","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefguard%2Fyubikey-provision/lists"}