wifi

README

wifi

Package wifi provides access to IEEE 802.11 WiFi device operations on Linux using nl80211. MIT Licensed.

Documentation

Overview

Package wifi provides access to IEEE 802.11 WiFi device operations on Linux using nl80211.

Index

• Variables
• type BSS
• type BSSLoad
  • func (l BSSLoad) String() string
• type BSSStatus
  • func (s BSSStatus) String() string
• type Client
  • func New() (*Client, error)
  • func (c *Client) AccessPoints(ifi *Interface) ([]*BSS, error)
  • func (c *Client) BSS(ifi *Interface) (*BSS, error)
  • func (c *Client) Close() error
  • func (c *Client) Connect(ifi *Interface, ssid string) error
  • func (c *Client) ConnectWPAPSK(ifi *Interface, ssid, psk string) error
  • func (c *Client) Disconnect(ifi *Interface) error
  • func (c *Client) Interfaces() ([]*Interface, error)
  • func (c *Client) Scan(ctx context.Context, ifi *Interface) error
  • func (c *Client) SetDeadline(t time.Time) error
  • func (c *Client) SetReadDeadline(t time.Time) error
  • func (c *Client) SetWriteDeadline(t time.Time) error
  • func (c *Client) StationInfo(ifi *Interface) ([]*StationInfo, error)
  • func (c *Client) SurveyInfo(ifi *Interface) ([]*SurveyInfo, error)
• type Interface
• type InterfaceType
  • func (t InterfaceType) String() string
• type StationInfo
• type SurveyInfo

Variables

var (
	ErrNotSupported      = errors.New("not supported")
	ErrScanGroupNotFound = errors.New("scan multicast group unavailable")
	ErrScanAborted       = errors.New("scan aborted by the kernel")
	ErrScanValidation    = errors.New("scan validation failed")
)

Types

type BSS

type BSS struct {
	// The service set identifier, or "network name" of the BSS.
	SSID string

	// BSSID: The BSS service set identifier.  In infrastructure mode, this is the
	// hardware address of the wireless access point that a client is associated
	// with.
	BSSID net.HardwareAddr

	// Frequency: The frequency used by the BSS, in MHz.
	Frequency int

	// BeaconInterval: The time interval between beacon transmissions for this BSS.
	BeaconInterval time.Duration

	// LastSeen: The time since the client last scanned this BSS's information.
	LastSeen time.Duration

	// Status: The status of the client within the BSS.
	Status BSSStatus

	// Load: The load element of the BSS (contains StationCount, ChannelUtilization and AvailableAdmissionCapacity).
	Load BSSLoad
}

A BSS is an 802.11 basic service set. It contains information about a wireless network associated with an Interface.

type BSSLoad

type BSSLoad struct {
	// Version: Indicates the version of the BSS Load Element. Can be 1 or 2.
	Version int

	// StationCount: total number of STA currently associated with this BSS.
	StationCount uint16

	// ChannelUtilization: Percentage of time (linearly scaled 0 to 255) that the AP sensed the medium was busy. Calculated only for the primary channel.
	ChannelUtilization uint8

	// AvailableAdmissionCapacity: remaining amount of medium time availible via explicit admission controll in units of 32 us/s.
	AvailableAdmissionCapacity uint16
}

BSSLoad is an Information Element containing measurements of the load on the BSS.

func (BSSLoad) String

func (l BSSLoad) String() string

String returns the string representation of a BSSLoad.

type BSSStatus

type BSSStatus int

A BSSStatus indicates the current status of client within a BSS.

const (
	// BSSStatusAuthenticated indicates that a client is authenticated with a BSS.
	BSSStatusAuthenticated BSSStatus = iota

	// BSSStatusAssociated indicates that a client is associated with a BSS.
	BSSStatusAssociated

	// BSSStatusNotAssociated indicates that a client is not associated with a BSS.
	BSSStatusNotAssociated

	// BSSStatusIBSSJoined indicates that a client has joined an independent BSS.
	BSSStatusIBSSJoined
)

func (BSSStatus) String

func (s BSSStatus) String() string

String returns the string representation of a BSSStatus.

type Client

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

A Client is a type which can access WiFi device actions and statistics using operating system-specific operations.

func New

func New() (*Client, error)

New creates a new Client.

func (*Client) AccessPoints

func (c *Client) AccessPoints(ifi *Interface) ([]*BSS, error)

AccessPoints retrieves the currently known BSS around the specified Interface.

func (*Client) BSS

func (c *Client) BSS(ifi *Interface) (*BSS, error)

BSS retrieves the BSS associated with a WiFi interface.

func (*Client) Close

func (c *Client) Close() error

Close releases resources used by a Client.

func (*Client) Connect

func (c *Client) Connect(ifi *Interface, ssid string) error

Connect starts connecting the interface to the specified ssid.

func (*Client) ConnectWPAPSK

func (c *Client) ConnectWPAPSK(ifi *Interface, ssid, psk string) error

Connect starts connecting the interface to the specified ssid using WPA.

func (*Client) Disconnect

func (c *Client) Disconnect(ifi *Interface) error

Dissconnect disconnects the interface.

func (*Client) Interfaces

func (c *Client) Interfaces() ([]*Interface, error)

Interfaces returns a list of the system's WiFi network interfaces.

func (*Client) Scan

func (c *Client) Scan(ctx context.Context, ifi *Interface) error

Scan requests the wifi interface to scan for new access points.

Use context.WithDeadline to set a timeout.

func (*Client) SetDeadline

func (c *Client) SetDeadline(t time.Time) error

SetDeadline sets the read and write deadlines associated with the connection.

func (*Client) SetReadDeadline

func (c *Client) SetReadDeadline(t time.Time) error

SetReadDeadline sets the read deadline associated with the connection.

func (*Client) SetWriteDeadline

func (c *Client) SetWriteDeadline(t time.Time) error

SetWriteDeadline sets the write deadline associated with the connection.

func (*Client) StationInfo

func (c *Client) StationInfo(ifi *Interface) ([]*StationInfo, error)

StationInfo retrieves all station statistics about a WiFi interface.

Since v0.2.0: if there are no stations, an empty slice is returned instead of an error.

func (*Client) SurveyInfo

func (c *Client) SurveyInfo(ifi *Interface) ([]*SurveyInfo, error)

SurveyInfo retrieves the survey information about a WiFi interface.

type Interface

type Interface struct {
	// The index of the interface.
	Index int

	// The name of the interface.
	Name string

	// The hardware address of the interface.
	HardwareAddr net.HardwareAddr

	// The physical device that this interface belongs to.
	PHY int

	// The virtual device number of this interface within a PHY.
	Device int

	// The operating mode of the interface.
	Type InterfaceType

	// The interface's wireless frequency in MHz.
	Frequency int
}

An Interface is a WiFi network interface.

type InterfaceType

type InterfaceType int

An InterfaceType is the operating mode of an Interface.

const (
	// InterfaceTypeUnspecified indicates that an interface's type is unspecified
	// and the driver determines its function.
	InterfaceTypeUnspecified InterfaceType = iota

	// InterfaceTypeAdHoc indicates that an interface is part of an independent
	// basic service set (BSS) of client devices without a controlling access
	// point.
	InterfaceTypeAdHoc

	// InterfaceTypeStation indicates that an interface is part of a managed
	// basic service set (BSS) of client devices with a controlling access point.
	InterfaceTypeStation

	// InterfaceTypeAP indicates that an interface is an access point.
	InterfaceTypeAP

	// InterfaceTypeAPVLAN indicates that an interface is a VLAN interface
	// associated with an access point.
	InterfaceTypeAPVLAN

	// InterfaceTypeWDS indicates that an interface is a wireless distribution
	// interface, used as part of a network of multiple access points.
	InterfaceTypeWDS

	// InterfaceTypeMonitor indicates that an interface is a monitor interface,
	// receiving all frames from all clients in a given network.
	InterfaceTypeMonitor

	// InterfaceTypeMeshPoint indicates that an interface is part of a wireless
	// mesh network.
	InterfaceTypeMeshPoint

	// InterfaceTypeP2PClient indicates that an interface is a client within
	// a peer-to-peer network.
	InterfaceTypeP2PClient

	// InterfaceTypeP2PGroupOwner indicates that an interface is the group
	// owner within a peer-to-peer network.
	InterfaceTypeP2PGroupOwner

	// InterfaceTypeP2PDevice indicates that an interface is a device within
	// a peer-to-peer client network.
	InterfaceTypeP2PDevice

	// InterfaceTypeOCB indicates that an interface is outside the context
	// of a basic service set (BSS).
	InterfaceTypeOCB

	// InterfaceTypeNAN indicates that an interface is part of a near-me
	// area network (NAN).
	InterfaceTypeNAN
)

func (InterfaceType) String

func (t InterfaceType) String() string

String returns the string representation of an InterfaceType.

type StationInfo

type StationInfo struct {
	// The hardware address of the station.
	HardwareAddr net.HardwareAddr

	// The time since the station last connected.
	Connected time.Duration

	// The time since wireless activity last occurred.
	Inactive time.Duration

	// The number of bytes received by this station.
	ReceivedBytes int

	// The number of bytes transmitted by this station.
	TransmittedBytes int

	// The number of packets received by this station.
	ReceivedPackets int

	// The number of packets transmitted by this station.
	TransmittedPackets int

	// The current data receive bitrate, in bits/second.
	ReceiveBitrate int

	// The current data transmit bitrate, in bits/second.
	TransmitBitrate int

	// The signal strength of the last received PPDU, in dBm.
	Signal int

	// The average signal strength, in dBm.
	SignalAverage int

	// The number of times the station has had to retry while sending a packet.
	TransmitRetries int

	// The number of times a packet transmission failed.
	TransmitFailed int

	// The number of times a beacon loss was detected.
	BeaconLoss int
}

StationInfo contains statistics about a WiFi interface operating in station mode.

type SurveyInfo

type SurveyInfo struct {
	// The frequency in MHz of the channel.
	Frequency int

	// The noise level in dBm.
	Noise int

	// The time the radio has spent on this channel.
	ChannelTime time.Duration

	// The time the radio has spent on this channel while it was active.
	ChannelTimeActive time.Duration

	// The time the radio has spent on this channel while it was busy.
	ChannelTimeBusy time.Duration

	// The time the radio has spent on this channel while it was busy with external traffic.
	ChannelTimeExtBusy time.Duration

	// The time the radio has spent on this channel receiving data from a BSS.
	ChannelTimeBssRx time.Duration

	// The time the radio has spent on this channel receiving data.
	ChannelTimeRx time.Duration

	// The time the radio has spent on this channel transmitting data.
	ChannelTimeTx time.Duration

	// The time the radio has spent on this channel while it was scanning.
	ChannelTimeScan time.Duration

	// Indicates if the channel is currently in use.
	InUse bool
}