README
¶
go-openvpn
A go library to start and interface with openvpn processes.
Basic static key example
First use the following command to create a PSK (pre shared key)
openvpn --genkey --secret pre-shared.key
Server
// Create an instance of the openvpn struct
p := openvpn.NewStaticKeyServer("pre-shared.key")
// Start the openvpn process. Note that this method do not block so the program will continue at once.
p.Start()
// Listen for events
for {
select {
case event := <-p.Events:
log.Println("Event: ", event.Name, "(", event.Args, ")")
}
}
Client
// Create an instance of the openvpn struct
p := openvpn.NewStaticKeyClient("localhost", "pre-shared.key")
// Start the openvpn process. Note that this method do not block so the program will continue at once.
p.Start()
// Listen for events
for {
select {
case event := <-p.Events:
log.Println("Event: ", event.Name, "(", event.Args, ")")
}
}
References
- OpenVPN management interface: https://openvpn.net/community-resources/management-interface/
- Change certificate signature: https://itigloo.com/security/change-openssl-default-signature-algorithm/
Documentation
¶
Index ¶
- Constants
- type Config
- func (c *Config) Address(address string, port int)
- func (c *Config) ClientMode(ca *openssl.CA, cert *openssl.Cert, dh *openssl.DH, ta *openssl.TA)
- func (c *Config) ClientToClient()
- func (c *Config) Compression()
- func (c *Config) Device(t string)
- func (c *Config) Flag(key string)
- func (c *Config) InterfaceAddress() string
- func (c *Config) IpPool(pool string)
- func (c *Config) KeepAlive(interval, timeout int)
- func (c *Config) PersistKey()
- func (c *Config) PersistTun()
- func (c *Config) PingTimerRemote()
- func (c *Config) Port() int
- func (c *Config) Protocol(p string)
- func (c *Config) Remote(r string, port int)
- func (c *Config) Secret(key string)
- func (c *Config) ServerMode(port int, ca *openssl.CA, cert *openssl.Cert, dh *openssl.DH, ta *openssl.TA)
- func (c *Config) Set(key, val string)
- func (c *Config) Validate() (config []string, err error)
- type Management
- type OpenVpnManagement
- func (vm *OpenVpnManagement) Exec(cmd string)
- func (vm OpenVpnManagement) GetClients(data core.EventData) ([]utils.Client, error)
- func (vm OpenVpnManagement) Shutdown()
- func (vm *OpenVpnManagement) StartClient() error
- func (vm *OpenVpnManagement) StartServer() error
- func (vm OpenVpnManagement) Status() (string, error)
- type Process
Constants ¶
View Source
const ( TcpSocket = 0 UnixSocket = 1 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// contains filtered or unexported fields
}
func (*Config) ClientMode ¶
func (*Config) ClientToClient ¶
func (c *Config) ClientToClient()
func (*Config) Compression ¶
func (c *Config) Compression()
func (*Config) InterfaceAddress ¶
func (*Config) PersistKey ¶
func (c *Config) PersistKey()
func (*Config) PersistTun ¶
func (c *Config) PersistTun()
func (*Config) PingTimerRemote ¶
func (c *Config) PingTimerRemote()
func (*Config) ServerMode ¶
type Management ¶
type Management struct {
Conn *Process
Mode int
Events chan utils.Event `json:"-"`
OpenVpnEvents chan string
// contains filtered or unexported fields
}
func NewManagement ¶
func NewManagement(conn *Process, connector core.OpenVpnConnector) *Management
func (*Management) Fire ¶
func (m *Management) Fire(name string, args ...string)
func (*Management) Shutdown ¶
func (m *Management) Shutdown()
func (*Management) Start ¶
func (m *Management) Start() error
type OpenVpnManagement ¶
type OpenVpnManagement struct {
Events chan core.EventData
// contains filtered or unexported fields
}
func NewVpnManagement ¶
func (*OpenVpnManagement) Exec ¶
func (vm *OpenVpnManagement) Exec(cmd string)
func (OpenVpnManagement) GetClients ¶
func (OpenVpnManagement) Shutdown ¶
func (vm OpenVpnManagement) Shutdown()
func (*OpenVpnManagement) StartClient ¶
func (vm *OpenVpnManagement) StartClient() error
Starts OpenVPN management interface in client mode Events are sent by OpenVPN
func (*OpenVpnManagement) StartServer ¶
func (vm *OpenVpnManagement) StartServer() error
Starts OpenVPN management interface in server mode Events are poled from the server
func (OpenVpnManagement) Status ¶
func (vm OpenVpnManagement) Status() (string, error)
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.