Turn sublease header into const

sapcc · Apr 3, 2024 · b9182ba · b9182ba
1 parent 79682c8
commit b9182ba
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 13 deletions.
diff --git a/cmd/api/main.go b/cmd/api/main.go
@@ -90,7 +90,7 @@ func run(cmd *cobra.Command, args []string) {
 	corsMiddleware := cors.New(cors.Options{
 		AllowedOrigins: []string{"*"},
 		AllowedMethods: []string{"HEAD", "GET", "POST", "PUT", "DELETE"},
-		AllowedHeaders: []string{"Content-Type", "User-Agent", "Authorization", "X-Auth-Token", "X-Keppel-Sublease-Token"},
+		AllowedHeaders: []string{"Content-Type", "User-Agent", "Authorization", "X-Auth-Token", keppel.SubleaseHeader},
 	})
 	handler := httpapi.Compose(
 		keppelv1.NewAPI(cfg, ad, fd, sd, icd, db, auditor, rle),

diff --git a/internal/api/keppel/accounts_test.go b/internal/api/keppel/accounts_test.go
@@ -1291,8 +1291,8 @@ func TestGetPutAccountReplicationOnFirstUse(t *testing.T) {
 			Method: "PUT",
 			Path:   "/keppel/v1/accounts/first",
 			Header: map[string]string{
-				"X-Test-Perms":            "change:tenant1",
-				"X-Keppel-Sublease-Token": makeSubleaseToken("first", "registry.example.org", "not-the-valid-token"),
+				"X-Test-Perms":        "change:tenant1",
+				keppel.SubleaseHeader: makeSubleaseToken("first", "registry.example.org", "not-the-valid-token"),
 			},
 			Body: assert.JSONObject{
 				"account": assert.JSONObject{
@@ -1312,8 +1312,8 @@ func TestGetPutAccountReplicationOnFirstUse(t *testing.T) {
 			Method: "PUT",
 			Path:   "/keppel/v1/accounts/first",
 			Header: map[string]string{
-				"X-Test-Perms":            "change:tenant1",
-				"X-Keppel-Sublease-Token": makeSubleaseToken("first", "registry.example.org", "valid-token"),
+				"X-Test-Perms":        "change:tenant1",
+				keppel.SubleaseHeader: makeSubleaseToken("first", "registry.example.org", "valid-token"),
 			},
 			Body: assert.JSONObject{
 				"account": assert.JSONObject{
@@ -2137,8 +2137,8 @@ func TestReplicaAccountsInheritPlatformFilter(t *testing.T) {
 			Method: "PUT",
 			Path:   "/keppel/v1/accounts/first",
 			Header: map[string]string{
-				"X-Test-Perms":            "change:tenant1",
-				"X-Keppel-Sublease-Token": makeSubleaseToken("first", "registry.example.org", "valid-token"),
+				"X-Test-Perms": "change:tenant1",
+				SubleaseHeader: makeSubleaseToken("first", "registry.example.org", "valid-token"),
 			},
 			Body: assert.JSONObject{
 				"account": assert.JSONObject{
@@ -2171,8 +2171,8 @@ func TestReplicaAccountsInheritPlatformFilter(t *testing.T) {
 			Method: "PUT",
 			Path:   "/keppel/v1/accounts/second",
 			Header: map[string]string{
-				"X-Test-Perms":            "change:tenant1",
-				"X-Keppel-Sublease-Token": makeSubleaseToken("second", "registry.example.org", "valid-token"),
+				"X-Test-Perms":        "change:tenant1",
+				keppel.SubleaseHeader: makeSubleaseToken("second", "registry.example.org", "valid-token"),
 			},
 			Body: assert.JSONObject{
 				"account": assert.JSONObject{
@@ -2209,8 +2209,8 @@ func TestReplicaAccountsInheritPlatformFilter(t *testing.T) {
 			Method: "PUT",
 			Path:   "/keppel/v1/accounts/third",
 			Header: map[string]string{
-				"X-Test-Perms":            "change:tenant1",
-				"X-Keppel-Sublease-Token": makeSubleaseToken("third", "registry.example.org", "valid-token"),
+				"X-Test-Perms":        "change:tenant1",
+				keppel.SubleaseHeader: makeSubleaseToken("third", "registry.example.org", "valid-token"),
 			},
 			Body: assert.JSONObject{
 				"account": assert.JSONObject{

diff --git a/internal/api/keppel/sublease.go b/internal/api/keppel/sublease.go
@@ -25,6 +25,8 @@ import (
 	"net/http"
 )
 
+const SubleaseHeader = "X-Keppel-Sublease-Token"
+
 // SubleaseToken is the internal structure of a sublease token. Only the secret
 // is passed on to the federation driver. The other attributes are only
 // informational. GUIs/CLIs can display these data to the user for confirmation
@@ -51,13 +53,13 @@ func SubleaseTokenFromRequest(r *http.Request) (SubleaseToken, error) {
 
 	buf, err := base64.StdEncoding.DecodeString(in)
 	if err != nil {
-		return SubleaseToken{}, fmt.Errorf("malformed X-Keppel-Sublease-Token header: %s", err.Error())
+		return SubleaseToken{}, fmt.Errorf("malformed %s header: %w", SubleaseHeader, err)
 	}
 
 	var t SubleaseToken
 	err = json.Unmarshal(buf, &t)
 	if err != nil {
-		return SubleaseToken{}, fmt.Errorf("malformed X-Keppel-Sublease-Token header: %s", err.Error())
+		return SubleaseToken{}, fmt.Errorf("malformed %s header: %w", SubleaseHeader, err)
 	}
 	return t, nil
 }