Repository files navigation

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 Hydrais not an identity provider (user sign up, user login, password reset flow),but connects to your existing identity provider through alogin and consent app.Implementing the login and consent app in a different language is easy, and exemplary consent apps(Go,Node) andSDKs are provided.

If you're looking to jump straight into it, go ahead:

• Run your own OAuth 2.0 Server - step by step guide: A in-depth look at setting up ORY Hydra and performing a variety of OAuth 2.0 Flows.
• ORY Hydra 5 Minute Tutorial: Set up and use ORY Hydra using Docker Compose in under 5 Minutes. Good for quickly hacking a Proof of Concept.
• Install and Set Up ORY Hydra: An advanced look at installation options and interaction with ORY Hydra.
• Integrating your Login and Consent UI with ORY Hydra: The go-to place if you wish to adopt ORY Hydra in your new or existing stack.

Besides mitigating various attack vectors, such as database compromisation and OAuth 2.0 weaknesses, ORY Hydra is alsoable to securely manage JSON Web Keys.Click here to read more about security.

Table of Contents

• What is ORY Hydra?
  • Who's using it?
  • OAuth2 and OpenID Connect: Open Standards!
  • OpenID Connect Certified
• Quickstart
  • 5 minutes tutorial: Run your very own OAuth2 environment
  • Installation
• Ecosystem
  • ORY Security Console: Administrative User Interface
  • ORY Oathkeeper: Identity & Access Proxy
  • ORY Keto: Access Control Policies as a Server
  • Examples
• Security
  • Disclosing vulnerabilities
• Benchmarks
• Telemetry
• Documentation
  • Guide
  • HTTP API documentation
  • Upgrading and Changelog
  • Command line documentation
  • Develop
• Libraries and third-party projects
• Blog posts & articles

ORY Hydra is a server implementation of the OAuth 2.0 authorization framework and the OpenID Connect Core 1.0. Existing OAuth2implementations usually ship as libraries or SDKs such asnode-oauth2-serverorfosite, or as fully featured identity solutions with usermanagement and user interfaces, such asDex.

Implementing and using OAuth2 without understanding the whole specification is challenging and prone to errors, even whenSDKs 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 methodsto verify user consent allowing you to use ORY Hydra with any authentication endpoint, be itauthboss,User Frosting or your proprietary Java authentication.

The ORY community stands on the shoulders of individuals, companies, and maintainers. We thank everyone involved - fromsubmitting bug reports and feature requests to contributing patches to sponsoring our work. Our community is1000+ strong and growing rapidly. The ORY stack protects 1.200.000.000+ API requests every month with over15.000+ active service nodes. Our small but expert team would have never been able to achieve this without each andevery one of you.

The following list represents companies that have accompanied us along the way and that have made outstanding contributionsto our ecosystem.If you think that your company deserves a spot here, reach out tohi@ory.sh now!

Please consider giving back by becoming a sponsor of our open source work onPatreon orOpen Collective.

Type	Name	Logo	Website
Sponsor	Raspberry PI Foundation		raspberrypi.org
Contributor	Kyma Project		kyma-project.io
Sponsor	ThoughtWorks		thoughtworks.com
Sponsor	Tulip		tulip.com
Sponsor	Cashdeck / All My Funds		cashdeck.com.au
Sponsor	3 Rein		3rein.com(avaiable soon)
Contributor	Hootsuite		hootsuite.com
Adopter *	Segment		segment.com
Adopter *	Arduino		arduino.cc

We also want to thank all individual contributors

as well as all of our backers

and past & current supporters (in alphabetical order) onPatreon: 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:

• The OAuth 2.0 Authorization Framework
• OAuth 2.0 Threat Model and Security Considerations
• OAuth 2.0 Token Revocation
• OAuth 2.0 Token Introspection
• OAuth 2.0 for Native Apps
• Proof Key for Code Exchange by OAuth Public Clients

and the OpenID Foundation:

• OpenID Connect Core 1.0
• OpenID Connect Discovery 1.0
• OpenID Connect Dynamic Client Registration 1.0
• OpenID Connect Front-Channel Logout 1.0
• OpenID Connect Back-Channel Logout 1.0

ORY Hydra is an OpenID Foundationcertified OpenID Provider (OP).

The following OpenID profiles are certified:

• Basic OpenID Provider (response typescode)
• Implicit OpenID Provider (response typesid_token,id_token+token)
• Hybrid OpenID Provider (response typescode+id_token,code+id_token+token,code+token)
• OpenID Provider Publishing Configuration Information
• Dynamic OpenID Provider

To obtain certification, we deployed thereference 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:

• The documentation is availablehere.
• The REST API documentation is availablehere.

Thetutorial teaches you to set up ORY Hydra,a Postgres instance and an exemplary identity provider written in React using docker-compose.It will take you about 5 minutes to complete thetutorial.

Head over to theORY Developer Documentation to learn how to install ORY Hydra on Linux, macOS, Windows, and Docker and how to build ORY Hydra from source.

TheORY Security Console is a visual admin interface for managing ORY Hydra,ORY Oathkeeper, and ORY Keto.

ORY Oathkeeper is a BeyondCorp/Zero Trust Identity & Access Proxy (IAP) builton top of OAuth2 and ORY Hydra.

ORY Keto is a policy decision point. It uses a set of access control policies, similarto AWS IAM Policies, in order to determine whether a subject (user, application, service, car, ...) is authorized toperform a certain action on a resource.

Theory/examples repository contains numerous examples of setting up this projectindividually and together with other services from the ORY Ecosystem.

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 productioneach day. Of course, we also compiled a security guide with more details on cryptography and security concepts.Readthe security guide now.

If you think you found a security vulnerability, please refrain from posting it publicly on the forums, the chat, or GitHuband send us an email tohi@ory.am instead.

Our continuous integration runs a collection of benchmarks against ORY Hydra. You can find the resultshere.

Our services collect summarized, anonymized data that can optionally be turned off. Clickhere to learn more.

The Guide is availablehere.

The HTTP API is documentedhere.

New releases might introduce breaking changes. To help you identify and incorporate those changes, we document thesechanges inUPGRADE.md andCHANGELOG.md.

Runhydra -h orhydra help.

Developing with ORY Hydra is as easy as:

go get -d -u github.com/ory/hydracd $GOPATH/src/github.com/ory/hydramake initexport GO111MODULE=on## With databasemake test## Without databasemake quicktest

Then run it with in-memory database:

DSN=memory go run main.go serve all

Notes

• We changed organization name fromory-am toory. In order to keep backward compatibility, we did not rename Go packages.
• You can ignore warnings similar topackage github.com/ory/hydra/cmd/server: case-insensitive import collision: "github.com/sirupsen/logrus" and "github.com/sirupsen/logrus".

Official:

• User Login & Consent Example

Community:

• Kubernetes helm chart
• Werther - an Identity Provider over LDAP

⚠️ 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

• Creating an oauth2 custom lamda authorizer for use with Amazons (AWS) API Gateway using Hydra
• Warning, ORY Hydra has changed almost everything since writing thisarticle:Hydra: Run your own Identity and Access Management service in <5 Minutes