Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhost/hasura-auth
Authentication for Hasura.
https://github.com/nhost/hasura-auth
authentication backend email-password-login emails graphql hacktoberfest hacktoberfest2022 hasura jwt magic-link nodejs oauth-login roles sms typescript
Last synced: 6 days ago
JSON representation
Authentication for Hasura.
- Host: GitHub
- URL: https://github.com/nhost/hasura-auth
- Owner: nhost
- License: mit
- Created: 2021-06-09T11:24:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T08:05:39.000Z (10 days ago)
- Last Synced: 2024-12-04T09:34:25.705Z (9 days ago)
- Topics: authentication, backend, email-password-login, emails, graphql, hacktoberfest, hacktoberfest2022, hasura, jwt, magic-link, nodejs, oauth-login, roles, sms, typescript
- Language: Go
- Homepage: https://nhost.io
- Size: 15 MB
- Stars: 390
- Watchers: 7
- Forks: 115
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Audit: audit-ci.jsonc
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-hasura - Hasura Auth - Authentication for Hasura. Email+Password, Magic Link, Providers (Google, GitHub, Facebook, etc). (Tools and Extensions)
README
Hasura Auth
Authentication for Hasura
## Core Features
- 🧑🤝🧑 Users are stored in Postgres and accessed via GraphQL
- 🔑 Multiple sign-in methods.
- ✨ Integrates with GraphQL and Hasura Permissions
- 🔐 JWT tokens and Refresh Tokens.
- ✉️ Emails sent on various operations
- ✅ Optional checking for Pwned Passwords.
## Sign in methods
- [**Email and Password**](./docs/workflows/email-password.md) - simple email and password method.
- [**Email**](./docs/workflows/passwordless-email.md) - also called **passwordless email** or **magic link**.
- [**SMS**](./docs/workflows/passwordless-sms.md) - also called **passwordless sms**.
- [**Anonymous**](./docs/workflows/anonymous-users.md) - sign in users without any method. Anonymous users can be
converted to _regular_ users.
- [**OAuth providers**](./docs/workflows/oauth-providers.md): Facebook, Google, GitHub, Twitter, Apple, Azure AD, LinkedIn, Windows Live, Spotify, Strava, GitLab, BitBucket, Discord, WorkOS.
- [**Security keys with WebAuthn**](./docs/workflows/webauthn.md)
## Deploy Hasura Auth in Seconds
Use [Nhost](https://nhost.io) to start using Hasura Auth in seconds.
### Using Docker-compose
```sh
git clone https://github.com/nhost/hasura-auth.git
cd hasura-auth
cp .env.example .env
docker-compose -f docker-compose-example.yaml up
```
## Configuration
Read our [configuration guide](./docs/configuration.md) to customise the Hasura Auth settings.
## Workflows
- [Email and password](./docs/workflows/email-password.md)
- [Oauth social providers](./docs/workflows/oauth-providers.md)
- [Passwordless with emails (magic links)](./docs/workflows/passwordless-email.md)
- [Passwordless with SMS](./docs/workflows/passwordless-sms.md)
- [Anonymous users](./docs/workflows/anonymous-users.md)
- [Change email](./docs/workflows/change-email.md)
- [Change password](./docs/workflows/change-password.md)
- [Reset password](./docs/workflows/reset-password.md)
- [Refresh tokens](./docs/workflows/refresh-token.md)
- [Security keys with WebAuthn](./docs/workflows/webauthn.md)
## JWT Signing
The JWT tokens can be signed with either a symmetric key based on `HMAC-SHA` or with asymmetric keys based on `RSA`. To configure the JWT signing method, set the environment variable `HASURA_GRAPHQL_JWT_SECRET` which should follow the same format as [Hasura](https://hasura.io/docs/latest/graphql/core/auth/authentication/jwt.html#running-with-jwt) with a few considerations:
1. Only `HS` and `RS` algorithms are supported.
2. If using `RS` algorithm, the public key should be in PEM format.
3. If using `RS` algorithm, the private key should be in PKCS#8 format inside an extra field `signing_key`.
4. If using `RS` algorithm, an additional field `kid` can be added to specify the key id in the JWK Set.
When using asymmetric keys, you can get the JWK Set from the endpoing `.well-known/jwks.json`.
## Recipes
- Extending Hasura's permissions with [Custom JWT claims](./docs/recipes/custom-hasura-claims.md)
- [Extending the user schema](./docs/recipes/extending-user-schema.md)
## Reference
- List of the available [environment variables](./docs/environment-variables.md).
- The service comes with an [OpenAPI definition](./docs/openapi.json) which you can also see [online](https://editor.swagger.io/?url=https://raw.githubusercontent.com/nhost/hasura-auth/main/docs/openapi.json).
- [Database Schema](./docs/schema.md)
## 🤝 Contributing
Contributions and issues are welcome. Please have a look at the [developer's guide](./DEVELOPERS.md) if you want to prepare a pull request.
Feel free to check the issues page.
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
This project is MIT licensed.