chore(ssh,pkg): move ssh event structures to models

Author: henrybarreto

pkg/models/session.go

@@ -51,11 +51,6 @@ type Status struct {
 	Authenticated bool `json:"authenticated"`
 }
 
-type SessionRecorded struct {
-	UID    string `json:"uid"`
-	Output string `json:"output" bson:"output"`
-}
-
 type SessionUpdate struct {
 	Authenticated *bool   `json:"authenticated"`
 	Type          *string `json:"type"`

pkg/models/ssh.go

@@ -0,0 +1,41 @@
+package models
+
+type SSHCommand struct {
+	Command string `json:"command"`
+}
+
+type SSHSubsystem struct {
+	Subsystem string `json:"subsystem"`
+}
+
+type SSHExitStatus struct {
+	Status uint32 `json:"status"`
+}
+
+type SSHSignal struct {
+	Name    uint32 `json:"status"`
+	Dumped  bool   `json:"dumped"`
+	Message string `json:"message"`
+	Lang    string `json:"lang"`
+}
+
+type SSHWindowChange struct {
+	Columns uint32 `json:"columns"`
+	Rows    uint32 `json:"rows"`
+	Width   uint32 `json:"width"`
+	Height  uint32 `json:"height"`
+}
+
+// NOTE: [SSHPty] cannot use [SSHWindowChange] inside itself due [ssh.Unmarshal] issues.
+type SSHPty struct {
+	Term     string `json:"term"`
+	Columns  uint32 `json:"columns" `
+	Rows     uint32 `json:"rows"`
+	Width    uint32 `json:"width"`
+	Height   uint32 `json:"height"`
+	Modelist []byte `json:"modelist"`
+}
+
+type SSHPtyOutput struct {
+	Output string `json:"output"`
+}

ssh/server/channels/session.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	gliderssh "github.com/gliderlabs/ssh"
+	"github.com/shellhub-io/shellhub/pkg/models"
 	"github.com/shellhub-io/shellhub/ssh/session"
 	log "github.com/sirupsen/logrus"
 	gossh "golang.org/x/crypto/ssh"
@@ -188,9 +189,9 @@ func DefaultSessionHandler() gliderssh.ChannelHandler {
 
 				switch req.Type {
 				case ExitStatusRequest:
-					session.Event[session.Status](sess, req.Type, req.Payload, seat)
+					session.Event[models.SSHExitStatus](sess, req.Type, req.Payload, seat)
 				case ExitSignalRequest:
-					session.Event[session.Signal](sess, req.Type, req.Payload, seat)
+					session.Event[models.SSHSignal](sess, req.Type, req.Payload, seat)
 				default:
 					sess.Event(req.Type, req.Payload, seat)
 				}
@@ -226,11 +227,11 @@ func DefaultSessionHandler() gliderssh.ChannelHandler {
 
 					sess.Event(req.Type, req.Payload, seat)
 				case ExecRequestType, SubsystemRequestType:
-					session.Event[session.Command](sess, req.Type, req.Payload, seat)
+					session.Event[models.SSHCommand](sess, req.Type, req.Payload, seat)
 
 					sess.Type = ExecRequestType
 				case PtyRequestType:
-					var pty session.Pty
+					var pty models.SSHPty
 
 					if err := gossh.Unmarshal(req.Payload, &pty); err != nil {
 						reject(nil, "failed to recover the session dimensions")
@@ -240,7 +241,7 @@ func DefaultSessionHandler() gliderssh.ChannelHandler {
 
 					sess.Event(req.Type, pty, seat) //nolint:errcheck
 				case WindowChangeRequestType:
-					var dimensions session.Dimensions
+					var dimensions models.SSHWindowChange
 
 					if err := gossh.Unmarshal(req.Payload, &dimensions); err != nil {
 						reject(nil, "failed to recover the session dimensions")

ssh/server/channels/utils.go

@@ -39,8 +39,7 @@ func (c *Recorder) Write(output []byte) (int, error) {
 	}
 
 	// NOTE: Writes the event into the event stream to be processed and send to target endpoint.
-	c.session.Event(PtyOutputEventType, &models.SessionRecorded{
-		UID:    c.session.UID,
+	c.session.Event(PtyOutputEventType, &models.SSHPtyOutput{
 		Output: string(output),
 	}, c.seat)
 

ssh/session/camera.go

@@ -25,42 +25,6 @@ import (
 	gossh "golang.org/x/crypto/ssh"
 )
 
-type Command struct {
-	Command string `json:"command"`
-}
-
-type Subsystem struct {
-	Subsystem string `json:"subsystem"`
-}
-
-type Status struct {
-	Status uint32 `json:"status"`
-}
-
-type Signal struct {
-	Name    uint32 `json:"status"`
-	Dumped  bool   `json:"dumped"`
-	Message string `json:"message"`
-	Lang    string `json:"lang"`
-}
-
-type Dimensions struct {
-	Columns uint32 `json:"columns"`
-	Rows    uint32 `json:"rows"`
-	Width   uint32 `json:"width"`
-	Height  uint32 `json:"height"`
-}
-
-// NOTICE: [Pty] cannot use [Dimensions] inside itself due [ssh.Unmarshal] issues.
-type Pty struct {
-	Term     string `json:"term"`
-	Columns  uint32 `json:"columns" `
-	Rows     uint32 `json:"rows"`
-	Width    uint32 `json:"width"`
-	Height   uint32 `json:"height"`
-	Modelist []byte `json:"modelist"`
-}
-
 type Data struct {
 	Target *target.Target
 	// SSHID is the combination of device's name and namespace name.
@@ -75,7 +39,7 @@ type Data struct {
 	// TODO:
 	Lookup map[string]string
 	// Pty is the PTY dimension.
-	Pty Pty
+	Pty models.SSHPty
 	// Handled check if the session is already handling a "shell", "exec" or a "subsystem".
 	Handled bool
 }
@@ -550,17 +514,6 @@ func (s *Session) Auth(ctx gliderssh.Context, auth Auth) error {
 	return nil
 }
 
-func (s *Session) Record(ctx context.Context, url string, seat int) (*Camera, error) {
-	conn, err := s.api.RecordSession(ctx, s.UID, seat, url)
-	if err != nil {
-		log.WithError(err).Error("failed to start the record session process")
-
-		return nil, err
-	}
-
-	return NewCamera(conn), nil
-}
-
 func (s *Session) NewSeat() (int, error) {
 	seat := int(s.Seat.Load())
 	defer s.Seat.Add(1)