|
| 1 | +package e2e_test |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "fmt" |
| 6 | + "net/http" |
| 7 | + "net/url" |
| 8 | + "os" |
| 9 | + "path" |
| 10 | + "testing" |
| 11 | + |
| 12 | + "github.com/golang/protobuf/jsonpb" |
| 13 | + |
| 14 | + "github.com/oauth2-proxy/mockoidc" |
| 15 | + "github.com/raystack/shield/config" |
| 16 | + "github.com/raystack/shield/core/authenticate" |
| 17 | + "github.com/raystack/shield/pkg/logger" |
| 18 | + "github.com/raystack/shield/pkg/server" |
| 19 | + shieldv1beta1 "github.com/raystack/shield/proto/v1beta1" |
| 20 | + "github.com/raystack/shield/test/e2e/testbench" |
| 21 | + "github.com/stretchr/testify/suite" |
| 22 | +) |
| 23 | + |
| 24 | +type AuthenticationRegressionTestSuite struct { |
| 25 | + suite.Suite |
| 26 | + testBench *testbench.TestBench |
| 27 | + apiPort int |
| 28 | + mockOIDCServer *mockoidc.MockOIDC |
| 29 | + callbackPort int |
| 30 | +} |
| 31 | + |
| 32 | +func (s *AuthenticationRegressionTestSuite) SetupSuite() { |
| 33 | + wd, err := os.Getwd() |
| 34 | + s.Require().Nil(err) |
| 35 | + testDataPath := path.Join("file://", wd, fixturesDir) |
| 36 | + |
| 37 | + apiPort, err := testbench.GetFreePort() |
| 38 | + s.Require().NoError(err) |
| 39 | + grpcPort, err := testbench.GetFreePort() |
| 40 | + s.Require().NoError(err) |
| 41 | + s.apiPort = apiPort |
| 42 | + callbackPort, err := testbench.GetFreePort() |
| 43 | + s.Require().NoError(err) |
| 44 | + s.callbackPort = callbackPort |
| 45 | + |
| 46 | + s.mockOIDCServer, err = mockoidc.Run() |
| 47 | + s.Require().NoError(err) |
| 48 | + |
| 49 | + // mock callback host |
| 50 | + |
| 51 | + appConfig := &config.Shield{ |
| 52 | + Log: logger.Config{ |
| 53 | + Level: "error", |
| 54 | + }, |
| 55 | + App: server.Config{ |
| 56 | + Host: "localhost", |
| 57 | + Port: apiPort, |
| 58 | + GRPC: server.GRPCConfig{ |
| 59 | + Port: grpcPort, |
| 60 | + MaxRecvMsgSize: 2 << 10, |
| 61 | + MaxSendMsgSize: 2 << 10, |
| 62 | + }, |
| 63 | + ResourcesConfigPath: path.Join(testDataPath, "resource"), |
| 64 | + Authentication: authenticate.Config{ |
| 65 | + Session: authenticate.SessionConfig{ |
| 66 | + HashSecretKey: "hash-secret-should-be-32-chars--", |
| 67 | + BlockSecretKey: "hash-secret-should-be-32-chars--", |
| 68 | + }, |
| 69 | + Token: authenticate.TokenConfig{ |
| 70 | + RSAPath: "testdata/jwks.json", |
| 71 | + Issuer: "shield", |
| 72 | + }, |
| 73 | + OIDCConfig: map[string]authenticate.OIDCConfig{ |
| 74 | + "mock": { |
| 75 | + ClientID: s.mockOIDCServer.Config().ClientID, |
| 76 | + ClientSecret: s.mockOIDCServer.Config().ClientSecret, |
| 77 | + IssuerUrl: s.mockOIDCServer.Issuer(), |
| 78 | + }, |
| 79 | + }, |
| 80 | + OIDCCallbackHost: fmt.Sprintf("http://localhost:%d/callback", s.callbackPort), |
| 81 | + }, |
| 82 | + }, |
| 83 | + } |
| 84 | + |
| 85 | + s.testBench, err = testbench.Init(appConfig) |
| 86 | + s.Require().NoError(err) |
| 87 | +} |
| 88 | + |
| 89 | +func (s *AuthenticationRegressionTestSuite) TearDownSuite() { |
| 90 | + err := s.testBench.Close() |
| 91 | + s.Require().NoError(err) |
| 92 | + err = s.mockOIDCServer.Shutdown() |
| 93 | + s.Require().NoError(err) |
| 94 | +} |
| 95 | + |
| 96 | +func (s *AuthenticationRegressionTestSuite) TestUserSession() { |
| 97 | + ctx := context.Background() |
| 98 | + s.Run("1. return authenticate strategies of oidc", func() { |
| 99 | + authStrategyResp, err := s.testBench.Client.ListAuthStrategies(ctx, &shieldv1beta1.ListAuthStrategiesRequest{}) |
| 100 | + s.Assert().NoError(err) |
| 101 | + s.Assert().Equal("mock", authStrategyResp.GetStrategies()[0].GetName()) |
| 102 | + }) |
| 103 | + s.Run("2. authenticate a user successfully using oidc and create a session via cookies", func() { |
| 104 | + // start registration flow |
| 105 | + authResp, err := s.testBench.Client.Authenticate(ctx, &shieldv1beta1.AuthenticateRequest{ |
| 106 | + StrategyName: "mock", |
| 107 | + Redirect: false, |
| 108 | + ReturnTo: "", |
| 109 | + Email: mockoidc.DefaultUser().Email, |
| 110 | + }) |
| 111 | + s.Assert().NoError(err) |
| 112 | + s.Assert().NotNil(authResp.Endpoint) |
| 113 | + |
| 114 | + // mock oidc code |
| 115 | + parsedEndpoint, err := url.Parse(authResp.Endpoint) |
| 116 | + s.Assert().NoError(err) |
| 117 | + mockAuth0Code := "012345" |
| 118 | + s.mockOIDCServer.QueueCode(mockAuth0Code) |
| 119 | + |
| 120 | + // prepare mock callback server |
| 121 | + callbackMux := http.NewServeMux() |
| 122 | + callbackMux.Handle("/callback", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { |
| 123 | + code := r.URL.Query().Get("code") |
| 124 | + state := r.URL.Query().Get("state") |
| 125 | + s.Assert().Equal(mockAuth0Code, code) |
| 126 | + s.Assert().Equal(parsedEndpoint.Query().Get("state"), state) |
| 127 | + w.WriteHeader(http.StatusOK) |
| 128 | + })) |
| 129 | + srv := &http.Server{ |
| 130 | + Addr: fmt.Sprintf("localhost:%d", s.callbackPort), |
| 131 | + Handler: callbackMux, |
| 132 | + } |
| 133 | + // clean up callback server |
| 134 | + defer srv.Shutdown(ctx) |
| 135 | + go func() { |
| 136 | + if err := srv.ListenAndServe(); err != http.ErrServerClosed { |
| 137 | + s.Assert().NoError(err) |
| 138 | + } |
| 139 | + }() |
| 140 | + |
| 141 | + // start session in oidc server |
| 142 | + endpointRes, err := http.Get(authResp.Endpoint) |
| 143 | + s.Assert().NoError(err) |
| 144 | + s.Assert().Equal(http.StatusOK, endpointRes.StatusCode) |
| 145 | + |
| 146 | + // callback to shield and get valid cookies |
| 147 | + authCallbackFinalResp, err := http.Get(fmt.Sprintf("http://localhost:%d/v1beta1/auth/callback?code=%s&state=%s", |
| 148 | + s.apiPort, mockAuth0Code, parsedEndpoint.Query().Get("state"))) |
| 149 | + s.Assert().NoError(err) |
| 150 | + s.Assert().Equal(http.StatusOK, authCallbackFinalResp.StatusCode) |
| 151 | + s.Assert().Equal("sid", authCallbackFinalResp.Cookies()[0].Name) |
| 152 | + |
| 153 | + // verify if session is created |
| 154 | + getUserReq, _ := http.NewRequest("GET", fmt.Sprintf("http://localhost:%d/v1beta1/users/self", s.apiPort), nil) |
| 155 | + getUserReq.AddCookie(authCallbackFinalResp.Cookies()[0]) |
| 156 | + |
| 157 | + userResp, err := http.DefaultClient.Do(getUserReq) |
| 158 | + s.Assert().NoError(err) |
| 159 | + s.Assert().Equal(http.StatusOK, userResp.StatusCode) |
| 160 | + |
| 161 | + user := &shieldv1beta1.GetCurrentUserResponse{} |
| 162 | + s.Assert().NoError(jsonpb.Unmarshal(userResp.Body, user)) |
| 163 | + s.Assert().Equal(mockoidc.DefaultUser().Email, user.GetUser().Email) |
| 164 | + }) |
| 165 | +} |
| 166 | + |
| 167 | +func TestEndToEndAuthenticationRegressionTestSuite(t *testing.T) { |
| 168 | + suite.Run(t, new(AuthenticationRegressionTestSuite)) |
| 169 | +} |
0 commit comments