middleware

Documentation

Overview

Example

package main

import (
	"io"
	"log"
	"net/http"

	"github.com/heroku/x/dynoid/middleware"
)

const Audience = "testing"

func main() {
	authorized := middleware.AuthorizeSameSpace(Audience)
	secureHandler := authorized(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
		if _, err := io.WriteString(w, "Hello from a secure endpoint!\n"); err != nil {
			log.Printf("error writing response (%v)", err)
		}
	}))

	http.Handle("/secure", secureHandler)

	log.Fatal(http.ListenAndServe(":8080", nil))
}

Index

• Variables
• func Authorize(audience string, callback dynoid.IssuerCallback) func(http.Handler) http.Handler
• func AuthorizeSameSpace(audience string) func(http.Handler) http.Handler
• func AuthorizeSpaces(audience string, spaces ...string) func(http.Handler) http.Handler
• func AuthorizeSpacesWithIssuer(audience, issuer string, spaces ...string) func(http.Handler) http.Handler
• func Populate(audience string, callback dynoid.IssuerCallback) func(http.Handler) http.Handler

Examples

• Package

Variables

var (
	// returned when the `Authorization` header does not contain a Bearer token
	ErrTokenMissing = errors.New("token not found")
)

Functions

func Authorize

func Authorize(audience string, callback dynoid.IssuerCallback) func(http.Handler) http.Handler

Authorize populates the dyno identity blocks requests where the callback fails.

func AuthorizeSameSpace

func AuthorizeSameSpace(audience string) func(http.Handler) http.Handler

AuthorizeSameSpace restricts access to tokens from the same space/issuer for the given audience.

func AuthorizeSpaces

func AuthorizeSpaces(audience string, spaces ...string) func(http.Handler) http.Handler

AuthorizeSpaces populates the dyno identity and blocks any requests that aren't from one of the given spaces.

func AuthorizeSpacesWithIssuer

func AuthorizeSpacesWithIssuer(audience, issuer string, spaces ...string) func(http.Handler) http.Handler

AuthorizeSpacesWithIssuer populates the dyno identity and blocks any requests that aren't from one of the given spaces and issuer.

func Populate

func Populate(audience string, callback dynoid.IssuerCallback) func(http.Handler) http.Handler

Populate attempts to validate and parse a Token from the request for the given audience but doesn't enforce any restrictions.