Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spruceid/siwe
Sign-In with Ethereum library
https://github.com/spruceid/siwe
ethereum identity
Last synced: 5 days ago
JSON representation
Sign-In with Ethereum library
- Host: GitHub
- URL: https://github.com/spruceid/siwe
- Owner: spruceid
- License: apache-2.0
- Created: 2021-10-19T15:02:20.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T18:27:11.000Z (20 days ago)
- Last Synced: 2024-12-06T19:56:59.266Z (16 days ago)
- Topics: ethereum, identity
- Language: TypeScript
- Homepage: https://login.xyz
- Size: 2.35 MB
- Stars: 1,048
- Watchers: 35
- Forks: 143
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- DeFi-Developer-Road-Map - Sign in with Ethereum | SIWE - Workflow to authenticate Ethereum accounts using message signing in order to establish a cookie-based web session that manages user metadata. (Roadmap)
README
Sign-In with Ethereum describes how Ethereum accounts authenticate with
off-chain services by signing a standard message format parameterized by scope,
session details, and security mechanisms (e.g., a nonce). The goals of this
specification are to provide a self-custodied alternative to centralized
identity providers, improve interoperability across off-chain services for
Ethereum-based authentication, and provide wallet vendors a consistent
machine-readable message format to achieve improved user experiences and
consent management.
## Quickstart Examples
To try it out locally, check out these examples:
- [Node](https://github.com/spruceid/siwe-quickstart/tree/main/00_print)
- [Frontend](https://github.com/spruceid/siwe-quickstart/tree/main/01_frontend)
- [Backend](https://github.com/spruceid/siwe-quickstart/tree/main/02_backend)
- [End to end](https://github.com/spruceid/siwe-quickstart/tree/main/03_complete_app)
- [Sign-In with Ethereum Notepad](https://github.com/spruceid/siwe-notepad)
## Motivation
When signing in to popular non-blockchain services today, users will typically
use identity providers (IdPs) that are centralized entities with ultimate
control over users' identifiers, for example, large internet companies and email
providers. Incentives are often misaligned between these parties. Sign-In with
Ethereum offers a new self-custodial option for users who wish to assume more
control and responsibility over their own digital identity.
Already, many services support workflows to authenticate Ethereum accounts using
message signing, such as to establish a cookie-based web session which can
manage privileged metadata about the authenticating address. This is an
opportunity to standardize the sign-in workflow and improve interoperability
across existing services, while also providing wallet vendors a reliable method
to identify signing requests as Sign-In with Ethereum requests for improved UX.
This work is sponsored by the Ethereum Foundation and Ethereum Name Service
(ENS). It is being developed in the open through a series of recorded community
calls and public repositories, and its development is informed by over twenty
user interviews with a focus on currently-in-production uses, related prior
EIPs, and fits within product roadmaps.
## Specification
Specification can be found [here](https://eips.ethereum.org/EIPS/eip-4361).
## Disclaimer
Our TypeScript library for Sign-In with Ethereum has not yet undergone a formal security
audit. We welcome continued feedback on the usability, architecture, and security
of this implementation.
## Mono Repo Install and Build
Run `npm install` to install dependencies, then `npm run build` to build the library.
Development can occur on the `package/*` level with tests being run on each package itself.
To run all tests: `npm run test`