Skip to content

Releases

xBNC 1.0.0

xBNC 1.0.0 Pre-release
Pre-release

Choose a tag to compare

@unixfool unixfool released this 21 Nov 19:39

First complete version, ready for testing on real networks (testenv/real/PLAN.md).

Added

  • One port for the panel and IRC ([web] shared = true, installer --single-port N): browsers get the panel and IRC clients the bouncer, with the same certificate; plain http:// is sent to https://, and an IRC client without SSL is told to turn it on.
  • The installer asks for the ports (one for everything, or one for the panel and one for IRC), refuses ports that browsers will not open (6667, 6697…) and ports in use, and refuses port options that an existing configuration would not apply (without --reconfigure).
  • DCC ports: the installer writes [dcc] ports = "50000-50100" and opens them in the firewall (--dcc-ports A-B|off).
  • Let's Encrypt by DNS for machines without port 80 (--dns cloudflare|digitalocean|ovh|linode|rfc2136 --dns-credentials FILE, or asked in the installer).
  • Profile photos in Your account: cropped to 256×256 in the browser, stored by xBNC after checking the real format (PNG, JPEG or WebP, at most 256 KB and 1024×1024), shown in the panel to the user and the administrators (PUT/DELETE /api/v1/me/avatar, GET/DELETE /api/v1/users/{id}/avatar).
  • The version appears everywhere as xBNC v1.0.0 - https://xbnc.org (panel, sign-in, IRC welcome, /msg *status version), taken from the version of the code: it is also the default CTCP VERSION reply (it can be changed in the CTCP module; {version} is replaced by the running version) and the QUIT message xBNC sends when it leaves a network (disconnect, reconnect, network turned off, shutdown).
  • Official signed plugin catalogue: when its key is set, xBNC checks it once a day and updates the installed plugins that have a newer version there, after checking the Ed25519 signature and each SHA-256.
  • Installation without installing anything first: the .zip brings the program ready-made for x86_64 in bin/ (it runs on any distribution from 2019 on, glibc 2.28 or later, and is checked against bin/SHA256SUMS before use). On other machines, or with --build, the installer runs the new scripts/prereqs.sh, which installs the build tools with the system's package manager (apt, dnf, yum, pacman, zypper or apk) and Rust with rustup, and builds the program as the owner of the source folder, never as root. It warns when there is not enough memory or disk to build. update.sh takes the program the same way. prereqs.sh --check says what is missing without installing anything.
  • The installer speaks the language chosen for the installation, and English is the default. In a terminal it asks first, with a menu of the language files (locales/*.json); --language CODE chooses it without asking. That language becomes xBNC's default language, and a language that is not built in is installed in /etc/xbnc/locales. The texts of the installer, prereqs.sh and update.sh are in a new installer section of the language files, so translating xBNC into a language translates its installer too. They are read with bash and awk only, and xbncd locales check checks them like the other texts.
  • The official logo in the panel (sign-in page, side menu and phone header, with dark letters on the light theme and white ones on the dark theme), as the icon of the panel, of the browser tab and of the app installed on a phone, in the wiki, on the website and in the README.
  • The documentation in Spanish in docs/es/, generated from the Spanish wiki like the English one in docs/.
  • /msg *status joinnow: joins the waiting channels at once, without waiting for the hidden host.
  • Ten new modules:
    • Services login: Undernet's X with Login on Connect, NickServ, Q and AuthServ, waiting for the hidden host before joining channels, and nick recovery.
    • Invite and unban with X, ChanServ or Q.
    • Character encoding (Latin-1 and Windows-1252).
    • Detached channels (/quote DETACH #channel).
    • Hide flooding channels.
    • Strip colours.
    • Get op back when left alone.
    • FiSH encryption (ECB and CBC) with DH1080 key exchange (/msg *crypt).
    • Ignore, with SILENCE on Undernet (/msg *ignore).
    • Scheduled tasks in your time zone.
  • Ten new official plugins: trivia, greetings, link titles, factoids, weather, RSS/Atom news, karma, quotes, bad words and games (hangman, magic 8 ball and rock-paper-scissors).
  • IRCv3 with the server: multi-prefix, extended-join, away-notify, account-notify, account-tag, chghost, userhost-in-names, invite-notify, setname and cap-notify. They are offered to clients too, and clients that do not ask for them receive the usual messages.
  • Time zone per user (Your account): log files and scheduled tasks in your local time.
  • Test report (Your account and GET /api/v1/diagnostics): capabilities, ISUPPORT and login state of each network, without passwords or messages.
  • Security policy (SECURITY.md) and real-network test plan (testenv/real/PLAN.md).
  • Complete documentation in English in docs/ (installation, clients, networks, commands, panel, modules, plugins, security, configuration, administration, data, API, architecture, threat model, performance, testing and common problems), generated from the English wiki, plus docs/STATUS.md. README, CONTRIBUTING, SECURITY and the test plan in English, and a “Test report” template for GitHub issues.
  • freenode and EvilNet in the network wizard. The Undernet entry uses port 6667 without TLS, because the network does not offer it.
  • Secret module settings (passwords and keys) are stored encrypted and the panel never shows them again.
  • Plugins can ask for timer events every 5 to 60 seconds (timer_secs).
  • Complete *status, with 64 commands:
    • Help grouped in sections, with the command names in bold and aligned columns, in English and Spanish. It shows only what your account can use. help <command> explains one with an example, and help <word> searches.
    • The names used by other bouncers are accepted too (ListChans, ListMods, AddTrustedServerFingerprint…), not case-sensitive.
    • Backup servers per network (addserver, delserver, servers, jump server). If a server fails, xBNC tries the next one straight away.
    • Trusted server certificates by their SHA-256 fingerprint (addfingerprint), for networks with a self-signed certificate.
    • Local address (vhost) per network and per user (setbindhost, setuserbindhost), administrators only.
    • Disabled channels that stay saved (disablechan, enablechan) and joining order (movechan, swapchans). Also nicks, topics, and attach and detach with wildcards.
    • History: playbuffer, clearbuffer with wildcards, clearallbuffers, clearallchannelbuffers, clearallquerybuffers and setbuffer.
    • addnetwork and delnetwork (with confirmation), availmods, reloadmod and uptime.
    • Administration: users, allnetworks, clients <user>, traffic, broadcast, movenetwork, rehash, listports, the server's message of the day (setmotd, addmotd, clearmotd, showmotd), restart and shutdown.
  • The panel marks disabled channels.
  • Translations in files: every text of xBNC (panel, sign-in page, IRC messages, *status help, modules) lives in locales/<code>.json, with English as the base and Spanish included.
    • A new language is added by copying its file to /etc/xbnc/locales/ (locales_dir in xbnc.toml or XBNC_LOCALES_DIR), without rebuilding, and it appears in every language selector and in /msg *status language. It is read at start and on reload (systemctl reload or /msg *status rehash).
    • Whatever a translation lacks is shown in English. Texts with line breaks, control characters or placeholders different from English are ignored.
    • xbncd locales check checks a file (what is missing, what is extra, placeholders and bold tags) and xbncd locales list shows the installed languages with their share translated.
    • TRANSLATING.md: guide for translators.
    • Public API GET /api/v1/i18n and GET /api/v1/i18n/{code}.
  • Wiki in English and Spanish at https://xbnc.org/wiki/, a website of its own that anyone can read without installing xBNC: one page per topic (getting started, using xBNC, features, administration, development, reference, help and project), search across all of it, and the project pages (what's new, roadmap, contributing, security policy and licence).
  • The 18 official plugins come installed: xBNC installs the missing ones on the first start and after each update, and updates old ones. They stay off on every network until each user turns them on. One uninstalled on purpose does not come back until the next version.

Fixed

  • Weather, link titles and news never answered: the official plugins that go out to the internet were installed without their sites approved, so every request was refused. They come approved now (installations made before are repaired once); a site blocked by an administrator stays blocked.
  • News: with more than one feed, only the first one was checked, and every minute instead of every interval. A feed that cannot be read is told to the user once and shown by /msg *news list.
  • Feed and page titles: numeric entities (&#8217;, &#x2014;) and CDATA after a line break are decoded.
  • Plugin web requests follow up to 3 redirects, only over https and only to approved sites (moved feeds, Wikipedia articles that are redirects).
  • Official plugins are replaced by the shipped ones also when the version number is the same but the file has a fix.
  • EvilNet identifies with NickServ: “Automatic” and the network wizard use it, and networks added before with the AuthServ login are sent to NickServ.
  • Language: changing it in Settings did not apply to someone who had chosen a language on the sign-in page (the panel stayed in that one). Now it is saved and applied when clicked, also to whoever changes it.
  • The seen, remind, tell, poll, chanstats and antiflood plugins turned on in 0.8.0 stored “es” as their lang...
Read more