Release v1.6.2

.gitmodules

@@ -43,3 +43,9 @@
 [submodule "vendor/github.com/prometheus/procfs"]
 	path = vendor/github.com/prometheus/procfs
 	url = https://github.com/prometheus/procfs
+[submodule "vendor/github.com/sasha-s/go-deadlock"]
+	path = vendor/github.com/sasha-s/go-deadlock
+	url = https://github.com/sasha-s/go-deadlock
+[submodule "vendor/github.com/petermattis/goid"]
+	path = vendor/github.com/petermattis/goid
+	url = https://github.com/petermattis/goid

.travis.yml

@@ -0,0 +1,8 @@
+language: go
+sudo: false
+go:
+  - tip
+before_install:
+  - go get github.com/mattn/goveralls
+script:
+  - $HOME/gopath/bin/goveralls -service=travis-ci

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Welcome to the contributing guide for eris!
+
+## Developers
+
+- James Mills [@prologic](https://github.com/prologic) (*uthor / Maintainer*)
+
+### Contributors
+
+- [@bear](https://github.com/bear)
+- [@DanielOaks](https://github.com/DanielOaks)
+- [@kzisme](https://github.com/kzisme)
+
+## New Features
+
+* [Create an Issue](https://github.com/prologic/eris/issues/new)
+
+* [Fork eris](https://github.com/prologic/eris#fork-destination-box)
+
+```bash
+$ git clone git@github.com:myuser/eris.git
+```
+
+* Create a new feature branch:
+
+```bash
+$ git checkout -b myfeature#issueN master
+```
+
+* Hack on your feature with your favorite editor
+* Commit and Push your changes up:
+
+```bash
+$ git add -A
+$ git commit -m "my fancy new feature"
+$ git push -u origin my-feature
+```
+
+* Create a new [Pull Request](https://github.com/prologic/eris/compare/)
+* Give the pull request an appropriate title possibly matching the issue
+* In the pull request's description include the text `Closes #N` or `Fixes #N`
+
+# Reporting Bugs
+
+* File a new [Bug Report](https://github.com/prologic/eris/issues/new)
+* Label it as a "Bug"
+
+When describing your bug report; please be concise and as detailed as you can
+so we can easily work out what the problem is. It's also very helpful if you
+are able to provide a test case that repeatedly demonstrates the bug at hand:

Makefile

@@ -6,7 +6,7 @@ APP=eris
 PACKAGE=irc
 REPO?=prologic/$(APP)
 TAG?=latest
-BUILD?=-dev
+BUILD?=dev
 
 all: dev
 

README.md

@@ -1,5 +1,11 @@
 # eris - IRC Server / Daemon written in Go
 
+[![Build Status](https://travis-ci.org/prologic/eris.svg)](https://travis-ci.org/prologic/eris)
+[![Go Report Card](https://goreportcard.com/badge/github.com/prologic/eris)](https://goreportcard.com/report/github.com/prologic/eris)
+[![Coverage](https://coveralls.io/repos/prologic/eris/badge.svg)](https://coveralls.io/r/prologic/eris)
+[![GoDoc](https://godoc.org/github.com/prologic/eris?status.svg)](https://godoc.org/github.com/prologic/eris)
+[![Wiki](https://img.shields.io/badge/docs-wiki-blue.svg)](https://github.com/prologic/eris/wiki)
+
 > This project and repository is based off of [ergonomadic](https://github.com/edmund-huber/ergonomadic)
 > and much of my original contributions were made in my [fork of ergonomadic](https://github.com/prologic/ergonomadic)
 > but the upstream project was ultimately shutdown.
@@ -49,6 +55,40 @@ Or (*not recommended*)P
 * Secure connection tracking (+z) and SecureOnly user mode (+Z)
 * Secure channels (+Z)
 
+## Quick Start
+
+```#!bash
+$ go get github.com/prologic/eris
+$ cat > ircd.yml <<EOF
+network:
+  name: Test
+server:
+  name: Test
+  listen:
+    - ":6667"
+EOF
+$ eris
+```
+
+If you want TLS (**recommended**) then:
+
+```#!bash
+$ go get github.com/prologic/mksslcert
+$ mksslcert
+```
+
+This generates a self-signed cert `cert.pem` and `key.pem` into the `$PWD`.
+
+Then add a `tlslisten` block to your config:
+
+```#!yaml
+server:
+  tlslisten:
+    ":6697":
+      key: key.pem
+      cert: cert.pem
+```
+
 ## Installation
 
 ```#!bash
@@ -67,6 +107,14 @@ $ go install github.com/prologic/mkpasswd
 $ mkpasswd
 ```
 
+Self-signed certificates can also be generated using the `mksslcert` tool
+from [prologic/mksslcert](https://github.com/prologic/mksslcert):
+
+```#!bash
+$ go install github.com/prologic/mksslcert
+$ mksslcert
+```
+
 ## Deployment
 
 To run simply run the `eris` binary (*assuming a `ircd.yml` in the current directory*):
@@ -94,7 +142,7 @@ Which assumes a `ircd.yml` coniguration fiel int he current directory which Dock
 There are a number of supported accompanying services that are being developed alongside Eris:
 
 * [Soter](https://github.com/prologic/soter) -- An IRC Bot that persists channel modes and topics.
-* [Cadmus](https://github.com/prologic/cadmus) -- An IRC Bot that logs channels and provides an interface for viewing and searching logs (*Coming soon...*)
+* [Cadmus](https://github.com/prologic/cadmus) -- An IRC Bot that logs channels and provides an interface for viewing and searching logs
 
 ## License
 

irc/channel.go

@@ -155,16 +155,16 @@ func (channel *Channel) Join(client *Client, key Text) {
 		return
 	}
 
-	isInvited := channel.lists[InviteMask].Match(client.UserHost())
+	isInvited := channel.lists[InviteMask].Match(client.UserHost(false))
 	if !isOperator && channel.flags.Has(InviteOnly) && !isInvited {
 		client.ErrInviteOnlyChan(channel)
 		return
 	}
 
-	if channel.lists[BanMask].Match(client.UserHost()) &&
+	if channel.lists[BanMask].Match(client.UserHost(false)) &&
 		!isInvited &&
 		!isOperator &&
-		!channel.lists[ExceptMask].Match(client.UserHost()) {
+		!channel.lists[ExceptMask].Match(client.UserHost(false)) {
 		client.ErrBannedFromChan(channel)
 		return
 	}
@@ -508,7 +508,7 @@ func (channel *Channel) Invite(invitee *Client, inviter *Client) {
 	}
 
 	if channel.flags.Has(InviteOnly) {
-		channel.lists[InviteMask].Add(invitee.UserHost())
+		channel.lists[InviteMask].Add(invitee.UserHost(false))
 	}
 
 	inviter.RplInviting(invitee, channel.name)

irc/client.go

@@ -26,6 +26,7 @@ type Client struct {
 	hasQuit      bool
 	hops         uint
 	hostname     Name
+	hostmask     Name // Cloacked hostname (SHA256)
 	pingTime     time.Time
 	idleTimer    *time.Timer
 	nick         Name
@@ -83,6 +84,7 @@ func (client *Client) readloop() {
 
 	// Set the hostname for this client.
 	client.hostname = AddrLookupHostname(client.socket.conn.RemoteAddr())
+	client.hostmask = NewName(SHA256(client.hostname.String()))
 
 	for err == nil {
 		if line, err = client.socket.Read(); err != nil {
@@ -279,11 +281,14 @@ func (c *Client) ModeString() (str string) {
 	return
 }
 
-func (c *Client) UserHost() Name {
+func (c *Client) UserHost(cloacked bool) Name {
 	username := "*"
 	if c.HasUsername() {
 		username = c.username.String()
 	}
+	if cloacked {
+		return Name(fmt.Sprintf("%s!%s@%s", c.Nick(), username, c.hostmask))
+	}
 	return Name(fmt.Sprintf("%s!%s@%s", c.Nick(), username, c.hostname))
 }
 
@@ -303,7 +308,7 @@ func (c *Client) Nick() Name {
 }
 
 func (c *Client) Id() Name {
-	return c.UserHost()
+	return c.UserHost(true)
 }
 
 func (c *Client) String() string {

irc/client_lookup_set.go

@@ -105,7 +105,7 @@ func (clients *ClientLookupSet) FindAll(userhost Name) *ClientSet {
 
 	var casemappedNickMask string
 	for _, client := range clients.nicks {
-		casemappedNickMask = client.UserHost().String()
+		casemappedNickMask = client.UserHost(false).String()
 		if matcher.Match(casemappedNickMask) {
 			set.Add(client)
 		}
@@ -123,7 +123,7 @@ func (clients *ClientLookupSet) Find(userhost Name) *Client {
 
 	var casemappedNickMask string
 	for _, client := range clients.nicks {
-		casemappedNickMask = client.UserHost().String()
+		casemappedNickMask = client.UserHost(false).String()
 		if matcher.Match(casemappedNickMask) {
 			return client
 		}

irc/config.go

@@ -33,6 +33,10 @@ type Config struct {
 	sync.Mutex
 	filename string
 
+	Network struct {
+		Name string
+	}
+
 	Server struct {
 		PassConfig  `yaml:",inline"`
 		Listen      []string
@@ -97,6 +101,10 @@ func LoadConfig(filename string) (config *Config, err error) {
 
 	config.filename = filename
 
+	if config.Network.Name == "" {
+		return nil, errors.New("Network name missing")
+	}
+
 	if config.Server.Name == "" {
 		return nil, errors.New("Server name missing")
 	}

irc/password.go

@@ -68,7 +68,7 @@ func (store *MemoryPasswordStore) Verify(username, password string) error {
 	hash, ok := store.Get(username)
 	if !ok {
 		log.Debugf("username %s not found", username)
-		return fmt.Errorf("account not found: %S", username)
+		return fmt.Errorf("account not found: %s", username)
 	}
 
 	return store.hasher.Compare(hash, []byte(password))

irc/reply.go

@@ -173,8 +173,12 @@ func RplCap(client *Client, subCommand CapSubCommand, arg interface{}) string {
 // numeric replies
 
 func (target *Client) RplWelcome() {
-	target.NumericReply(RPL_WELCOME,
-		":Welcome to the Internet Relay Network %s", target.Id())
+	target.NumericReply(
+		RPL_WELCOME,
+		":Welcome to the %s Internet Relay Network %s",
+		target.server.Network(),
+		target.Id(),
+	)
 }
 
 func (target *Client) RplYourHost() {
@@ -260,9 +264,22 @@ func (target *Client) RplWhois(client *Client) {
 }
 
 func (target *Client) RplWhoisUser(client *Client) {
-	target.NumericReply(RPL_WHOISUSER,
-		"%s %s %s * :%s", client.Nick(), client.username, client.hostname,
-		client.realname)
+	var clientHost Name
+
+	if target.flags[Operator] {
+		clientHost = client.hostname
+	} else {
+		clientHost = client.hostmask
+	}
+
+	target.NumericReply(
+		RPL_WHOISUSER,
+		"%s %s %s * :%s",
+		client.Nick(),
+		client.username,
+		clientHost,
+		client.realname,
+	)
 }
 
 func (target *Client) RplWhoisOperator(client *Client) {
@@ -320,6 +337,14 @@ func (target *Client) RplChannelModeIs(channel *Channel) {
 // <channel> <user> <host> <server> <nick> ( "H" / "G" ) ["*"] [ ( "@" / "+" ) ]
 // :<hopcount> <real name>
 func (target *Client) RplWhoReply(channel *Channel, client *Client) {
+	var clientHost Name
+
+	if target.flags[Operator] {
+		clientHost = client.hostname
+	} else {
+		clientHost = client.hostmask
+	}
+
 	channelName := "*"
 	flags := ""
 
@@ -349,9 +374,18 @@ func (target *Client) RplWhoReply(channel *Channel, client *Client) {
 			}
 		}
 	}
-	target.NumericReply(RPL_WHOREPLY,
-		"%s %s %s %s %s %s :%d %s", channelName, client.username, client.hostname,
-		client.server.name, client.Nick(), flags, client.hops, client.realname)
+	target.NumericReply(
+		RPL_WHOREPLY,
+		"%s %s %s %s %s %s :%d %s",
+		channelName,
+		client.username,
+		clientHost,
+		client.server.name,
+		client.Nick(),
+		flags,
+		client.hops,
+		client.realname,
+	)
 }
 
 // <name> :End of WHO list
@@ -562,9 +596,22 @@ func (target *Client) RplLUserMe() {
 }
 
 func (target *Client) RplWhoWasUser(whoWas *WhoWas) {
-	target.NumericReply(RPL_WHOWASUSER,
+	var whoWasHost Name
+
+	if target.flags[Operator] {
+		whoWasHost = whoWas.hostname
+	} else {
+		whoWasHost = whoWas.hostmask
+	}
+
+	target.NumericReply(
+		RPL_WHOWASUSER,
 		"%s %s %s * :%s",
-		whoWas.nickname, whoWas.username, whoWas.hostname, whoWas.realname)
+		whoWas.nickname,
+		whoWas.username,
+		whoWasHost,
+		whoWas.realname,
+	)
 }
 
 func (target *Client) RplEndOfWhoWas(nickname Name) {

irc/server.go

@@ -37,6 +37,7 @@ type Server struct {
 	idle        chan *Client
 	motdFile    string
 	name        Name
+	network     Name
 	description string
 	newConns    chan net.Conn
 	operators   map[Name][]byte
@@ -63,6 +64,7 @@ func NewServer(config *Config) *Server {
 		idle:        make(chan *Client),
 		motdFile:    config.Server.MOTD,
 		name:        NewName(config.Server.Name),
+		network:     NewName(config.Network.Name),
 		description: config.Server.Description,
 		newConns:    make(chan net.Conn),
 		operators:   config.Operators(),
@@ -314,6 +316,7 @@ func (s *Server) Rehash() error {
 
 	s.motdFile = s.config.Server.MOTD
 	s.name = NewName(s.config.Server.Name)
+	s.network = NewName(s.config.Network.Name)
 	s.description = s.config.Server.Description
 	s.operators = s.config.Operators()
 
@@ -324,6 +327,10 @@ func (s *Server) Id() Name {
 	return s.name
 }
 
+func (s *Server) Network() Name {
+	return s.network
+}
+
 func (s *Server) String() string {
 	return s.name.String()
 }

irc/utils.go

@@ -0,0 +1,11 @@
+package irc
+
+import (
+	"crypto/sha256"
+	"fmt"
+)
+
+func SHA256(data string) string {
+	hash := sha256.Sum256([]byte(data))
+	return fmt.Sprintf("%x", hash)
+}

irc/version.go

@@ -1,14 +1,18 @@
 package irc
 
+import (
+	"fmt"
+)
+
 var (
 	//PackageName package name
 	Package = "eris"
 
 	// Version release version
-	Version = "1.6.0"
+	Version = "1.6.2"
 
 	// Build will be overwritten automatically by the build system
-	Build = "-dev"
+	Build = "dev"
 
 	// GitCommit will be overwritten automatically by the build system
 	GitCommit = "HEAD"
@@ -16,5 +20,5 @@ var (
 
 // FullVersion display the full version and build
 func FullVersion() string {
-	return Package + " v" + Version + Build + " (" + GitCommit + ")"
+	return fmt.Sprintf("%s-%s-%s@%s", Package, Version, Build, GitCommit)
 }

irc/whowas.go

@@ -17,6 +17,7 @@ type WhoWas struct {
 	nickname Name
 	username Name
 	hostname Name
+	hostmask Name
 	realname Text
 }
 
@@ -33,6 +34,7 @@ func (list *WhoWasList) Append(client *Client) {
 		nickname: client.Nick(),
 		username: client.username,
 		hostname: client.hostname,
+		hostmask: client.hostmask,
 		realname: client.realname,
 	}
 	list.end = (list.end + 1) % len(list.buffer)

ircd.yml

@@ -1,3 +1,7 @@
+network:
+  # network name
+  name: Local
+
 server:
   # server name
   name: localhost.localdomain

scripts/release.sh

@@ -21,7 +21,7 @@ fi
 echo -n "Building binaries ... "
 
 GOOS=linux GOARCH=amd64 go build -o ./bin/eris-Linux-x86_64 .
-GOOS=linux GOARCH=arm64 go build -o ./bin/eris-Linux-x86_64 .
+GOOS=linux GOARCH=arm64 go build -o ./bin/eris-Linux-arm_64 .
 GOOS=darwin GOARCH=amd64 go build -o ./bin/eris-Darwin-x86_64 .
 GOOS=windows GOARCH=amd64 go build -o ./bin/eris-Windows-x86_64.exe .