golint fixes

[govpn.git] / src / cypherpunks.ru / govpn / client / client.go

diff --git a/src/cypherpunks.ru/govpn/client/client.go b/src/cypherpunks.ru/govpn/client/client.go
index cfeba815de38bf0585a974aa0ea4311c540b688d..60e115dd1b2ebe7821fb72758fa9652a485de7ba 100644 (file)
--- a/src/cypherpunks.ru/govpn/client/client.go
+++ b/src/cypherpunks.ru/govpn/client/client.go
@@ -1,3 +1,21 @@
+/*
+GoVPN -- simple secure free software virtual private network daemon
+Copyright (C) 2014-2017 Sergey Matveev <stargrave@stargrave.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
 package client
 
 import (
@@ -12,13 +30,17 @@ import (
        "cypherpunks.ru/govpn"
 )
 
-type Protocol uint8
+// Protocol is a GoVPN supported protocol: UDP, TCP or both
+type Protocol int
 
 const (
+       // ProtocolUDP GoVPN over UDP
        ProtocolUDP Protocol = iota
+       // ProtocolTCP GoVPN over TCP
        ProtocolTCP
 )
 
+// Configuration hold GoVPN client configuration
 type Configuration struct {
        PrivateKey          *[ed25519.PrivateKeySize]byte
        Peer                *govpn.PeerConf
@@ -27,12 +49,14 @@ type Configuration struct {
        ProxyAddress        string
        ProxyAuthentication string
        RemoteAddress       string
-       UpPath, DownPath    string
+       UpPath              string
+       DownPath            string
        StatsAddress        string
        NoReconnect         bool
        MTU                 int
 }
 
+// Validate return an error if a configuration is invalid
 func (c *Configuration) Validate() error {
        if c.MTU > govpn.MTUMax {
                return fmt.Errorf("Invalid MTU %d, maximum allowable is %d", c.MTU, govpn.MTUMax)
@@ -50,6 +74,7 @@ func (c *Configuration) isProxy() bool {
        return len(c.ProxyAddress) > 0
 }
 
+// Client is a GoVPN client
 type Client struct {
        idsCache      *govpn.MACCache
        tap           *govpn.TAP
@@ -62,10 +87,11 @@ type Client struct {
        termSignal    chan os.Signal
        config        Configuration
 
-       // Error receive any error of all routines
+       // Error channel receives any kind of routine errors
        Error chan error
 }
 
+// MainCycle main loop of a connecting/connected client
 func (c *Client) MainCycle() {
        var err error
        c.tap, err = govpn.TAPListen(c.config.InterfaceName, c.config.MTU)
@@ -103,14 +129,14 @@ MainCycle:
                case <-c.termSignal:
                        govpn.BothPrintf(`[finish remote="%s"]`, c.config.RemoteAddress)
                        c.termination <- struct{}{}
-                       // send a non-error to let know everything went fine
+                       // empty value signals that everything is fine
                        c.Error <- nil
                        break MainCycle
                case <-c.timeouted:
                        if c.config.NoReconnect {
                                break MainCycle
                        }
-                       govpn.BothPrintf(`[sleep seconds="%d"]`, c.config.Peer.Timeout)
+                       govpn.BothPrintf(`[sleep seconds="%d"]`, c.config.Peer.Timeout/time.Second)
                        time.Sleep(c.config.Peer.Timeout)
                case <-c.rehandshaking:
                }
@@ -118,20 +144,25 @@ MainCycle:
                close(c.rehandshaking)
                close(c.termination)
        }
-       if _, err = govpn.ScriptCall(c.config.DownPath, c.config.InterfaceName, c.config.RemoteAddress); err != nil {
+       if _, err = govpn.ScriptCall(
+               c.config.DownPath,
+               c.config.InterfaceName,
+               c.config.RemoteAddress,
+       ); err != nil {
                c.Error <- err
        }
 }
 
+// NewClient return a configured GoVPN client, to trigger connection MainCycle must be executed
 func NewClient(conf Configuration, verifier *govpn.Verifier, termSignal chan os.Signal) *Client {
-       client := &Client{
+       client := Client{
                idsCache:    govpn.NewMACCache(),
                firstUpCall: true,
                config:      conf,
                termSignal:  termSignal,
                Error:       make(chan error, 1),
        }
-       confs := map[govpn.PeerId]*govpn.PeerConf{*verifier.Id: conf.Peer}
+       confs := map[govpn.PeerID]*govpn.PeerConf{*verifier.ID: conf.Peer}
        client.idsCache.Update(&confs)
-       return client
+       return &client
 }