-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* oauth2: scopes should be separated by %20 and not +, to ensure javascript compatibility - closes #277 * oauth2/introspect: make endpoint rfc7662 compatible - closes #289 * warden: make it clear that ladon.Request.Subject is not required or break bc and remove it - closes #270 * travis: execute gox build only when new commit is a new tag - closes #285 * docs: improve introduction (#267) * core: (health) monitoring endpoint - closes #216 * oauth2/introspect: make endpoint rfc7662 compatible - closes #289 * connections: remove connections API - closes #265 * oauth2: token revocation endpoint - closes #233 * vendor: update to fosite 0.5.0 * core: add sql support #292 * connections: remove connections API - closes #265 * all: coverage report is missing covered lines of nested packages - closes #296 * cmd: prettify the `hydra token user` output - closes #281 * travis: make it possible for travis-ci to build forked repos - closes #295
- Loading branch information
Showing
115 changed files
with
2,965 additions
and
2,499 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,4 +11,5 @@ vendor/ | |
cover.out | ||
output/ | ||
_book/ | ||
dist/ | ||
dist/ | ||
coverage.* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,22 @@ | ||
# Contribution Guide | ||
|
||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
**Table of Contents** | ||
|
||
- [Introduction](#introduction) | ||
- [Contributing Code](#contributing-code) | ||
- [Disclosing vulnerabilities](#disclosing-vulnerabilities) | ||
- [Code Style](#code-style) | ||
- [Developer’s Certificate of Origin](#developer%E2%80%99s-certificate-of-origin) | ||
- [Pull request procedure](#pull-request-procedure) | ||
- [Communication](#communication) | ||
- [Conduct](#conduct) | ||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
## Introduction | ||
|
||
We welcome and encourage community contributions to Hydra. | ||
|
||
Since the project is still unstable, there are specific priorities for development. Pull requests that do not address these priorities will not be accepted until Hydra is production ready. | ||
|
@@ -21,6 +38,10 @@ At least one review from a maintainer is required for all patches (even patches | |
|
||
Reviewers should leave a "LGTM" comment once they are satisfied with the patch. If the patch was submitted by a maintainer with write access, the pull request should be merged by the submitter after review. | ||
|
||
## Disclosing vulnerabilities | ||
|
||
Please disclose vulnerabilities exclusively to [[email protected]](mailto:[email protected]). Do not use GitHub issues. | ||
|
||
## Code Style | ||
|
||
Please follow these guidelines when formatting source code: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Patreon | ||
|
||
We are proud to be part of the Open Knowledge and Open Source movement. | ||
We have been using Open Source Software throughout our career and want to contribute back. | ||
We believe that developers and operators should not have to fiddle with hard to understand configuration files, | ||
runtime and installation. Our vision is to enhance the developer and operator ecosystem with easy to use | ||
and secure Open Source Software, and we need your help to achieve that! | ||
|
||
Support ORY's Open Source Software on [patreon](https://patreon.com/user?u=4298803)! | ||
|
||
## Patrons | ||
|
||
[Be the first!](https://patreon.com/user?u=4298803) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,35 +3,36 @@ | |
[![Join the chat at https://gitter.im/ory-am/hydra](https://img.shields.io/badge/join-chat-00cc99.svg)](https://gitter.im/ory-am/hydra?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
[![Join mailinglist](https://img.shields.io/badge/join-mailinglist-00cc99.svg)](https://groups.google.com/forum/#!forum/ory-hydra/new) | ||
[![Join newsletter](https://img.shields.io/badge/join-newsletter-00cc99.svg)](http://eepurl.com/bKT3N9) | ||
[![Follow newsletter](https://img.shields.io/badge/follow-twitter-00cc99.svg)](https://twitter.com/_aeneasr) | ||
[![Follow twitter](https://img.shields.io/badge/follow-twitter-00cc99.svg)](https://twitter.com/_aeneasr) | ||
[![Follow GitHub](https://img.shields.io/badge/follow-github-00cc99.svg)](https://github.com/arekkas) | ||
|
||
[![Build Status](https://travis-ci.org/ory-am/hydra.svg?branch=master)](https://travis-ci.org/ory-am/hydra) | ||
[![Coverage Status](https://coveralls.io/repos/ory-am/hydra/badge.svg?branch=master&service=github)](https://coveralls.io/github/ory-am/hydra?branch=master) | ||
[![Code Climate](https://codeclimate.com/github/ory-am/hydra/badges/gpa.svg)](https://codeclimate.com/github/ory-am/hydra) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/ory-am/hydra)](https://goreportcard.com/report/github.com/ory-am/hydra) | ||
|
||
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/364/badge)](https://bestpractices.coreinfrastructure.org/projects/364) | ||
|
||
[![Docs Guide](https://img.shields.io/badge/docs-guide-blue.svg)](https://ory-am.gitbooks.io/hydra/content/) | ||
[![HTTP API Documentation](https://img.shields.io/badge/docs-http%20api-blue.svg)](http://docs.hdyra.apiary.io/) | ||
[![Code Documentation](https://img.shields.io/badge/docs-godoc-blue.svg)](https://godoc.org/github.com/ory-am/hydra) | ||
|
||
Hydra is being developed by german-based company [Ory](https://ory.am). | ||
[![Code Documentation](https://img.shields.io/badge/support-patreon-green.svg)](https://patreon.com/user?u=4298803) | ||
|
||
Hydra is a runnable server implementation of the OAuth2 2.0 authorization framework and the OpenID Connect Core 1.0. | ||
|
||
Hydra is being developed by german-based company [ORY](https://ory.am). | ||
Join our [newsletter](http://eepurl.com/bKT3N9) to stay on top of new developments. | ||
We offer basic support requests on [Google Groups](https://groups.google.com/forum/#!forum/ory-hydra/new) and [Gitter](https://gitter.im/ory-am/hydra) | ||
as well as [consulting](mailto:[email protected]) around integrating Hydra into | ||
your particular environment and [premium support](mailto:[email protected]). | ||
We answer basic support requests on [Google Groups](https://groups.google.com/forum/#!forum/ory-hydra/new) and [Gitter](https://gitter.im/ory-am/hydra) | ||
and offer [premium services](http://www.ory.am/products/hydra) around Hydra. | ||
|
||
Hydra uses the security first OAuth2 and OpenID Connect SDK [Fosite](https://github.com/ory-am/fosite) and [Ladon](https://github.com/ory-am/ladon) for policy-based access control. | ||
Hydra uses the security first OAuth2 and OpenID Connect SDK [Fosite](https://github.com/ory-am/fosite) and | ||
the access control SDK [Ladon](https://github.com/ory-am/ladon). | ||
|
||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
**Table of Contents** | ||
|
||
- [What is Hydra?](#what-is-hydra) | ||
- [What is Hydra / OAuth2 not?](#what-is-hydra--oauth2-not) | ||
- [When does Hydra / OAuth2 make sense?](#when-does-hydra--oauth2-make-sense) | ||
- [Feature Overview](#feature-overview) | ||
- [Quickstart](#quickstart) | ||
- [Installation](#installation) | ||
- [Download binaries](#download-binaries) | ||
|
@@ -46,82 +47,23 @@ Hydra uses the security first OAuth2 and OpenID Connect SDK [Fosite](https://git | |
- [Command Line Documentation](#command-line-documentation) | ||
- [Develop](#develop) | ||
- [Third-party libraries and projects](#third-party-libraries-and-projects) | ||
- [Hall of Fame](#hall-of-fame) | ||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
## What is Hydra? | ||
|
||
At first, there was the monolith. The monolith worked well with the bespoke authentication module. | ||
Then, the web evolved into an elastic cloud that serves thousands of different user agents | ||
in every part of the world. | ||
|
||
Hydra is driven by the need for a **scalable, low-latency, in memory | ||
Access Control, OAuth2, and OpenID Connect layer** that integrates with every identity provider you can imagine. | ||
|
||
* Hydra is built security first: architecture and work flows are designed to neutralize various common (OWASP TOP TEN) and uncommon attack vectors. [Learn more](https://ory-am.gitbooks.io/hydra/content/basics/security.html). | ||
* Hydra can manage all of your access control needs, such as policy based access control and access token validation. [Learn more](https://ory-am.gitbooks.io/hydra/content/access-control.html). | ||
* Hydra depends on an identity provider of your choosing, e.g. [authboss](https://github.com/go-authboss/authboss), and works with any identity provider that is able to read and issue JSON Web Tokens. [Learn more](https://ory-am.gitbooks.io/hydra/content/oauth2/consent.html). | ||
* Hydra has nano-second latency on high profile endpoints, overwhelmingly efficient memory and CPU consumption and scales effortlessly. [Learn more](https://ory-am.gitbooks.io/hydra/content/basics/architecture.html). | ||
* Hydra focuses on ease of use, integration, management and operation. [Get Hydra up and running in 5 Minutes](https://ory-am.gitbooks.io/hydra/content/demo.html). | ||
* Hydra helps you manage [Social Login Connections](https://ory-am.gitbooks.io/hydra/content/sso.html) as well as [JSON Web Keys](https://ory-am.gitbooks.io/hydra/content/jwk.html) and is planned to help you manage User Groups and Two Factor Authentication as well. | ||
* Hydra is available through [Docker](https://hub.docker.com/r/oryam/hydra/) and relies on RethinkDB for persistence. | ||
Database drivers are extensible in case you want to use RabbitMQ, MySQL, MongoDB, or some other database instead. | ||
|
||
Hydra is built for high volume environments and is capable of serving tens of thousands of simultaneous requests per second per instance. Read [this issue](https://github.com/ory-am/hydra/issues/161) for information on reproducing these benchmarks yourself. | ||
|
||
### What is Hydra / OAuth2 not? | ||
|
||
I am new to all of this. When should I reconsider if using OAuth2 / Hydra is the right choice for me? | ||
|
||
1. Hydra is not something that manages user accounts. Hydra does not offer user registration, password reset, user | ||
login, sending confirmation emails. This is what the *Identity Provider* ("login endpoint") is responsible for. | ||
The communication between Hydra and the Identity Provider is called [*Consent Flow*](https://ory-am.gitbooks.io/hydra/content/oauth2/consent.html). | ||
[Auth0.com](https://auth0.com) is an Identity Provider. We might implement this feature at some point and if, it is going to be a different product. | ||
2. If you think running an OAuth2 Provider can solve your user authentication ("log a user in"), Hydra is probably not for you. OAuth2 is a delegation protocol: | ||
|
||
> The OAuth 2.0 authorization framework enables a third-party application *[think: a dropbox app that manages your dropbox photos]* | ||
to obtain limited access to an HTTP service, either on behalf of *[do you allow "amazing photo app" to access all your photos?]* | ||
a resource owner *[user]* by orchestrating an approval interaction *[consent flow]* between the resource owner and the | ||
HTTP service, or by allowing the third-party application *[OAuth2 Client App]* to obtain access on its own behalf. | ||
- **[IETF](https://tools.ietf.org/html/rfc6749)** | ||
3. If you are building a simple service for 50-100 registered users, OAuth2 and Hydra will be overkill. | ||
4. Hydra does not support the OAuth2 resource owner password credentials flow. | ||
5. Hydra has no user interface. You must manage OAuth2 Clients and other things using the RESTful endpoints. | ||
A user interface is scheduled to accompany the stable release. | ||
|
||
### When does Hydra / OAuth2 make sense? | ||
|
||
1. If you want third-party developers to access your APIs, Hydra is the perfect fit. This is what an OAuth2 Provider does. | ||
2. If you want to become a Identity Provider, like Google, Facebook or Microsoft, OpenID Connect and thus Hydra is a perfect fit. | ||
3. Running an OAuth2 Provider works great with browser, mobile and wearable apps, as you can avoid storing user | ||
credentials on the device, phone or wearable and revoke access tokens, and thus access privileges, at any time. Adding | ||
OAuth2 complexity to your environment when you never plan to do (1), | ||
might not be worth it. Our advice: write a pros/cons list. | ||
4. If you have a lot of services and want to limit automated access (think: cronjobs) for those services, | ||
OAuth2 might make sense for you. Example: The comment service is not allowed to read user passwords when fetching | ||
the latest user profile updates. | ||
|
||
## Feature Overview | ||
|
||
1. **Availability:** Hydra uses pub/sub to have the latest data available in memory. The in-memory architecture allows for heavy duty workloads. | ||
2. **Scalability:** Hydra scales effortlessly on every platform you can imagine, including Heroku, Cloud Foundry, Docker, | ||
Google Container Engine and many more. | ||
3. **Integration:** Hydra wraps your existing stack like a blanket and keeps it safe. Hydra uses cryptographic tokens to authenticate users and request their consent, no APIs required. | ||
The deprecated php-3.0 authentication service your intern wrote? It works with that too, don't worry. | ||
We wrote an example with React to show you what this could look like: [React.js Identity Provider Example App](https://github.com/ory-am/hydra-idp-react). | ||
4. **Security:** Hydra leverages the security first OAuth2 framework **[Fosite](https://github.com/ory-am/fosite)**, | ||
encrypts important data at rest, and supports HTTP over TLS (https) out of the box. | ||
5. **Ease of use:** Developers and operators are human. Therefore, Hydra is easy to install and manage. Hydra does not care if you use React, Angular, or Cocoa for your user interface. | ||
To support you even further, there are APIs available for *cryptographic key management, social log on, policy based access control, policy management, and two factor authentication (tbd).* | ||
Hydra is packaged using [Docker](https://hub.docker.com/r/oryam/hydra/). | ||
6. **Open Source:** Hydra is licensed under Apache Version 2.0 | ||
7. **Professional:** Hydra implements peer reviewed open standards published by [The Internet Engineering Task Force (IETF®)](https://www.ietf.org/) and the [OpenID Foundation](https://openid.net/) | ||
and under supervision of the [LMU Teaching and Research Unit Programming and Modelling Languages](http://www.en.pms.ifi.lmu.de). No funny business. | ||
8. <img src="docs/images/monitoring.gif" width="45%" align="right"> **Real Time:** Operation is a lot easier with real time. There are no caches, | ||
no invalidation strategies and no magic - just simple, cloud native pub-sub. Hydra leverages RethinkDB, so check out their real time database monitoring too! | ||
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](https://github.com/oauthjs/node-oauth2-server) | ||
or [fosite](https://github.com/ory-am/fosite/issues), or as fully featured identity solutions with user | ||
management and user interfaces, such as [Dex](https://github.com/coreos/dex). | ||
|
||
<br clear="all"> | ||
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 Hydra is to make OAuth 2.0 and OpenID Connect 1.0 better accessible. | ||
|
||
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 Hydra with any authentication endpoint, be it [authboss](https://github.com/go-authboss/authboss), | ||
[auth0.com](https://auth0.com/) or your proprietary PHP authentication. | ||
|
||
## Quickstart | ||
|
||
|
@@ -185,7 +127,7 @@ hydra | |
### 5 minutes tutorial: Run your very own OAuth2 environment | ||
|
||
The **[tutorial](https://ory-am.gitbooks.io/hydra/content/demo.html)** teaches you to set up Hydra, | ||
a RethinkDB instance and an exemplary identity provider written in React using docker compose. | ||
a Posgres instance and an exemplary identity provider written in React using docker compose. | ||
It will take you about 5 minutes to get complete the **[tutorial](https://ory-am.gitbooks.io/hydra/content/demo.html)**. | ||
|
||
<img src="docs/images/oauth2-flow.gif" alt="OAuth2 Flow"> | ||
|
@@ -200,7 +142,7 @@ OAuth2 and OAuth2 related specifications are over 200 written pages. Implementin | |
Even if you use a secure SDK (there are numerous SDKs not secure by design in the wild), messing up the implementation | ||
is a real threat - no matter how good you or your team is. To err is human. | ||
|
||
An in-depth list of security features is listed [in the security guide](https://ory-am.gitbooks.io/hydra/content/basics/security.html). | ||
An in-depth list of security features is listed [in the security guide](https://ory-am.gitbooks.io/hydra/content/faq/security.html). | ||
|
||
## Reception | ||
|
||
|
@@ -261,10 +203,3 @@ DATABASE_URL=rethinkdb://localhost:28015/hydra go run main.go host | |
## Third-party libraries and projects | ||
|
||
* [Hydra middleware for Gin](https://github.com/janekolszak/gin-hydra) | ||
|
||
## Hall of Fame | ||
|
||
A list of extraordinary contributors and [bug hunters](https://github.com/ory-am/hydra/issues/84). | ||
|
||
* [Alexander Widerberg (leetal)](https://github.com/leetal) for implementing the prototype RethinkDB adapters. | ||
* The active Community on Gitter. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
package client | ||
|
||
import ( | ||
"github.com/ory-am/fosite" | ||
"github.com/stretchr/testify/assert" | ||
"testing" | ||
) | ||
|
||
func TestClient(t *testing.T) { | ||
c := &Client{ | ||
ID: "foo", | ||
RedirectURIs: []string{"foo"}, | ||
Scope: "foo bar", | ||
} | ||
|
||
assert.EqualValues(t, c.RedirectURIs, c.GetRedirectURIs()) | ||
assert.EqualValues(t, []byte(c.Secret), c.GetHashedSecret()) | ||
assert.EqualValues(t, fosite.Arguments{"authorization_code"}, c.GetGrantTypes()) | ||
assert.EqualValues(t, fosite.Arguments{"code"}, c.GetResponseTypes()) | ||
assert.EqualValues(t, (c.Owner), c.GetOwner()) | ||
assert.EqualValues(t, (c.Public), c.IsPublic()) | ||
assert.Len(t, c.GetScopes(), 2) | ||
assert.EqualValues(t, c.RedirectURIs, c.GetRedirectURIs()) | ||
} |
Oops, something went wrong.