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.

Sign up for GitHub

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

fix: invalid error response handling during oauth refresh flow #5401

Merged
merged 3 commits into from
Jan 6, 2025
Merged

fix: invalid error response handling during oauth refresh flow #5401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e8f9cb
fix: invalid error response handling during oauth refresh flow
Dec 30, 2024
aaca8c1
chore: adding more tests to increase coverage
Jan 2, 2025
845ecdb
Merge remote-tracking branch 'origin/master' into fix.oauth-invalid-e…
Jan 6, 2025
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
9 changes: 5 additions & 4 deletions services/oauth/v2/common/constants.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ const (
// CategoryAuthStatusInactive Identifier to be sent from destination(during transformation/delivery)
CategoryAuthStatusInactive = "AUTH_STATUS_INACTIVE"
// RefTokenInvalidGrant Identifier for invalid_grant or access_denied errors(during refreshing the token)
RefTokenInvalidGrant = "ref_token_invalid_grant"
TimeOutError = "timeout"
NetworkError = "network_error"
None = "none"
RefTokenInvalidGrant = "ref_token_invalid_grant"
RefTokenInvalidResponse = "INVALID_REFRESH_RESPONSE"
TimeOutError = "timeout"
NetworkError = "network_error"
None = "none"

DestKey ContextKey = "destination"
SecretKey ContextKey = "secret"
Expand Down
31 changes: 21 additions & 10 deletions services/oauth/v2/oauth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,17 +330,28 @@ func (h *OAuthHandler) GetRefreshTokenErrResp(response string, accountSecret *Ac
h.Logger.Debugn("Failed with error response", logger.NewErrorField(err))
message = fmt.Sprintf("Unmarshal of response unsuccessful: %v", response)
errorType = "unmarshallableResponse"
} else if gjson.Get(response, "body.code").String() == common.RefTokenInvalidGrant {
// User (or) AccessToken (or) RefreshToken has been revoked
bodyMsg := gjson.Get(response, "body.message").String()
if bodyMsg == "" {
// Default message
h.Logger.Debugn("Unable to get body.message", logger.NewStringField("Response", response))
message = ErrPermissionOrTokenRevoked.Error()
} else {
message = bodyMsg
} else {
code := gjson.Get(response, "body.code").String()
switch code {
case common.RefTokenInvalidGrant:
// User (or) AccessToken (or) RefreshToken has been revoked
bodyMsg := gjson.Get(response, "body.message").String()
if bodyMsg == "" {
// Default message
h.Logger.Debugn("Unable to get body.message", logger.NewStringField("Response", response))
message = ErrPermissionOrTokenRevoked.Error()
} else {
message = bodyMsg
}
errorType = common.RefTokenInvalidGrant
case common.RefTokenInvalidResponse:
errorType = code
msg := gjson.Get(response, "body.message").String()
if msg == "" {
msg = "invalid refresh response"
}
message = msg
}
errorType = common.RefTokenInvalidGrant
}
return errorType, message
}
Expand Down
153 changes: 153 additions & 0 deletions services/oauth/v2/oauth_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package v2_test

import (
"bytes"
"fmt"
"io"
"math/rand"
"net"
"net/http"
Expand Down Expand Up @@ -576,6 +578,157 @@ var _ = Describe("Oauth", func() {
Expect(response).To(Equal(expectedResponse))
Expect(err).To(MatchError(fmt.Errorf("error occurred while fetching/refreshing account info from CP: mock mock 127.0.0.1:1234->127.0.0.1:12340: read: connection timed out")))
})

It("refreshToken function call when stored cache is same as provided secret and cpApiCall returns a failed response because of faulty implementation in some downstream service", func() {
refreshTokenParams := &v2.RefreshTokenParams{
AccountID: "123",
WorkspaceID: "456",
DestDefName: "testDest",
Destination: Destination,
Secret: []byte(`{"access_token":"storedAccessToken","refresh_token":"dummyRefreshToken","developer_token":"dummyDeveloperToken"}`),
}

ctrl := gomock.NewController(GinkgoT())
mockHttpClient := mockhttpclient.NewMockHttpClient(ctrl)
cpResponseString := `{
"status": 500,
"code": "INVALID_REFRESH_RESPONSE",
"body": {
"code": "INVALID_REFRESH_RESPONSE",
"message": "Missing required token fields in refresh response"
},
"access_token":"storedAccessToken",
"refresh_token":"dummyRefreshToken",
"developer_token":"dummyDeveloperToken"
}`
mockHttpClient.EXPECT().Do(gomock.Any()).Return(&http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(cpResponseString)),
}, nil)
cpConnector := controlplane.NewConnector(
config.Default,
controlplane.WithClient(mockHttpClient),
controlplane.WithStats(stats.Default),
)

mockTokenProvider := mock_oauthV2.NewMockTokenProvider(ctrl)
mockTokenProvider.EXPECT().Identity().Return(&testutils.BasicAuthMock{})
oauthHandler := v2.NewOAuthHandler(mockTokenProvider,
v2.WithCache(v2.NewCache()),
v2.WithLocker(kitsync.NewPartitionRWLocker()),
v2.WithStats(stats.Default),
v2.WithLogger(logger.NewLogger().Child("MockOAuthHandler")),
v2.WithCpConnector(cpConnector),
)
statusCode, response, err := oauthHandler.RefreshToken(refreshTokenParams)
Expect(statusCode).To(Equal(http.StatusInternalServerError))
expectedResponse := &v2.AuthResponse{
Err: "INVALID_REFRESH_RESPONSE",
ErrorMessage: "Missing required token fields in refresh response",
}
Expect(response).To(Equal(expectedResponse))
Expect(err).To(MatchError(fmt.Errorf("error occurred while fetching/refreshing account info from CP: Missing required token fields in refresh response")))
})

It("refreshToken function call when stored cache is same as provided secret and cpApiCall returns a failed response because of invalid refresh response without message", func() {
refreshTokenParams := &v2.RefreshTokenParams{
AccountID: "123",
WorkspaceID: "456",
DestDefName: "testDest",
Destination: Destination,
Secret: []byte(`{"access_token":"storedAccessToken","refresh_token":"dummyRefreshToken","developer_token":"dummyDeveloperToken"}`),
}

ctrl := gomock.NewController(GinkgoT())
mockHttpClient := mockhttpclient.NewMockHttpClient(ctrl)
cpResponseString := `{
"status": 500,
"code": "INVALID_REFRESH_RESPONSE",
"body": {
"code": "INVALID_REFRESH_RESPONSE"
},
"access_token":"storedAccessToken",
"refresh_token":"dummyRefreshToken",
"developer_token":"dummyDeveloperToken"
}`
mockHttpClient.EXPECT().Do(gomock.Any()).Return(&http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(cpResponseString)),
}, nil)
cpConnector := controlplane.NewConnector(
config.Default,
controlplane.WithClient(mockHttpClient),
controlplane.WithStats(stats.Default),
)

mockTokenProvider := mock_oauthV2.NewMockTokenProvider(ctrl)
mockTokenProvider.EXPECT().Identity().Return(&testutils.BasicAuthMock{})
oauthHandler := v2.NewOAuthHandler(mockTokenProvider,
v2.WithCache(v2.NewCache()),
v2.WithLocker(kitsync.NewPartitionRWLocker()),
v2.WithStats(stats.Default),
v2.WithLogger(logger.NewLogger().Child("MockOAuthHandler")),
v2.WithCpConnector(cpConnector),
)
statusCode, response, err := oauthHandler.RefreshToken(refreshTokenParams)
Expect(statusCode).To(Equal(http.StatusInternalServerError))
expectedResponse := &v2.AuthResponse{
Err: "INVALID_REFRESH_RESPONSE",
ErrorMessage: "invalid refresh response",
}
Expect(response).To(Equal(expectedResponse))
Expect(err).To(MatchError(fmt.Errorf("error occurred while fetching/refreshing account info from CP: invalid refresh response")))
})

It("refreshToken function call when stored cache is same as provided secret and cpApiCall returns a failed response because of invalid refresh response without message", func() {
refreshTokenParams := &v2.RefreshTokenParams{
AccountID: "123",
WorkspaceID: "456",
DestDefName: "testDest",
Destination: Destination,
Secret: []byte(`{"access_token":"storedAccessToken","refresh_token":"dummyRefreshToken","developer_token":"dummyDeveloperToken"}`),
}

ctrl := gomock.NewController(GinkgoT())
mockHttpClient := mockhttpclient.NewMockHttpClient(ctrl)
cpResponseString := fmt.Sprintf(`{
"status": 500,
"code": "%[1]s",
"body": {
"code": "%[1]s"
},
"access_token":"storedAccessToken",
"refresh_token":"dummyRefreshToken",
"developer_token":"dummyDeveloperToken"
}`, common.RefTokenInvalidGrant)
mockHttpClient.EXPECT().Do(gomock.Any()).Return(&http.Response{
StatusCode: http.StatusOK,
Body: io.NopCloser(bytes.NewBufferString(cpResponseString)),
}, nil)
cpConnector := controlplane.NewConnector(
config.Default,
controlplane.WithClient(mockHttpClient),
controlplane.WithStats(stats.Default),
)

mockTokenProvider := mock_oauthV2.NewMockTokenProvider(ctrl)
mockTokenProvider.EXPECT().Identity().Return(&testutils.BasicAuthMock{})
oauthHandler := v2.NewOAuthHandler(mockTokenProvider,
v2.WithCache(v2.NewCache()),
v2.WithLocker(kitsync.NewPartitionRWLocker()),
v2.WithStats(stats.Default),
v2.WithLogger(logger.NewLogger().Child("MockOAuthHandler")),
v2.WithCpConnector(cpConnector),
)
statusCode, response, err := oauthHandler.RefreshToken(refreshTokenParams)
Expect(statusCode).To(Equal(http.StatusBadRequest))
expectedResponse := &v2.AuthResponse{
Err: common.RefTokenInvalidGrant,
ErrorMessage: v2.ErrPermissionOrTokenRevoked.Error(),
}
Expect(response).To(Equal(expectedResponse))
Expect(err).To(MatchError(fmt.Errorf("invalid grant")))
})
})

Describe("Test AuthStatusToggle function", func() {
Expand Down
Loading