{"id":13425512,"url":"https://github.com/algorandfoundation/liquid-auth","last_synced_at":"2025-03-15T19:33:49.575Z","repository":{"id":237893640,"uuid":"756393958","full_name":"algorandfoundation/liquid-auth","owner":"algorandfoundation","description":"Liquid Auth Service","archived":false,"fork":false,"pushed_at":"2025-01-15T17:38:17.000Z","size":13105,"stargazers_count":22,"open_issues_count":4,"forks_count":6,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-01-15T19:58:52.481Z","etag":null,"topics":["authentication","fido2","p2p","passkeys","webrtc"],"latest_commit_sha":null,"homepage":"http://liquidauth.com/","language":"TypeScript","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/algorandfoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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-02-12T15:27:19.000Z","updated_at":"2025-01-15T17:38:20.000Z","dependencies_parsed_at":"2024-06-18T17:24:17.507Z","dependency_job_id":"6badb39a-5cce-4724-bf03-1bdf71d78166","html_url":"https://github.com/algorandfoundation/liquid-auth","commit_stats":null,"previous_names":["algorandfoundation/liquid-auth"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Fliquid-auth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Fliquid-auth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Fliquid-auth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorandfoundation%2Fliquid-auth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algorandfoundation","download_url":"https://codeload.github.com/algorandfoundation/liquid-auth/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243782298,"owners_count":20347239,"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":["authentication","fido2","p2p","passkeys","webrtc"],"created_at":"2024-07-31T00:01:13.942Z","updated_at":"2025-03-15T19:33:44.551Z","avatar_url":"https://github.com/algorandfoundation.png","language":"TypeScript","readme":"# Algorand Authentication Service\n\n- [Vision](VISION.md)\n- [Architecture Diagram](ARCHITECTURE.md)\n- [Sequence Diagram](SEQUENCE.md)\n- [Decisions](.decisions/README.md)\n\n# Overview\n\nThis project holds the standard FIDO2 api endpoints and the Proof of Knowledge for Algorand specific private keys.\nThe api is a stateful session-based architecture with endpoint guards.\nA user must prove ownership of a private key to associate PublicKeyCredentials\n\n## Getting started\n\n### Prerequisites\n- Node.js 18+\n- Docker\n\n#### Clone the project\n\n```bash\ngit clone git@github.com:algorandfoundation/liquid-auth.git \u0026\u0026 cd liquid-auth\n```\n\n### NGROK\n\n**note on VPNs**: Ngrok will not work with VPNs, so to run locally the project, `disable` it or `configure` your VPN's split tunneling to allow ngrok traffic.\n\nSign up for a free account at [ngrok](https://ngrok.com/) and follow the instructions to get your \u003cNGROK_AUTH_TOKEN\u003e and \u003cNGROK_STATIC_DOMAIN\u003e.\n\n#### With Docker\nDon't run the ngrok commands directly as expressed in the ngrok guide as it will create run-time port conflicts.\n\n#### Without Docker\nngrok will ask you to add your auth token to your configuration file.\n\n``` bash\nngrok config add-authtoken \u003cNGROK_AUTH_TOKEN\u003e\n```\n\nWill then ask you to deploy your static domain, make sure to change the port to **5173** like this:\n\n``` bash\nngrok http --domain=\u003cNGROK_STATIC_DOMAIN\u003e 5173\n```\n\n#### Configure NGROK\n\nAdd a `ngrok.yml` configuration to the root directory.\n\n##### Example Configuration\n```yaml\nversion: 2\nauthtoken: \u003cNGROK_AUTH_TOKEN\u003e\ntunnels:\n  website:\n    addr: liquid-auth:5173\n    proto: http\n    domain: \u003cNGROK_STATIC_DOMAIN\u003e\n\n```\n*Make sure to update the `authtoken` and `domain` in the `ngrok.yml` file with your ngrok details.*\n\n#### Update the Service's .env.docker file\n\nUpdate the [.env.docker](.env.docker) file with the following keys with the values from ngrok:\n\n```bash\nHOSTNAME=\u003cNGROK_STATIC_DOMAIN\u003e\nORIGIN=https://\u003cNGROK_STATIC_DOMAIN\u003e\n```\n\n### Start services\n\nRun the following command to start the backend:\n\n```bash\ndocker-compose up -d\n```\n\nNavigate to the ngrok URL in your browser to test the FIDO2 feature.\n\n\n## Using the app\n\n#### Install the [Android client](https://github.com/algorandfoundation/liquid-auth-android/releases) to your device.\n\n![Step-1.png](.docs%2FStep-1.png)\n\n\n### QR Connect\n\nOpen the Connect Modal on the website and scan the QR code using the \"Connect\" button on the Android device.\nFollow the instructions on the Android device to register a credential.\n\n\n![Step-1-QRCode.png](.docs%2FStep-1-QRCode.png)\n\n\n### Peer to Peer\n\nOnce the credential is registered, you can send messages over the peer connection.\n\n![Step-2.png](.docs%2FStep-2.png)\n","funding_links":[],"categories":["Wallets \u0026 Asset Interaction","Wallets"],"sub_categories":["Wallet Providers","Protocols"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorandfoundation%2Fliquid-auth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgorandfoundation%2Fliquid-auth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorandfoundation%2Fliquid-auth/lists"}