{"id":22314207,"url":"https://github.com/keycard-tech/status-keycard-go","last_synced_at":"2025-08-12T01:06:27.262Z","repository":{"id":38360831,"uuid":"416652174","full_name":"keycard-tech/status-keycard-go","owner":"keycard-tech","description":"A shared library that wraps keycard-go functions ","archived":false,"fork":false,"pushed_at":"2025-05-29T10:30:07.000Z","size":2211,"stargazers_count":3,"open_issues_count":1,"forks_count":6,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-07-29T10:57:41.277Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/keycard-tech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2021-10-13T08:29:57.000Z","updated_at":"2025-06-01T17:49:00.000Z","dependencies_parsed_at":"2024-06-19T09:16:55.043Z","dependency_job_id":"606e19ee-fcba-423b-9f9e-2d3bd39b12f2","html_url":"https://github.com/keycard-tech/status-keycard-go","commit_stats":{"total_commits":113,"total_committers":5,"mean_commits":22.6,"dds":"0.35398230088495575","last_synced_commit":"16d62b4536118d37aaf1976b53e3aefbb8827c33"},"previous_names":["keycard-tech/status-keycard-go","status-im/status-keycard-go"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/keycard-tech/status-keycard-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keycard-tech%2Fstatus-keycard-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keycard-tech%2Fstatus-keycard-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keycard-tech%2Fstatus-keycard-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keycard-tech%2Fstatus-keycard-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keycard-tech","download_url":"https://codeload.github.com/keycard-tech/status-keycard-go/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keycard-tech%2Fstatus-keycard-go/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269982057,"owners_count":24507301,"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","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-12-03T22:09:22.878Z","updated_at":"2025-08-12T01:06:27.220Z","avatar_url":"https://github.com/keycard-tech.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# status-keycard-go\n\nThis library provides a higher level Keycard API for Status app. It is currently only used in [status-desktop](https://github.com/status-im/status-desktop/).\n\nThere are 2 types of API provided.\n\n## Flow API \n\nEach keycard command is executed in a single _flow_. A flow roughly looks like this: \n   1. List available readers\n   2. Look for a keycard\n   3. Set up a connection\n   4. Execute the command\n   5. Close the connection\n\nIf client interaction is required at any stage (e.g. insert a card, input a PIN), the flow is \"paused\" and signals to the client. The client should manually continue the flow when the required action was performed. This basically drives the UI right from `status-keycard-go` library.  \n\n\u003e [!NOTE]\n\u003e status-desktop doesn't use this API anymore. Consider switching to Session API. \n\n## Session API\n\nThe main problem with Flow API is that it does not signal certain changes, e.g. \"reader disconnected\" and \"card removed\". Session API addresses this issue. \n\nThe journey begins with `Start` endpoint. When the keycard service is started, it monitors all connected readers and cards. This allows to track the state of reader+card and notify the client on any change. As soon as a keycard is found, a \"connection\" (pair and open secure channel) is established automatically and will be reused until `Stop` is called or the keycard is removed. \n\nIn the `Ready`/`Authorized` states client can execute wanted commands, each as a separate endpoint. \n\nCheck out the detailed usage in ./api/README.md\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeycard-tech%2Fstatus-keycard-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeycard-tech%2Fstatus-keycard-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeycard-tech%2Fstatus-keycard-go/lists"}