README
¶
RelyAuth
RelyAuth is a universal authentication service for verifying request credentials, inspired by Hasura GraphQL Engine's Authentication.
Features
- Multi-platform support: Works with Hasura GraphQL Engine and DDN via webhook mode.
- Multiple auth modes: API Key, JWT, Webhook, and more.
- Fallback strategies: Provides authentication redundancy with configurable fallback chains.
- Flexible data transformation: Uses JMESPath and Go templates for data manipulation.
- IP allowlisting: Support for IP-based access control with CIDR notation.
- Header-based authentication: Extract credentials from headers, query parameters, or cookies.
- Pattern matching: Regex-based pattern matching for flexible credential validation.
Get Started
With Hasura
You can use RelyAuth as a webhook auth service. Read the tutorial at relychan.com/docs/auth/hasura.
Documentation
Read the complete RelyAuth documentation at relychan.com/docs/auth/
AI Assistance Disclosure
This project has been developed with assistance from AI coding tools, including:
- Test case development.
- Documentation improvements.
- Code review and optimization suggestions.
All AI-generated code has been reviewed, tested, and validated by human developers to ensure quality, security, and correctness. The AI tools serve as development accelerators while maintaining human oversight and decision-making.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Acknowledgments
- Inspired by Hasura GraphQL Engine's Authentication.
- Built with Go and leverages excellent open-source libraries.
- Community contributions and feedback.
Support
- Documentation: relychan.com/docs/auth/
- Issues: GitHub Issues
Note: This is an authentication service. Always follow security best practices when deploying to production environments.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth defines a universal authentication manager
|
Package auth defines a universal authentication manager |
|
apikey
Package apikey implements the API key auth mode.
|
Package apikey implements the API key auth mode. |
|
authmetrics
Package authmetrics defines global metrics and attributes for the auth service.
|
Package authmetrics defines global metrics and attributes for the auth service. |
|
authmode
Package authmode defines common types and utilities for auth modes.
|
Package authmode defines common types and utilities for auth modes. |
|
jwt
Package jwt implements the authenticator for the JWT auth mode
|
Package jwt implements the authenticator for the JWT auth mode |
|
noauth
Package noauth implements the noAuth mode.
|
Package noauth implements the noAuth mode. |
|
webhook
Package webhook implements the webhook auth mode
|
Package webhook implements the webhook auth mode |
|
Package config defines configurations for the auth server.
|
Package config defines configurations for the auth server. |
|
Package handler implements handler routes for auth webhooks.
|
Package handler implements handler routes for auth webhooks. |
|
Package main generates JSON schemas for the rely-auth config.
|
Package main generates JSON schemas for the rely-auth config. |
|
Package main start an http server for auth hooks.
|
Package main start an http server for auth hooks. |