portlist

Documentation

Overview

Package portlist provides functionality to fetch open ports in the current machine.

Index

• type List
  • func (pl List) String() string
• type Option
  • func WithIncludeLocalhost(includeLocalhost bool) Option
  • func WithProcMountPoint(mountPoint string) Option
• type Poller
  • func NewPoller(opts ...Option) (*Poller, error)
  • func (p *Poller) OpenPorts() (List, error)
• type Port

Types

type List

type List []Port

List is a list of Ports.

func (List) String

func (pl List) String() string

type Option

type Option func(cfg *config)

Option is used to configure the Poller.

func WithIncludeLocalhost

func WithIncludeLocalhost(includeLocalhost bool) Option

WithIncludeLocalhost allows to include/exclude localhost ports (false by default).

func WithProcMountPoint

func WithProcMountPoint(mountPoint string) Option

WithProcMountPoint allows to change the proc filesystem mount point (this is used mainly in tests).

type Poller

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

Poller scans the systems for listening ports.

func NewPoller

func NewPoller(opts ...Option) (*Poller, error)

NewPoller initializes a new Poller.

func (*Poller) OpenPorts

func (p *Poller) OpenPorts() (List, error)

OpenPorts returns the list of currently listening ports.

type Port

type Port struct {
	Proto   string // "tcp" or "udp"
	Port    uint16 // port number
	Process string // optional process name, if found (requires suitable permissions)
	Pid     int    // process ID, if known (requires suitable permissions)
}

Port is a listening port on the machine.