core

Documentation

Overview

Package core provides functionality for managing core functionalities in Keploy.

Index

• func GetPortToSendToKernel(_ context.Context, rules []config.BypassRule) []uint
• type App
• type AppInfo
• type Core
  • func New(logger *zap.Logger, hook Hooks, proxy Proxy, tester Tester, ...) *Core
  • func (c *Core) GetContainerIP(_ context.Context, id uint64) (string, error)
  • func (c *Core) GetIncoming(ctx context.Context, id uint64, opts models.IncomingOptions) (<-chan *models.TestCase, error)
  • func (c *Core) GetOutgoing(ctx context.Context, id uint64, opts models.OutgoingOptions) (<-chan *models.Mock, error)
  • func (c *Core) Hook(ctx context.Context, id uint64, opts models.HookOptions) error
  • func (c *Core) MockOutgoing(ctx context.Context, id uint64, opts models.OutgoingOptions) error
  • func (c *Core) Run(ctx context.Context, id uint64, _ models.RunOptions) models.AppError
  • func (c *Core) Setup(ctx context.Context, cmd string, opts models.SetupOptions) (uint64, error)
• type DestInfo
• type HookCfg
• type Hooks
• type NetworkAddress
• type OutgoingInfo
• type Proxy
• type ProxyOptions
• type Session
• type Sessions
  • func NewSessions() *Sessions
  • func (s *Sessions) Delete(id uint64)
  • func (s *Sessions) Get(id uint64) (*Session, bool)
  • func (s *Sessions) GetAllMC() []chan<- *models.Mock
  • func (s *Sessions) Set(id uint64, session *Session)
• type TestBenchInfo
• type Tester

Functions

func GetPortToSendToKernel

func GetPortToSendToKernel(_ context.Context, rules []config.BypassRule) []uint

Types

type App

type App interface {
	Setup(ctx context.Context, opts app.Options) error
	Run(ctx context.Context, inodeChan chan uint64, opts app.Options) error
	Kind(ctx context.Context) utils.CmdType
	KeployIPv4Addr() string
}

type AppInfo

type AppInfo interface {
	SendInode(ctx context.Context, id uint64, inode uint64) error
}

type Core

type Core struct {
	Proxy  // embedding the Proxy interface to transfer the proxy methods to the core object
	Hooks  // embedding the Hooks interface to transfer the hooks methods to the core object
	Tester // embedding the Tester interface to transfer the tester methods to the core object
	// contains filtered or unexported fields
}

func New

func New(logger *zap.Logger, hook Hooks, proxy Proxy, tester Tester, client docker.Client) *Core

func (*Core) GetContainerIP

func (c *Core) GetContainerIP(_ context.Context, id uint64) (string, error)

func (*Core) GetIncoming

func (c *Core) GetIncoming(ctx context.Context, id uint64, opts models.IncomingOptions) (<-chan *models.TestCase, error)

func (*Core) GetOutgoing

func (c *Core) GetOutgoing(ctx context.Context, id uint64, opts models.OutgoingOptions) (<-chan *models.Mock, error)

func (*Core) Hook

func (c *Core) Hook(ctx context.Context, id uint64, opts models.HookOptions) error

func (*Core) MockOutgoing

func (c *Core) MockOutgoing(ctx context.Context, id uint64, opts models.OutgoingOptions) error

func (*Core) Run

func (c *Core) Run(ctx context.Context, id uint64, _ models.RunOptions) models.AppError

func (*Core) Setup

func (c *Core) Setup(ctx context.Context, cmd string, opts models.SetupOptions) (uint64, error)

type DestInfo

type DestInfo interface {
	Get(ctx context.Context, srcPort uint16) (*NetworkAddress, error)
	Delete(ctx context.Context, srcPort uint16) error
}

type HookCfg

type HookCfg struct {
	AppID      uint64
	Pid        uint32
	IsDocker   bool
	KeployIPV4 string
	Mode       models.Mode
}

type Hooks

type Hooks interface {
	AppInfo
	DestInfo
	OutgoingInfo
	TestBenchInfo
	Load(ctx context.Context, id uint64, cfg HookCfg) error
	Record(ctx context.Context, id uint64, opts models.IncomingOptions) (<-chan *models.TestCase, error)
}

type NetworkAddress

type NetworkAddress struct {
	AppID    uint64
	Version  uint32
	IPv4Addr uint32
	IPv6Addr [4]uint32
	Port     uint32
}

type OutgoingInfo

type OutgoingInfo interface {
	PassThroughPortsInKernel(ctx context.Context, id uint64, ports []uint) error
}

type Proxy

type Proxy interface {
	StartProxy(ctx context.Context, opts ProxyOptions) error
	Record(ctx context.Context, id uint64, mocks chan<- *models.Mock, opts models.OutgoingOptions) error
	Mock(ctx context.Context, id uint64, opts models.OutgoingOptions) error
	SetMocks(ctx context.Context, id uint64, filtered []*models.Mock, unFiltered []*models.Mock) error
	GetConsumedMocks(ctx context.Context, id uint64) ([]string, error)
}

Proxy listens on all available interfaces and forwards traffic to the destination

type ProxyOptions

type ProxyOptions struct {
	// DNSIPv4Addr is the proxy IP returned by the DNS server. default is loopback address
	DNSIPv4Addr string
	// DNSIPv6Addr is the proxy IP returned by the DNS server. default is loopback address
	DNSIPv6Addr string
}

type Session

type Session struct {
	ID   uint64
	Mode models.Mode
	TC   chan<- *models.TestCase
	MC   chan<- *models.Mock
	models.OutgoingOptions
}

type Sessions

type Sessions struct {
	// contains filtered or unexported fields
}

func NewSessions

func NewSessions() *Sessions

func (*Sessions) Delete

func (s *Sessions) Delete(id uint64)

func (*Sessions) Get

func (s *Sessions) Get(id uint64) (*Session, bool)

func (*Sessions) GetAllMC

func (s *Sessions) GetAllMC() []chan<- *models.Mock

func (*Sessions) Set

func (s *Sessions) Set(id uint64, session *Session)

type TestBenchInfo

type TestBenchInfo interface {
	SendKeployPids(key models.ModeKey, pid uint32) error
	SendKeployPorts(key models.ModeKey, port uint32) error
}

type Tester

type Tester interface {
	Setup(ctx context.Context, opts models.TestingOptions) error
}