Pass options separately (#2)

* Pass options separately

* Restore options

* godoc

* don't export

* move struct back to file

* Showcase VerifyACL

* uses ctx in handler

* renmae project to projectID

* fix name

common.go

@@ -3,13 +3,17 @@ package authcontrol
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"net/http"
+	"reflect"
 	"strings"
 
 	"github.com/0xsequence/authcontrol/proto"
 )
 
-func defaultErrHandler(r *http.Request, w http.ResponseWriter, err error) {
+type ErrHandler func(r *http.Request, w http.ResponseWriter, err error)
+
+func errHandler(r *http.Request, w http.ResponseWriter, err error) {
 	rpcErr, ok := err.(proto.WebRPCError)
 	if !ok {
 		rpcErr = proto.ErrWebrpcEndpoint.WithCause(err)
@@ -32,45 +36,45 @@ type UserStore interface {
 // map[service]map[method]T
 type Config[T any] map[string]map[string]T
 
-// returns the config value for the given request.
-func (c Config[T]) Get(r *rcpRequest) (v T, ok bool) {
+// Get returns the config value for the given request.
+func (c Config[T]) Get(r *WebRPCRequest) (v T, ok bool) {
 	if c == nil {
 		return v, false
 	}
 
-	methodCfg, ok := c[r.serviceName][r.methodName]
+	methodCfg, ok := c[r.ServiceName][r.MethodName]
 	if !ok {
 		return v, false
 	}
 
 	return methodCfg, true
 }
 
-// rcpRequest is a parsed RPC request.
-type rcpRequest struct {
-	packageName string
-	serviceName string
-	methodName  string
+// WebRPCRequest is a parsed RPC request.
+type WebRPCRequest struct {
+	PackageName string
+	ServiceName string
+	MethodName  string
 }
 
 // newRequest parses a path into an rcpRequest.
-func newRequest(path string) *rcpRequest {
+func ParseRequest(path string) *WebRPCRequest {
 	p := strings.Split(path, "/")
 	if len(p) < 4 {
 		return nil
 	}
 
-	t := &rcpRequest{
-		packageName: p[len(p)-3],
-		serviceName: p[len(p)-2],
-		methodName:  p[len(p)-1],
+	r := &WebRPCRequest{
+		PackageName: p[len(p)-3],
+		ServiceName: p[len(p)-2],
+		MethodName:  p[len(p)-1],
 	}
 
-	if t.packageName != "rpc" {
+	if r.PackageName != "rpc" {
 		return nil
 	}
 
-	return t
+	return r
 }
 
 // ACL is a list of session types, encoded as a bitfield.
@@ -98,3 +102,23 @@ func (a ACL) And(session ...proto.SessionType) ACL {
 func (t ACL) Includes(session proto.SessionType) bool {
 	return t&ACL(1<<session) != 0
 }
+
+// VerifyACL checks that the given ACL config is valid for the given service.
+// It can be used in unit tests to ensure that all methods are covered.
+func VerifyACL[T any](acl Config[ACL]) error {
+	var t T
+	iType := reflect.TypeOf(&t).Elem()
+	service := iType.Name()
+	m, ok := acl[service]
+	if !ok {
+		return errors.New("service " + service + " not found")
+	}
+	var errList []error
+	for i := 0; i < iType.NumMethod(); i++ {
+		method := iType.Method(i)
+		if _, ok := m[method.Name]; !ok {
+			errList = append(errList, errors.New(""+service+"."+method.Name+" not found"))
+		}
+	}
+	return errors.Join(errList...)
+}

common_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/go-chi/jwtauth/v5"
 	"github.com/stretchr/testify/require"
 
+	"github.com/0xsequence/authcontrol"
 	"github.com/0xsequence/authcontrol/proto"
 )
 
@@ -55,3 +56,40 @@ func executeRequest(t *testing.T, ctx context.Context, handler http.Handler, pat
 
 	return true, nil
 }
+
+func TestVerifyACL(t *testing.T) {
+	type Service interface {
+		Method1() error
+		Method2() error
+		Method3() error
+	}
+
+	err := authcontrol.VerifyACL[Service](nil)
+	require.Error(t, err)
+
+	err = authcontrol.VerifyACL[Service](authcontrol.Config[authcontrol.ACL]{
+		"WrongName": {
+			"Method1": authcontrol.NewACL(proto.SessionType_User),
+			"Method2": authcontrol.NewACL(proto.SessionType_User),
+			"Method3": authcontrol.NewACL(proto.SessionType_User),
+		},
+	})
+	require.Error(t, err)
+
+	err = authcontrol.VerifyACL[Service](authcontrol.Config[authcontrol.ACL]{
+		"Service": {
+			"Method1": authcontrol.NewACL(proto.SessionType_User),
+			"Method2": authcontrol.NewACL(proto.SessionType_User),
+		},
+	})
+	require.Error(t, err)
+
+	err = authcontrol.VerifyACL[Service](authcontrol.Config[authcontrol.ACL]{
+		"Service": {
+			"Method1": authcontrol.NewACL(proto.SessionType_User),
+			"Method2": authcontrol.NewACL(proto.SessionType_User),
+			"Method3": authcontrol.NewACL(proto.SessionType_User),
+		},
+	})
+	require.NoError(t, err)
+}

context.go

@@ -105,12 +105,12 @@ func GetAccessKey(ctx context.Context) (string, bool) {
 // Project ID
 //
 
-// withProjectID adds the projectID to the context.
-func withProjectID(ctx context.Context, projectID uint64) context.Context {
-	return context.WithValue(ctx, ctxKeyProjectID, projectID)
+// withProjectID adds the project to the context.
+func withProjectID(ctx context.Context, project uint64) context.Context {
+	return context.WithValue(ctx, ctxKeyProjectID, project)
 }
 
-// GetProjectID returns the projectID and if its active from the context.
+// GetProjectID returns the project and if its active from the context.
 // In case its not set, it will return 0.
 func GetProjectID(ctx context.Context) (uint64, bool) {
 	v, ok := ctx.Value(ctxKeyProjectID).(uint64)

middleware.go

@@ -13,20 +13,15 @@ import (
 type Options struct {
 	KeyFuncs   []KeyFunc
 	UserStore  UserStore
-	ErrHandler func(r *http.Request, w http.ResponseWriter, err error)
+	ErrHandler ErrHandler
 }
 
 func Session(auth *jwtauth.JWTAuth, o *Options) func(next http.Handler) http.Handler {
-	eh := defaultErrHandler
+	eh := errHandler
 	if o != nil && o.ErrHandler != nil {
 		eh = o.ErrHandler
 	}
 
-	var keyFuncs []KeyFunc
-	if o != nil {
-		keyFuncs = o.KeyFuncs
-	}
-
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			ctx := r.Context()
@@ -43,9 +38,11 @@ func Session(auth *jwtauth.JWTAuth, o *Options) func(next http.Handler) http.Han
 				token       jwt.Token
 			)
 
-			for _, f := range keyFuncs {
-				if accessKey = f(r); accessKey != "" {
-					break
+			if o != nil {
+				for _, f := range o.KeyFuncs {
+					if accessKey = f(r); accessKey != "" {
+						break
+					}
 				}
 			}
 
@@ -125,14 +122,14 @@ func Session(auth *jwtauth.JWTAuth, o *Options) func(next http.Handler) http.Han
 // AccessControl middleware that checks if the session type is allowed to access the endpoint.
 // It also sets the compute units on the context if the endpoint requires it.
 func AccessControl(acl Config[ACL], o *Options) func(next http.Handler) http.Handler {
-	eh := defaultErrHandler
+	eh := errHandler
 	if o != nil && o.ErrHandler != nil {
 		eh = o.ErrHandler
 	}
 
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			req := newRequest(r.URL.Path)
+			req := ParseRequest(r.URL.Path)
 			if req == nil {
 				eh(r, w, proto.ErrUnauthorized.WithCausef("invalid rpc method"))
 				return

middleware_test.go

@@ -79,7 +79,7 @@ func TestSession(t *testing.T) {
 
 	auth := jwtauth.New("HS256", []byte("secret"), nil)
 
-	options := authcontrol.Options{
+	options := &authcontrol.Options{
 		UserStore: mockStore{
 			UserAddress:  false,
 			AdminAddress: true,
@@ -89,8 +89,8 @@ func TestSession(t *testing.T) {
 
 	r := chi.NewRouter()
 	r.Use(
-		authcontrol.Session(auth, &options),
-		authcontrol.AccessControl(ACLConfig, &options),
+		authcontrol.Session(auth, options),
+		authcontrol.AccessControl(ACLConfig, options),
 	)
 	r.Handle("/*", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
 
@@ -193,7 +193,17 @@ func TestInvalid(t *testing.T) {
 		authcontrol.Session(auth, options),
 		authcontrol.AccessControl(ACLConfig, options),
 	)
-	r.Handle("/*", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}))
+	r.Handle("/*", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		ctx := r.Context()
+		resp := map[string]any{}
+		resp["accessKey"], _ = authcontrol.GetAccessKey(ctx)
+		resp["account"], _ = authcontrol.GetAccount(ctx)
+		resp["project"], _ = authcontrol.GetProjectID(ctx)
+		resp["service"], _ = authcontrol.GetService(ctx)
+		resp["session"], _ = authcontrol.GetSessionType(ctx)
+		resp["user"], _ = authcontrol.GetUser[any](ctx)
+		assert.NoError(t, json.NewEncoder(w).Encode(resp))
+	}))
 
 	// Without JWT
 	ok, err := executeRequest(t, ctx, r, fmt.Sprintf("/rpc/%s/%s", ServiceName, MethodName), AccessKey, nil)