ergo/CHANGELOG.md

Changelog

All notable changes to Oragono will be documented in this file.

This project adheres to Semantic Versioning. For the purposes of versioning, we consider the “public API” to refer to the configuration files, CLI interface and database format.

[0.12.0] - 2018-10-15

There’s been a host of changes in the past six months, and this Halloween release has a number of very useful improvements.

For example, passwords are now hashed in a much better way than we did it before (jlatt’s original method back from Ergonomadic was the right way to do things), the database now auto-upgrades for you when it detects a new version, thanks to Slingamn we now have vhosts, and there’s been a ton of rewrites under-the-hood to improve stability and performance.

If you have any trouble with this release, please let us know with an issue on our tracker, or by talking to us in #oragono on Freenode.

Thanks to slingamn for a lot of heavy lifting this release and to vilmibm for contributing a documentation fix!

Config Changes

• allow-multiple-per-connection key removed from accounts.
• autoupgrade key added under datastore, specifying whether to upgrade to new database versions automatically.
• bcrypt-cost key added under accounts, to control how strongly account passwords are hashed.
• stackimpact section removed from debug.
• unix-bind-mode key added under server, controlling the bind mode used for unix listening sockets.
• vhosts section added under accounts, configuring our new vhost support.
• new oper capabilities accreg, sajoin, vhosts and chanreg added.

Security

• Password hashing has been improved (with current passwords being automatically upgraded to use the new method).
• Various crashes have been resolved.

Added

• Added database auto-upgrades.
• Added new subcommands to ChanServ including:
  • AMODE to allow setting persistent channel modes for users.
  • DROP to unregister a channel.
• Added vhosts (virtual/vanity hosts), controlled via HostServ.

Changed

• ChanServ and NickServ now show in their help output when commands have been disabled.
• Channel keys and modes are now stored for registered channels.
• Client capability handling rewritten under-the-hood.
• Disabled services commands now show as disabled (rather than being completely hidden).
• Many under-the-hood optimisations (thanks @slingamn!).
• Rehashing is now more consistent and safe.

Removed

• Removed StackImpact debug support, as we don’t find it useful these days.

Fixed

• Fixed LUSERS to make it display correct client count and output correct params (thanks @moortens!.
• Fixed PROXY support for IPv6 clients.
• Fixed SAMODE crash when using it on a channel you’re not joined to.
• Fixed WHOIS so that RPL_WHOISACCOUNT is now sent correctly.
• Fixed fakelag timing to better match expected values.
• Fixed issue where incoming and outgoing private messages were being incorrectly modified (a space was being added to the end) due to a bug with our protocol handling.
• Fixed password hashing method, with existing passwords being auto-upgraded to use the new method.

[0.11.0] - 2018-04-15

And v0.11.0 finally comes along! This release has been in the works for almost four months now, with an alpha and beta helping square away the issues.

We’re adding a lot of features to improve debugging, better support international users, and make things better for network administrators. Among the new features, you can use the LANGUAGE command to set a custom server language (see our CrowdIn to contribute), expose a debugging pprof endpoint, reserve nicknames with NickServ, and force email verification for new user accounts. On the improvements side we have a CAP REQ fix, and we now have a manual that contains a nice overview of Oragono’s documentation.

If you have any trouble with this release, please let us know with an issue on our tracker, or by talking to us in #oragono on Freenode.

Thanks a bunch to everyone for the help with this release – especially to our translators and to Slingamn for being an awesome co-maintainer!

Config Changes

• callbacks section added under accounts/registration, configuring our new email verification (disabled by default).
• fakelag section added, configuring our new fakelag implementation.
• ips-per-subnet key renamed to connections-per-subnet.
• motd-formatting is now enabled by default.
• nick-reservation section added under accounts, configuring our new nickname ownership abilities.
• nofakelag and unregister oper classes added.
• pprof-listener key added under debug (disabled by default).
• skip-server-password key added under accounts, to better support certain clients.
• verify-timeout default value changed from 120 hours to 32 hours under accounts/registration.

Added

• Added 32-bit builds.
• Added a debug pprof endpoint, which is disabled by default and can be exposed in the config.
• Added a manual to our documentation! This is primarily where we’ll be adding user-facing information and instructions from now on.
• Added current running git commit to the sent version string.
• Added fakelag, so that the server can slow down clients hitting it too aggressively. Disabled by default while we work out the kinks and the specific settings (thanks @slingamn!).
• Added IRCv3 capability batch and draft capability draft/labeled-response.
• Added listening support for unix sockets.
• Added new Brazilian Portuguese translation (thanks to Alexandre Oliveira!)).
• Added new French translation (thanks to Joshua!).
• Added new Norwegian translation (thanks to Morten!).
• Added new subcommands to CHANSERV, including:
  • OP to op yourself or the given user (can only be run by channel founders).
• Added new subcommands to NICKSERV, including:
  • DROP to de-associate a nickname from your current account.
  • GHOST to remove the given client (if they’re logged in with your user account).
  • GROUP to associate a nickname with your current account.
  • IDENTIFY to login to an account.
  • INFO to see information about the given (or your own) account.
  • REGISTER to register an account.
  • UNREGISTER to delete your account.
• Added new Turkish translation (thanks to Yaser!).
• Added proposed IRCv3 capabilities draft/languages and draft/resume.
• Added the ability to associate multiple nicknames with your account, and enforce nickname ownership.
• Added the ability to force email verification when users register accounts.
• Added user modes, including:
  • B: Mark yourself as a bot, and display that you’re a bot in WHOIS.

Changed

• genpasswd now requires that you confirm the input passphrase.
• Message IDs are now much shorter and easier to read – down from 39 characters to 16 while preserving a very similar gaurantee of uniqueness (thanks @prawnsalad for bringing up this issue).

Fixed

• We now correctly suspend registration when receiving a CAP REQ, as per the spec.
• We now properly cut off clients who try to send us too much data at once.

[0.10.3] - 2017-12-26

This patch fixes a couple bugs, updates cap/isupport token names in response to spec changes, and allows unprivileged users to list channel bans. Ah, DLINE and KLINE also store oper names, so you can see who set those pesky bans later on!

Overall, a fairly standard patch that just improves things. No config changes, no database changes.

Also, Merry Christmas and Happy Holidays!

Added

• DLINE/KLINE: We now save the name of whichever oper set the ban (and display it later).

Changed

• draft/maxline capability is now oragono.io/maxline.
• WHO: First parameter now must be a mask or channel name, cannot be ommitted.
• Casemapping is now advertised using the UTF8MAPPING token, matching the new spec changes.
• We now allow unprivileged users to list channel bans.

Fixed

• Fixed a bug around removing channel bans.
• Fixed a client timeout bug.

[0.10.2] - 2017-11-13

This patch release fixes a bunch of crashes that were introduced in the last release, 0.10.1.

If you have 0.10.1 running, replace it with this release.

Security

• Fixed lots of miscellaneous crashes.

[0.10.1] - 2017-11-09

This patch release of Oragono fixes a fairly big channel mode bug, where users could set channel modes when they weren’t actually allowed to.

Config Changes

• recover-from-errors key added under debug, which enables recovery from client-caused errors (at the cost of possible server instability).

Security

• Clients could set channel modes when they weren’t supposed to be able to.

Added

• We now allow recovering from client-caused panics.

Fixed

• SAMODE now lists other users’ modes.
• Removed some possible crashes and races.

[0.10.0] - 2017-10-23

There has been a bunch of new changes in this release! From sts being ratified to supporting WEBIRC to rewriting a whole lot of our internals, 0.10.0 represents a real step forward in terms of where Oragono’s going.

In addition to the new features, this issue fixes a bunch of fairly large bugs (such as an errant INVITE being able to crash the server, the +mRchannel modes not working at all, and making rehashing safer).

I’d like to thank @slingamn for really contributing a lot in this release! He’s done a whole bunch of the internal work, cleaned up the code, and in general just been a great help while developing. Running Oragono on an actual network has really helped find and track down some serious bugs, and lead us to some much-needed improvements.

Config Changes

• motd-formatting key added under server, which supports MOTD formatting characters.
• rest-api section removed from server (since we no longer support the Rest API).
• webirc section added under server, which specifies the gateways can use the WEBIRC command.
• ws-listen key removed from server (since we no longer support websocket ports).
• Connection limits and connection throttling has become more relaxed by default.

Security

• INVITE: Fixed a server crash when sending an invite for a channel that doesn’t exist (thanks @josephbisch for telling me about the bug!).

Added

• Added support for the WEBIRC command, allowing gateways to connect.
• We now list XLINEs with DLINE LIST and KLINE LIST.
• We now support using escaped formatting codes in the MOTD (tl;dr easy colors, bold and italics).

Changed

• D-LINE and K-LINE code is now cleaner under the hood and less likely to crash.
• Ident (looking up usernames) now times out a whole lot quicker, meaning you connect to the server more quickly.
• IRCv3 capability draft/sts has been renamed to sts, since it’s now been ratified.
• Rehashing is now safer.
• Server opers could always speak on channels, even when they shouldn’t be able to. Now they aren’t above the law.

Removed

• Removed the draft/message-ids cap since… it doesn’t actually exist. The feature is now enabled by default when clients request the draft/message-tags-0.2 capability, as written in the Message IDs spec.
• Removed websocket support (conflicted with existing larger IRCd’s implementations and not used by any real clients).
• REST API has been removed, until we can build up the web interface in parallel with it.

Fixed

• AWAY was sending an incorrect mode string, and now sends the correct mode string (thanks @jwheare for pointing this out).
• Fixed some bugs with our MONITOR implementation which meant we weren’t returning the right info to clients.
• The Moderated (+m) and RegisteredOnly (+R) channel modes could not be set. Now they can be set.

[0.9.1] - 2017-09-28

This is a patch release to fix compatibility with Irssi and resolve some issues! Thanks very much @dequis, @slingamn and squigz for the help and for bringing up the issues.

Added

• Allow the MODE b syntax, which certain clients use to check lists.

Changed

• QUIT: We now send the actual quit message to other users.

Fixed

• Fix incorrectly forwarding AWAY messages to clients without away-notify.
• Fix incorrect login check which prevented account registration.
• Fix ERR_NOSUCHNICK numerics (we weren’t sending the nick correctly).

[0.9.0] - 2017-09-25

So many fixes! You can now set the default modes for new channels, use HAProxy again, use the umode +R to protect yourself against unwanted PMs, and we now warn on configurations/setups that look incorrect!

In addition, this release makes testing easier, makes sure we better adhere to the SASL specification and also removes some memory leaks around the place. All in all, just a solid upgrade and less bugs across the board.

Config Changes

• Added allow-multiple-per-connection flag under accounts/registration, which can be used for account setup by testing software. Never enable it in production.
• Added default-modes key under channels, which is a standard modestring that’s applied to new channels.
• Added proxy-allowed-from key under server, which is a list of hostnames/IPs that the HAProxy PROXY command can be used from.

Security

• Clients could use a nickname that isn’t sane. This has the possibility of allowing clients to subvert our admin commands and monitoring features.

Added

• Added a warning if the server’s not listening on a TLS port or if it’s not listening for TLS connections on port 6697.
• Added a warning if you’re trying to run from source or an otherwise unreleased version.
• Added INFO.md document to better explain the design decisions behind Oragono, exactly how to rehash, etc.
• Added support for HAProxy’s PROXY v1 command, useful for certain installations.
• Added user modes, including:
  • R: Only receive private messages and notices from other registered users.

Fixed

• Fixed a bug where certain clients couldn’t connect as we were incorrectly rejecting their valid PTR record (thanks @slingamn!).
• Fixed a crash around monitoring clients.
• Fixed a memory leak in our socket code when clients disconnect.
• Fixed a SASL bug that resulted in certains clients getting caught in a cycle of trying (and failing) to abort authentication.
• Fixed an instance where clients could use a nickname that isn’t sane (thanks @euank!).
• Fixed an issue where certain clients who connect incorrectly would stay connected (thanks @euank!).
• Fixed how we handle particularly unique Unicode strings (we now ensure they stabilize while casefolding).
• Fixed some issues around rehashing, where listeners wouldn’t rehash in time and could crash (thanks @slingamn!).

[0.8.2] - 2017-06-30

Just a patch release to fix a bug! The bug that’s been fixed prevented you from modifying channel privilidges at all, which isn’t great. With this release, now you can do so again!

This is one I’m gonna have to add to the testcases, to make sure it doesn’t happen again.

Fixed

• Fixed a bug where users could not give other users operator/halfop/voice in channels.

[0.8.1] - 2017-06-26

Lots of quality-of-life fixes, improved oversight for opers, and a proposed channel renaming command!

With this release, we’re moving to a proper Github organisation, becoming more consistent with other IRCds, and introducing a bunch more snomasks. In addition, when setting DLINE and KLINE bans, you can also kill all clients who match the ban by supplying the parameter ANDKILL when you set the ban.

Channel LIST filtering is now more useful, and I’ll keep expanding this in future releases. As well, there’s been some useful extensions to WHOIS, and a bug with SANICK fixed thanks to @lbeziaud. @enckse has also added Oragono to the Arch AUR, to make it easier to install on that distro.

Thanks to everyone for suggesting improvements and reporting issues! There’s a lot to do as we move forward, and I have a pretty decent plan of where to go next.

Added

• Added proposed channel rename capability draft/rename.
• Send a bunch more server notice masks, now including:
  • j: Channel registration.
  • k: Kills, including those resulting from DLINEs and KLINEs.
  • n: Nick changes.
  • o: Clients opering-up.
  • q: Clients quitting.
  • u: Account registration and login.
  • x: Setting and removing DLINE/KLINE.

Changed

• DLINE and KLINE: Added ANDKILL parameter to also kill all clients that match the ban.
• LIST: Implement extended list conditions U (which filters the channels by user count).
• Renamed a number of dependency libraries, and changed Oragono to its’ own organisation (only useful if you’re building Oragono from source).
• WHOIS: Show the target’s real IP address if you’re whoising yourself or you’re an oper.
• WHOIS: Show whether the target has connected securely using TLS.

Removed

• Removed the JOIN 0 command (matching what InspIRCd has done here), since this is easily abusable.

Fixed

• SANICK works properly now (thanks @lbeziaud!).

[0.8.0] - 2017-05-09

Debugging! Fixes! Better realtime monitoring!

This release isn’t too exciting, but packs large improvements to how we handle floods and similar issues. As well, the introduction of snomasks (take a look at /HELPOP snomasks) should help opers keep a basic view over their server during use. Only the "c" (connects) snomask is active right now, but others will be added and extended in future releases.

Config Changes

• Added debug section containing additional debug settings.
• Added modes key on oper config, for setting modes on oper-up.
• Added ability to log to stdout in logger methods.

Added

• Added ability to log to stdout.
• Added ability to use StackImpact profiling.
• Added initial server notice masks (snomasks).

Changed

• Socket code rewritten to be a lot faster and safer.
• Updated account registration to use the latest proposed syntax (now being /ACC REGISTER instead of /REG CREATE).

Fixed

• Clients now timeout properly if they don’t complete connection registration.
• Word wrapping (with draft/maxline) no longer randomly drops characters.

[0.7.2] - 2017-04-17

This is a patch release of Oragono to fix discovered bugs and crashes. I’ll also be implementing some more stringent checks before pushing releases after this, to ensure these same sort of bugs don’t happen again.

Security

• Fixed a bug where any user joining an unregistered channel was given chanop status (thanks @vegax87).

Fixed

• Fixed a number of various crashes and races.

[0.7.1] - 2017-03-28

This is a quick patch release of Oragono to work around a discovered bug.

Security

• Fixed a bug where non-logged in users could register channels. Bleh.

[0.7.0] - 2017-03-27

This release brings channel registration with ChanServ, logging improvements, and a whole host of improvements across the board.

Thanks to a suggestion by dp- on our channel (#oragono on Freenode), the socket handling code has been overhauled to allow for a larger number of more stable connections. As well, improved testing has brought with it a bunch of strange hang and crash fixes, which means that Oragono should be more stable than ever.

Channel registration is really cool. Essentially, you register the channel with /CS REGISTER as you would on any network, and then all topic changes, the +b/+e/+I lists, and your founder status, are all remembered and re-applied when the server’s restarted.

Config Changes

• channels section added to control channel registration.
• logging key under server removed, replaced with logging section.
• max-sendq key added under server.
• registration and authentication-enabled keys moved under accounts section.
• samode capability added to oper capabilities.
• sts section added under server.

Added

• Added ChanServ service, to allow channel registration.
• Added USERHOST command (thanks @vegax87).
• Added SAMODE command.
• Added draft IRCv3 capability draft/sts.

Changed

• DLINE and KLINE now let you specify years, months and days (e.g. 1y12m30d) in durations.
• Logging is now much more useful, displays colours and can log to disk.
• Socket handling has been rewritten, which means we should support more connections more effectively (thanks dp- for the suggestion!).

Fixed

• Fixed a bunch of small hangs and crashes.
• Fixed an account issue where clients could login to multiple accounts at once.
• Fixed an issue where server times were incorrect (thanks @martinlindhe!).
• Fixed halfops not being able to talk during moderated mode (+m).
• Fixed issues that prevented rehashing after the first rehash had gone through successfully.
• Fixed the inability to view channel ban, ban exception, and invite exception lists.

[0.6.0] - 2017-01-19

We’ve added a ton of new features in this release! Automated connection throttling, the ability to KLINE, updated casemapping and line-length specifications.

I’ve also started including a new section in the changelog called Config Changes, which should help you find what you need to update across releases.

Config Changes

• enabled key added under the connection-limits section.
• connection-throttling section added under server.
• linelen section added under limits.

Added

• Added ARM build (for Raspberry PIs and similar).
• Added automated connection throttling! See the new connection-throttling section in the config.
• Added KLINE and UNKLINE commands. Complementing DLINE’s per-IP and per-network bans, this lets you ban masks from the server.
• Added LUSERS command (thanks @vegax87).
• Added draft IRCv3 capabilities draft/message-tags-0.2 and draft/message-ids.
• Added proposed IRCv3 capability draft/maxline.

Changed

• Changed casemapping from “rfc7700” to “rfc7613”, to match new draft spec.
• Connection limits can now be freely enabled or disabled. If updating, check the new enabled flag under the connection-limits section of the config.

Fixed

• Fixed an issue where UNDLINE didn’t save across server launches.
• Removed several race conditions which could result in server panics.
• WHOIS: Multiple channels now appear in a single reply (thanks @vegax87).

[0.5.0] - 2016-12-10

This release includes a ton of fixes, as well as the ability to ban IP addresses from your network with the DLINE command!

As well, there are some major fixes with the libraries Oragono depends on, which fix various DoS attacks, crashes and timeouts. In short, this release is more stable and fixes a bunch of issues.

This release also updates the database, so be sure to run the oragono upgradedb command.

Added

• Added ability to ban IP addresses and networks from the server with the DLINE and UNDLINE commands.
• Added alpha REST API (intended primarily for use with a future web interface to manage accounts, DLINEs, etc).

Changed

• Database upgraded to make handling accounts simpler.
• Only give chanop (@) on channel join, not channel founder (~). We’ll do channel founder and all on registered chans only.

Fixed

• Fixed a bunch of bugs around setting nicknames on join.
• Fixed crash when using STATUSMSG-like messaging.
• Fixed crash with gIRC-Go ircmsg library we depend on.
• Fixed not sending MODE changes to all clients in a channel.
• Fixed timeout issue with go-ident library we depend on (which caused hangs on connection).
• Prevented a DoS related to lots of clients connecting at once.
• Removed races around setting and changing NICKs, to be more safe.
• Send channel NOTICEs properly.

[0.4.0] - 2016-11-03

This release packs a more extensive oper privelege framework, bugfixes for capabilities/modes, support for new RP commands and more RPL_ISUPPORT tokens. In general, a bunch of new features and bugfixes to make using Oragono more smooth.

Added

• Added automatic client connection limiting, similar to other IRCds.
• Added operator classes, allowing for more finely-grained permissions for operators.
• Added roleplaying commands, both inside channels and between clients.
• Length of channel mode lists (ban / ban-except / invite-except) is now restricted to the limit in config.
• Support MAXLIST, MAXTARGETS, MODES, TARGMAX in RPL_ISUPPORT.
• Added support for IRCv3 capability chghost.

Changed

• In the config file, “operator” changed to “opers”, and new oper class is required.

Fixed

• Fixed being able to change modes when not an operator.
• Fixed bug where HELP wouldn’t correctly display for operators, and added more help topics.
• Fixed bug where you would always have certain capabilities enabled.
• Fixed display of large MONITOR lists.

[0.3.0] - 2016-10-23

We now support dynamically reloading the config file, along with some new IRCv3 capabilities and some fixes.

The REHASH changes are fairly extensive here, but should now be stable (this also fixes a denial of service possible with the old code).

Security

• Prevent a denial of service where the server would stop accepting connections.

Added

• Added REHASH command.
• Added ability to message channel members with a specific privelege (i.e. support for STATUSMSG).
• Added ability to enable and disable SASL.
• Added support for IRCv3 capabilities cap-notify and echo-message.

Changed

• Server operators no longer have permissions to do everything in channels.

Fixed

• MODE: Fixed issue where channel privelege changes returned incorrectly.

[0.2.0] - 2016-10-16

Improved compatibility, more features.

Now comes with a new proper Unicode-capable casemapping and integrated help!

Added

• Added integrated help (with the /HELP command).
• Added support for IRCv3.2 capability negotiation including CAP values.
• Added support for IRCv3 capabilities account-notify, invite-notify, monitor, sasl, and draft capability message-tags as draft/message-tags.

Changed

• Casemapping changed from custom unicode mapping to preliminary rfc7700 mapping.

Removed

• Removed channel persistence with the +P mode (not too useful as currently implemented, to be replaced later).
• Removed the PROXY command (breaks our TLS user mode, and our integrated support for TLS should be fine).

[0.1.0] - 2016-09-18

Initial release of Oragono!

Security

• PROXY command is now restricted appropriately.
• Nicknames, usernames and channel names that break the protocol are no longer allowed.
• Default channel modes set to restrict new channels more appropriately by default.

Added

• YAML config file format.
• buntdb key-value store for persistent data.
• Native SSL/TLS support (thanks to @edmand).
• Ability to generate testing certificates from the command line.
• Support for looking up usernames with ident on client connection.
• RPL_ISUPPORT numeric as advertised by most other IRCds today.
• Ability to parse complex mode change syntax commonly used these days (i.e. +h-ov dan dan dan).
• User mode for clients connected via TLS (+Z).
• Ability to register and login to accounts (with passphrase or certfp).
• Added support for IRCv3 capabilities account-tag, away-notify, extended-join, sasl, server-time, and userhost-in-names.

Changed

• Channel creator (O) privilege changed to founder/admin/halfops (qah) privileges.
• Private (+p) channel mode changed to secret (+s), to match what’s used by servers today.
• Default channel modes changed to (+nt), matching most other IRCds.
• CLI commands and arguments made more consistent with typical software.
• Usernames set by the USER command now start with "~" (to work with new ident support).
• Renamed ONICK command to SANICK to be more consistent with other IRCds.
• Made maximum nickname and channel name lengths configurable.
• Made maximum WHOWAS entries configurable.

Removed

• Removed gitconfig configuration format [replaced with YAML].
• Removed sqlite database [replaced with buntdb key-value store].
• Removed THEATER command (it broke and I’m not that interested in putting the work in to get it working again with the aim of this project. PRs accepted).

Fixed

• Fixed clients no longer being able to send commands after a single command errored out.
• CAP: Registration is now properly suspended during CAP negotiation.
• CAP: Remove CAP CLEAR (recommended in IRCv3 3.2), and allow capability negotiation after registration.
• MODE: Fixed <modestring> evaluation (we were parsing all ungrabbed parameters as a modestring, when it is actually only the first param).
• MODE: New-style mode change syntax (with both adding and removing modes in a single MODE command) is now parsed properly.
• MOTD: Now store MOTD in-memory rather than on-disk, and don’t limit it to 80 characters per line (not required with today’s servers or clients).
• NICK: Restrict nicknames that break the protocol.
• USER: Restrict usernames that break the protocol.
• PROXY: Restrict to specified hostnames only.
• WHOIS: Include the required <nick> param on RPL_ENDOFWHOIS.
• WHOIS: Hide hidden channels in WHOIS responses.