README
¶
auth 
Simple HTTP authentication middleware, supporting Basic, Bearer, token and other authentication schemes.
Installation
go get -u gopkg.in/vinxi/auth.v0
API
See godoc reference.
Examples
Unique basic user auth
package main
import (
"fmt"
"gopkg.in/vinxi/auth.v0"
"gopkg.in/vinxi/vinxi.v0"
)
const port = 3100
func main() {
// Create a new vinxi proxy
vs := vinxi.NewServer(vinxi.ServerOptions{Port: port})
// Attach the auth middleware
vs.Use(auth.User("foo", "pas$w0rd"))
// Target server to forward
vs.Forward("http://httpbin.org")
fmt.Printf("Server listening on port: %d\n", port)
err := vs.Listen()
if err != nil {
fmt.Errorf("Error: %s\n", err)
}
}
Custom config allowing multiple credentials types
package main
import (
"fmt"
"gopkg.in/vinxi/auth.v0"
"gopkg.in/vinxi/vinxi.v0"
)
const port = 3100
func main() {
// Create a new vinxi proxy
vs := vinxi.NewServer(vinxi.ServerOptions{Port: port})
// Bind the auth middleware with custom config
// Any of the following credentials will be authorized
tokens := []auth.Token{
{Type: "Basic", Value: "foo:s3cr3t"},
{Type: "Bearer", Value: "s3cr3t"},
{Value: "s3cr3t token"},
}
vs.Use(auth.New(&auth.Config{Tokens: tokens}))
// Target server to forward
vs.Forward("http://httpbin.org")
fmt.Printf("Server listening on port: %d\n", port)
err := vs.Listen()
if err != nil {
fmt.Errorf("Error: %s\n", err)
}
}
License
MIT
Documentation
¶
Index ¶
Constants ¶
const Version = "0.1.0"
Version defines the current package semantic version.
Variables ¶
This section is empty.
Functions ¶
func DecodeBasicAuthHeader ¶
DecodeBasicAuthHeader decodes a given string as HTTP basic auth scheme.
Types ¶
type BasicAuth ¶
type BasicAuth struct {
User, Password string
}
BasicAuth represents the user-password pair used as helper struct.
type Config ¶
type Config struct {
// RealM token used for unauthorized
RealM string
// Tokens stores a list of allowed authorization tokens.
// Tokens could be of any type.
Tokens []Token
// Matchers stores a list of matchers used to compare an incoming
// authorization header againts the registered allowed tokens.
Matchers []Matcher
}
Config represents the authorization middleware configuration.
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
Handler authentication middleware handler.
func New ¶
New creates a new authorization middleware handler with the given config.
func Tokens ¶
Tokens creates a new auth handler allowing the given token strings. Tokens must be transported via Authorization header.
func User ¶
User function is optional but handy, used to check input parameters when creating new middlewares
func Users ¶
Users creates a new auth middleware allowing access to the list of users.
type Matcher ¶
Matcher represents the required auth header matcher function signature implemented by matchers.
type Token ¶
type Token struct {
// Type stores the authorization type. Usually Basic or Bearer.
Type string
// Value stores the authorization token.
// If the authorization token has no type, this field will be filled instead.
Value string
}
Token represents the parsed schema of an HTTP authorization header.
Source Files
¶
- auth.go
- basic.go
- version.go
Directories