Initial commit of tokenauth.

Author: octavore

users/tokenauth/module.go

@@ -0,0 +1,62 @@
+package tokenauth
+
+import (
+	"net/http"
+
+	"strings"
+
+	"github.com/octavore/naga/service"
+	"github.com/octavore/nagax/users"
+)
+
+const (
+	defaultHTTPHeader  = "Authorization"
+	defaultTokenPrefix = "token"
+)
+
+var (
+	_ service.Module      = &Module{}
+	_ users.Authenticator = &Module{}
+)
+
+type TokenSource interface {
+	Get(token string) *string
+}
+
+type Module struct {
+	tokenSource TokenSource
+	header      string
+	prefix      string
+}
+
+func (m *Module) Init(c *service.Config) {
+	c.Start = func() {
+		m.header = defaultHTTPHeader
+		m.prefix = defaultTokenPrefix
+	}
+}
+
+func (m *Module) Authenticate(rw http.ResponseWriter, req *http.Request) (bool, *string, error) {
+	val := req.Header.Get(m.header)
+	if val == "" {
+		return false, nil, nil
+	}
+	parts := strings.SplitN(val, " ", 2)
+	if len(parts) != 2 {
+		return false, nil, nil
+	}
+	prefix := strings.ToLower(parts[0])
+	if prefix != m.prefix {
+		return false, nil, nil
+	}
+	token := parts[1]
+	userID := m.tokenSource.Get(token)
+	if userID == nil {
+		return false, nil, users.ErrNotAuthorized
+	}
+	return true, userID, nil
+}
+
+func (m *Module) Logout(rw http.ResponseWriter, req *http.Request) {
+	// noop
+}

users/tokenauth/module_test.go

@@ -0,0 +1,94 @@
+package tokenauth
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/octavore/nagax/users"
+)
+
+type dummyTokenSource map[string]string
+
+func (d *dummyTokenSource) Get(k string) *string {
+	v, ok := (*d)[k]
+	if !ok {
+		return nil
+	}
+	return &v
+}
+
+func setup() (*Module, *httptest.ResponseRecorder, *http.Request) {
+	m := &Module{
+		tokenSource: &dummyTokenSource{"goodToken": "1234"},
+		header:      defaultHTTPHeader,
+		prefix:      defaultTokenPrefix,
+	}
+	return m, httptest.NewRecorder(), httptest.NewRequest("GET", "/", nil)
+}
+
+func TestAuthenticateGoodToken(t *testing.T) {
+	m, rw, req := setup()
+	req.Header.Set(defaultHTTPHeader, "Token goodToken")
+	b, s, err := m.Authenticate(rw, req)
+	if err != nil {
+		t.Fatal("unexpected error", err)
+	}
+	if !b {
+		t.Error("unexpected value", b)
+	}
+	if s == nil {
+		t.Error("unexpected value", s)
+	} else if *s != "1234" {
+		t.Error("unexpected value", *s)
+	}
+
+	// different capitalization for prefix
+	m, rw, req = setup()
+	req.Header.Set(defaultHTTPHeader, "tOkEn goodToken")
+	b, s, err = m.Authenticate(rw, req)
+	if err != nil {
+		t.Fatal("unexpected error", err)
+	}
+	if !b {
+		t.Error("unexpected value", b)
+	}
+	if s == nil {
+		t.Error("unexpected value", s)
+	} else if *s != "1234" {
+		t.Error("unexpected value", *s)
+	}
+}
+
+func TestAuthenticateBadPrefix(t *testing.T) {
+	m, rw, req := setup()
+	req.Header.Set(defaultHTTPHeader, "Basic badToken")
+
+	// returns false (not authenticated) but without an error
+	b, s, err := m.Authenticate(rw, req)
+	if err != nil {
+		t.Fatal("unexpected error", nil)
+	}
+	if b {
+		t.Error("unexpected value", b)
+	}
+	if s != nil {
+		t.Error("unexpected value", *s)
+	}
+}
+
+func TestAuthenticateBadToken(t *testing.T) {
+	m, rw, req := setup()
+	req.Header.Set(defaultHTTPHeader, "Token badToken")
+	// returns false (not authenticated) with an error
+	b, s, err := m.Authenticate(rw, req)
+	if err != users.ErrNotAuthorized {
+		t.Fatal("unexpected error", err)
+	}
+	if b {
+		t.Error("unexpected value", b)
+	}
+	if s != nil {
+		t.Error("unexpected value", *s)
+	}
+}

users/tokenauth/options.go

@@ -0,0 +1,34 @@
+package tokenauth
+
+import (
+	"strings"
+)
+
+type option func(*Module)
+
+func (m *Module) Configure(opts ...option) {
+	for _, opt := range opts {
+		opt(m)
+	}
+}
+
+// WithTokenSource sets the backing token source. Required.
+func WithTokenSource(ts TokenSource) option {
+	return func(m *Module) {
+		m.tokenSource = ts
+	}
+}
+
+// WithHeader sets the http header to use. Defaults to 'Authorization'. Optional.
+func WithHeader(header string) option {
+	return func(m *Module) {
+		m.header = header
+	}
+}
+
+// WithPrefix sets the prefix to check for in the header. Defaults to 'Token'. Optional.
+func WithPrefix(prefix string) option {
+	return func(m *Module) {
+		m.prefix = strings.ToLower(prefix)
+	}
+}