From badd8c49b6e65e8529cc4274105a8ee7be985382 Mon Sep 17 00:00:00 2001
From: Derek McGowan <derek@mcgstyle.net>
Date: Thu, 28 Jan 2016 17:02:09 -0800
Subject: [PATCH] Update auth context keys to use constant

Prevent using strings throughout the code to reference a string key defined in the auth package.

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
---
 docs/auth/auth.go                 | 14 ++++++++++++--
 docs/auth/htpasswd/access_test.go |  2 +-
 docs/auth/silly/access_test.go    |  2 +-
 docs/auth/token/token_test.go     |  2 +-
 docs/handlers/app.go              |  2 +-
 docs/handlers/context.go          |  3 ++-
 6 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/docs/auth/auth.go b/docs/auth/auth.go
index b3bb580d2..0ba2eba3e 100644
--- a/docs/auth/auth.go
+++ b/docs/auth/auth.go
@@ -39,6 +39,16 @@ import (
 	"github.com/docker/distribution/context"
 )
 
+const (
+	// UserKey is used to get the user object from
+	// a user context
+	UserKey = "auth.user"
+
+	// UserNameKey is used to get the user name from
+	// a user context
+	UserNameKey = "auth.user.name"
+)
+
 // UserInfo carries information about
 // an autenticated/authorized client.
 type UserInfo struct {
@@ -102,9 +112,9 @@ type userInfoContext struct {
 
 func (uic userInfoContext) Value(key interface{}) interface{} {
 	switch key {
-	case "auth.user":
+	case UserKey:
 		return uic.user
-	case "auth.user.name":
+	case UserNameKey:
 		return uic.user.Name
 	}
 
diff --git a/docs/auth/htpasswd/access_test.go b/docs/auth/htpasswd/access_test.go
index db0405475..553f05cf9 100644
--- a/docs/auth/htpasswd/access_test.go
+++ b/docs/auth/htpasswd/access_test.go
@@ -56,7 +56,7 @@ func TestBasicAccessController(t *testing.T) {
 			}
 		}
 
-		userInfo, ok := authCtx.Value("auth.user").(auth.UserInfo)
+		userInfo, ok := authCtx.Value(auth.UserKey).(auth.UserInfo)
 		if !ok {
 			t.Fatal("basic accessController did not set auth.user context")
 		}
diff --git a/docs/auth/silly/access_test.go b/docs/auth/silly/access_test.go
index ff2155b18..a7c14cb9d 100644
--- a/docs/auth/silly/access_test.go
+++ b/docs/auth/silly/access_test.go
@@ -29,7 +29,7 @@ func TestSillyAccessController(t *testing.T) {
 			}
 		}
 
-		userInfo, ok := authCtx.Value("auth.user").(auth.UserInfo)
+		userInfo, ok := authCtx.Value(auth.UserKey).(auth.UserInfo)
 		if !ok {
 			t.Fatal("silly accessController did not set auth.user context")
 		}
diff --git a/docs/auth/token/token_test.go b/docs/auth/token/token_test.go
index 119aa738a..6524e1663 100644
--- a/docs/auth/token/token_test.go
+++ b/docs/auth/token/token_test.go
@@ -375,7 +375,7 @@ func TestAccessController(t *testing.T) {
 		t.Fatalf("accessController returned unexpected error: %s", err)
 	}
 
-	userInfo, ok := authCtx.Value("auth.user").(auth.UserInfo)
+	userInfo, ok := authCtx.Value(auth.UserKey).(auth.UserInfo)
 	if !ok {
 		t.Fatal("token accessController did not set auth.user context")
 	}
diff --git a/docs/handlers/app.go b/docs/handlers/app.go
index 70b7417f5..87c1e05a1 100644
--- a/docs/handlers/app.go
+++ b/docs/handlers/app.go
@@ -588,7 +588,7 @@ func (app *App) dispatcher(dispatch dispatchFunc) http.Handler {
 		}
 
 		// Add username to request logging
-		context.Context = ctxu.WithLogger(context.Context, ctxu.GetLogger(context.Context, "auth.user.name"))
+		context.Context = ctxu.WithLogger(context.Context, ctxu.GetLogger(context.Context, auth.UserNameKey))
 
 		if app.nameRequired(r) {
 			nameRef, err := reference.ParseNamed(getName(context))
diff --git a/docs/handlers/context.go b/docs/handlers/context.go
index 85a171237..552db2df6 100644
--- a/docs/handlers/context.go
+++ b/docs/handlers/context.go
@@ -10,6 +10,7 @@ import (
 	"github.com/docker/distribution/digest"
 	"github.com/docker/distribution/registry/api/errcode"
 	"github.com/docker/distribution/registry/api/v2"
+	"github.com/docker/distribution/registry/auth"
 	"golang.org/x/net/context"
 )
 
@@ -77,7 +78,7 @@ func getUploadUUID(ctx context.Context) (uuid string) {
 // getUserName attempts to resolve a username from the context and request. If
 // a username cannot be resolved, the empty string is returned.
 func getUserName(ctx context.Context, r *http.Request) string {
-	username := ctxu.GetStringValue(ctx, "auth.user.name")
+	username := ctxu.GetStringValue(ctx, auth.UserNameKey)
 
 	// Fallback to request user with basic auth
 	if username == "" {