IRC daemon, notifier, bot, TUI client, and its frontends
Go to file
Přemysl Eric Janouch b18a8048c1
degesch: add a slack plugin
Slack's IRC gateway is crap but it doesn't need to be *such* crap.
2017-05-13 20:04:21 +02:00
liberty@084e964286 Bump liberty 2017-01-23 23:50:27 +01:00
plugins degesch: add a slack plugin 2017-05-13 20:04:21 +02:00
.gitignore Rename project to uirc3 2015-04-30 01:39:08 +02:00
.gitmodules Move to liberty 2015-02-28 20:09:51 +01:00
.travis.yml Travis CI: brevify notifications 2017-02-03 23:17:15 +01:00
CMakeLists.txt degesch: Lua is no longer experimental 2017-01-23 23:41:14 +01:00
LICENSE Update copyright years 2017-04-22 19:41:27 +02:00
NEWS Bump version 2016-12-30 08:15:44 +01:00
README.adoc Update README, add a screenshot for degesch 2016-10-30 18:52:20 +01:00
common.c Bump liberty 2017-01-23 23:50:27 +01:00
config.h.in degesch: detect //TRANSLIT support, use cp1252 2016-03-26 14:27:59 +01:00
degesch.c Avoid the "poller_fd::closed" feature 2017-05-06 21:35:44 +02:00
degesch.png Update README, add a screenshot for degesch 2016-10-30 18:52:20 +01:00
kike-gen-replies.sh kike: fix the Makefile 2014-08-10 03:46:49 +02:00
kike-replies kike: implement LINKS 2015-06-13 22:28:38 +02:00
kike.c Avoid the "poller_fd::closed" feature 2017-05-06 21:35:44 +02:00
test degesch: one final fix for the test script 2015-07-06 02:36:11 +02:00
zyklonb.c Avoid the "poller_fd::closed" feature 2017-05-06 21:35:44 +02:00

README.adoc

uirc3

The unethical IRC trinity. This project consists of an experimental IRC client, daemon, and bot. Its all youre ever going to need for chatting, as long as you can make do with minimalist software.

All of them have these potentially interesting properties:

  • full IPv6 support

  • TLS support, including client certificates

  • lean on dependencies (with the exception of 'degesch')

  • compact and arguably easy to hack on

  • permissive license

degesch

The IRC client. It is largely defined by being built on top of GNU Readline that has been hacked to death. Its interface should feel somewhat familiar for weechat or irssi users.

degesch

This is the largest application within the project. It has most of the stuff youd expect of an IRC client, such as being able to set up multiple servers, a powerful configuration system, integrated help, text formatting, CTCP queries, automatic splitting of overlong messages, autocomplete, logging to file, auto-away, command aliases and basic support for Lua scripting.

kike

The IRC daemon. It is designed to be used as a regular user application rather than a system-wide daemon. If all you want is a decent, minimal IRCd for testing purposes or a small network of respectful users (or bots), this one will do it just fine.

Notable features:

  • TLS autodetection (why doesnt everyone have this?), using secure defaults

  • IRCop authentication via TLS client certificates

  • epoll/kqueue support; this means that it should be able to handle quite a number of concurrent user connections

  • partial IRCv3 support

Not supported:

  • server linking (which also means no services); I consider existing protocols for this purpose ugly and tricky to implement correctly; Ive also found no use for this feature yet

  • online changes to configuration; the configuration system from degesch could be used to implement this feature if needed

  • limits of almost any kind, just connections and mode +l

ZyklonB

The IRC bot. It builds upon the concept of my other VitaminA IRC bot. The main characteristic of these two bots is that they run plugins as coprocesses, which allows for enhanced reliability and programming language freedom.

While originally intended to be a simple rewrite of the original AWK bot in C, it fairly quickly became a playground, and it eventually got me into writing the rest of the package.

It survives crashes, server disconnects and timeouts, and also has native SOCKS support (even though socksify can add that easily to any program).

Packages

Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinuxs AUR, or from openSUSE Build Service for the rest of mainstream distributions. Consult the list of repositories and their respective links at:

Building

Build dependencies: CMake, pkg-config, help2man, awk, sh, liberty (included)
Runtime dependencies: openssl
Additionally for degesch: curses, libffi, lua >= 5.3 (optional), readline >= 6.0 or libedit >= 2013-07-12

$ git clone --recursive https://github.com/pjanouch/uirc3.git
$ mkdir uirc3/build
$ cd uirc3/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug \
           -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF -DWANT_LUA=ON
$ make

To install the application, you can do either the usual:

# make install

Or you can try telling CMake to make a package for you. For Debian it is:

$ cpack -G DEB
# dpkg -i uirc3-*.deb

Usage

degesch has in-program configuration. Just run it and read the instructions.

For the rest you might want to generate a configuration file:

$ zyklonb --write-default-config
$ kike --write-default-config

After making any necessary edits to the file (there are comments to aid you in doing that), simply run the appropriate program with no arguments:

$ zyklonb
$ kike

ZyklonB stays running in the foreground, therefore I recommend launching it inside a Screen or tmux session.

kike, on the other hand, immediately forks into the background. Use the PID file or something like killall if you want to terminate it. You can run it as a forking type systemd user service.

Client Certificates

kike uses SHA1 fingerprints of TLS client certificates to authenticate users. To get the fingerprint from a certificate file in the required form, use:

$ openssl x509 -in public.pem -outform DER | sha1sum

Custom Key Bindings in degesch

The default and preferred frontend used in degesch is GNU Readline. This means that you can change your bindings by editing ~/.inputrc. For example:

# Preload with system-wide settings
$include /etc/inputrc

# Make M-left and M-right reorder buffers
$if degesch
"\e\e[C": move-buffer-right
"\e\e[D": move-buffer-left
$endif

Consult the source code and the GNU Readline manual for a list of available functions. Also refer to the latter for the exact syntax of this file. Beware that you can easily break the program if youre not careful.

How do I make degesch look like the screenshot?

First of all, you must build it with Lua support. With the defaults, degesch doesnt look very fancy because some things are rather hackish, and I also dont want to depend on UTF-8 or 256color terminals in the code. In addition to that, I appear to be one of the few people who use black on white terminals.

/set behaviour.date_change_line = "%a %e %b %Y"
/set behaviour.plugin_autoload += "fancy-prompt.lua,thin-cursor.lua"
/set behaviour.backlog_helper = "LESSSECURE=1 less -R +Gb -PsBacklog ?ltlines %lt-%lb?L/%L. .?e(END):?pB%pB\\%..'"
/set behaviour.backlog_helper_strip_formatting = off
/set attributes.reset = "\x1b[0m"
/set attributes.userhost = "\x1b[38;5;109m"
/set attributes.join = "\x1b[38;5;108m"
/set attributes.part = "\x1b[38;5;138m"
/set attributes.external = "\x1b[38;5;248m"
/set attributes.timestamp = "\x1b[48;5;255m\x1b[38;5;250m"

Configuration profiles

Even though the applications dont directly support configuration profiles, they conform to the XDG standard, and thus you can change the location they load configuration from via XDG_CONFIG_HOME (normally ~/.config) and the location where store their data via XDG_DATA_HOME (normally ~/.local/share).

It would be relatively easy to make the applications assume whatever name you run them under (for example by using symbolic links), and load different configurations accordingly, but I consider it rather messy and unnecessary.

Contributing and Support

Use this projects GitHub to report any bugs, request features, or submit pull requests. If you want to discuss this project, or maybe just hang out with the developer, feel free to join me at irc://irc.janouch.name, channel #dev.

Disclaimer

I am not an antisemitist, Im just being an offensive asshole with the naming. And no, Im not going to change the names.

License

uirc3 is written by Přemysl Janouch <p.janouch@gmail.com>.

You may use the software under the terms of the ISC license, the text of which is included within the package, or, at your option, you may relicense the work under the MIT or the Modified BSD License, as listed at the following site:

Note that degesch technically becomes GPL-licensed when you compile it against GNU Readline, but that is not a concern of this source package.