From d35e9264bbf9e65a251c2f4cc2c344157c7b670b Mon Sep 17 00:00:00 2001 From: Will Browne Date: Tue, 20 Aug 2024 13:29:41 +0100 Subject: [PATCH] Plugins: Use plugins SDK constants for OAuth header names (#90892) use SDK consts --- .../clientmiddleware/oauthtoken_middleware.go | 17 ++++++----------- .../oauthtoken_middleware_test.go | 16 ++++++++-------- 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware.go b/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware.go index 1a2b91cdd16..b37a6f88e95 100644 --- a/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware.go +++ b/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware.go @@ -27,11 +27,6 @@ func NewOAuthTokenMiddleware(oAuthTokenService oauthtoken.OAuthTokenService) plu }) } -const ( - tokenHeaderName = "Authorization" - idTokenHeaderName = "X-ID-Token" -) - type OAuthTokenMiddleware struct { baseMiddleware oAuthTokenService oauthtoken.OAuthTokenService @@ -69,19 +64,19 @@ func (m *OAuthTokenMiddleware) applyToken(ctx context.Context, pCtx backend.Plug switch t := req.(type) { case *backend.QueryDataRequest: - t.Headers[tokenHeaderName] = authorizationHeader + t.Headers[backend.OAuthIdentityTokenHeaderName] = authorizationHeader if idTokenHeader != "" { - t.Headers[idTokenHeaderName] = idTokenHeader + t.Headers[backend.OAuthIdentityIDTokenHeaderName] = idTokenHeader } case *backend.CheckHealthRequest: - t.Headers[tokenHeaderName] = authorizationHeader + t.Headers[backend.OAuthIdentityTokenHeaderName] = authorizationHeader if idTokenHeader != "" { - t.Headers[idTokenHeaderName] = idTokenHeader + t.Headers[backend.OAuthIdentityIDTokenHeaderName] = idTokenHeader } case *backend.CallResourceRequest: - t.Headers[tokenHeaderName] = []string{authorizationHeader} + t.Headers[backend.OAuthIdentityTokenHeaderName] = []string{authorizationHeader} if idTokenHeader != "" { - t.Headers[idTokenHeaderName] = []string{idTokenHeader} + t.Headers[backend.OAuthIdentityIDTokenHeaderName] = []string{idTokenHeader} } } } diff --git a/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware_test.go b/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware_test.go index 8928cc550a4..95e0a4212e2 100644 --- a/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware_test.go +++ b/pkg/services/pluginsintegration/clientmiddleware/oauthtoken_middleware_test.go @@ -112,8 +112,8 @@ func TestOAuthTokenMiddleware(t *testing.T) { require.NotNil(t, cdt.QueryDataReq) require.Len(t, cdt.QueryDataReq.Headers, 3) require.Equal(t, "test", cdt.QueryDataReq.Headers[otherHeader]) - require.Equal(t, "Bearer access-token", cdt.QueryDataReq.Headers[tokenHeaderName]) - require.Equal(t, "id-token", cdt.QueryDataReq.Headers[idTokenHeaderName]) + require.Equal(t, "Bearer access-token", cdt.QueryDataReq.Headers[backend.OAuthIdentityTokenHeaderName]) + require.Equal(t, "id-token", cdt.QueryDataReq.Headers[backend.OAuthIdentityIDTokenHeaderName]) }) t.Run("Should forward OAuth Identity when calling CallResource", func(t *testing.T) { @@ -125,10 +125,10 @@ func TestOAuthTokenMiddleware(t *testing.T) { require.NotNil(t, cdt.CallResourceReq) require.Len(t, cdt.CallResourceReq.Headers, 3) require.Equal(t, "test", cdt.CallResourceReq.Headers[otherHeader][0]) - require.Len(t, cdt.CallResourceReq.Headers[tokenHeaderName], 1) - require.Equal(t, "Bearer access-token", cdt.CallResourceReq.Headers[tokenHeaderName][0]) - require.Len(t, cdt.CallResourceReq.Headers[idTokenHeaderName], 1) - require.Equal(t, "id-token", cdt.CallResourceReq.Headers[idTokenHeaderName][0]) + require.Len(t, cdt.CallResourceReq.Headers[backend.OAuthIdentityTokenHeaderName], 1) + require.Equal(t, "Bearer access-token", cdt.CallResourceReq.Headers[backend.OAuthIdentityTokenHeaderName][0]) + require.Len(t, cdt.CallResourceReq.Headers[backend.OAuthIdentityIDTokenHeaderName], 1) + require.Equal(t, "id-token", cdt.CallResourceReq.Headers[backend.OAuthIdentityIDTokenHeaderName][0]) }) t.Run("Should forward OAuth Identity when calling CheckHealth", func(t *testing.T) { @@ -140,8 +140,8 @@ func TestOAuthTokenMiddleware(t *testing.T) { require.NotNil(t, cdt.CheckHealthReq) require.Len(t, cdt.CheckHealthReq.Headers, 3) require.Equal(t, "test", cdt.CheckHealthReq.Headers[otherHeader]) - require.Equal(t, "Bearer access-token", cdt.CheckHealthReq.Headers[tokenHeaderName]) - require.Equal(t, "id-token", cdt.CheckHealthReq.Headers[idTokenHeaderName]) + require.Equal(t, "Bearer access-token", cdt.CheckHealthReq.Headers[backend.OAuthIdentityTokenHeaderName]) + require.Equal(t, "id-token", cdt.CheckHealthReq.Headers[backend.OAuthIdentityIDTokenHeaderName]) }) }) }