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

DXCDT-547: Add websocket connection and send data on connect #863

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ require (
github.com/golang/mock v1.6.0
github.com/google/go-cmp v0.5.9
github.com/google/uuid v1.3.1
github.com/gorilla/websocket v1.5.0
github.com/hashicorp/go-version v1.6.0
github.com/hashicorp/hc-install v0.6.0
github.com/hashicorp/terraform-exec v0.19.0
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ github.com/google/uuid v1.3.1 h1:KjJaJ9iWZ3jOFZIf1Lqf4laDRCasjl0BCmnEGxkdLb4=
github.com/google/uuid v1.3.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gorilla/css v1.0.0 h1:BQqNyPTi50JCFMTw/b67hByjMVXZRwGha6wxVGkeihY=
github.com/gorilla/css v1.0.0/go.mod h1:Dn721qIggHpt4+EFCcTLTU/vk5ySda2ReITrtgBl60c=
github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ=
github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=
github.com/hashicorp/go-version v1.6.0 h1:feTTfFNnjP967rlCxM/I9g701jU+RN74YKx2mOkIeek=
Expand Down
110 changes: 107 additions & 3 deletions internal/cli/universal_login_customize.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,25 @@ package cli

import (
"context"
"fmt"
"net"
"net/http"
"net/url"
"time"

"github.com/auth0/go-auth0/management"
"github.com/gorilla/websocket"
"github.com/pkg/browser"
"github.com/spf13/cobra"
"golang.org/x/sync/errgroup"

"github.com/auth0/auth0-cli/internal/ansi"
"github.com/auth0/auth0-cli/internal/auth0"
"github.com/auth0/auth0-cli/internal/display"
)

const webAppURL = "http://localhost:5173"

type (
universalLoginBrandingData struct {
AuthenticationProfile *management.Prompt `json:"auth_profile"`
Expand All @@ -32,6 +42,13 @@ type (
Prompt string `json:"prompt"`
CustomText map[string]map[string]interface{} `json:"custom_text"`
}

webSocketHandler struct {
shutdown context.CancelFunc
display *display.Renderer
api *auth0.API
brandingData *universalLoginBrandingData
}
)

func customizeUniversalLoginCmd(cli *cli) *cobra.Command {
Expand Down Expand Up @@ -61,9 +78,7 @@ func customizeUniversalLoginCmd(cli *cli) *cobra.Command {
return err
}

cli.renderer.JSONResult(universalLoginBrandingData)

return nil
return startWebSocketServer(ctx, cli.api, cli.renderer, universalLoginBrandingData)
},
}

Expand Down Expand Up @@ -237,3 +252,92 @@ func fetchPromptCustomTextWithDefaults(
CustomText: brandingTextTranslations,
}, nil
}

func startWebSocketServer(
ctx context.Context,
api *auth0.API,
display *display.Renderer,
brandingData *universalLoginBrandingData,
) error {
ctx, cancel := context.WithCancel(ctx)
defer cancel()

listener, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
return err
}
defer listener.Close()

handler := &webSocketHandler{
display: display,
api: api,
shutdown: cancel,
brandingData: brandingData,
}

server := &http.Server{
Handler: handler,
ReadTimeout: time.Minute * 10,
WriteTimeout: time.Minute * 10,
}

errChan := make(chan error, 1)
go func() {
errChan <- server.Serve(listener)
}()

openWebAppInBrowser(display, listener.Addr())

select {
case err := <-errChan:
return err
case <-ctx.Done():
return server.Close()
}
}

func openWebAppInBrowser(display *display.Renderer, addr net.Addr) {
port := addr.(*net.TCPAddr).Port
webAppURLWithPort := fmt.Sprintf("%s?ws_port=%d", webAppURL, port)

display.Infof("Perform your changes within the UI: %q", webAppURLWithPort)
sergiught marked this conversation as resolved.
Show resolved Hide resolved

if err := browser.OpenURL(webAppURLWithPort); err != nil {
display.Warnf("Failed to open the browser. Visit the URL manually.")
}
}

func (h *webSocketHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
upgrader := websocket.Upgrader{
CheckOrigin: checkOriginFunc,
}

connection, err := upgrader.Upgrade(w, r, nil)
if err != nil {
h.display.Errorf("error accepting WebSocket connection: %v", err)
h.shutdown()
return
}

connection.SetReadLimit(1e+6) // 1 MB.

if err = connection.WriteJSON(h.brandingData); err != nil {
h.display.Errorf("failed to write json message: %v", err)
h.shutdown()
return
}
}

func checkOriginFunc(r *http.Request) bool {
origin := r.Header["Origin"]
if len(origin) == 0 {
return false
}

originURL, err := url.Parse(origin[0])
if err != nil {
return false
}

return originURL.String() == webAppURL
}
51 changes: 51 additions & 0 deletions internal/cli/universal_login_customize_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cli
import (
"context"
"fmt"
"net/http"
"testing"

"github.com/auth0/go-auth0/management"
Expand Down Expand Up @@ -829,3 +830,53 @@ func TestFetchUniversalLoginBrandingData(t *testing.T) {
})
}
}

func TestCheckOriginFunc(t *testing.T) {
var testCases = []struct {
testName string
request *http.Request
expected bool
}{
{
testName: "No Origin Header",
request: &http.Request{
Header: http.Header{},
},
expected: false,
},
{
testName: "Valid Origin",
request: &http.Request{
Header: http.Header{
"Origin": []string{webAppURL},
},
},
expected: true,
},
{
testName: "Invalid Origin",
request: &http.Request{
Header: http.Header{
"Origin": []string{"https://invalid.com"},
},
},
expected: false,
},
{
testName: "Malformed Origin",
request: &http.Request{
Header: http.Header{
"Origin": []string{"malformed-url"},
},
},
expected: false,
},
}

for _, test := range testCases {
t.Run(test.testName, func(t *testing.T) {
actual := checkOriginFunc(test.request)
assert.Equal(t, test.expected, actual)
})
}
}