An RFC-compliant IRC daemon written in D
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Les De Ridder 8e461051cd Add basic PROXY (version 1) debug support 1 week ago
source/ircd Add basic PROXY (version 1) debug support 1 week ago
.gitignore Refactor version info generation 1 month ago
LICENSE Update license year 9 months ago
README.md Add basic PROXY (version 1) debug support 1 week ago
config.template.sdl Convert tabs to spaces 9 months ago
dub.sdl Update readme 1 week ago
dub.selections.json Update dependencies 1 month ago
generate-version-info.fish Refactor version info generation 1 month ago

README.md

salty-ircd

salty-ircd is an Internet Relay Chat daemon written in D.

Goals

The main goals of salty-ircd are strict RFC compliance and security.

RFC compliance

salty-ircd aims to be fully compliant with the IRC RFCs (by default), specifically RFC 1459, RFC 2811, RFC 2812, and RFC 2813 (planned), including all errata. Newer RFCs take precedence over older RFCs.

Any additional features breaking RFC compliance are available through compile-time options.

Security

The following rules apply when any compile-time option is enabled (breaking strict RFC compliance):

  • TLS is required for all connections, except connections from localhost (useful for running a Tor hidden service, which already has encryption)
  • TLS client certificates are required for oper and vhost authentication

Building

Build dependencies:

  • A D compiler
  • dub
  • fish
  • git

Build command:

  • RFC compliant: dub build
  • Modern (all additional features): dub build -c=modern

The ‘modern’ configuration aims to be mostly compatible with UnrealIRCd user modes/chars.

When -d=ProxyV1 is added to the build command, salty-ircd can accept traffic through the PROXY protocol (version 1), e.g. from an UnrealIRCd server running with a custom module. Please see this module’s readme for more information. Note that this is simply a development/debugging option and should not be used for a production server.

TODO: Add a method to supply a custom list of compile-time options.

Running

First, create the configuration file, config.sdl. You can find a template in config.template.sdl.

Then, simply run ./out/salty-ircd.

License

University of Illinois/NCSA Open Source License.