Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More verbose error message at director registration failure #992

Merged
merged 4 commits into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions director/director.go
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,7 @@ func registerServeAd(engineCtx context.Context, ctx *gin.Context, sType server_s
return
} else {
log.Warningln("Failed to verify token:", err)
ctx.JSON(http.StatusForbidden, gin.H{"error": "Authorization token verification failed"})
ctx.JSON(http.StatusForbidden, gin.H{"error": fmt.Sprintf("Authorization token verification failed %v", err)})
return
}
}
Expand All @@ -575,7 +575,7 @@ func registerServeAd(engineCtx context.Context, ctx *gin.Context, sType server_s
return
} else {
log.Warningln("Failed to verify token:", err)
ctx.JSON(http.StatusForbidden, gin.H{"error": "Authorization token verification failed."})
ctx.JSON(http.StatusForbidden, gin.H{"error": fmt.Sprintf("Authorization token verification failed %v", err)})
return
}
}
Expand Down
4 changes: 2 additions & 2 deletions director/director_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ func TestDirectorRegistration(t *testing.T) {

assert.Equal(t, http.StatusForbidden, w.Result().StatusCode, "Expected failing status code of 403")
body, _ := io.ReadAll(w.Result().Body)
assert.Equal(t, `{"error":"Authorization token verification failed"}`, string(body), "Failure wasn't because token verification failed")
assert.Contains(t, string(body), "Authorization token verification failed", "Failure wasn't because token verification failed")

namaspaceADs := listNamespacesFromOrigins()
assert.False(t, NamespaceAdContainsPath(namaspaceADs, "/foo/bar"), "Found namespace in the director cache even if the token validation failed.")
Expand Down Expand Up @@ -424,7 +424,7 @@ func TestDirectorRegistration(t *testing.T) {

assert.Equal(t, http.StatusForbidden, w.Result().StatusCode, "Expected failing status code of 403")
body, _ := io.ReadAll(w.Result().Body)
assert.Equal(t, `{"error":"Authorization token verification failed"}`, string(body), "Failure wasn't because token verification failed")
assert.Contains(t, string(body), "Authorization token verification failed", "Failure wasn't because token verification failed")

namaspaceADs := listNamespacesFromOrigins()
assert.False(t, NamespaceAdContainsPath(namaspaceADs, "/foo/bar"), "Found namespace in the director cache even if the token validation failed.")
Expand Down
14 changes: 7 additions & 7 deletions director/origin_api.go
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,12 @@ func checkNamespaceStatus(prefix string, registryWebUrlStr string) (bool, error)
func verifyAdvertiseToken(ctx context.Context, token, namespace string) (bool, error) {
issuerUrl, err := server_utils.GetNSIssuerURL(namespace)
if err != nil {
return false, err
return false, errors.Wrap(err, "failed to get issuer for namespace "+namespace)
}

keyLoc, err := server_utils.GetJWKSURLFromIssuerURL(issuerUrl)
if err != nil {
return false, err
return false, errors.Wrap(err, "failed to get JWKS URL from the issuer URL at "+issuerUrl)
}

var ar NamespaceCache
Expand All @@ -135,17 +135,17 @@ func verifyAdvertiseToken(ctx context.Context, token, namespace string) (bool, e
regUrlStr := param.Federation_RegistryUrl.GetString()
approved, err := checkNamespaceStatus(namespace, regUrlStr)
if err != nil {
return false, errors.Wrap(err, "Failed to check namespace approval status")
return false, errors.Wrap(err, "failed to check namespace approval status")
}
if !approved {
adminApprovalErr = errors.New(namespace + " has not been approved by an administrator.")
adminApprovalErr = errors.New(namespace + " has not been approved by an administrator")
return false, adminApprovalErr
}
if ar == nil {
ar = jwk.NewCache(ctx)
client := &http.Client{Transport: config.GetTransport()}
if err = ar.Register(keyLoc, jwk.WithMinRefreshInterval(15*time.Minute), jwk.WithHTTPClient(client)); err != nil {
return false, err
return false, errors.Wrap(err, fmt.Sprintf("failed to register JWKS URL %s at the JWKS cache", keyLoc))
}
namespaceKeysMutex.Lock()
defer namespaceKeysMutex.Unlock()
Expand All @@ -162,7 +162,7 @@ func verifyAdvertiseToken(ctx context.Context, token, namespace string) (bool, e
keyset, err := ar.Get(ctx, keyLoc)

if err != nil {
return false, err
return false, errors.Wrap(err, "failed to fetch JWKS from JWKS cache for "+keyLoc)
}

tok, err := jwt.Parse([]byte(token), jwt.WithKeySet(keyset), jwt.WithValidate(true))
Expand All @@ -172,7 +172,7 @@ func verifyAdvertiseToken(ctx context.Context, token, namespace string) (bool, e

scope_any, present := tok.Get("scope")
if !present {
return false, errors.New("No scope is present; required to advertise to director")
return false, errors.New("no scope is present; required to advertise to director")
}
scope, ok := scope_any.(string)
if !ok {
Expand Down
2 changes: 1 addition & 1 deletion director/origin_api_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ func TestVerifyAdvertiseToken(t *testing.T) {

ok, err = verifyAdvertiseToken(ctx, tok, "/test-namespace")
assert.Equal(t, false, ok)
assert.Equal(t, "No scope is present; required to advertise to director", err.Error())
assert.Equal(t, "no scope is present; required to advertise to director", err.Error())

// Create a token with a bad scope - should return an error upon validation
wrongScopeTokenCfg := token.NewWLCGToken()
Expand Down
Loading