Add --port flag for the web UI for #203

This commit is contained in:
David Dworken 2024-04-14 18:18:11 -07:00
parent 3b7f943d55
commit 6343c208c6
No known key found for this signature in database
3 changed files with 9 additions and 7 deletions

View File

@ -3029,12 +3029,12 @@ func TestWebUi(t *testing.T) {
tester.RunInteractiveShell(t, `echo foobar`) tester.RunInteractiveShell(t, `echo foobar`)
// Start the server // Start the server
require.NoError(t, tester.RunInteractiveShellBackground(t, `hishtory start-web-ui --force-creds hishtory:my_password`)) require.NoError(t, tester.RunInteractiveShellBackground(t, `hishtory start-web-ui --port 8001 --force-creds hishtory:my_password`))
time.Sleep(time.Second) time.Sleep(time.Second)
defer tester.RunInteractiveShell(t, `killall hishtory`) defer tester.RunInteractiveShell(t, `killall hishtory`)
// And check that the server seems to be returning valid data // And check that the server seems to be returning valid data
req, err := http.NewRequest("GET", "http://localhost:8000?q=foobar", nil) req, err := http.NewRequest("GET", "http://localhost:8001?q=foobar", nil)
require.NoError(t, err) require.NoError(t, err)
req.SetBasicAuth("hishtory", "my_password") req.SetBasicAuth("hishtory", "my_password")
resp, err := http.DefaultClient.Do(req) resp, err := http.DefaultClient.Do(req)
@ -3046,12 +3046,12 @@ func TestWebUi(t *testing.T) {
require.Contains(t, string(respBody), "echo foobar") require.Contains(t, string(respBody), "echo foobar")
// And that it rejects requests without auth // And that it rejects requests without auth
resp, err = http.Get("http://localhost:8000?q=foobar") resp, err = http.Get("http://localhost:8001?q=foobar")
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, 401, resp.StatusCode) require.Equal(t, 401, resp.StatusCode)
// And requests with incorrect auth // And requests with incorrect auth
req, err = http.NewRequest("GET", "http://localhost:8000?q=foobar", nil) req, err = http.NewRequest("GET", "http://localhost:8001?q=foobar", nil)
require.NoError(t, err) require.NoError(t, err)
req.SetBasicAuth("hishtory", "wrong-password") req.SetBasicAuth("hishtory", "wrong-password")
resp, err = http.DefaultClient.Do(req) resp, err = http.DefaultClient.Do(req)

View File

@ -13,6 +13,7 @@ import (
var disableAuth *bool var disableAuth *bool
var forceCreds *string var forceCreds *string
var port *int
var webUiCmd = &cobra.Command{ var webUiCmd = &cobra.Command{
Use: "start-web-ui", Use: "start-web-ui",
@ -32,7 +33,7 @@ var webUiCmd = &cobra.Command{
if *disableAuth && *forceCreds != "" { if *disableAuth && *forceCreds != "" {
lib.CheckFatalError(fmt.Errorf("cannot specify both --disable-auth and --force-creds")) lib.CheckFatalError(fmt.Errorf("cannot specify both --disable-auth and --force-creds"))
} }
lib.CheckFatalError(webui.StartWebUiServer(hctx.MakeContext(), *disableAuth, overridenUsername, overridenPassword)) lib.CheckFatalError(webui.StartWebUiServer(hctx.MakeContext(), *port, *disableAuth, overridenUsername, overridenPassword))
os.Exit(1) os.Exit(1)
}, },
} }
@ -41,4 +42,5 @@ func init() {
rootCmd.AddCommand(webUiCmd) rootCmd.AddCommand(webUiCmd)
disableAuth = webUiCmd.Flags().Bool("disable-auth", false, "Disable authentication for the Web UI (Warning: This means your entire shell history will be accessible from the local web server)") disableAuth = webUiCmd.Flags().Bool("disable-auth", false, "Disable authentication for the Web UI (Warning: This means your entire shell history will be accessible from the local web server)")
forceCreds = webUiCmd.Flags().String("force-creds", "", "Specify the credentials to use for basic auth in the form `user:password`") forceCreds = webUiCmd.Flags().String("force-creds", "", "Specify the credentials to use for basic auth in the form `user:password`")
port = webUiCmd.Flags().Int("port", 8000, "The port for the web server to listen on")
} }

View File

@ -126,7 +126,7 @@ func secureStringEquals(s1, s2 string) bool {
return subtle.ConstantTimeCompare([]byte(s1), []byte(s2)) == 1 return subtle.ConstantTimeCompare([]byte(s1), []byte(s2)) == 1
} }
func StartWebUiServer(ctx context.Context, disableAuth bool, overridenUsername, overridenPassword string) error { func StartWebUiServer(ctx context.Context, port int, disableAuth bool, overridenUsername, overridenPassword string) error {
username := "hishtory" username := "hishtory"
// Note that uuid.NewRandom() uses crypto/rand and returns a UUID with 122 bits of security // Note that uuid.NewRandom() uses crypto/rand and returns a UUID with 122 bits of security
password := uuid.Must(uuid.NewRandom()).String() password := uuid.Must(uuid.NewRandom()).String()
@ -144,7 +144,7 @@ func StartWebUiServer(ctx context.Context, disableAuth bool, overridenUsername,
server := http.Server{ server := http.Server{
BaseContext: func(l net.Listener) context.Context { return ctx }, BaseContext: func(l net.Listener) context.Context { return ctx },
Addr: ":8000", Addr: fmt.Sprintf(":%d", port),
} }
fmt.Printf("Starting web server on %s...\n", server.Addr) fmt.Printf("Starting web server on %s...\n", server.Addr)
fmt.Printf("Username: %s\nPassword: %s\n", username, password) fmt.Printf("Username: %s\nPassword: %s\n", username, password)