AuthGuard
An easy-to-use, and easy-to-customize, identity server. It supports multiple authentication and authorization options and can be extended to support other ones, or add new features. It's an API-only solution, there is currently no dedicated dashboard.
Documentation
You can see the full documentation on the website here. OpenAPI documentation is available under the api module, and can also be found here. Tutorials are also available on the same website.
For the documentation of a specific plugin please visit the extensions repository and check that plugin readme.
Why Use AuthGuard?
Identity management is almost never the core part of apps, websites, or services. AuthGuard is a simple service which can be used to provide that so that you can focus on the important parts of what you are building. With AuthGuard you:
- Have a ready identity management solution.
- Have full control over your data.
- Can easily extend it to make it fit your own needs even beyond authentication and authorization (e.g. integrating it with monitoring tools, or a data processing pipeline).
- Are not tied to a certain database, or a class of databases. You can make it work with any database even ones which are not officially supported.
- Have more advanced features available out-of-the-box like requiring OTPs, or re-entring passwords to perform certain actions..etc.
AuthGuard Distributions
There's no "one size fits all". AuthGuard is, more or less, a "kernel". In order for you to run it and make it usable, you need to create a distribution. An AuthGuard distribution is essentially AuthGuard + plugins. It's required to at least have a plugin providing data access implementation in order for the server to run. We have three standard distributions pre-built for three databases: MongoDB, PostgreSQL, MySQL. Standard distributions come with the following plugins:
- Standard data access (persistence + cache)
- JWT
- Sessions
- Account lock
- Verification
- JavaMail provider (for SMTP, IMAP, and POP3)
Running Standard Distributions
Standard distributions are available as executable jar files, in releases or as container images. The images are hosted on GitHub Packages which you can pull and run. The images are:
- Mongo Stadndard:
ghcr.io/authguard/authguard-mongo-standard:<version> - Postgres Standard:
ghcr.io/authguard/authguard-postgres-standard:<version> - MySQL Standard:
ghcr.io/authguard/authguard-mysql-standard:<version>
Creating a Distribution
There are two ways to create a distribution:
- Using a build system (Maven, Gradle, SBT...etc) by adding them as dependencies
- Running the
restjar and setting the classpath manually
All modules are published as Maven artifacts to GitHub Packages, make sure that you add the correct repositories to you build configuration to be able to pull them. For example, if you are using Maven you need to add the following two repositories
<repositories>
<repository>
<id>authguard-github</id>
<name>GitHub AuthGuard Maven Packages</name>
<url>https://maven.pkg.github.com/AuthGuard/AuthGuard</url>
</repository>
<repository>
<id>exntesions-github</id>
<name>GitHub AuthGuard Extensions Maven Packages</name>
<url>https://maven.pkg.github.com/AuthGuard/extensions</url>
</repository>
</repositories>
Plugins
There are some standard plugins created and support by the AuthGuard team. Some are considered core parts and exist as modules in the main project, while the others get their own repository. The other standard extensions can be found in the extension repository.
JWT
A plugin which provides JWT exchanges and other features around JWTs:
- JWT auth exchanges
- JWT API keys
- OAuth and OpenID Connect support
Sessions
A plugin to add support for sessions. Requires a session store to be provided by a DAL implementation.
Verification
The verification plugin will send a verification email to an email which needs to be verified. Requires an email provider implementation.
Account Lock
Adds support for locking accounts after a number of failed logins within a period.
LDAP
Adds support for LDAP-based authentication by using an LDAP server as an identity provider.
Adds subscribers for events which may require sending emails. This plugin does not come with an email provider, and one must be added. We have an implementation using JavaMail and another one (provided as an example to how to use external APIs) using SendGrid API.
SMS
Similar to the email plugin, this one only adds definitions and subscribers, and an SMS provider implementation must be provided.
JavaMail
The standard email provider, it uses JavaMail library and support SMTP, IMAP, and POP3 protocols.
License and Price
The project in its entirety is open-source and no features are hidden behind a professional plan. It is also free of charge for non-commercial use. If you want to use it for a commercial product or a business, please support the project by purchasing a license from our store. The store is temporary until we move to a better one, but all license will be transferred.
Open-Source Credits
This project is made possible by other open-source projects, and they deserve the recognition.
- Javalin
- Apache Commons
- Bouncy Castle
- Auth0 JWT
- Guice
- Reflections
- RxJava
- Vertx
- OkHttp
- Vavr
- Unbounded LDAP
- Logback
- Jackson
- Immutables
- Mapstruct
- JUnit
- Mockito
- WireMock
- AssertJ
- Rest Assured
- JavaMail
![[Snyk] Upgrade org.apache.commons:commons-lang3 from 3.7 to 3.12.0](https://avatars.githubusercontent.com/u/19733683?v=4)
| Arbitrary Code Execution
| 611/1000 
| 506/1000 
3 Aug 13, 2022
15 Dec 19, 2022
20 Nov 29, 2022
20.2k Dec 30, 2022
3 Jun 22, 2022
27.6k Jan 5, 2023
2 Apr 8, 2022
6k Jan 7, 2023
3 Feb 17, 2022
2 Mar 12, 2022
1 Jan 28, 2022
1 Oct 21, 2021
2 Dec 31, 2021
69 Dec 17, 2022
22 Aug 11, 2022
1 Jan 10, 2022
2 Nov 22, 2022
29 Oct 24, 2022