hydra

README

hydra

Hydra middleware for Echo framework. It uses Hydra's API to extract and validate auth token.

Example

import (
    "github.com/webx-top/echo"
    "github.com/webx-top/echo/engine/standard"
    "github.com/ory-am/hydra/firewall"
    hydraMW "github.com/webx-top/echo/middleware/hydra"
)

func handler(c echo.Context) error {
	ctx := c.Get("hydra").(*firewall.Context) // or hydraMW.GetContext(c)
	// Now you can access ctx.Subject etc.
	return nil
}

func main(){
	// Initialize Hydra
	hc, err := hydraMW.Connect(hydraMW.Options{
		ClientID     : "...",
		ClientSecret : "...",
		ClusterURL   : "",
	})
	if err != nil {
		panic(err)
	}

	// Use the middleware
 	e := echo.New()
	e.Get("/", handler, hydraMW.ScopesRequired(hc, nil, "scope1", "scope2"))
	e.Run(standard.New(":4444"))
}

Documentation

Overview

Copyright 2016 Wenhui Shen <www.webx.top>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Connect(val Options) (hc *hydraSDK.Client, err error)
• func GetClient(hc *hydraSDK.Client, id string) (fosite.Client, error)
• func GetContext(c echo.Context) *firewall.Context
• func NewTokenAccessRequest(resource string, action string, context map[string]interface{}) *firewall.TokenAccessRequest
• func ScopesRequired(opt interface{}, tokenAccessRequest *firewall.TokenAccessRequest, ...) echo.MiddlewareFunc
• type Options

Variables

var DefaultClient *hydraSDK.Client

Functions

func Connect

func Connect(val Options) (hc *hydraSDK.Client, err error)

func GetClient

func GetClient(hc *hydraSDK.Client, id string) (fosite.Client, error)

func GetContext

func GetContext(c echo.Context) *firewall.Context

func NewTokenAccessRequest

func NewTokenAccessRequest(resource string, action string, context map[string]interface{}) *firewall.TokenAccessRequest

func ScopesRequired

func ScopesRequired(opt interface{}, tokenAccessRequest *firewall.TokenAccessRequest, scopes ...string) echo.MiddlewareFunc

Types

type Options

type Options struct {
	Skipper      echo.Skipper
	ClientID     string
	ClientSecret string
	ClusterURL   string
}