strongswan

Documentation

Overview

Package strongswan provides an i3 barista module for strongSwan VPNs.

Index

• type Info
  • func (i *Info) Connected() bool
  • func (i *Info) Connecting() bool
  • func (i *Info) Enabled() bool
• type Module
  • func New() *Module
  • func NewWithSocket(socket string) *Module
  • func (m *Module) Close() error
  • func (m *Module) Output(outputFunc func(Info) bar.Output) *Module
  • func (m *Module) Stream(sink bar.Sink)

Types

type Info

type Info struct {
	// Error is set if an error was encountered when retrieving the
	// information.
	Error error

	IKE       string
	Child     string
	VirtualIP string
	// contains filtered or unexported fields
}

Info contains information about the strongSwan VPN.

func (*Info) Connected

func (i *Info) Connected() bool

Connected returns true if the IKE and Child SAs are UP.

func (*Info) Connecting

func (i *Info) Connecting() bool

Connecting returns true if one, but not both of, the IKE and Child SAs are up.

func (*Info) Enabled

func (i *Info) Enabled() bool

Enabled returns true if the module is enabled, i.e. it is able to communicate with a charon daemon.

type Module

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

Module implements bar.Module.

func New

func New() *Module

New returns a new default strongswan Module.

func NewWithSocket

func NewWithSocket(socket string) *Module

NewWithSocket returns a new strongswan Module with with a specified vici socket.

func (*Module) Close

func (m *Module) Close() error

func (*Module) Output

func (m *Module) Output(outputFunc func(Info) bar.Output) *Module

Output configures a module to display the output of a user-defined function.

func (*Module) Stream

func (m *Module) Stream(sink bar.Sink)

Stream implements the bar.Module Stream method.