}
}
-// VersionGet return version of GoVPN
+// VersionGet returns version of GoVPN
func VersionGet() string {
return "GoVPN version " + Version + " built with " + runtime.Version()
}
-// CatchSignalShutdown return a channel.
+// CatchSignalShutdown returns a channel.
// that channel will get a SIG_INT or SIG_KILL signal is received
// this is intended to be used to stop a client/server
func CatchSignalShutdown() chan interface{} {
return sum[len(sum)-8:], nil
}
-// HandshakeStarts start handshake's procedure from the client.
+// HandshakeStarts starts handshake's procedure from the client.
// It is the entry point for starting the handshake procedure.
// First handshake packet will be sent immediately.
func HandshakeStart(addr string, conn io.Writer, conf *PeerConf) (*Handshake, error) {
state := NewHandshake(addr, conn, conf)
- var (
- dhPubRepr *[32]byte
- err error
- )
+ var dhPubRepr *[32]byte
+ var err error
if state.dhPriv, dhPubRepr, err = dhKeypairGen(); err != nil {
return nil, errors.Wrap(err, "dhKeypairGen")
}
return buf.Bytes(), nil
}
-// NewLogger returns a logger for specified level. Syslog or Windows Events can be turned on.
+// NewLogger returns a logger for specified level. Syslog or Windows
+// Events can be turned on.
func NewLogger(level string, syslog bool) (*logrus.Logger, error) {
var logger *logrus.Logger
logLevel, err := logrus.ParseLevel(level)
noncesT chan *[NonceSize]byte
}
-// LogFields return a logrus compatible Fields to identity a single peer in logs
+// LogFields returns a logrus compatible Fields to identity a single
+// peer in logs
func (p *Peer) LogFields() logrus.Fields {
return logrus.Fields{
logPrefixPeer + "addr": p.Addr,
}
}
-// ConfigurationLogFields return a logrus compatible Fields with the settings of
-// a single peer. Complement LogFields() for extra debugging details.
+// ConfigurationLogFields returns a logrus compatible Fields with the
+// settings of a single peer. Complement LogFields() for extra debugging
+// details.
func (p *Peer) ConfigurationLogFields() logrus.Fields {
return logrus.Fields{
logPrefixPeer + "timeout": p.Timeout.String(),