chore: document custom JWKs in broadcast endpoint

ory · Jul 9, 2024 · 5b3120c · 5b3120c
1 parent eeaf6f0
commit 5b3120c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/jwk/handler.go b/jwk/handler.go
@@ -80,6 +80,9 @@ func (h *Handler) SetRoutes(admin *httprouterx.RouterAdmin, public *httprouterx.
 // if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like
 // [node-jwks-rsa](https://github.com/auth0/node-jwks-rsa) among others.
 //
+// Adding custom keys requires first creating a keyset via the createJsonWebKeySet operation,
+// and then configuring the webfinger.jwks.broadcast_keys configuration value to include the keyset name.
+//
 //	Consumes:
 //	- application/json
 //

diff --git a/jwk/manager_strategy.go b/jwk/manager_strategy.go
@@ -43,7 +43,7 @@ func (m ManagerStrategy) GenerateAndPersistKeySet(ctx context.Context, set, kid,
 }
 
 func (m ManagerStrategy) AddKey(ctx context.Context, set string, key *jose.JSONWebKey) error {
-	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
+	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.AddKey")
 	defer span.End()
 	attrs := map[string]string{
 		"set": set,
@@ -54,7 +54,7 @@ func (m ManagerStrategy) AddKey(ctx context.Context, set string, key *jose.JSONW
 }
 
 func (m ManagerStrategy) AddKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error {
-	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
+	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.AddKeySet")
 	defer span.End()
 	attrs := map[string]string{
 		"set": set,
@@ -65,7 +65,7 @@ func (m ManagerStrategy) AddKeySet(ctx context.Context, set string, keys *jose.J
 }
 
 func (m ManagerStrategy) UpdateKey(ctx context.Context, set string, key *jose.JSONWebKey) error {
-	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
+	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.UpdateKey")
 	defer span.End()
 	attrs := map[string]string{
 		"set": set,
@@ -76,7 +76,7 @@ func (m ManagerStrategy) UpdateKey(ctx context.Context, set string, key *jose.JS
 }
 
 func (m ManagerStrategy) UpdateKeySet(ctx context.Context, set string, keys *jose.JSONWebKeySet) error {
-	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
+	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.UpdateKeySet")
 	defer span.End()
 	attrs := map[string]string{
 		"set": set,
@@ -87,7 +87,7 @@ func (m ManagerStrategy) UpdateKeySet(ctx context.Context, set string, keys *jos
 }
 
 func (m ManagerStrategy) GetKey(ctx context.Context, set, kid string) (*jose.JSONWebKeySet, error) {
-	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
+	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GetKey")
 	defer span.End()
 	attrs := map[string]string{
 		"set": set,
@@ -106,7 +106,7 @@ func (m ManagerStrategy) GetKey(ctx context.Context, set, kid string) (*jose.JSO
 }
 
 func (m ManagerStrategy) GetKeySet(ctx context.Context, set string) (*jose.JSONWebKeySet, error) {
-	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
+	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GetKeySet")
 	defer span.End()
 	attrs := map[string]string{
 		"set": set,
@@ -143,7 +143,7 @@ func (m ManagerStrategy) DeleteKey(ctx context.Context, set, kid string) error {
 }
 
 func (m ManagerStrategy) DeleteKeySet(ctx context.Context, set string) error {
-	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.GenerateAndPersistKeySet")
+	ctx, span := otel.GetTracerProvider().Tracer(tracingComponent).Start(ctx, "jwk.DeleteKeySet")
 	defer span.End()
 	attrs := map[string]string{
 		"set": set,