Compare commits
43 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
a6c6ddd155 | ||
|
|
e5cec00ab9 | ||
|
|
8c73a63311 | ||
|
|
0b121f8cb3 | ||
|
|
867ca0560d | ||
|
|
4871e65a82 | ||
|
|
2500a11831 | ||
|
|
a08fddfb00 | ||
|
|
7adf919eb6 | ||
|
|
96fc79f2ec | ||
|
|
e6bb174667 | ||
|
|
5d1e21401a | ||
|
|
75ddd24710 | ||
|
|
7b097119b3 | ||
|
|
59fefebb3b | ||
|
|
5fcf1a9ebd | ||
|
|
d4bdf43bfe | ||
|
|
c792d21e93 | ||
|
|
48a91b87cb | ||
|
|
4045bbb373 | ||
|
|
a22f7d20d5 | ||
|
|
66473209bd | ||
|
|
7bffda6818 | ||
|
|
73fe81d8d1 | ||
|
|
a5c2783e8f | ||
|
|
7eee870172 | ||
|
|
c960f84603 | ||
|
|
04475f172e | ||
|
|
d9c72ac9ee | ||
|
|
c63c6c659e | ||
|
|
91ad6cf100 | ||
|
|
6ff4194c85 | ||
|
|
491b82d735 | ||
|
|
a85762e2c7 | ||
|
|
186e949cb0 | ||
|
|
67698b4fa2 | ||
|
|
666d4b3fc9 | ||
|
|
07cbec85ee | ||
|
|
0c960873e7 | ||
|
|
8c414e2cc8 | ||
|
|
c15d706a4e | ||
|
|
c4bc115f49 | ||
|
|
558e0208f1 |
5
.gitignore
vendored
5
.gitignore
vendored
@@ -1,3 +1,8 @@
|
||||
*.swp
|
||||
/catbox
|
||||
/test-net
|
||||
*.crt
|
||||
*.crl
|
||||
*.pem
|
||||
terrarium
|
||||
terrarium.exe
|
||||
|
||||
@@ -4,7 +4,6 @@ builds:
|
||||
- linux
|
||||
goarch:
|
||||
- amd64
|
||||
- arm
|
||||
archive:
|
||||
wrap_in_directory: true
|
||||
files:
|
||||
|
||||
151
CHANGELOG.html
Normal file
151
CHANGELOG.html
Normal file
@@ -0,0 +1,151 @@
|
||||
<html>
|
||||
<head>
|
||||
<title></title>
|
||||
<meta name="author" content="eyedeekay" />
|
||||
<meta name="description" content="terrarium.git" />
|
||||
<meta name="keywords" content="master" />
|
||||
<link rel="stylesheet" type="text/css" href="style.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="navbar">
|
||||
<a href="#shownav">
|
||||
Show navigation
|
||||
</a>
|
||||
<div id="shownav">
|
||||
<div id="hidenav">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="index.html">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CHANGELOG.html">
|
||||
CHANGELOG
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<br>
|
||||
<a href="#hidenav">
|
||||
Hide Navigation
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<h1>
|
||||
0.0.08
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
include license in plugin package
|
||||
</li>
|
||||
<li>
|
||||
fix license in plugin config
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
0.0.07
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
restart changelog.
|
||||
</li>
|
||||
<li>
|
||||
fix websiteURL in plugin.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.14.0
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Stop publishing arm releases.
|
||||
</li>
|
||||
<li>
|
||||
Support TLS 1.3.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.13.0 (2019-07-08)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Include Go version in version string.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.12.0 (2019-07-06)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Update dependencies.
|
||||
</li>
|
||||
<li>
|
||||
Send messages during connect immediately rather than only after we’ve
|
||||
performed our reverse DNS lookup.
|
||||
</li>
|
||||
<li>
|
||||
Stop logging client reads/writes.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.11.0 (2019-01-01)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
No longer automatically rehash once a week. I changed my mind about this!
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.10.0 (2018-08-18)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Rehashing now reloads the TLS certificate and key.
|
||||
</li>
|
||||
<li>
|
||||
Rehashing now automatically happens once a week. This is so we load new
|
||||
certificates.
|
||||
</li>
|
||||
<li>
|
||||
Require valid TLS certificates on outbound TLS connections. This means
|
||||
servers we connect to must have valid certificates that match the name we
|
||||
connect to them as.
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
1.9.0 (2018-07-28)
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Started tracking changes in a changelog.
|
||||
</li>
|
||||
<li>
|
||||
If a message is invalid, send a notice to opers about it rather than just
|
||||
log. This is to catch bugs arising from this behaviour.
|
||||
</li>
|
||||
<li>
|
||||
Send a notice to opers if there is an unprocessed buffer after a read
|
||||
error. This is again to catch bugs from this behaviour.
|
||||
</li>
|
||||
<li>
|
||||
Failing to set read deadlines now logs rather than triggers client quit.
|
||||
This is to allow for the read to happen which can have data in the
|
||||
buffer.
|
||||
</li>
|
||||
<li>
|
||||
Delay before flagging the client as dead if there is a write error. This
|
||||
is to give us a window to read anything further from the client that
|
||||
might be available.
|
||||
</li>
|
||||
</ul>
|
||||
<div>
|
||||
<iframe src="https://snowflake.torproject.org/embed.html" width="320" height="240" frameborder="0" scrolling="no"></iframe>
|
||||
</div>
|
||||
<div>
|
||||
<a href="https://geti2p.net/">
|
||||
I2P
|
||||
</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
16
CHANGELOG.md
16
CHANGELOG.md
@@ -1,3 +1,19 @@
|
||||
# 0.0.08
|
||||
|
||||
- include license in plugin package
|
||||
- fix license in plugin config
|
||||
|
||||
# 0.0.07
|
||||
|
||||
- restart changelog.
|
||||
- fix websiteURL in plugin.
|
||||
|
||||
# 1.14.0
|
||||
|
||||
* Stop publishing arm releases.
|
||||
* Support TLS 1.3.
|
||||
|
||||
|
||||
# 1.13.0 (2019-07-08)
|
||||
|
||||
* Include Go version in version string.
|
||||
|
||||
122
Makefile
Normal file
122
Makefile
Normal file
@@ -0,0 +1,122 @@
|
||||
VERSION=1.14.0
|
||||
CGO_ENABLED=0
|
||||
export CGO_ENABLED=0
|
||||
|
||||
GOOS?=$(shell uname -s | tr A-Z a-z)
|
||||
GOARCH?="amd64"
|
||||
|
||||
ARG=-v -tags netgo -ldflags '-w -extldflags "-static"'
|
||||
|
||||
BINARY=terrarium
|
||||
SIGNER=hankhill19580@gmail.com
|
||||
CONSOLEPOSTNAME=IRC
|
||||
USER_GH=eyedeekay
|
||||
|
||||
build: dep
|
||||
go build $(ARG) -tags="netgo" -o $(BINARY)-$(GOOS)-$(GOARCH) ./cmd/$(BINARY)
|
||||
make su3
|
||||
|
||||
clean:
|
||||
rm -f $(BINARY)-plugin plugin $(BINARY)-*zip -r
|
||||
rm -f *.su3 *.zip $(BINARY)-$(GOOS)-$(GOARCH) $(BINARY)-*
|
||||
|
||||
all: windows linux osx bsd
|
||||
|
||||
windows:
|
||||
GOOS=windows GOARCH=amd64 make build su3
|
||||
GOOS=windows GOARCH=386 make build su3
|
||||
|
||||
linux:
|
||||
GOOS=linux GOARCH=amd64 make build su3
|
||||
GOOS=linux GOARCH=arm64 make build su3
|
||||
GOOS=linux GOARCH=386 make build su3
|
||||
|
||||
osx:
|
||||
GOOS=darwin GOARCH=amd64 make build su3
|
||||
GOOS=darwin GOARCH=arm64 make build su3
|
||||
|
||||
bsd:
|
||||
GOOS=freebsd GOARCH=amd64 make build su3
|
||||
GOOS=openbsd GOARCH=amd64 make build su3
|
||||
|
||||
dep:
|
||||
# cp "$(HOME)/build/shellservice.jar" conf/lib/shellservice.jar -v
|
||||
|
||||
SIGNER_DIR=$(HOME)/i2p-go-keys/
|
||||
|
||||
su3:
|
||||
i2p.plugin.native -name=$(BINARY)-$(GOOS)-$(GOARCH) \
|
||||
-signer=$(SIGNER) \
|
||||
-signer-dir=$(SIGNER_DIR) \
|
||||
-version "$(VERSION)" \
|
||||
-author=$(SIGNER) \
|
||||
-autostart=true \
|
||||
-clientname=$(BINARY)-$(GOOS)-$(GOARCH) \
|
||||
-consolename="$(BINARY) - $(CONSOLEPOSTNAME)" \
|
||||
-name="$(BINARY)-$(GOOS)-$(GOARCH)" \
|
||||
-delaystart="1" \
|
||||
-desc="`cat desc`" \
|
||||
-exename=$(BINARY)-$(GOOS)-$(GOARCH) \
|
||||
-icondata=icon/icon.png \
|
||||
-updateurl="http://idk.i2p/$(BINARY)/$(BINARY)-$(GOOS)-$(GOARCH).su3" \
|
||||
-website="http://idk.i2p/$(BINARY)/" \
|
||||
-command="$(BINARY)-$(GOOS)-$(GOARCH) -conf \"\$$PLUGIN/catbox-i2p.conf\"" \
|
||||
-license=AGPL \
|
||||
-res=conf/
|
||||
unzip -o $(BINARY)-$(GOOS)-$(GOARCH).zip -d $(BINARY)-$(GOOS)-$(GOARCH)-zip
|
||||
|
||||
sum:
|
||||
sha256sum $(BINARY)-$(GOOS)-$(GOARCH).su3
|
||||
|
||||
version:
|
||||
gothub release -u eyedeekay -r $(BINARY) -t "$(VERSION)" -d "`cat desc`"; true
|
||||
|
||||
upload:
|
||||
gothub upload -R -u eyedeekay -r $(BINARY) -t "$(VERSION)" -f $(BINARY)-$(GOOS)-$(GOARCH).su3 -n $(BINARY)-$(GOOS)-$(GOARCH).su3 -l "`sha256sum $(BINARY)-$(GOOS)-$(GOARCH).su3`"
|
||||
|
||||
upload-windows:
|
||||
GOOS=windows GOARCH=amd64 make upload
|
||||
GOOS=windows GOARCH=386 make upload
|
||||
|
||||
upload-linux:
|
||||
GOOS=linux GOARCH=amd64 make upload
|
||||
GOOS=linux GOARCH=arm64 make upload
|
||||
GOOS=linux GOARCH=386 make upload
|
||||
|
||||
upload-osx:
|
||||
GOOS=darwin GOARCH=amd64 make upload
|
||||
GOOS=darwin GOARCH=arm64 make upload
|
||||
|
||||
upload-bsd:
|
||||
GOOS=freebsd GOARCH=amd64 make upload
|
||||
GOOS=openbsd GOARCH=amd64 make upload
|
||||
|
||||
upload-all: upload-windows upload-linux upload-osx upload-bsd
|
||||
|
||||
download-su3s:
|
||||
GOOS=windows GOARCH=amd64 make download-single-su3
|
||||
GOOS=windows GOARCH=386 make download-single-su3
|
||||
GOOS=linux GOARCH=amd64 make download-single-su3
|
||||
GOOS=linux GOARCH=arm64 make download-single-su3
|
||||
GOOS=linux GOARCH=386 make download-single-su3
|
||||
GOOS=darwin GOARCH=amd64 make download-single-su3
|
||||
GOOS=darwin GOARCH=arm64 make download-single-su3
|
||||
GOOS=freebsd GOARCH=amd64 make download-single-su3
|
||||
GOOS=openbsd GOARCH=amd64 make download-single-su3
|
||||
|
||||
download-single-su3:
|
||||
wget-ds "https://github.com/$(USER_GH)/$(BINARY)/releases/download/$(VERSION)/$(BINARY)-$(GOOS)-$(GOARCH).su3"
|
||||
|
||||
release: clean all version upload-all
|
||||
|
||||
index:
|
||||
@echo "<!DOCTYPE html>" > index.html
|
||||
@echo "<html>" >> index.html
|
||||
@echo "<head>" >> index.html
|
||||
@echo " <title>$(BINARY) - $(CONSOLEPOSTNAME)</title>" >> index.html
|
||||
@echo " <link rel=\"stylesheet\" type=\"text/css\" href =\"/style.css\" />" >> index.html
|
||||
@echo "</head>" >> index.html
|
||||
@echo "<body>" >> index.html
|
||||
pandoc README.md >> index.html
|
||||
@echo "</body>" >> index.html
|
||||
@echo "</html>" >> index.html
|
||||
72
README.md
72
README.md
@@ -1,12 +1,17 @@
|
||||
|
||||
# 
|
||||
|
||||
[](https://travis-ci.org/horgh/catbox)
|
||||
Status](https://travis-ci.org/eyedeekay/terrarium.svg)](https://travis-ci.org/eyedeekay/terrarium)
|
||||
[](https://goreportcard.com/report/github.com/horgh/catbox)
|
||||
Card](https://goreportcard.com/badge/i2pgit.org/idk/terrarium)](https://goreportcard.com/report/i2pgit.org/idk/terrarium)
|
||||
|
||||
catbox is an IRC server with a focus on being small and understandable. The
|
||||
goal is security.
|
||||
terrarium is an IRC server with a focus on being small and understandable,
|
||||
originally forked from [horgh/catbox](https://github.com/horgh/catbox). The
|
||||
goal is to create an easy-to-configure I2P IRC server which is highly stable
|
||||
and secure, while retaining the ability to link with non-I2P IRC servers using
|
||||
TLS in order to bridge anonymous and non-anonymous chat. For now, Bridged
|
||||
servers are not anonymous, this may change in the future as I evaluate the
|
||||
feasibility of outproxies or Tor.
|
||||
|
||||
|
||||
# Features
|
||||
@@ -17,24 +22,48 @@ goal is security.
|
||||
* K: line style connection banning
|
||||
* TLS
|
||||
|
||||
catbox implements enough of [RFC 1459](https://tools.ietf.org/html/rfc1459)
|
||||
to be recognisable as IRC and be minimally functional. I likely won't add
|
||||
much more and don't intend it to be complete. If I don't think something is
|
||||
required it likely won't be here.
|
||||
terrarium implements enough of [RFC 1459](https://tools.ietf.org/html/rfc1459)
|
||||
to be recognisable as IRC and be minimally functional. It will intentionally
|
||||
omit unnecessary features. Priority features are those which enable moderation
|
||||
and provide more flexible security.
|
||||
|
||||
# Plugin Installation URL's
|
||||
|
||||
[A guide to installing I2P plugins can be found on the I2P web site.](https://geti2p.net/en/docs/plugins)
|
||||
|
||||
### Inside I2P
|
||||
|
||||
- [Windows (In-I2P)](http://idk.i2p/terrarium/terrarium-windows-amd64.su3)
|
||||
- [Linux (In-I2P)](http://idk.i2p/terrarium/terrarium-linux-amd64.su3)
|
||||
|
||||
### Outside I2P
|
||||
|
||||
- [Windows](https://github.com/terrarium/blizzard/releases)
|
||||
- [Linux](https://github.com/terrarium/blizzard/releases)
|
||||
|
||||
# Installation
|
||||
1. Download catbox from the Releases tab on GitHub, or build from source
|
||||
1. Clone the software from [i2pgit.org](https://i2pgit.org/idk/terrarium)
|
||||
(`git clone https://i2pgit.org/idk/terrarium go/src/i2pgit.org/idk/terrarium && cd go/src/i2pgit.org/idk/terrarium`).
|
||||
2. Build from source
|
||||
(`go build`).
|
||||
2. Configure catbox through config files. There are example configs in the
|
||||
3. Configure terrarium through config files. There are example configs in the
|
||||
`conf` directory. All settings are optional and have defaults.
|
||||
3. Run it, e.g. `./catbox -conf catbox.conf`. I typically run catbox
|
||||
inside tmux using [this program](bin/tmux-run.sh).
|
||||
4. Run it, e.g. `./terrarium -conf terrarium.conf`. You might run it via systemd
|
||||
via a service such as:
|
||||
|
||||
```
|
||||
[Service]
|
||||
ExecStart=/home/ircd/terrarium/terrarium -conf /home/ircd/terrarium/terrarium.conf
|
||||
Restart=always
|
||||
|
||||
[Install]
|
||||
WantedBy=default.target
|
||||
```
|
||||
|
||||
|
||||
# Configuration
|
||||
|
||||
## catbox.conf
|
||||
## terrarium.conf
|
||||
Global server settings.
|
||||
|
||||
|
||||
@@ -64,10 +93,19 @@ Clients connect to the network hostname and verify against it. Servers
|
||||
connect to each other by server hostname and verify against it.
|
||||
|
||||
|
||||
## I2P
|
||||
An example I2P configuration can be found in:
|
||||
|
||||
`conf/catbox-i2p.conf`
|
||||
|
||||
That's all the docs I have for now
|
||||
|
||||
# Why the name?
|
||||
My domain name is summercat.com, cats love boxes, and a tribute to
|
||||
ircd-ratbox, the IRC daemon I used in the past.
|
||||
It was forked from an IRC server called catbox which had a focus on simplicity
|
||||
and understandability. It now has the ability to connect to other IRC servers
|
||||
through I2P Tunnels. Clearnet is to I2P Tunnels is sort of like Catbox is to
|
||||
Terrarium.
|
||||
|
||||
|
||||
# Logo
|
||||
catbox logo (c) 2017 Bee
|
||||
terrarium logo (c) 2017 Bee
|
||||
|
||||
4
args.go
4
args.go
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"flag"
|
||||
@@ -13,7 +13,7 @@ type Args struct {
|
||||
ListenFD int
|
||||
}
|
||||
|
||||
func getArgs() *Args {
|
||||
func GetArgs() *Args {
|
||||
configFile := flag.String("conf", "", "Configuration file.")
|
||||
fd := flag.Int("listen-fd", -1,
|
||||
"File descriptor with listening port to use (optional).")
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# This is a way to run catbox in a tmux session.
|
||||
#
|
||||
# It runs in such a way as if catbox exits, the tmux window stays around so
|
||||
# that we can inspect catbox's recent output. This is useful for debugging.
|
||||
#
|
||||
# It would probably be better to run catbox via systemd or something, but I
|
||||
# don't want catbox's output to be logged anywhere. I only want recent output
|
||||
# to be accessible. Possibly systemd could be made to do that, but anyway.
|
||||
|
||||
set -e
|
||||
|
||||
tmux start-server
|
||||
tmux new-session -d -s catbox
|
||||
|
||||
tmux set-option -g set-remain-on-exit on
|
||||
tmux set-option -g history-limit 10000
|
||||
tmux set-option -g prefix2 C-a
|
||||
tmux set-option -g prefix C-a
|
||||
tmux bind-key C-a send-prefix
|
||||
tmux set-window-option -g mode-keys vi
|
||||
|
||||
tmux new-window /home/ircd/catbox/catbox -conf /home/ircd/catbox/catbox.conf
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import "github.com/horgh/irc"
|
||||
|
||||
|
||||
55
cmd/terrarium/catbox.go
Normal file
55
cmd/terrarium/catbox.go
Normal file
@@ -0,0 +1,55 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"log"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"syscall"
|
||||
|
||||
"i2pgit.org/idk/terrarium"
|
||||
)
|
||||
|
||||
func main() {
|
||||
log.SetFlags(log.Ldate | log.Ltime)
|
||||
log.SetOutput(os.Stdout)
|
||||
|
||||
args := terrarium.GetArgs()
|
||||
if args == nil {
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
binPath, err := filepath.Abs(os.Args[0])
|
||||
if err != nil {
|
||||
log.Fatalf("Unable to determine absolute path to binary: %s: %s",
|
||||
os.Args[0], err)
|
||||
}
|
||||
|
||||
cb, err := terrarium.NewCatbox(args.ConfigFile)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if err := cb.Start(args.ListenFD); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if cb.Restart {
|
||||
log.Printf("Shutdown completed. Restarting...")
|
||||
|
||||
if err := syscall.Exec( // nolint: gas
|
||||
binPath,
|
||||
[]string{
|
||||
binPath,
|
||||
"-conf",
|
||||
cb.ConfigFile,
|
||||
},
|
||||
nil,
|
||||
); err != nil {
|
||||
log.Fatalf("Restart failed: %s", err)
|
||||
}
|
||||
|
||||
log.Fatalf("not reached")
|
||||
}
|
||||
|
||||
log.Printf("Server shutdown cleanly.")
|
||||
}
|
||||
661
conf/LICENSE
Normal file
661
conf/LICENSE
Normal file
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
61
conf/catbox-i2p.conf
Normal file
61
conf/catbox-i2p.conf
Normal file
@@ -0,0 +1,61 @@
|
||||
# The main terrarium config.
|
||||
#
|
||||
# The commented options are the defaults which are used if you do not specify
|
||||
# the option.
|
||||
|
||||
# Host to listen on.
|
||||
listen-host = 127.0.0.1
|
||||
|
||||
# Port to listen on. Set -1 to not listen.
|
||||
listen-port = 7667
|
||||
|
||||
# Port to listen on (TLS). Set -1 to not listen.
|
||||
listen-port-tls = -1
|
||||
|
||||
listen-i2p = terrarium.i2p
|
||||
sam-address = 127.0.0.1:7656
|
||||
|
||||
# File containing server certificate for TLS. PEM encoded.
|
||||
# Must be set if you have a TLS listen port.
|
||||
#certificate-file =
|
||||
|
||||
# File containing server key for TLS. PEM encoded.
|
||||
# Must be set if you have a TLS listen port.
|
||||
#key-file =
|
||||
|
||||
# Name server goes by.
|
||||
server-name = irc.terrarium.i2p
|
||||
|
||||
# Short info line (shown in WHOIS).
|
||||
#server-info = IRC
|
||||
|
||||
# MOTD. Only one line at this time.
|
||||
#motd = Hello this is terrarium
|
||||
|
||||
# Maximum nick length. RFCs say 9, but longer is okay.
|
||||
#max-nick-length = 9
|
||||
|
||||
# Maximum period of time a client can be idle before we ping it.
|
||||
#ping-time = 30s
|
||||
|
||||
# Maximum period of time a client can be idle before we consider it dead.
|
||||
#dead-time = 240s
|
||||
|
||||
# Time to wait between attempts connecting to servers (minimum).
|
||||
#connect-attempt-time = 60s
|
||||
|
||||
# TS6 SID. Must be unique in the network. Format: [0-9][A-Z0-9]{2}
|
||||
#ts6-sid = 000
|
||||
|
||||
# Administrator's email. It gets displayed in some errors.
|
||||
#admin-email =
|
||||
|
||||
# Path to opers configuration. This defines server operators.
|
||||
#opers-config =
|
||||
|
||||
# Path to servers configuration. This defines servers to link with.
|
||||
#servers-config =
|
||||
|
||||
# Path to the users configuration. This defines spoofs and whether users are
|
||||
# exempt from flood protection.
|
||||
#users-config =
|
||||
@@ -1,4 +1,4 @@
|
||||
# The main catbox config.
|
||||
# The main terrarium config.
|
||||
#
|
||||
# The commented options are the defaults which are used if you do not specify
|
||||
# the option.
|
||||
@@ -27,7 +27,7 @@
|
||||
#server-info = IRC
|
||||
|
||||
# MOTD. Only one line at this time.
|
||||
#motd = Hello this is catbox
|
||||
#motd = Hello this is terrarium
|
||||
|
||||
# Maximum nick length. RFCs say 9, but longer is okay.
|
||||
#max-nick-length = 9
|
||||
|
||||
24
config.go
24
config.go
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
@@ -18,6 +18,11 @@ type Config struct {
|
||||
KeyFile string
|
||||
ServerName string
|
||||
|
||||
// Listen on Hidden Service addresses
|
||||
ListenI2P string
|
||||
ListenI2PTLS string
|
||||
SAMAddress string
|
||||
|
||||
// Description of server. This shows in WHOIS, etc.
|
||||
ServerInfo string
|
||||
|
||||
@@ -101,6 +106,21 @@ func checkAndParseConfig(file string) (*Config, error) {
|
||||
c.ListenPortTLS = m["listen-port-tls"]
|
||||
}
|
||||
|
||||
c.ListenI2P = "-1"
|
||||
if m["listen-i2p"] != "" {
|
||||
c.ListenI2P = m["listen-i2p"]
|
||||
}
|
||||
|
||||
c.ListenI2PTLS = "-1"
|
||||
if m["listen-i2p-tls"] != "" {
|
||||
c.ListenI2PTLS = m["listen-i2p-tls"]
|
||||
}
|
||||
|
||||
c.SAMAddress = "127.0.0.1:7656"
|
||||
if m["sam-address"] != "" {
|
||||
c.SAMAddress = m["sam-address"]
|
||||
}
|
||||
|
||||
if m["certificate-file"] != "" {
|
||||
c.CertificateFile = m["certificate-file"]
|
||||
}
|
||||
@@ -119,7 +139,7 @@ func checkAndParseConfig(file string) (*Config, error) {
|
||||
c.ServerInfo = m["server-info"]
|
||||
}
|
||||
|
||||
c.MOTD = "Hello this is catbox"
|
||||
c.MOTD = "Hello this is terrarium"
|
||||
if m["motd"] != "" {
|
||||
c.MOTD = m["motd"]
|
||||
}
|
||||
|
||||
1
desc
Normal file
1
desc
Normal file
@@ -0,0 +1 @@
|
||||
terrarium is an IRC server with a focus on being small, understandable, and private. It builds all of it's connections using SAM, and is capable of linking with other I2P IRC servers.
|
||||
22
go.mod
22
go.mod
@@ -1,9 +1,19 @@
|
||||
module github.com/horgh/catbox
|
||||
module i2pgit.org/idk/terrarium
|
||||
|
||||
go 1.18
|
||||
|
||||
require (
|
||||
github.com/horgh/config v0.0.0-20190101204049-770bc48a3bdf
|
||||
github.com/horgh/irc v0.0.0-20190101204118-d089b0b5b5c5
|
||||
github.com/pkg/errors v0.8.1
|
||||
github.com/stretchr/objx v0.2.0 // indirect
|
||||
github.com/stretchr/testify v1.3.0
|
||||
github.com/eyedeekay/sam3 v0.33.2
|
||||
github.com/horgh/config v0.0.0-20180303191532-3d1f920eb228
|
||||
github.com/horgh/irc v0.0.0-20180101050313-f421bdb90dcc
|
||||
github.com/pkg/errors v0.8.0
|
||||
github.com/stretchr/testify v1.7.1
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/davecgh/go-spew v1.1.0 // indirect
|
||||
github.com/eyedeekay/i2pkeys v0.0.0-20220310052025-204d4ae6dcae // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
gopkg.in/yaml.v2 v2.4.0 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
|
||||
)
|
||||
|
||||
79
go.sum
79
go.sum
@@ -1,28 +1,79 @@
|
||||
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
|
||||
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/eyedeekay/goSam v0.32.31-0.20210122211817-f97683379f23/go.mod h1:UgJnih/LpotwKriwVPOEa6yPDM2NDdVrKfLtS5DOLPE=
|
||||
github.com/eyedeekay/i2pkeys v0.0.0-20220310052025-204d4ae6dcae h1:SwegHeaf4pkDMB24UltIvJlj2+nd06QUZAbs8BDyfjM=
|
||||
github.com/eyedeekay/i2pkeys v0.0.0-20220310052025-204d4ae6dcae/go.mod h1:W9KCm9lqZ+Ozwl3dwcgnpPXAML97+I8Jiht7o5A8YBM=
|
||||
github.com/eyedeekay/sam3 v0.32.32/go.mod h1:qRA9KIIVxbrHlkj+ZB+OoxFGFgdKeGp1vSgPw26eOVU=
|
||||
github.com/eyedeekay/sam3 v0.33.2 h1:WP+fD4oPxiE0cA+gTKRNiZo3SrGI2+5FkzrnU/6Mmz4=
|
||||
github.com/eyedeekay/sam3 v0.33.2/go.mod h1:sPtlI4cRm7wD0UywOzLPvvdY1G++vBSK3n+jiIGqWlU=
|
||||
github.com/getlantern/context v0.0.0-20190109183933-c447772a6520/go.mod h1:L+mq6/vvYHKjCX2oez0CgEAJmbq1fbb/oNJIWQkBybY=
|
||||
github.com/getlantern/errors v1.0.1/go.mod h1:l+xpFBrCtDLpK9qNjxs+cHU6+BAdlBaxHqikB6Lku3A=
|
||||
github.com/getlantern/go-socks5 v0.0.0-20171114193258-79d4dd3e2db5/go.mod h1:kGHRXch95rnGLHjER/GhhFiHvfnqNz7KqWD9kGfATHY=
|
||||
github.com/getlantern/golog v0.0.0-20201105130739-9586b8bde3a9/go.mod h1:ZyIjgH/1wTCl+B+7yH1DqrWp6MPJqESmwmEQ89ZfhvA=
|
||||
github.com/getlantern/hex v0.0.0-20190417191902-c6586a6fe0b7/go.mod h1:dD3CgOrwlzca8ed61CsZouQS5h5jIzkK9ZWrTcf0s+o=
|
||||
github.com/getlantern/hidden v0.0.0-20190325191715-f02dbb02be55/go.mod h1:6mmzY2kW1TOOrVy+r41Za2MxXM+hhqTtY3oBKd2AgFA=
|
||||
github.com/getlantern/netx v0.0.0-20190110220209-9912de6f94fd/go.mod h1:wKdY0ikOgzrWSeB9UyBVKPRhjXQ+vTb+BPeJuypUuNE=
|
||||
github.com/getlantern/ops v0.0.0-20190325191751-d70cb0d6f85f/go.mod h1:D5ao98qkA6pxftxoqzibIBBrLSUli+kYnJqrgBf9cIA=
|
||||
github.com/getlantern/ops v0.0.0-20200403153110-8476b16edcd6/go.mod h1:D5ao98qkA6pxftxoqzibIBBrLSUli+kYnJqrgBf9cIA=
|
||||
github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
|
||||
github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
|
||||
github.com/google/renameio v1.0.0/go.mod h1:t/HQoYBZSsWSNK35C6CO/TpPLDVWvxOHboWUAweKUpk=
|
||||
github.com/horgh/config v0.0.0-20180303191532-3d1f920eb228 h1:R302KZFIBabAYgFZ0hgqRTeCF43Lm5rir+UnJYW3idQ=
|
||||
github.com/horgh/config v0.0.0-20180303191532-3d1f920eb228/go.mod h1:DSwQKBmwAzGuDhYajjeJshx5PCPCJfSZJXtbV+8/nck=
|
||||
github.com/horgh/config v0.0.0-20190101202014-d9e8eabe6dbb h1:u6pj1d0h6XSjJ84iixIMvSZT1fbLC1g4qqkV54EMOfo=
|
||||
github.com/horgh/config v0.0.0-20190101202014-d9e8eabe6dbb/go.mod h1:DSwQKBmwAzGuDhYajjeJshx5PCPCJfSZJXtbV+8/nck=
|
||||
github.com/horgh/config v0.0.0-20190101204049-770bc48a3bdf h1:/jDikK0Oteboi7/Z6uzan5aQhiqwMwKTIA+5ZooDclk=
|
||||
github.com/horgh/config v0.0.0-20190101204049-770bc48a3bdf/go.mod h1:DSwQKBmwAzGuDhYajjeJshx5PCPCJfSZJXtbV+8/nck=
|
||||
github.com/horgh/irc v0.0.0-20180101050313-f421bdb90dcc h1:FXH8Jqdcz9BbR94qHrCVGA5FhbcWNC+HpIXYwVgOc2I=
|
||||
github.com/horgh/irc v0.0.0-20180101050313-f421bdb90dcc/go.mod h1:UqEB9NVUSZzN4ESuQX3yEvi80Mgg2O4kttl8oU9+nds=
|
||||
github.com/horgh/irc v0.0.0-20190101203129-f09ebee6408d h1:ANDjU4bIeLO80xssAxig8qftG6ohyg08IqsIPnKqafg=
|
||||
github.com/horgh/irc v0.0.0-20190101203129-f09ebee6408d/go.mod h1:JLhFcwXOnpvhMer1MERfJuFIoJnADayDWe0VkMN3LP4=
|
||||
github.com/horgh/irc v0.0.0-20190101204118-d089b0b5b5c5 h1:wndND79llNLTZZW/Xcg9oKMk/NuGMo+pAX+LKg1mZF8=
|
||||
github.com/horgh/irc v0.0.0-20190101204118-d089b0b5b5c5/go.mod h1:JLhFcwXOnpvhMer1MERfJuFIoJnADayDWe0VkMN3LP4=
|
||||
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
|
||||
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
|
||||
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
|
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/oxtoacart/bpool v0.0.0-20190530202638-03653db5a59c/go.mod h1:X07ZCGwUbLaax7L0S3Tw4hpejzu63ZrrQiUe6W0hcy0=
|
||||
github.com/pkg/errors v0.8.0 h1:WdK/asTD0HN+q6hsWO3/vpuAkAr+tw6aNJNDFFf0+qw=
|
||||
github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
|
||||
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/riobard/go-x25519 v0.0.0-20190716001027-10cc4d8d0b33/go.mod h1:BjmVxzAnkLeoEbqHEerI4eSw6ua+RaIB0S4jMV21RAs=
|
||||
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
|
||||
github.com/rogpeppe/go-internal v1.6.2/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
|
||||
github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
|
||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
||||
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
|
||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||
golang.org/x/tools v0.0.0-20200410194907-79a7a3126eef/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
|
||||
golang.org/x/tools v0.0.0-20201125231158-b5590deeca9b/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
|
||||
gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
|
||||
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
|
||||
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
honnef.co/go/tools v0.0.1-2020.1.6/go.mod h1:pyyisuGw24ruLjrr1ddx39WE0y9OooInRzEYLhQB2YY=
|
||||
|
||||
268
index.html
Normal file
268
index.html
Normal file
@@ -0,0 +1,268 @@
|
||||
<html>
|
||||
<head>
|
||||
<title></title>
|
||||
<meta name="author" content="eyedeekay" />
|
||||
<meta name="description" content="terrarium.git" />
|
||||
<meta name="keywords" content="master" />
|
||||
<link rel="stylesheet" type="text/css" href="style.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="navbar">
|
||||
<a href="#shownav">
|
||||
Show navigation
|
||||
</a>
|
||||
<div id="shownav">
|
||||
<div id="hidenav">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="index.html">
|
||||
index
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CHANGELOG.html">
|
||||
CHANGELOG
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<br>
|
||||
<a href="#hidenav">
|
||||
Hide Navigation
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a href="/"></a>
|
||||
<h1>
|
||||
<img src="doc/terrarium-with-text.png" alt="terrarium"/>
|
||||
</h1>
|
||||
<p>
|
||||
<a href="https://travis-ci.org/eyedeekay/terrarium" rel="nofollow">
|
||||
<img src="https://travis-ci.org/eyedeekay/terrarium.svg" alt="Build
|
||||
Status"/>
|
||||
</a>
|
||||
<a href="https://goreportcard.com/report/i2pgit.org/idk/terrarium" rel="nofollow">
|
||||
<img src="https://goreportcard.com/badge/i2pgit.org/idk/terrarium" alt="Go Report
|
||||
Card"/>
|
||||
</a>
|
||||
</p>
|
||||
<p>
|
||||
terrarium is an IRC server with a focus on being small and understandable,
|
||||
originally forked from
|
||||
<a href="https://github.com/horgh/catbox" rel="nofollow">
|
||||
horgh/catbox
|
||||
</a>
|
||||
. The
|
||||
goal is to create an easy-to-configure I2P IRC server which is highly stable
|
||||
and secure, while retaining the ability to link with non-I2P IRC servers using
|
||||
TLS in order to bridge anonymous and non-anonymous chat. For now, Bridged
|
||||
servers are not anonymous, this may change in the future as I evaluate the
|
||||
feasibility of outproxies or Tor.
|
||||
</p>
|
||||
<h1>
|
||||
Features
|
||||
</h1>
|
||||
<ul>
|
||||
<li>
|
||||
Server to server linking
|
||||
</li>
|
||||
<li>
|
||||
IRC operators
|
||||
</li>
|
||||
<li>
|
||||
Private (WHOIS shows no channels, LIST isn’t supported)
|
||||
</li>
|
||||
<li>
|
||||
Flood protection
|
||||
</li>
|
||||
<li>
|
||||
K: line style connection banning
|
||||
</li>
|
||||
<li>
|
||||
TLS
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
terrarium implements enough of
|
||||
<a href="https://tools.ietf.org/html/rfc1459" rel="nofollow">
|
||||
RFC 1459
|
||||
</a>
|
||||
to be recognisable as IRC and be minimally functional. It will intentionally
|
||||
omit unnecessary features. Priority features are those which enable moderation
|
||||
and provide more flexible security.
|
||||
</p>
|
||||
<h1>
|
||||
Plugin Installation URL’s
|
||||
</h1>
|
||||
<p>
|
||||
<a href="https://geti2p.net/en/docs/plugins" rel="nofollow">
|
||||
A guide to installing I2P plugins can be found on the I2P web site.
|
||||
</a>
|
||||
</p>
|
||||
<h3>
|
||||
Inside I2P
|
||||
</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="http://idk.i2p/terrarium/terrarium-windows-amd64.su3" rel="nofollow">
|
||||
Windows (In-I2P)
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="http://idk.i2p/terrarium/terrarium-linux-amd64.su3" rel="nofollow">
|
||||
Linux (In-I2P)
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>
|
||||
Outside I2P
|
||||
</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://github.com/terrarium/blizzard/releases" rel="nofollow">
|
||||
Windows
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/terrarium/blizzard/releases" rel="nofollow">
|
||||
Linux
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>
|
||||
Installation
|
||||
</h1>
|
||||
<ol>
|
||||
<li>
|
||||
Clone the software from
|
||||
<a href="https://i2pgit.org/idk/terrarium" rel="nofollow">
|
||||
i2pgit.org
|
||||
</a>
|
||||
(
|
||||
<code>
|
||||
git clone https://i2pgit.org/idk/terrarium go/src/i2pgit.org/idk/terrarium && cd go/src/i2pgit.org/idk/terrarium
|
||||
</code>
|
||||
).
|
||||
</li>
|
||||
<li>
|
||||
Build from source
|
||||
(
|
||||
<code>
|
||||
go build
|
||||
</code>
|
||||
).
|
||||
</li>
|
||||
<li>
|
||||
Configure terrarium through config files. There are example configs in the
|
||||
<code>
|
||||
conf
|
||||
</code>
|
||||
directory. All settings are optional and have defaults.
|
||||
</li>
|
||||
<li>
|
||||
Run it, e.g.
|
||||
<code>
|
||||
./terrarium -conf terrarium.conf
|
||||
</code>
|
||||
. You might run it via systemd
|
||||
via a service such as:
|
||||
<code>
|
||||
[Service]
|
||||
ExecStart=/home/ircd/terrarium/terrarium -conf /home/ircd/terrarium/terrarium.conf
|
||||
Restart=always
|
||||
[Install]
|
||||
WantedBy=default.target
|
||||
</code>
|
||||
</li>
|
||||
</ol>
|
||||
<h1>
|
||||
Configuration
|
||||
</h1>
|
||||
<h2>
|
||||
terrarium.conf
|
||||
</h2>
|
||||
<p>
|
||||
Global server settings.
|
||||
</p>
|
||||
<h2>
|
||||
opers.conf
|
||||
</h2>
|
||||
<p>
|
||||
IRC operators.
|
||||
</p>
|
||||
<h2>
|
||||
servers.conf
|
||||
</h2>
|
||||
<p>
|
||||
The servers to link with.
|
||||
</p>
|
||||
<h2>
|
||||
users.conf
|
||||
</h2>
|
||||
<p>
|
||||
Privileges and hostname spoofs for users.
|
||||
</p>
|
||||
<p>
|
||||
The only privilege right now is flood exemption.
|
||||
</p>
|
||||
<h2>
|
||||
TLS
|
||||
</h2>
|
||||
<p>
|
||||
A setup for a network might look like this:
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
Give each server a certificate with 2 SANs: Its own hostname, e.g.
|
||||
server1.example.com, and the network hostname, e.g. irc.example.com.
|
||||
</li>
|
||||
<li>
|
||||
Set up irc.example.com with DNS round-robin listing each server’s IP.
|
||||
</li>
|
||||
<li>
|
||||
List each server by its own hostname in servers.conf.
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
Clients connect to the network hostname and verify against it. Servers
|
||||
connect to each other by server hostname and verify against it.
|
||||
</p>
|
||||
<h2>
|
||||
I2P
|
||||
</h2>
|
||||
<p>
|
||||
An example I2P configuration can be found in:
|
||||
</p>
|
||||
<p>
|
||||
<code>
|
||||
conf/catbox-i2p.conf
|
||||
</code>
|
||||
</p>
|
||||
<p>
|
||||
That’s all the docs I have for now
|
||||
</p>
|
||||
<h1>
|
||||
Why the name?
|
||||
</h1>
|
||||
<p>
|
||||
It was forked from an IRC server called catbox which had a focus on simplicity
|
||||
and understandability. It now has the ability to connect to other IRC servers
|
||||
through I2P Tunnels. Clearnet is to I2P Tunnels is sort of like Catbox is to
|
||||
Terrarium.
|
||||
</p>
|
||||
<h1>
|
||||
Logo
|
||||
</h1>
|
||||
<p>
|
||||
terrarium logo © 2017 Bee
|
||||
</p>
|
||||
<div>
|
||||
<iframe src="https://snowflake.torproject.org/embed.html" width="320" height="240" frameborder="0" scrolling="no"></iframe>
|
||||
</div>
|
||||
<div>
|
||||
<a href="https://geti2p.net/">
|
||||
I2P
|
||||
</a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
@@ -430,13 +430,13 @@ func (c *LocalClient) registerUser() {
|
||||
})
|
||||
|
||||
// Send a CLICONN message. This is a custom command I built into ratbox
|
||||
// so that local opers can know about remote connections. For catbox we
|
||||
// so that local opers can know about remote connections. For terrarium we
|
||||
// don't need to handle this to know about remote connections as I inform
|
||||
// local operators about remote users connecting in the UID command, but to
|
||||
// allow my ratbox servers to know about connections to ratbox, send CLICONN
|
||||
// (for now). If I ever stop running all ratbox servers on my network, this
|
||||
// can be removed.
|
||||
// catbox should propagate this command though.
|
||||
// terrarium should propagate this command though.
|
||||
server.maybeQueueMessage(irc.Message{
|
||||
Prefix: string(u.UID),
|
||||
Command: "CLICONN",
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
142
main.go
142
main.go
@@ -1,14 +1,15 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"math/rand"
|
||||
"net"
|
||||
"os"
|
||||
"os/signal"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"strings"
|
||||
"sync"
|
||||
@@ -17,6 +18,8 @@ import (
|
||||
|
||||
"github.com/horgh/irc"
|
||||
"github.com/pkg/errors"
|
||||
|
||||
sam "github.com/eyedeekay/sam3/helper"
|
||||
)
|
||||
|
||||
// Catbox holds the state for this local server.
|
||||
@@ -95,6 +98,10 @@ type Catbox struct {
|
||||
Listener net.Listener
|
||||
TLSListener net.Listener
|
||||
|
||||
// I2P Streaming and I2P+TLS listeners.
|
||||
I2PListener net.Listener
|
||||
I2PListenerTLS net.Listener
|
||||
|
||||
// WaitGroup to ensure all goroutines clean up before we end.
|
||||
WG sync.WaitGroup
|
||||
|
||||
@@ -198,52 +205,18 @@ const ExcessFloodThreshold = 50
|
||||
// from a user.
|
||||
const ChanModesPerCommand = 4
|
||||
|
||||
func main() {
|
||||
log.SetFlags(log.Ldate | log.Ltime)
|
||||
log.SetOutput(os.Stdout)
|
||||
|
||||
args := getArgs()
|
||||
if args == nil {
|
||||
os.Exit(1)
|
||||
func randString() string {
|
||||
var letterRunes = []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
|
||||
n := 3
|
||||
b := make([]rune, n)
|
||||
for i := range b {
|
||||
b[i] = letterRunes[rand.Intn(len(letterRunes))]
|
||||
}
|
||||
|
||||
binPath, err := filepath.Abs(os.Args[0])
|
||||
if err != nil {
|
||||
log.Fatalf("Unable to determine absolute path to binary: %s: %s",
|
||||
os.Args[0], err)
|
||||
}
|
||||
|
||||
cb, err := newCatbox(args.ConfigFile)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if err := cb.start(args.ListenFD); err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
if cb.Restart {
|
||||
log.Printf("Shutdown completed. Restarting...")
|
||||
|
||||
if err := syscall.Exec( // nolint: gas
|
||||
binPath,
|
||||
[]string{
|
||||
binPath,
|
||||
"-conf",
|
||||
cb.ConfigFile,
|
||||
},
|
||||
nil,
|
||||
); err != nil {
|
||||
log.Fatalf("Restart failed: %s", err)
|
||||
}
|
||||
|
||||
log.Fatalf("not reached")
|
||||
}
|
||||
|
||||
log.Printf("Server shutdown cleanly.")
|
||||
return string(b)
|
||||
}
|
||||
|
||||
func newCatbox(configFile string) (*Catbox, error) {
|
||||
func NewCatbox(configFile string) (*Catbox, error) {
|
||||
rand.Seed(time.Now().UnixNano())
|
||||
cb := Catbox{
|
||||
ConfigFile: configFile,
|
||||
LocalClients: make(map[uint64]*LocalClient),
|
||||
@@ -267,6 +240,9 @@ func newCatbox(configFile string) (*Catbox, error) {
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("configuration problem: %s", err)
|
||||
}
|
||||
if cfg.ServerName == "irc.terrarium.i2p" {
|
||||
cfg.ServerName = randString() + ".dirt.i2p"
|
||||
}
|
||||
cb.Config = cfg
|
||||
|
||||
if cb.Config.ListenPortTLS != "-1" || cb.Config.CertificateFile != "" ||
|
||||
@@ -328,7 +304,7 @@ func (cb *Catbox) loadCertificate() error {
|
||||
//
|
||||
// We open the TCP port, start goroutines, and then receive messages on our
|
||||
// channels.
|
||||
func (cb *Catbox) start(listenFD int) error {
|
||||
func (cb *Catbox) Start(listenFD int) error {
|
||||
if listenFD == -1 && cb.Config.ListenPort == "-1" &&
|
||||
cb.Config.ListenPortTLS == "-1" {
|
||||
log.Fatalf("You must set a listen port.")
|
||||
@@ -373,6 +349,49 @@ func (cb *Catbox) start(listenFD int) error {
|
||||
go cb.acceptConnections(cb.TLSListener)
|
||||
}
|
||||
|
||||
// I2P Listener
|
||||
if cb.Config.ListenI2P != "-1" {
|
||||
ln, err := sam.I2PListener(cb.Config.ListenI2P, cb.Config.SAMAddress, cb.Config.ListenI2P)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to listen (I2P): %s", err)
|
||||
}
|
||||
cb.I2PListener = ln
|
||||
err = ioutil.WriteFile(cb.Config.ListenI2P+".i2paddresshelper", []byte("http://"+cb.Config.ListenI2P+"/?i2paddresshelper="+cb.I2PListener.Addr().String()), 0644)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to write I2P addresshelper link to file: %s", err)
|
||||
}
|
||||
if strings.HasSuffix(cb.Config.ServerName, ".i2p") {
|
||||
err = ioutil.WriteFile(cb.Config.ServerName+".i2paddresshelper", []byte("http://"+cb.Config.ServerName+"/?i2paddresshelper="+cb.I2PListener.Addr().String()), 0644)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to write I2P addresshelper link to file: %s", err)
|
||||
}
|
||||
}
|
||||
cb.WG.Add(1)
|
||||
go cb.acceptConnections(cb.Listener)
|
||||
}
|
||||
|
||||
// I2P Listener with TLS
|
||||
if cb.Config.ListenI2PTLS != "-1" {
|
||||
ln, err := sam.I2PListener(cb.Config.ListenI2PTLS, cb.Config.SAMAddress, cb.Config.ListenI2PTLS)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to listen (I2P): %s", err)
|
||||
}
|
||||
tlsln := tls.NewListener(ln, cb.TLSConfig)
|
||||
cb.I2PListenerTLS = tlsln
|
||||
err = ioutil.WriteFile(cb.Config.ListenI2PTLS+".tls.i2paddresshelper", []byte("http://"+cb.Config.ListenI2PTLS+"?i2paddresshelper="+cb.I2PListener.Addr().String()), 0644)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to write I2P addresshelper link to file: %s", err)
|
||||
}
|
||||
if strings.HasSuffix(cb.Config.ServerName, ".i2p") {
|
||||
err = ioutil.WriteFile(cb.Config.ServerName+".tls.i2paddresshelper", []byte("http://"+cb.Config.ServerName+"?i2paddresshelper="+cb.I2PListener.Addr().String()), 0644)
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to write I2P addresshelper link to file: %s", err)
|
||||
}
|
||||
}
|
||||
cb.WG.Add(1)
|
||||
go cb.acceptConnections(cb.Listener)
|
||||
}
|
||||
|
||||
// Alarm is a goroutine to wake up this one periodically so we can do things
|
||||
// like ping clients.
|
||||
cb.WG.Add(1)
|
||||
@@ -382,7 +401,7 @@ func (cb *Catbox) start(listenFD int) error {
|
||||
// Catch SIGUSR1 and restart.
|
||||
signalChan := make(chan os.Signal)
|
||||
signal.Notify(signalChan, syscall.SIGHUP)
|
||||
signal.Notify(signalChan, syscall.SIGUSR1)
|
||||
signal.Notify(signalChan, syscall.SIGINT)
|
||||
|
||||
cb.WG.Add(1)
|
||||
go func() {
|
||||
@@ -395,7 +414,7 @@ func (cb *Catbox) start(listenFD int) error {
|
||||
cb.newEvent(Event{Type: RehashEvent})
|
||||
break
|
||||
}
|
||||
if sig == syscall.SIGUSR1 {
|
||||
if sig == syscall.SIGINT {
|
||||
log.Printf("Received SIGUSR1 signal, restarting")
|
||||
cb.newEvent(Event{Type: RestartEvent})
|
||||
break
|
||||
@@ -414,7 +433,7 @@ func (cb *Catbox) start(listenFD int) error {
|
||||
}
|
||||
}()
|
||||
|
||||
log.Printf("catbox started")
|
||||
log.Printf("terrarium started")
|
||||
cb.eventLoop()
|
||||
|
||||
// We don't need to drain any channels. None close that will have any
|
||||
@@ -650,7 +669,7 @@ func (cb *Catbox) introduceClient(conn net.Conn) {
|
||||
return
|
||||
}
|
||||
|
||||
if tlsVersion != "TLS 1.2" {
|
||||
if tlsVersion != "TLS 1.2" && tlsVersion != "TLS 1.3" {
|
||||
cb.noticeOpers(fmt.Sprintf("Rejecting client %s using %s",
|
||||
client.Conn.IP, tlsVersion))
|
||||
// Send ERROR and start up the writer to try to let them get it. Don't
|
||||
@@ -997,6 +1016,19 @@ func (cb *Catbox) connectToServer(linkInfo *ServerDefinition) {
|
||||
var err error
|
||||
|
||||
if linkInfo.TLS {
|
||||
if strings.HasSuffix(linkInfo.Hostname, ".i2p") {
|
||||
cb.noticeOpers(fmt.Sprintf("Connecting to %s with I2P and TLS...", linkInfo.Name))
|
||||
|
||||
cb.noticeOpers(fmt.Sprintf("Connecting to %s with I2P...",
|
||||
linkInfo.Name))
|
||||
I2PSession, err := sam.I2PStreamSession(cb.Config.ListenI2P+"-tls-"+linkInfo.Hostname, cb.Config.SAMAddress, cb.Config.ListenI2P+"-tls-"+linkInfo.Hostname)
|
||||
if err == nil {
|
||||
conn, err = I2PSession.Dial("tcp", linkInfo.Hostname)
|
||||
if err == nil {
|
||||
conn = tls.Client(conn, cb.TLSConfig)
|
||||
}
|
||||
}
|
||||
} else {
|
||||
cb.noticeOpers(fmt.Sprintf("Connecting to %s with TLS...", linkInfo.Name))
|
||||
|
||||
dialer := &net.Dialer{
|
||||
@@ -1004,6 +1036,14 @@ func (cb *Catbox) connectToServer(linkInfo *ServerDefinition) {
|
||||
}
|
||||
conn, err = tls.DialWithDialer(dialer, "tcp",
|
||||
fmt.Sprintf("%s:%d", linkInfo.Hostname, linkInfo.Port), cb.TLSConfig)
|
||||
}
|
||||
} else if strings.HasSuffix(linkInfo.Hostname, ".i2p") {
|
||||
cb.noticeOpers(fmt.Sprintf("Connecting to %s with I2P...",
|
||||
linkInfo.Name))
|
||||
I2PSession, err := sam.I2PStreamSession(cb.Config.ListenI2P+"-"+linkInfo.Hostname, cb.Config.SAMAddress, cb.Config.ListenI2P+"-"+linkInfo.Hostname)
|
||||
if err == nil {
|
||||
conn, err = I2PSession.Dial("tcp", linkInfo.Hostname)
|
||||
}
|
||||
} else {
|
||||
cb.noticeOpers(fmt.Sprintf("Connecting to %s without TLS...",
|
||||
linkInfo.Name))
|
||||
@@ -1030,7 +1070,7 @@ func (cb *Catbox) connectToServer(linkInfo *ServerDefinition) {
|
||||
return
|
||||
}
|
||||
|
||||
if tlsVersion != "TLS 1.2" {
|
||||
if tlsVersion != "TLS 1.2" && tlsVersion != "TLS 1.3" {
|
||||
cb.noticeOpers(fmt.Sprintf(
|
||||
"Disconnecting from %s because of TLS version: %s", linkInfo.Name,
|
||||
tlsVersion))
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
157
style.css
Normal file
157
style.css
Normal file
@@ -0,0 +1,157 @@
|
||||
/* edgar default CSS file */
|
||||
|
||||
body {
|
||||
font-family: "Roboto";
|
||||
font-family: monospace;
|
||||
text-align: justify;
|
||||
background-color: #373636;
|
||||
color: whitesmoke;
|
||||
font-size: 1.15em;
|
||||
}
|
||||
|
||||
ul {
|
||||
width: 55%;
|
||||
display: block;
|
||||
}
|
||||
|
||||
ol {
|
||||
width: 55%;
|
||||
display: block;
|
||||
}
|
||||
|
||||
li {
|
||||
margin-top: 1%;
|
||||
}
|
||||
|
||||
p {
|
||||
max-width: 90%;
|
||||
margin-top: 1%;
|
||||
margin-left: 3%;
|
||||
margin-right: 3%;
|
||||
}
|
||||
|
||||
img {
|
||||
float: left;
|
||||
top: 5%;
|
||||
left: 5%;
|
||||
max-width: 60%;
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.inline {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.link-button:focus {
|
||||
outline: none;
|
||||
}
|
||||
|
||||
.link-button:active {
|
||||
color: red;
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: monospace;
|
||||
border-radius: 5%;
|
||||
padding: 1%;
|
||||
border-color: darkgray;
|
||||
font-size: .9em;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #C6D9FE;
|
||||
padding: 1%;
|
||||
}
|
||||
|
||||
ul li {
|
||||
color: #C6D9FE;
|
||||
}
|
||||
|
||||
iframe {
|
||||
background: aliceblue;
|
||||
border-radius: 15%;
|
||||
margin: 2%;
|
||||
}
|
||||
|
||||
.container {
|
||||
width: 36vw;
|
||||
height: 64vh;
|
||||
display: inline-block;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.editor-toolbar a {
|
||||
display: inline-block;
|
||||
text-align: center;
|
||||
text-decoration: none !important;
|
||||
color: whitesmoke !important;
|
||||
}
|
||||
|
||||
#feed {
|
||||
width: 60vw;
|
||||
height: unset !important;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
float: right;
|
||||
background-color: #373636;
|
||||
color: whitesmoke;
|
||||
border: #C6D9FE solid 1px;
|
||||
}
|
||||
|
||||
.thread-post,
|
||||
.thread {
|
||||
color: whitesmoke !important;
|
||||
background-color: #373636;
|
||||
border: 1px solid darkgray;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
|
||||
.thread-post {
|
||||
margin-left: 4%;
|
||||
}
|
||||
|
||||
input {
|
||||
text-align: center;
|
||||
color: whitesmoke !important;
|
||||
background-color: #373636;
|
||||
border: 1px solid darkgray;
|
||||
font: normal normal normal 14px/1 FontAwesome;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
|
||||
.thread-hash {
|
||||
text-align: right;
|
||||
color: whitesmoke !important;
|
||||
background-color: #373636;
|
||||
border: 1px solid darkgray;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
|
||||
.post-body {
|
||||
text-align: left;
|
||||
color: whitesmoke !important;
|
||||
font-size: inherit;
|
||||
padding-top: 1%;
|
||||
padding-bottom: 1%;
|
||||
}
|
||||
#show {display:none; }
|
||||
#hide {display:block; }
|
||||
#show:target {display: block; }
|
||||
#hide:target {display: none; }
|
||||
|
||||
#shownav {display:none; }
|
||||
#hidenav {display:block; }
|
||||
#shownav:target {display: block; }
|
||||
#hidenav:target {display: none; }
|
||||
|
||||
#navbar {
|
||||
float: right;
|
||||
width: 10%;
|
||||
}
|
||||
@@ -20,7 +20,7 @@ import (
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
// Catbox holds information about a harnessed catbox.
|
||||
// Catbox holds information about a harnessed terrarium.
|
||||
type Catbox struct {
|
||||
Name string
|
||||
SID string
|
||||
@@ -33,19 +33,19 @@ type Catbox struct {
|
||||
LogChan <-chan string
|
||||
}
|
||||
|
||||
const catboxDir = ".."
|
||||
const terrariumDir = ".."
|
||||
|
||||
func harnessCatbox(
|
||||
name,
|
||||
sid string,
|
||||
) (*Catbox, error) {
|
||||
if err := buildCatbox(); err != nil {
|
||||
return nil, fmt.Errorf("error building catbox: %s", err)
|
||||
return nil, fmt.Errorf("error building terrarium: %s", err)
|
||||
}
|
||||
|
||||
catbox, err := startCatbox(name, sid)
|
||||
terrarium, err := startCatbox(name, sid)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("error starting catbox: %s", err)
|
||||
return nil, fmt.Errorf("error starting terrarium: %s", err)
|
||||
}
|
||||
|
||||
var wg sync.WaitGroup
|
||||
@@ -53,34 +53,34 @@ func harnessCatbox(
|
||||
logChan := make(chan string, 1024)
|
||||
|
||||
wg.Add(1)
|
||||
go logReader(&wg, fmt.Sprintf("%s stderr", name), catbox.Stderr, logChan)
|
||||
go logReader(&wg, fmt.Sprintf("%s stderr", name), terrarium.Stderr, logChan)
|
||||
|
||||
wg.Add(1)
|
||||
go logReader(&wg, fmt.Sprintf("%s stdout", name), catbox.Stdout, logChan)
|
||||
go logReader(&wg, fmt.Sprintf("%s stdout", name), terrarium.Stdout, logChan)
|
||||
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
if err := catbox.Command.Wait(); err != nil {
|
||||
log.Printf("catbox exited: %s", err)
|
||||
if err := terrarium.Command.Wait(); err != nil {
|
||||
log.Printf("terrarium exited: %s", err)
|
||||
}
|
||||
}()
|
||||
|
||||
catbox.WaitGroup = &wg
|
||||
catbox.LogChan = logChan
|
||||
terrarium.WaitGroup = &wg
|
||||
terrarium.LogChan = logChan
|
||||
|
||||
// It is important to wait for catbox to fully start. If we don't, then
|
||||
// It is important to wait for terrarium to fully start. If we don't, then
|
||||
// certain things we do in tests will not work well. For example, trying to
|
||||
// reload the conf by sending a SIGHUP will kill the process.
|
||||
startedRE := regexp.MustCompile(
|
||||
`^\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2} catbox started$`)
|
||||
`^\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2} terrarium started$`)
|
||||
|
||||
if !waitForLog(logChan, startedRE) {
|
||||
catbox.stop()
|
||||
return nil, fmt.Errorf("error waiting for catbox to start")
|
||||
terrarium.stop()
|
||||
return nil, fmt.Errorf("error waiting for terrarium to start")
|
||||
}
|
||||
|
||||
return catbox, nil
|
||||
return terrarium, nil
|
||||
}
|
||||
|
||||
var builtCatbox bool
|
||||
@@ -91,12 +91,12 @@ func buildCatbox() error {
|
||||
}
|
||||
|
||||
cmd := exec.Command("go", "build")
|
||||
cmd.Dir = catboxDir
|
||||
cmd.Dir = terrariumDir
|
||||
|
||||
log.Printf("Running %s in [%s]...", cmd.Args, cmd.Dir)
|
||||
output, err := cmd.CombinedOutput()
|
||||
if err != nil {
|
||||
return fmt.Errorf("error building catbox: %s: %s", err, output)
|
||||
return fmt.Errorf("error building terrarium: %s: %s", err, output)
|
||||
}
|
||||
|
||||
builtCatbox = true
|
||||
@@ -112,7 +112,7 @@ func startCatbox(
|
||||
return nil, fmt.Errorf("error retrieving a temporary directory: %s", err)
|
||||
}
|
||||
|
||||
catboxConf := filepath.Join(tmpDir, "catbox.conf")
|
||||
terrariumConf := filepath.Join(tmpDir, "terrarium.conf")
|
||||
|
||||
listener, port, err := getRandomPort()
|
||||
if err != nil {
|
||||
@@ -120,15 +120,15 @@ func startCatbox(
|
||||
return nil, fmt.Errorf("error opening random port: %s", err)
|
||||
}
|
||||
|
||||
catbox, err := runCatbox(catboxConf, listener, port, name, sid)
|
||||
terrarium, err := runCatbox(terrariumConf, listener, port, name, sid)
|
||||
if err != nil {
|
||||
_ = os.RemoveAll(tmpDir)
|
||||
_ = listener.Close()
|
||||
return nil, fmt.Errorf("error running catbox: %s", err)
|
||||
return nil, fmt.Errorf("error running terrarium: %s", err)
|
||||
}
|
||||
|
||||
catbox.ConfigDir = tmpDir
|
||||
return catbox, nil
|
||||
terrarium.ConfigDir = tmpDir
|
||||
return terrarium, nil
|
||||
}
|
||||
|
||||
func getRandomPort() (net.Listener, uint16, error) {
|
||||
@@ -161,12 +161,12 @@ func runCatbox(
|
||||
return nil, err
|
||||
}
|
||||
|
||||
cmd := exec.Command("./catbox",
|
||||
cmd := exec.Command("./terrarium",
|
||||
"-conf", conf,
|
||||
"-listen-fd", "3",
|
||||
)
|
||||
|
||||
cmd.Dir = catboxDir
|
||||
cmd.Dir = terrariumDir
|
||||
|
||||
f, err := ln.(*net.TCPListener).File()
|
||||
if err != nil {
|
||||
@@ -257,7 +257,7 @@ func logReader(
|
||||
|
||||
func (c *Catbox) stop() {
|
||||
if err := c.Command.Process.Kill(); err != nil {
|
||||
log.Printf("error killing catbox: %s", err)
|
||||
log.Printf("error killing terrarium: %s", err)
|
||||
}
|
||||
c.WaitGroup.Wait()
|
||||
|
||||
@@ -267,7 +267,7 @@ func (c *Catbox) stop() {
|
||||
}
|
||||
|
||||
func (c *Catbox) linkServer(other *Catbox) error {
|
||||
conf := filepath.Join(c.ConfigDir, "catbox.conf")
|
||||
conf := filepath.Join(c.ConfigDir, "terrarium.conf")
|
||||
serversConf := filepath.Join(c.ConfigDir, "servers.conf")
|
||||
extra := fmt.Sprintf("servers-config = %s", serversConf)
|
||||
|
||||
|
||||
@@ -11,20 +11,20 @@ import (
|
||||
|
||||
// Test one client sending a message to another client.
|
||||
func TestPRIVMSG(t *testing.T) {
|
||||
catbox, err := harnessCatbox("irc.example.org", "000")
|
||||
terrarium, err := harnessCatbox("irc.example.org", "000")
|
||||
if err != nil {
|
||||
t.Fatalf("error harnessing catbox: %s", err)
|
||||
t.Fatalf("error harnessing terrarium: %s", err)
|
||||
}
|
||||
defer catbox.stop()
|
||||
defer terrarium.stop()
|
||||
|
||||
client1 := NewClient("client1", "127.0.0.1", catbox.Port)
|
||||
client1 := NewClient("client1", "127.0.0.1", terrarium.Port)
|
||||
recvChan1, sendChan1, _, err := client1.Start()
|
||||
if err != nil {
|
||||
t.Fatalf("error starting client: %s", err)
|
||||
}
|
||||
defer client1.Stop()
|
||||
|
||||
client2 := NewClient("client2", "127.0.0.1", catbox.Port)
|
||||
client2 := NewClient("client2", "127.0.0.1", terrarium.Port)
|
||||
recvChan2, _, _, err := client2.Start()
|
||||
if err != nil {
|
||||
t.Fatalf("error starting client: %s", err)
|
||||
|
||||
@@ -15,18 +15,18 @@ import (
|
||||
// Also test that the TS gets propagated between servers and a client on
|
||||
// another server gets the same TS
|
||||
func TestMODETS(t *testing.T) {
|
||||
catbox1, err := harnessCatbox("irc1.example.org", "001")
|
||||
require.NoError(t, err, "harness catbox")
|
||||
defer catbox1.stop()
|
||||
terrarium1, err := harnessCatbox("irc1.example.org", "001")
|
||||
require.NoError(t, err, "harness terrarium")
|
||||
defer terrarium1.stop()
|
||||
|
||||
catbox2, err := harnessCatbox("irc2.example.org", "002")
|
||||
require.NoError(t, err, "harness catbox")
|
||||
defer catbox2.stop()
|
||||
terrarium2, err := harnessCatbox("irc2.example.org", "002")
|
||||
require.NoError(t, err, "harness terrarium")
|
||||
defer terrarium2.stop()
|
||||
|
||||
err = catbox1.linkServer(catbox2)
|
||||
require.NoError(t, err, "link catbox1 to catbox2")
|
||||
err = catbox2.linkServer(catbox1)
|
||||
require.NoError(t, err, "link catbox2 to catbox1")
|
||||
err = terrarium1.linkServer(terrarium2)
|
||||
require.NoError(t, err, "link terrarium1 to terrarium2")
|
||||
err = terrarium2.linkServer(terrarium1)
|
||||
require.NoError(t, err, "link terrarium2 to terrarium1")
|
||||
|
||||
// Wait until we link.
|
||||
//
|
||||
@@ -37,18 +37,18 @@ func TestMODETS(t *testing.T) {
|
||||
linkRE := regexp.MustCompile(`Established link to irc2\.`)
|
||||
var attempts int
|
||||
for {
|
||||
if waitForLog(catbox1.LogChan, linkRE) {
|
||||
if waitForLog(terrarium1.LogChan, linkRE) {
|
||||
break
|
||||
}
|
||||
attempts++
|
||||
if attempts >= 5 {
|
||||
require.Fail(t, "failed to link")
|
||||
}
|
||||
require.NoError(t, err, catbox1.rehash(), "rehash catbox1")
|
||||
require.NoError(t, err, catbox2.rehash(), "rehash catbox2")
|
||||
require.NoError(t, err, terrarium1.rehash(), "rehash terrarium1")
|
||||
require.NoError(t, err, terrarium2.rehash(), "rehash terrarium2")
|
||||
}
|
||||
|
||||
client1 := NewClient("client1", "127.0.0.1", catbox1.Port)
|
||||
client1 := NewClient("client1", "127.0.0.1", terrarium1.Port)
|
||||
recvChan1, sendChan1, _, err := client1.Start()
|
||||
require.NoError(t, err, "start client")
|
||||
defer client1.Stop()
|
||||
@@ -110,7 +110,7 @@ func TestMODETS(t *testing.T) {
|
||||
t,
|
||||
creationTimeMessage,
|
||||
&irc.Message{
|
||||
Prefix: catbox1.Name,
|
||||
Prefix: terrarium1.Name,
|
||||
Command: "329",
|
||||
Params: []string{client1.GetNick(), "#test", creationTimeString},
|
||||
},
|
||||
@@ -124,7 +124,7 @@ func TestMODETS(t *testing.T) {
|
||||
|
||||
// Try a client on the other server and ensure they get the same time.
|
||||
|
||||
client2 := NewClient("client2", "127.0.0.1", catbox2.Port)
|
||||
client2 := NewClient("client2", "127.0.0.1", terrarium2.Port)
|
||||
recvChan2, sendChan2, _, err := client2.Start()
|
||||
require.NoError(t, err, "start client 2")
|
||||
defer client2.Stop()
|
||||
@@ -178,7 +178,7 @@ func TestMODETS(t *testing.T) {
|
||||
t,
|
||||
creationTimeMessage2,
|
||||
&irc.Message{
|
||||
Prefix: catbox2.Name,
|
||||
Prefix: terrarium2.Name,
|
||||
Command: "329",
|
||||
Params: []string{client2.GetNick(), "#test", creationTimeString},
|
||||
},
|
||||
|
||||
10
util.go
10
util.go
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
import (
|
||||
"context"
|
||||
@@ -439,6 +439,8 @@ func tlsVersionToString(version uint16) string {
|
||||
return "TLS 1.1"
|
||||
case tls.VersionTLS12:
|
||||
return "TLS 1.2"
|
||||
case tls.VersionTLS13:
|
||||
return "TLS 1.3"
|
||||
default:
|
||||
return fmt.Sprintf("Unknown TLS version %x", version)
|
||||
}
|
||||
@@ -490,6 +492,12 @@ func cipherSuiteToString(suite uint16) string {
|
||||
return "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305"
|
||||
case tls.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305:
|
||||
return "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305"
|
||||
case tls.TLS_AES_128_GCM_SHA256:
|
||||
return "TLS_AES_128_GCM_SHA256"
|
||||
case tls.TLS_AES_256_GCM_SHA384:
|
||||
return "TLS_AES_256_GCM_SHA384"
|
||||
case tls.TLS_CHACHA20_POLY1305_SHA256:
|
||||
return "TLS_CHACHA20_POLY1305_SHA256"
|
||||
default:
|
||||
return fmt.Sprintf("Unknown cipher suite %x", suite)
|
||||
}
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
package main
|
||||
package terrarium
|
||||
|
||||
// CreatedDate is the date we're built. This would be nice to generate
|
||||
// dynamically, but I don't want to complicate the build.
|
||||
const CreatedDate = "2019-07-08"
|
||||
|
||||
// Version is our version.
|
||||
const Version = "catbox-1.13.0"
|
||||
const Version = "terrarium-1.13.0"
|
||||
|
||||
Reference in New Issue
Block a user