Repository files navigation

Ory Hydra is a hardened,OpenID Certified OAuth 2.0 Server and OpenID ConnectProvider optimized for low-latency, high throughput, and low resourceconsumption. 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, andexemplary consent apps (Node)andSDKs for common languages areprovided.

The easiest way to get started with Ory Software is in Ory Cloud! It isfree for developers,forever, no credit card required!

Ory Cloud has easy examples, administrative user interfaces, hosted pages (e.g.for login or registration), support for custom domains, collaborative featuresfor your colleagues, and much more!

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.0Flows.
• Ory Hydra 5 Minute Tutorial:Set up and use Ory Hydra using Docker Compose in under 5 Minutes. Good forhacking a Proof of Concept.
• Run Ory Hydra in Docker: Anadvanced guide to a fully functional set up 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 a compromised database andOAuth 2.0 weaknesses, Ory Hydra is also able to securely manage JSON Web Keys.Click here to read moreabout 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 Kratos: Identity and User Infrastructure and Management
  • Ory Hydra: OAuth2 & OpenID Connect Server
  • Ory Oathkeeper: Identity & Access Proxy
  • Ory Keto: Access Control Policies as a Server
• Security
  • Disclosing vulnerabilities
• Benchmarks
• Telemetry
• Documentation
  • Guide
  • HTTP API documentation
  • Upgrading and Changelog
  • Command line documentation
  • Develop
    • Dependencies
    • Formatting Code
    • Running Tests
      • Short Tests
      • Regular Tests
    • E2E Tests
    • Build Docker
    • Run the Docker Compose quickstarts
• Libraries and third-party projects
• Blog posts & articles

Ory Hydra is a server implementation of the OAuth 2.0 authorization frameworkand the OpenID Connect Core 1.0. Existing OAuth2 implementations usually ship aslibraries or SDKs such asnode-oauth2-server orOry Fosite, or as fully featuredidentity solutions with user management and user interfaces, such asKeycloak.

Implementing and using OAuth2 without understanding the whole specification ischallenging and prone to errors, even when SDKs are being used. The primary goalof 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.0without forcing you to use a "Hydra User Management" or some template engine ora predefined front-end. Instead, it relies on HTTP redirection and cryptographicmethods to verify user consent allowing you to use Ory Hydra with anyauthentication endpoint, be itOry Kratos,authboss,User Frosting or your proprietary Javaauthentication.

The Ory community stands on the shoulders of individuals, companies, andmaintainers. We thank everyone involved - from submitting bug reports andfeature requests, to contributing patches, to sponsoring our work. Our communityis 1000+ strong and growing rapidly. The Ory stack protects 16.000.000.000+ APIrequests every month with over 250.000+ active service nodes. We would havenever been able to achieve this without each and everyone of you!

The following list represents companies that have accompanied us along the wayand that have made outstanding contributions to our ecosystem.If you thinkthat your company deserves a spot here, reach out tooffice-muc@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	Tulip		tulip.com
Sponsor	Cashdeck / All My Funds		cashdeck.com.au
Contributor	Hootsuite		hootsuite.com
Adopter *	Segment		segment.com
Adopter *	Arduino		arduino.cc
Adopter *	DataDetect		unifiedglobalarchiving.com/data-detect/
Adopter *	Sainsbury's		sainsburys.co.uk
Adopter *	Contraste		contraste.com
Adopter *	Reyah		reyah.eu
Adopter *	Zero		getzero.dev
Adopter *	Padis		padis.io
Adopter *	Cloudbear		cloudbear.eu
Adopter *	Security Onion Solutions		securityonionsolutions.com
Adopter *	Factly		factlylabs.com
Adopter *	Nortal		nortal.com
Sponsor	OrderMyGear		ordermygear.com
Sponsor	Spiri.bo		spiri.bo
Sponsor	Strivacity		strivacity.com
Adopter *	Hanko		hanko.io
Adopter *	Rabbit		rabbit.co.th
Adopter *	inMusic		inmusicbrands.com
Adopter *	Buhta		buhta.com
Adopter *	Connctd		connctd.com
Adopter *	Paralus		paralus.io
Adopter *	TIER IV		tier4.jp
Adopter *	R2Devops		r2devops.io
Adopter *	LunaSec		lunasec.io
Adopter *	Serlo		serlo.org

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, ChancyKennedy, 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
• OAuth 2.0 Dynamic Client Registration Protocol
• OAuth 2.0 Dynamic Client Registration Management Protocol
• Proof Key for Code Exchange by OAuth Public Clients
• JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants

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 starter guide to working with Ory Hydra. In-depth docs areavailable as well:

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

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

Head over to theOry Developer Documentation to learnhow to install Ory Hydra on Linux, macOS, Windows, and Docker and how to buildOry Hydra from source.

We build Ory on several guiding principles when it comes to our architecturedesign:

• Minimal dependencies
• Runs everywhere
• Scales without effort
• Minimize room for human and network errors

Ory's architecture is designed to run best on a Container Orchestration systemsuch as Kubernetes, CloudFoundry, OpenShift, and similar projects. Binaries aresmall (5-15MB) and available for all popular processor types (ARM, AMD64, i386)and operating systems (FreeBSD, Linux, macOS, Windows) without systemdependencies (Java, Node, Ruby, libxml, ...).

Ory Kratos is an API-first Identity and UserManagement system that is built according tocloud architecture best practices.It implements core use cases that almost every software application needs todeal 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 andOpenID Connect Provider which easily connects to any existing identity system bywriting a tiny "bridge" application. It gives absolute control over the userinterface and user experience flows.

Ory Oathkeeper is a BeyondCorp/Zero TrustIdentity & Access Proxy (IAP) with configurable authentication, authorization,and request mutation rules for your web services: Authenticate JWT, AccessTokens, API Keys, mTLS; Check if the contained subject is allowed to perform therequest; Encode resulting content into custom headers (X-User-ID), JSON WebTokens and more!

Ory Keto is a policy decision point. It uses aset of access control policies, similar to AWS IAM Policies, in order todetermine whether a subject (user, application, service, car, ...) is authorizedto perform a certain action on a resource.

Why should I use Ory Hydra? It's not that hard to implement two OAuth2endpoints 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 bycompanies all around the world, has a vibrant community and faces millions ofrequests in production each day. Of course, we also compiled a security guidewith more details on cryptography and security concepts. Readthe security guide now.

If you think you found a security vulnerability, please refrain from posting itpublicly on the forums, the chat, or GitHub and 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 turnedoff. Clickhere to learn more.

The full Ory Hydra documentation is availablehere.

The HTTP API is documentedhere.

New releases might introduce breaking changes. To help you identify andincorporate those changes, we document these changes inCHANGELOG.md.

Runhydra -h orhydra help.

We love all contributions! Please read ourcontribution guidelines.

You need Go 1.13+ withGO111MODULE=on and (for the test suites):

• Docker and Docker Compose
• Makefile
• NodeJS / npm

It is possible to develop Ory Hydra on Windows, but please be aware that allguides assume a Unix shell like bash or zsh.

You can format all code usingmake format. Our CI checks if your code isproperly formatted.

There are three types of tests you can run:

• Short tests (do not require a SQL database like PostgreSQL)
• Regular tests (do require PostgreSQL, MySQL, CockroachDB)
• End to end tests (do require databases and will use a test browser)

All of the above tests can be run using the makefile. See the commands below.

Makefile commands

# quick testsmake quicktest# regular testsmaketesttest-resetdb# end-to-end testsmake e2e

It is recommended to use the make file to run your tests usingmake quicktest, however, you can still use thego test command.

Please note:

All tests run against a sqlite in-memory database, thus it is required to usethe-tags sqlite,json1 build tag.

Short tests run fairly quickly. You can either test all of the code at once:

gotest -v -failfast -short -tags sqlite,json1 ./...

or test just a specific module:

gotest -v -failfast -short -tags sqlite,json1 ./client

or a specific test:

gotest -v -failfast -short -tags sqlite,json1 -run ^TestName$ ./...

Regular tests require a database set up. Our test suite is able to work withdocker directly (usingory/dockertest) butwe encourage to use the Makefile instead. Using dockertest can bloat the numberof Docker Images on your system and are quite slow. Instead we recommend doing:

maketest

Please be aware thatmake test recreates the databases every time you runmake test. This can be annoying if you are trying to fix something veryspecific and need the database tests all the time. In that case we suggest thatyou initialize the databases with:

make test-resetdbexport TEST_DATABASE_MYSQL='mysql://root:secret@(127.0.0.1:3444)/mysql?parseTime=true&multiStatements=true'export TEST_DATABASE_POSTGRESQL='postgres://postgres:secret@127.0.0.1:3445/postgres?sslmode=disable'export TEST_DATABASE_COCKROACHDB='cockroach://root@127.0.0.1:3446/defaultdb?sslmode=disable'

Then you can rungo test as often as you'd like:

gotest -p 1 ./...# or in a module:cd client; gotest.

The E2E tests useCypress to run full browser tests.You can execute these tests with:

make e2e

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, butthankfully you can run the e2e test in the browser which helps with debugging!Just run:

./test/e2e/circle-ci.bash memory --watch# Or for the JSON Web Token Access Token strategy:# ./test/e2e/circle-ci.bash memory-jwt --watch

or if you would like to test one of the databases:

make test-resetdbexport TEST_DATABASE_MYSQL='mysql://root:secret@(127.0.0.1:3444)/mysql?parseTime=true&multiStatements=true'export TEST_DATABASE_POSTGRESQL='postgres://postgres:secret@127.0.0.1:3445/postgres?sslmode=disable'export TEST_DATABASE_COCKROACHDB='cockroach://root@127.0.0.1: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 allSpecs"!

The code for these tests is located in./cypress/integration and./cypress/support and./cypress/helpers. The website you're seeing is located in./test/e2e/oauth2-client.

To run Ory Hydra against the OpenID Connect conformity suite, run

$ test/conformity/start.sh --build

and then in a separate shell

$ test/conformity/test.sh

Running these tests will take a significant amount of time which is why they arenot part of the CI pipeline.

You can build a development Docker Image using:

make docker

If you wish to check your code changes against any of the docker-composequickstart files, run:

make dockerdocker compose -f quickstart.yml up# ....

1. mkdir persistence/sql/src/YYYYMMDD000001_migration_name/
2. Put the migration files into this directory, following the standard namingconventions. If you wish to execute different parts of a migration inseparate transactions, add split marks (lines with the text--split) wheredesired. Why this might be necessary is explained ingobuffalo/fizz#104.
3. Runmake persistence/sql/migrations/<migration_id> to generate migrationfragments.
4. If an update causes the migration to have fewer fragments than the numberalready generated, runmake persistence/sql/migrations/<migration_id>-clean. This is equivalent toarm command with the right parameters, but comes with better tabcompletion.
5. Before committing generated migration fragments, run the above clean commandand generate a fresh copy of migration fragments to make sure thesql/srcandsql/migrations directories are consistent.

Official:

• User Login & Consent Example

Community:

• Visitthis document for an overview of community projects and articles

Developer Blog:

• Visit theOry Blog for guides, tutorials andarticles around Ory Hydra and the Ory ecosystem.