Merge pull request #164 from sil-org/fix-doc-errors

Correct inaccurate authentication function documentation.

Author: briskt

auth.go

@@ -15,7 +15,7 @@ const (
 type User interface{}
 
 // AuthenticateRequest checks the provided API key against the keys stored in the database. If the key is active and
-// valid, a Webauthn client and WebauthnUser are created and stored in the request context.
+// valid, an authentication user (e.g. Webauthn user and client) is created and returned.
 func AuthenticateRequest(r *http.Request) (User, error) {
 	// get key and secret from headers
 	key := r.Header.Get(HeaderAPIKey)

router/middleware.go

@@ -8,9 +8,9 @@ import (
 	mfa "github.com/sil-org/serverless-mfa-api-go"
 )
 
-// authenticationMiddleware gets API key information from request headers and validates the key/signature
-// Then it uses api meta information provided in headers to configure a webauthn client and fetch the
-// user from storage and attach to context.
+// authenticationMiddleware gets API key information from request headers and validates the key/signature.
+// If the key is active and valid an authenticated user (e.g. Webauthn user and client) is added to the request
+// context.
 func authenticationMiddleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		user, err := mfa.AuthenticateRequest(r)