OAuth2 Server and OpenID Certified™ OpenID Connect Provider written in Go - cloud native, security-f...
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
ORY Hydra is a hardened, OpenID Certified OAuth 2.0 Server and OpenID Connect Provider optimized for low-latency, high throughput, and low resource consumption. ORY Hydra is not an identity provider (user sign up, user login, password reset flow), but connects to your existing identity provider through a login and consent app. Implementing the login and consent app in a different language is easy, and exemplary consent apps (Go, Node) and SDKs are provided.
If you're looking to jump straight into it, go ahead:
Besides mitigating various attack vectors, such as database compromisation and OAuth 2.0 weaknesses, ORY Hydra is also able to securely manage JSON Web Keys. Click here to read more about security.
Table of Contents
ORY Hydra is a server implementation of the OAuth 2.0 authorization framework and the OpenID Connect Core 1.0. Existing OAuth2 implementations usually ship as libraries or SDKs such as node-oauth2-server or fosite, or as fully featured identity solutions with user management and user interfaces, such as Keycloak.
Implementing and using OAuth2 without understanding the whole specification is challenging and prone to errors, even when SDKs are being used. The primary goal of ORY Hydra is to make OAuth 2.0 and OpenID Connect 1.0 better accessible.
ORY Hydra implements the flows described in OAuth2 and OpenID Connect 1.0 without forcing you to use a "Hydra User Management" or some template engine or a predefined front-end. Instead it relies on HTTP redirection and cryptographic methods to verify user consent allowing you to use ORY Hydra with any authentication endpoint, be it authboss, User Frosting or your proprietary Java authentication.
The ORY community stands on the shoulders of individuals, companies, and maintainers. We thank everyone involved - from submitting bug reports and feature requests, to contributing patches, to sponsoring our work. Our community is 1000+ strong and growing rapidly. The ORY stack protects 1.200.000.000+ API requests every month with over 15.000+ active service nodes. We would have never been able to achieve this without each and everyone of you!
The following list represents companies that have accompanied us along the way and that have made outstanding contributions to our ecosystem. If you think that your company deserves a spot here, reach out to [email protected] now!
|Sponsor||Raspberry PI Foundation||raspberrypi.org|
|Sponsor||Cashdeck / All My Funds||cashdeck.com.au|
We also want to thank all individual contributors
as well as all of our backers
and past & current supporters (in alphabetical order) on Patreon: Alexander Alimovs, Billy, Chancy Kennedy, Drozzy, Edwin Trejos, Howard Edidin, Ken Adler Oz Haven, Stefan Hans, TheCrealm.
* Uses one of ORY's major projects in production.
ORY Hydra implements Open Standards set by the IETF:
and the OpenID Foundation:
ORY Hydra is an OpenID Foundation certified OpenID Provider (OP).
The following OpenID profiles are certified:
To obtain certification, we deployed the reference user login and consent app (unmodified) and ORY Hydra v1.0.0.
This section is a quickstart guide to working with ORY Hydra. In-depth docs are available as well:
Head over to the ORY Developer Documentation to learn how to install ORY Hydra on Linux, macOS, Windows, and Docker and how to build ORY Hydra from source.
We build Ory on several guiding principles when it comes to our architecture design:
ORY's architecture designed to run best on a Container Orchestration Systems such as Kubernetes, CloudFoundry, OpenShift, and similar projects. Binaries are small (5-15MB) and available for all popular processor types (ARM, AMD64, i386) and operating systems (FreeBSD, Linux, macOS, Windows) without system dependencies (Java, Node, Ruby, libxml, ...).
ORY Kratos is an API-first Identity and User Management system that is built according to cloud architecture best practices. It implements core use cases that almost every software application needs to deal with: Self-service Login and Registration, Multi-Factor Authentication (MFA/2FA), Account Recovery and Verification, Profile and Account Management.
ORY Hydra is an OpenID Certified™ OAuth2 and OpenID Connect Provider can connect to any existing identity database (LDAP, AD, KeyCloak, PHP+MySQL, ...) and user interface.
ORY Oathkeeper is a BeyondCorp/Zero Trust Identity & Access Proxy (IAP) with configurable authentication, authorization, and request mutation rules for your web services: Authenticate JWT, Access Tokens, API Keys, mTLS; Check if the contained subject is allowed to perform the request; Encode resulting content into custom headers (
X-User-ID), JSON Web Tokens and more!
ORY Keto is a policy decision point. It uses a set of access control policies, similar to AWS IAM Policies, in order to determine whether a subject (user, application, service, car, ...) is authorized to perform a certain action on a resource.
Why should I use ORY Hydra? It's not that hard to implement two OAuth2 endpoints and there are numerous SDKs out there!
OAuth2 and OAuth2 related specifications are over 400 written pages. Implementing OAuth2 is easy, getting it right is hard. ORY Hydra is trusted by companies all around the world, has a vibrant community and faces millions of requests in production each day. Of course, we also compiled a security guide with more details on cryptography and security concepts. Read the security guide now.
If you think you found a security vulnerability, please refrain from posting it publicly on the forums, the chat, or GitHub and send us an email to [email protected] instead.
Our continuous integration runs a collection of benchmarks against ORY Hydra. You can find the results here.
Our services collect summarized, anonymized data that can optionally be turned off. Click here to learn more.
The Guide is available here.
The HTTP API is documented here.
We encourage all contributions and encourage you to read our contribution guidelines.
You need Go 1.13+ with
GO111MODULE=onand (for the test suites):
It is possible to develop ORY Hydra on Windows, but please be aware that all guides assume a Unix shell like bash or zsh.
When cloning ORY Hydra, run
make deps. It will download several required dependencies. If you haven't run the command in a while it's probably a good idea to run it again.
You can format all code using
make format. Our CI checks if your code is properly formatted.
There are three types of tests you can run:
Short tests run fairly quickly. You can either test all of the code at once:
shell script go test -short ./...
or test just a specific module:
shell script cd client; go test -short .
Regular tests require a database set up. Our test suite is able to work with docker directly (using ory/dockertest) but we encourage to use the Makefile instead. Using dockertest can bloat the number of Docker Images on your system and are quite slow. Instead we recommend doing:
shell script make test
Please be aware that
make testrecreates the databases every time you run
make test. This can be annoying if you are trying to fix something very specific and need the database tests all the time. In that case we suggest that you initialize the databases with:
shell script make resetdb export TEST_DATABASE_MYSQL='mysql://root:[email protected](127.0.0.1:3444)/mysql?parseTime=true&multiStatements=true' export TEST_DATABASE_POSTGRESQL='postgres://postgres:[email protected]:3445/postgres?sslmode=disable' export TEST_DATABASE_COCKROACHDB='cockroach://[email protected]:3446/defaultdb?sslmode=disable'
Then you can run
go testas often as you'd like:
```shell script go test -p 1 ./...
cd client; go test . ```
The E2E tests use Cypress to run full browser tests. You can execute these tests with:
The runner will not show the Browser window, as it runs in the CI Mode (background). That makes debugging these type of tests very difficult, but thankfully you can run the e2e test in the browser which helps with debugging! Just run:
```shell script ./test/e2e/circle-ci.bash memory --watch
or if you would like to test one of the databases:
```shell script make resetdb export TEST_DATABASE_MYSQL='mysql://root:[email protected](127.0.0.1:3444)/mysql?parseTime=true&multiStatements=true' export TEST_DATABASE_POSTGRESQL='postgres://postgres:[email protected]:3445/postgres?sslmode=disable' export TEST_DATABASE_COCKROACHDB='cockroach://[email protected]:3446/defaultdb?sslmode=disable'
You can test against each individual database:
./test/e2e/circle-ci.bash postgres --watch ./test/e2e/circle-ci.bash memory --watch ./test/e2e/circle-ci.bash mysql --watch
Once you run the script, a Cypress window will appear. Hit the button "Run all Specs"!
You can build a development Docker Image using:
shell script make docker
If you wish to check your code changes against any of the docker-compose quickstart files, run:
shell script make docker docker compose -f quickstart.yml up # ....
Official: * User Login & Consent Example
:warning: Outdated Community Projects: The following projects are outdated and won't work anymore in most cases. Having said that they still might help you to better understand how to integrate HYDRA and solve specific cases. * ORY Hydra middleware for Gin * Consent App SDK for Go