tuns

feat: metric drain open rss

created pr with 34.1 on 2024-11-13T02:18:51Z · by c8ef7d19

added 34.2 on 2024-11-14T03:06:46Z · by c8ef7d19


                      1:  4bd8050 = 1:  4bd8050 feat: metric drain


                      -:  ------- > 2:  ea49338 chore: add userId to metric drain visit

added 34.3 on 2024-11-14T03:22:31Z · by c8ef7d19


                      1:  4bd8050 = 1:  4bd8050 feat: metric drain


                      2:  ea49338 = 2:  ea49338 chore: add userId to metric drain visit


                      -:  ------- > 3:  343f29e chore: update pubsub

changed status to accepted on 2024-11-23T03:33:38Z · by c8ef7d19

cmds

checkout latest patchset:

ssh pr.pico.sh print 34 | git am -3

checkout any patchset in a patch request:

ssh pr.pico.sh print 34.[rev] | git am -3

add changes to patch request:

git format-patch main --stdout | ssh pr.pico.sh pr add 34

set PR to open (enables RSS notifications):

ssh pr.pico.sh pr open 34

set PR to draft (stops RSS notifications):

ssh pr.pico.sh pr draft 34

Patchset `34.3` on 2024-11-14T03:22:31Z · commit 4bd8050

→ feat: metric drain

Eric Bower 2024-11-13T02:16:16Z

chore: add userId to metric drain visit

Eric Bower 2024-11-14T03:05:56Z

chore: update pubsub

Eric Bower 2024-11-14T03:21:06Z

feat: metric drain

Eric Bower 2024-11-13T02:16:16Z

This change will enable http remote forwards to have site analytics
enabled automatically.

Semantic diff summary

2 added, 7 modified, 0 signature changed, 0 removed across 6 analyzed files (2 files skipped: unsupported file type)

cmd/sish.go

chunk lines 17-23 modified
function_declaration initConfig modified

httpmuxer/httpmuxer.go

type_declaration MetricDrainVisit added
function_declaration Start modified

sshmuxer/sshmuxer.go

chunk lines 16-23 modified
function_declaration Start modified

utils/conn.go

method_declaration UserId added

utils/state.go

chunk lines 231-237 modified

utils/utils.go

function_declaration checkAuthenticationKeyRequest modified

+4 -0 Makefile #

......@@ -19,3 +19,7 @@ docs-prod: ssg
dev:
	go run main.go --http-address localhost:3000 --domain testing.ssi.sh
.PHONY: dev

fmt:
	go fmt ./...
.PHONY: fmt

+7 -2 cmd/sish.go #

......@@ -17,6 +17,7 @@ import (
	"github.com/spf13/viper"
	"gopkg.in/natefinch/lumberjack.v2"

	"github.com/picosh/pubsub"
	pipeLogger "github.com/picosh/pubsub/log"
	picoUtils "github.com/picosh/utils"
)

......@@ -206,17 +207,21 @@ func initConfig() {
		slog.NewTextHandler(multiWriter, &slog.HandlerOptions{AddSource: true, Level: logLevel}),
	)

	realLogger, err := pipeLogger.SendLogRegister(logger, &pipeLogger.PubSubConnectionInfo{
	info := &pubsub.RemoteClientInfo{
		RemoteHost:     picoUtils.GetEnv("PICO_PIPE_ENDPOINT", "send.pico.sh:22"),
		KeyLocation:    picoUtils.GetEnv("PICO_PIPE_KEY", "ssh_data/term_info_ed25519"),
		KeyPassphrase:  picoUtils.GetEnv("PICO_PIPE_PASSPHRASE", ""),
		RemoteHostname: picoUtils.GetEnv("PICO_PIPE_REMOTE_HOST", "send.pico.sh"),
		RemoteUser:     picoUtils.GetEnv("PICO_PIPE_USER", "pico"),
	}, 100)
	}
	realLogger, err := pipeLogger.SendLogRegister(logger, info, 100)
	if err != nil {
		slog.Error("unable to set real logger", slog.Any("error", err))
	}

	metricDrain := pubsub.NewRemoteClientWriter(info, logger, 100)
	go metricDrain.KeepAlive("pub metric-drain -b=false")

	trueLogger := logger

	if realLogger != nil {

+2 -0 go.mod #

......@@ -2,6 +2,8 @@ module github.com/antoniomika/sish

go 1.23.1

replace github.com/picosh/pubsub => /home/erock/dev/pico/pubsub

require (
	github.com/ScaleFT/sshkeys v1.2.0
	github.com/antoniomika/multilistener v0.0.0-20240307222635-f0dc097d8acc

+28 -0 httpmuxer/httpmuxer.go #

......@@ -31,6 +31,16 @@ import (
	"github.com/gin-gonic/gin"
)

type MetricDrainVisit struct {
	UserID    string `json:"user_id"`
	Host      string `json:"host"`
	Path      string `json:"path"`
	IpAddress string `json:"ip_adress"`
	UserAgent string `json:"user_agent"`
	Referer   string `json:"referer"`
	Status    int    `json:"status"`
}

// Start initializes the HTTP service.
func Start(state *utils.State) {
	releaseMode := gin.ReleaseMode

......@@ -106,6 +116,24 @@ func Start(state *utils.State) {
			param.ErrorMessage,
		)

		visit := MetricDrainVisit{
			UserID:    "",
			Host:      param.Request.Host,
			IpAddress: param.ClientIP,
			Status:    param.StatusCode,
			Path:      originalURI,
			UserAgent: param.Request.UserAgent(),
			Referer:   param.Request.Referer(),
		}
		data, err := json.Marshal(visit)
		if err != nil {
			slog.Error("could not json marshall visit record", "err", err)
		}
		_, err = state.MetricDrain.Write(data)
		if err != nil {
			slog.Error("could not send to visit to metric-drain", "err", err)
		}

		slog.Info(logLine)

		if viper.GetBool("log-to-client") && param.Keys["httpHolder"] != nil {

+13 -0 sshmuxer/sshmuxer.go #

......@@ -16,6 +16,8 @@ import (
	"github.com/antoniomika/sish/httpmuxer"
	"github.com/antoniomika/sish/utils"
	"github.com/antoniomika/syncmap"
	"github.com/picosh/pubsub"
	picoUtils "github.com/picosh/utils"
	"github.com/pires/go-proxyproto"
	"github.com/spf13/viper"
	"golang.org/x/crypto/ssh"

......@@ -70,10 +72,21 @@ func Start() {

	utils.WatchKeys()

	info := &pubsub.RemoteClientInfo{
		RemoteHost:     picoUtils.GetEnv("PICO_PIPE_ENDPOINT", "send.pico.sh:22"),
		KeyLocation:    picoUtils.GetEnv("PICO_PIPE_KEY", "ssh_data/term_info_ed25519"),
		KeyPassphrase:  picoUtils.GetEnv("PICO_PIPE_PASSPHRASE", ""),
		RemoteHostname: picoUtils.GetEnv("PICO_PIPE_REMOTE_HOST", "send.pico.sh"),
		RemoteUser:     picoUtils.GetEnv("PICO_PIPE_USER", "pico"),
	}
	metricDrain := pubsub.NewRemoteClientWriter(info, slog.Default(), 100)
	go metricDrain.KeepAlive("pub metric-drain -b=false")

	state := utils.NewState()
	state.Ports.HTTPPort = httpPort
	state.Ports.HTTPSPort = httpsPort
	state.Ports.SSHPort = sshPort
	state.MetricDrain = metricDrain

	state.Console.State = state

+10 -0 utils/conn.go #

......@@ -99,6 +99,16 @@ func (s *SSHConnection) User() string {
	return user
}

// User returns the user of the session, either using the extensions user or the passed user.
func (s *SSHConnection) UserId() string {
	user, ok := s.SSHConn.Permissions.Extensions["userId"]
	if !ok {
		user = ""
	}

	return user
}

// TeeConn represents a simple net.Conn interface for SNI Processing.
type TeeConn struct {
	Conn     net.Conn

+1 -0 utils/state.go #

......@@ -231,6 +231,7 @@ type State struct {
	ActiveConnections prometheus.GaugeFunc
	ActiveTunnels     *prometheus.GaugeVec
	ConnectionTime    *prometheus.GaugeVec
	MetricDrain       io.Writer
}

// NewState returns a new State struct.

+6 -0 utils/utils.go #

......@@ -597,7 +597,13 @@ func checkAuthenticationKeyRequest(authUrl string, authKey []byte, addr net.Addr
			return false, extensionsInfo, nil
		}

		userId, ok := userData["id"].(string)
		if !ok {
			return false, extensionsInfo, nil
		}

		extensionsInfo["user"] = userName
		extensionsInfo["userId"] = userId
	}

	return true, extensionsInfo, nil

...	...		@@ -206,17 +207,21 @@ func initConfig() {
206	207		slog.NewTextHandler(multiWriter, &slog.HandlerOptions{AddSource: true, Level: logLevel}),
207	208		)
208	209
209		-	realLogger, err := pipeLogger.SendLogRegister(logger, &pipeLogger.PubSubConnectionInfo{
	210	+	info := &pubsub.RemoteClientInfo{
210	211		RemoteHost: picoUtils.GetEnv("PICO_PIPE_ENDPOINT", "send.pico.sh:22"),
211	212		KeyLocation: picoUtils.GetEnv("PICO_PIPE_KEY", "ssh_data/term_info_ed25519"),
212	213		KeyPassphrase: picoUtils.GetEnv("PICO_PIPE_PASSPHRASE", ""),
213	214		RemoteHostname: picoUtils.GetEnv("PICO_PIPE_REMOTE_HOST", "send.pico.sh"),
214	215		RemoteUser: picoUtils.GetEnv("PICO_PIPE_USER", "pico"),
215		-	}, 100)
	216	+	}
	217	+	realLogger, err := pipeLogger.SendLogRegister(logger, info, 100)
216	218		if err != nil {
217	219		slog.Error("unable to set real logger", slog.Any("error", err))
218	220		}
219	221
	222	+	metricDrain := pubsub.NewRemoteClientWriter(info, logger, 100)
	223	+	go metricDrain.KeepAlive("pub metric-drain -b=false")
	224	+
220	225		trueLogger := logger
221	226
222	227		if realLogger != nil {

...	...		@@ -106,6 +116,24 @@ func Start(state *utils.State) {
106	116		param.ErrorMessage,
107	117		)
108	118
	119	+	visit := MetricDrainVisit{
	120	+	UserID: "",
	121	+	Host: param.Request.Host,
	122	+	IpAddress: param.ClientIP,
	123	+	Status: param.StatusCode,
	124	+	Path: originalURI,
	125	+	UserAgent: param.Request.UserAgent(),
	126	+	Referer: param.Request.Referer(),
	127	+	}
	128	+	data, err := json.Marshal(visit)
	129	+	if err != nil {
	130	+	slog.Error("could not json marshall visit record", "err", err)
	131	+	}
	132	+	_, err = state.MetricDrain.Write(data)
	133	+	if err != nil {
	134	+	slog.Error("could not send to visit to metric-drain", "err", err)
	135	+	}
	136	+
109	137		slog.Info(logLine)
110	138
111	139		if viper.GetBool("log-to-client") && param.Keys["httpHolder"] != nil {

...	...		@@ -70,10 +72,21 @@ func Start() {
70	72
71	73		utils.WatchKeys()
72	74
	75	+	info := &pubsub.RemoteClientInfo{
	76	+	RemoteHost: picoUtils.GetEnv("PICO_PIPE_ENDPOINT", "send.pico.sh:22"),
	77	+	KeyLocation: picoUtils.GetEnv("PICO_PIPE_KEY", "ssh_data/term_info_ed25519"),
	78	+	KeyPassphrase: picoUtils.GetEnv("PICO_PIPE_PASSPHRASE", ""),
	79	+	RemoteHostname: picoUtils.GetEnv("PICO_PIPE_REMOTE_HOST", "send.pico.sh"),
	80	+	RemoteUser: picoUtils.GetEnv("PICO_PIPE_USER", "pico"),
	81	+	}
	82	+	metricDrain := pubsub.NewRemoteClientWriter(info, slog.Default(), 100)
	83	+	go metricDrain.KeepAlive("pub metric-drain -b=false")
	84	+
73	85		state := utils.NewState()
74	86		state.Ports.HTTPPort = httpPort
75	87		state.Ports.HTTPSPort = httpsPort
76	88		state.Ports.SSHPort = sshPort
	89	+	state.MetricDrain = metricDrain
77	90
78	91		state.Console.State = state
79	92

...	...		@@ -597,7 +597,13 @@ func checkAuthenticationKeyRequest(authUrl string, authKey []byte, addr net.Addr
597	597		return false, extensionsInfo, nil
598	598		}
599	599
	600	+	userId, ok := userData["id"].(string)
	601	+	if !ok {
	602	+	return false, extensionsInfo, nil
	603	+	}
	604	+
600	605		extensionsInfo["user"] = userName
	606	+	extensionsInfo["userId"] = userId
601	607		}
602	608
603	609		return true, extensionsInfo, nil

...	...		@@ -19,3 +19,7 @@ docs-prod: ssg
19	19		dev:
20	20		go run main.go --http-address localhost:3000 --domain testing.ssi.sh
21	21		.PHONY: dev
	22	+
	23	+	fmt:
	24	+	go fmt ./...
	25	+	.PHONY: fmt

...	...		@@ -17,6 +17,7 @@ import (
17	17		"github.com/spf13/viper"
18	18		"gopkg.in/natefinch/lumberjack.v2"
19	19
	20	+	"github.com/picosh/pubsub"
20	21		pipeLogger "github.com/picosh/pubsub/log"
21	22		picoUtils "github.com/picosh/utils"
22	23		)

...	...		@@ -2,6 +2,8 @@ module github.com/antoniomika/sish
2	2
3	3		go 1.23.1
4	4
	5	+	replace github.com/picosh/pubsub => /home/erock/dev/pico/pubsub
	6	+
5	7		require (
6	8		github.com/ScaleFT/sshkeys v1.2.0
7	9		github.com/antoniomika/multilistener v0.0.0-20240307222635-f0dc097d8acc

...	...		@@ -31,6 +31,16 @@ import (
31	31		"github.com/gin-gonic/gin"
32	32		)
33	33
	34	+	type MetricDrainVisit struct {
	35	+	UserID string `json:"user_id"`
	36	+	Host string `json:"host"`
	37	+	Path string `json:"path"`
	38	+	IpAddress string `json:"ip_adress"`
	39	+	UserAgent string `json:"user_agent"`
	40	+	Referer string `json:"referer"`
	41	+	Status int `json:"status"`
	42	+	}
	43	+
34	44		// Start initializes the HTTP service.
35	45		func Start(state *utils.State) {
36	46		releaseMode := gin.ReleaseMode

...	...		@@ -16,6 +16,8 @@ import (
16	16		"github.com/antoniomika/sish/httpmuxer"
17	17		"github.com/antoniomika/sish/utils"
18	18		"github.com/antoniomika/syncmap"
	19	+	"github.com/picosh/pubsub"
	20	+	picoUtils "github.com/picosh/utils"
19	21		"github.com/pires/go-proxyproto"
20	22		"github.com/spf13/viper"
21	23		"golang.org/x/crypto/ssh"

...	...		@@ -99,6 +99,16 @@ func (s *SSHConnection) User() string {
99	99		return user
100	100		}
101	101
	102	+	// User returns the user of the session, either using the extensions user or the passed user.
	103	+	func (s *SSHConnection) UserId() string {
	104	+	user, ok := s.SSHConn.Permissions.Extensions["userId"]
	105	+	if !ok {
	106	+	user = ""
	107	+	}
	108	+
	109	+	return user
	110	+	}
	111	+
102	112		// TeeConn represents a simple net.Conn interface for SNI Processing.
103	113		type TeeConn struct {
104	114		Conn net.Conn

...	...		@@ -231,6 +231,7 @@ type State struct {
231	231		ActiveConnections prometheus.GaugeFunc
232	232		ActiveTunnels *prometheus.GaugeVec
233	233		ConnectionTime *prometheus.GaugeVec
	234	+	MetricDrain io.Writer
234	235		}
235	236
236	237		// NewState returns a new State struct.

tuns

Patchset 34.3 on 2024-11-14T03:22:31Z · commit 4bd8050

Patchset `34.3` on 2024-11-14T03:22:31Z · commit 4bd8050