ContextQMD
Back to Hydra

README

README.md

26.2.036.5 KB
Original Source
<h1 align="center"> </h1> <h4 align="center"> <a href="https://www.ory.com/chat">Chat</a> · <a href="https://github.com/ory/hydra/discussions">Discussions</a> · <a href="https://www.ory.com/l/sign-up-newsletter">Newsletter</a> · <a href="https://www.ory.com/docs/">Docs</a> · <a href="https://console.ory.sh/">Try Ory Network</a> · <a href="https://www.ory.com/jobs/">Jobs</a> </h4>

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. It connects to your existing identity provider through a login and consent app, giving you absolute control over the user interface and experience.

<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->

What is Ory Hydra?

Ory Hydra is a server implementation of the OAuth 2.0 authorization framework and the OpenID Connect Core 1.0. It follows cloud architecture best practices and focuses on:

  • OAuth 2.0 and OpenID Connect flows
  • Token issuance and validation
  • Client management
  • Consent and login flow orchestration
  • JWKS management
  • Low latency and high throughput

We recommend starting with the Ory Hydra introduction docs to learn more about its architecture, feature set, and how it compares to other systems.

Why Ory Hydra

Ory Hydra is designed to:

  • Be a standalone OAuth 2.0 and OpenID Connect server without user management
  • Connect to any existing identity provider through a login and consent app
  • Give you absolute control over the user interface and experience flows
  • Work with any authentication endpoint: Ory Kratos, authboss, User Frosting, or your proprietary system
  • Scale to large numbers of clients and tokens
  • Fit into modern cloud native environments such as Kubernetes and managed platforms

OAuth2 and OpenID Connect: Open Standards

Ory Hydra implements Open Standards set by the IETF:

and the OpenID Foundation:

OpenID Connect Certified

Ory Hydra is an OpenID Foundation certified OpenID Provider (OP).

<p align="center"> </p>

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.

Deployment options

You can run Ory Hydra in two main ways:

  • As a managed service on the Ory Network
  • As a self hosted service under your own control, with or without the Ory Enterprise License

Use Ory Hydra on the Ory Network

The Ory Network is the fastest way to use Ory services in production. Ory OAuth2 & OpenID Connect is powered by the open source Ory Hydra server and is API compatible.

The Ory Network provides:

  • OAuth2 and OpenID Connect for single sign on, API access, and machine to machine authorization
  • Identity and credential management that scales to billions of users and devices
  • Registration, login, and account management flows for passkeys, biometrics, social login, SSO, and multi factor authentication
  • Prebuilt login, registration, and account management pages and components
  • Low latency permission checks based on the Zanzibar model with the Ory Permission Language
  • GDPR friendly storage with data locality and compliance in mind
  • Web based Ory Console and Ory CLI for administration and operations
  • Cloud native APIs compatible with the open source servers
  • Fair, usage based pricing

Sign up for a free developer account to get started.

Self-host Ory Hydra

You can run Ory Hydra yourself for full control over infrastructure, deployment, and customization.

The install guide explains how to:

  • Install Hydra on Linux, macOS, Windows, and Docker
  • Configure databases such as PostgreSQL, MySQL, and CockroachDB
  • Deploy to Kubernetes and other orchestration systems
  • Build Hydra from source

This guide uses the open source distribution to get you started without license requirements. It is a great fit for individuals, researchers, hackers, and companies that want to experiment, prototype, or run unimportant workloads without SLAs. You get the full core engine, and you are free to inspect, extend, and build it from source.

If you run Hydra as part of a business-critical system, for example OAuth2 and OpenID Connect for all your users, you should use a commercial agreement to reduce operational and security risk. The Ory Enterprise License (OEL) layers on top of self-hosted Hydra and provides:

  • Additional enterprise features that are not available in the open source version
  • Regular security releases, including CVE patches, with service level agreements
  • Support for advanced scaling, multi-tenancy, and complex deployments
  • Premium support options with SLAs, direct access to engineers, and onboarding help
  • Access to a private Docker registry with frequent and vetted, up-to-date enterprise builds

For guaranteed CVE fixes, current enterprise builds, advanced features, and support in production, you need a valid Ory Enterprise License and access to the Ory Enterprise Docker registry. To learn more, contact the Ory team.

Quickstart

Install the Ory CLI and create a new project to try Ory OAuth2 & OpenID Connect.

bash
# Install the Ory CLI if you do not have it yet:
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -b . ory
sudo mv ./ory /usr/local/bin/

# Sign in or sign up
ory auth

# Create a new project
ory create project --create-workspace "Ory Open Source" --name "GitHub Quickstart" --use-project

Try out the OAuth 2.0 Client Credentials flow:

bash
ory create oauth2-client \
    --name "Client Credentials Demo" \
    --grant-type client_credentials
# Note the client ID and secret from output

ory perform client-credentials \
    --client-id <your-client-id> \
    --client-secret <your-client-secret>
# Note the access token from output

ory introspect token <your-access-token>

Try out the OAuth 2.0 Authorize Code + OpenID Connect flow:

bash
ory create oauth2-client \
    --name "Authorize Code with OpenID Connect Demo" \
    --grant-type authorization_code,refresh_token \
    --response-type code \
    --redirect-uri http://127.0.0.1:4446/callback

ory perform authorization-code \
    --client-id <your-client-id> \
    --client-secret <your-client-secret>

Who is using Ory Hydra

<!--BEGIN ADOPTERS-->

The Ory community stands on the shoulders of individuals, companies, and maintainers. The Ory team thanks everyone involved - from submitting bug reports and feature requests, to contributing patches and documentation. The Ory community counts more than 50.000 members and is growing. The Ory stack protects 7.000.000.000+ API requests every day across thousands of companies. None of this would have been possible 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 <a href="mailto:[email protected]">[email protected]</a> now!

<table> <thead> <tr> <th>Name</th> <th>Logo</th> <th>Website</th> <th>Case Study</th> </tr> </thead> <tbody> <tr> <td>OpenAI</td> <td align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/openai.svg" /> 
            </picture>
        </td>
        <td><a href="https://openai.com/">openai.com</a></td>
        <td><a href="https://www.ory.com/case-studies/openai">OpenAI Case Study</a></td>
    </tr>
    <tr>
        <td>Fandom</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/fandom.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.fandom.com/">fandom.com</a></td>
        <td><a href="https://www.ory.com/case-studies/fandom">Fandom Case Study</a></td>
    </tr>
    <tr>
        <td>Lumin</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/lumin.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.luminpdf.com/">luminpdf.com</a></td>
        <td><a href="https://www.ory.com/case-studies/lumin">Lumin Case Study</a></td>
    </tr>
    <tr>
        <td>Sencrop</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/sencrop.svg" />
                
            </picture>
        </td>
        <td><a href="https://sencrop.com/">sencrop.com</a></td>
        <td><a href="https://www.ory.com/case-studies/sencrop">Sencrop Case Study</a></td>
    </tr>
    <tr>
        <td>OSINT Industries</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/osint.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.osint.industries/">osint.industries</a></td>
        <td><a href="https://www.ory.com/case-studies/osint">OSINT Industries Case Study</a></td>
    </tr>
    <tr>
        <td>HGV</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/hgv.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.hgv.it/">hgv.it</a></td>
        <td><a href="https://www.ory.com/case-studies/hgv">HGV Case Study</a></td>
    </tr>
    <tr>
        <td>Maxroll</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/maxroll.svg" />
                
            </picture>
        </td>
        <td><a href="https://maxroll.gg/">maxroll.gg</a></td>
        <td><a href="https://www.ory.com/case-studies/maxroll">Maxroll Case Study</a></td>
    </tr>
    <tr>
        <td>Zezam</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/zezam.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.zezam.io/">zezam.io</a></td>
        <td><a href="https://www.ory.com/case-studies/zezam">Zezam Case Study</a></td>
    </tr>
    <tr>
        <td>T.RowePrice</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/troweprice.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.troweprice.com/">troweprice.com</a></td>
    </tr>
    <tr>
        <td>Mistral</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/mistral.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.mistral.ai/">mistral.ai</a></td>
    </tr>
    <tr>
        <td>Axel Springer</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/axelspringer.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.axelspringer.com/">axelspringer.com</a></td>
    </tr>
    <tr>
        <td>Hemnet</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/hemnet.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.hemnet.se/">hemnet.se</a></td>
    </tr>
    <tr>
        <td>Cisco</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/cisco.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.cisco.com/">cisco.com</a></td>
    </tr>
    <tr>
        <td>Presidencia de la República Dominicana</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/republica-dominicana.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.presidencia.gob.do/">presidencia.gob.do</a></td>
    </tr>
    <tr>
        <td>Moonpig</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/moonpig.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.moonpig.com/">moonpig.com</a></td>
    </tr>
    <tr>
        <td>Booster</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/booster.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.choosebooster.com/">choosebooster.com</a></td>
    </tr>
    <tr>
        <td>Zaptec</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/zaptec.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.zaptec.com/">zaptec.com</a></td>
    </tr>
    <tr>
        <td>Klarna</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/klarna.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.klarna.com/">klarna.com</a></td>
    </tr>
    <tr>
        <td>Raspberry PI Foundation</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/raspi.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.raspberrypi.org/">raspberrypi.org</a></td>
    </tr>
    <tr>
        <td>Tulip</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/tulip.svg" />
                
            </picture>
        </td>
        <td><a href="https://tulip.com/">tulip.com</a></td>
    </tr>
    <tr>
        <td>Hootsuite</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/hootsuite.svg" />
                
            </picture>
        </td>
        <td><a href="https://hootsuite.com/">hootsuite.com</a></td>
    </tr>
    <tr>
        <td>Segment</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/segment.svg" />
                
            </picture>
        </td>
        <td><a href="https://segment.com/">segment.com</a></td>
    </tr>
    <tr>
        <td>Arduino</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/arduino.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.arduino.cc/">arduino.cc</a></td>
    </tr>
    <tr>
        <td>Sainsbury's</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/sainsburys.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.sainsburys.co.uk/">sainsburys.co.uk</a></td>
    </tr>
    <tr>
        <td>Contraste</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/contraste.svg" />
                
            </picture>
        </td>
        <td><a href="https://www.contraste.com/en">contraste.com</a></td>
    </tr>
    <tr>
        <td>inMusic</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/inmusic.svg" />
                
            </picture>
        </td>
        <td><a href="https://inmusicbrands.com/">inmusicbrands.com</a></td>
    </tr>
    <tr>
        <td>Buhta</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/buhta.svg" />
                
            </picture>
        </td>
        <td><a href="https://buhta.com/">buhta.com</a></td>
    </tr>
    </tr>
        <tr>
        <td>Amplitude</td>
        <td align="center">
            <picture>
                <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/amplitude.svg" />
                
            </picture>
        </td>
        <td><a href="https://amplitude.com/">amplitude.com</a></td>
    </tr>
<tr>
  <td align="center"><a href="https://tier4.jp/en/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/tieriv.svg" /></picture></a></td>
  <td align="center"><a href="https://kyma-project.io"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/kyma.svg" /></picture></a></td>
  <td align="center"><a href="https://serlo.org/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/serlo.svg" /></picture></a></td>
  <td align="center"><a href="https://padis.io/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/padis.svg" /></picture></a></td>
</tr>
<tr>
  <td align="center"><a href="https://cloudbear.eu/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/cloudbear.svg" /></picture></a></td>
  <td align="center"><a href="https://securityonionsolutions.com/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/securityonion.svg" /></picture></a></td>
  <td align="center"><a href="https://factlylabs.com/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/factly.svg" /></picture></a></td>
  <td align="center"><a href="https://cashdeck.com.au/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/allmyfunds.svg" /></picture></a></td>
</tr>
<tr>
  <td align="center"><a href="https://nortal.com/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/nortal.svg" /></picture></a></td>
  <td align="center"><a href="https://www.ordermygear.com/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/ordermygear.svg" /></picture></a></td>
  <td align="center"><a href="https://r2devops.io/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/r2devops.svg" /></picture></a></td>
  <td align="center"><a href="https://www.paralus.io/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/paralus.svg" /></picture></a></td>
</tr>
<tr>
  <td align="center"><a href="https://dyrector.io/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/dyrector_io.svg" /></picture></a></td>
  <td align="center"><a href="https://pinniped.dev/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/pinniped.svg" /></picture></a></td>
  <td align="center"><a href="https://pvotal.tech/"><picture><source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ory/meta/master/static/adopters/light/pvotal.svg" /></picture></a></td>
  <td></td>
</tr>
</tbody>
</table>

Many thanks to all individual contributors

<a href="https://opencollective.com/ory" target="_blank"></a>

<!--END ADOPTERS-->

Ecosystem

<!--BEGIN ECOSYSTEM-->

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

  • 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 system 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: Identity and User Infrastructure and Management

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: OAuth2 & OpenID Connect Server

Ory Hydra is an OpenID Certified™ OAuth2 and OpenID Connect Provider which easily connects to any existing identity system by writing a tiny "bridge" application. It gives absolute control over the user interface and user experience flows.

Ory Oathkeeper: Identity & Access Proxy

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: Access Control Policies as a Server

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.

<!--END ECOSYSTEM-->

Documentation

The full Ory Hydra documentation is available at www.ory.com/docs/hydra, including:

For upgrading and changelogs, check releases tab and CHANGELOG.md.

Developing Ory Hydra

See DEVELOP.md for information on:

  • Contribution guidelines
  • Prerequisites
  • Install from source
  • Running tests
  • Build Docker image
  • Preview API documentation

Security

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. Read the security guide for more details on cryptography and security concepts.

Disclosing vulnerabilities

If you think you found a security vulnerability, please refrain from posting it publicly on the forums, the chat, or GitHub. You can find all info for responsible disclosure in our security.txt.

Telemetry

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

Libraries and third-party projects

Official:

Community:

Developer Blog:

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