wireguard

package

v0.5.0 Latest Latest Go to latest Published: Nov 24, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/karasz/gomesh

Links

Open Source Insights

Documentation ¶

Overview ¶

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index ¶

func GenerateKey() (string, error)
func PublicKey(a string) (string, error)
func SetOutput(out bool)
type Peer
type Peers
- func LoadPeers(peersPath string) (Peers, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GenerateKey ¶

func GenerateKey() (string, error)

GenerateKey will return a base64 encoded string suitable for using as a Wireguyard PrivateKey

func PublicKey ¶

func PublicKey(a string) (string, error)

PublicKey will return a base64 encoded public key from a base64 encoded PrivateKey

func SetOutput ¶ added in v0.4.0

func SetOutput(out bool)

SetOutput will instruct to use standard out if called with true argument or files if called with false

Types ¶

type Peer ¶

type Peer struct {
	Name       string
	PrivateKey string
	Address    []string
	ListenPort int
	Endpoint   string
	AllowedIPs []string
	FwMark     int
	DNS        string
	MTU        int
	Table      string
	PreUp      string
	PostUp     string
	PreDown    string
	PostDown   string
	SaveConfig bool
}

Peer is a Wireguard Peer

type Peers ¶

type Peers []Peer

Peers is a map containing all registered peers

func LoadPeers ¶

func LoadPeers(peersPath string) (Peers, error)

LoadPeers will load the register with Peers from the specified JSON file

func (Peers) AddPeer ¶

func (p Peers) AddPeer(pr Peer) error

AddPeer will add a Peer to the register

func (Peers) DeletePeer ¶

func (p Peers) DeletePeer(pr string)

DeletePeer will delete the named Peer from the register

func (Peers) DumpPeers ¶

func (p Peers) DumpPeers(overwrite bool) error

DumpPeers will generate a JSON file at the provided location with the registered Peers

func (Peers) GenerateConfigs ¶

func (p Peers) GenerateConfigs(folder string, peername string) error

GenerateConfigs will generate the Wireguard mesh configs in the specified folder

func (Peers) PrettyPrint ¶

func (p Peers) PrettyPrint(brief bool)

PrettyPrint will print a table with the peers

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL