status-im/status-keycard-go
2
0
Fork 0
mirror of https://github.com/status-im/status-keycard-go.git synced 2025-02-07 03:54:47 +00:00
Code Issues Projects Releases Wiki Activity
status-keycard-go/README.md
Igor Sirotin efec05e104
feat: Session API (#13) 
* feat: KeycardContextV2

* feat: ApplicationInfoV2 with string version

* feat: rpc service

* feat: http server for the session API

* feat: ensure api mutual exclusivity

* chore: go mod tidy
2025-01-29 21:01:47 +00:00

1.5 KiB
Raw Blame History

status-keycard-go

This library provides a higher level Keycard API for Status app. It is currently only used in status-desktop.

There are 2 types of API provided.

Flow API

Each keycard command is executed in a single flow. A flow roughly looks like this:

  1. List available readers
  2. Look for a keycard
  3. Set up a connection
  4. Execute the command
  5. Close the connection

If 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.

Note

status-desktop doesn't use this API anymore. Consider switching to Session API.

Session API

The 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.

The 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.

In the Ready/Authorized states client can execute wanted commands, each as a separate endpoint.

Check out the detailed usage in ./api/README.md