Jay Taylor's notes
back to listing indexory/hydra
[web search]-
-
Guide | API Docs | Code Docs
Support us on patreon!
ORY Hydra is a hardened OAuth2 and OpenID Connect server optimized for low-latency, high throughput, and low resource consumption. ORY Hydra is not an identity provider (user sign up, user log in, password reset flow), but connects to your existing identity provider through a consent app. Implementing the consent app in a different language is easy, and exemplary consent apps (Go, Node) and SDKs are provided.
Besides mitigating various attack vectors, such as database compromisation and OAuth 2.0 weaknesses, ORY Hydra is able to securely manage JSON Web Keys, and has a sophisticated policy-based access control you can use if you want to. Click here to read more about security.
Installation
There are various ways of installing ORY Hydra on your system.
Download binaries
The client and server binaries are downloadable at releases. There is currently no installer available. You have to add the ORY Hydra binary to the PATH environment variable yourself or put the binary in a location that is already in your path (
/usr/bin
, ...). If you do not understand what that all of this means, ask in our chat channel. We are happy to help.Using Docker
Starting the host is easiest with docker. The host process handles HTTP requests and is backed by a database. Read how to install docker on Linux, OSX or Windows. ORY Hydra is available on Docker Hub.
You can use ORY Hydra without a database, but be aware that restarting, scaling or stopping the container will lose all data:
$ docker run -e "DATABASE_URL=memory" -e "ISSUER=https://localhost:4444/" -d --name my-hydra -p 4444:4444 oryd/hydra ec91228cb105db315553499c81918258f52cee9636ea2a4821bdb8226872f54b
Note: We had to create a new docker hub repository. Tags prior to 0.7.5 are available here.
Using the client command line interface: You can ssh into the ORY Hydra container and execute the ORY Hydra command from there:
$ docker exec -i -t <hydra-container-id> /bin/sh # e.g. docker exec -i -t ec91228 /bin/sh root@ec91228cb105:/go/src/github.com/ory/hydra# hydra Hydra is a twelve factor OAuth2 and OpenID Connect provider [...]
Building from source
If you wish to compile ORY Hydra yourself, you need to install and set up Go 1.9+ and add
$GOPATH/bin
to your$PATH
as well as golang/dep. To do so, run the following commands in a shell (bash, sh, cmd.exe, ...):go get -d -u github.com/ory/hydra cd $GOPATH/src/github.com/ory/hydra dep ensure go install github.com/ory/hydra hydra
Notes
- We changed organization name from
ory-am
toory
. In order to keep backwards compatibility, we did not rename Go packages. - You can ignore warnings similar to
package github.com/ory/hydra/cmd/server: case-insensitive import collision: "github.com/Sirupsen/logrus" and "github.com/sirupsen/logrus"
.
Security
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.
Telemetry
ORY Hydra collects summarized, anonymized telemetry which can optionally be turned off. Click here to learn more.
Sponsors & Adopters
ORY Hydra is open source with a permissive license. We are a dedicated, young but also experienced team of developers in the area of cloud computing and internet security. Please support our mission for a safer web and become a sponsor, buy an engineer membership, or tell us why and how you are using ORY Hydra.
Sponsorship
Become a ORY Hydra sponsor now and help keep the project open source, free, and maintained. Additionally, sponsors unlock
- Access to ORY's private slack community.
- Featured logo & link in the readme and on the website.
- placement in release announcements.
Sponsorship starts at 600$ per month. We accept smaller contributions as well, but without the benefits listed above.
Sponsors
Adopters
ORY Hydra is battle-tested in production systems. This is a curated list of ORY Hydra adopters. Tell us if you think that your company should be listed here.
Documentation
Guide
The Guide is available on GitBook.
HTTP API documentation
The HTTP API is documented at Apiary.
Command line documentation
Run
hydra -h
orhydra help
.Develop
Developing with ORY Hydra is as easy as:
go get -d -u github.com/ory/hydra cd $GOPATH/src/github.com/ory/hydra dep ensure go test ./...
Then run it with in-memory database:
DATABASE_URL=memory go run main.go host
Notes
- We changed organization name from
ory-am
toory
. In order to keep backwards compatibility, we did not rename Go packages. - You can ignore warnings similar to
package github.com/ory/hydra/cmd/server: case-insensitive import collision: "github.com/sirupsen/logrus" and "github.com/sirupsen/logrus"
.
Reception
Hydra has received a lot of positive feedback. Let's see what the community is saying:
Nice! Lowering barriers to the use of technologies like these is important.
OAuth is a framework not a protocol. The security it provides can vary greatly between implementations. Fosite (which is what this is based on) is a very good implementation from a security perspective: https://github.com/ory/fosite#a-word-on-security
[...] Thanks for releasing this by the way, looks really well engineered. [...]
Libraries and third-party projects
Official:
Community:
Blog posts & articles
- Creating an oauth2 custom lamda authorizer for use with Amazons (AWS) API Gateway using Hydra
- Warning, ORY Hydra has changed almost everything since writing this article: Hydra: Run your own Identity and Access Management service in <5 Minutes
- We changed organization name from