Package: irssi Version: 1.4.3-2 Severity: minor Tags: upstream X-Debbugs-Cc: debbug.ir...@sideload.33mail.com
In the course of troubleshooting connection issues I found some problems with the /help pages that added to the frustration: /help server: ① “/server connect” is indistinguised from “/connect”. There are 3 ways to connect. It’s clear that /connect $network uses existing configs, but there is no documented difference between “/server connect” and “/connect $server-info”. ② negation is mostly undocumented. There is -auto/noauto, -cap/nocap, but what about -tls? TLS is apparently switched on by default whether the user asks for it or not. Yet TLS is mostly useless to onion hosts and localhost. One way or another, I had some servers configured for TLS and I needed to modify them to disable TLS. I first tried “/server modify -tls no” (because irssi.org instructs user to set things to “yes” or “no”, but apparently it is not intended to be literal). It failed because irssi could not find a host by the name of “no”. I eventually got lucky and tried -notls. Same confusion with -notls_verify. All negations should be documented. Perhaps a negations section which simply lists all the parameters for which negation is supported. ③ The -tls_cert option does not state /whose/ TLS cert - the user’s or the server? I worked it out that it must be the user’s. But this could easily be more clear. ④ -noautosendcmd is a /server option but there is no autosendcmd for the server (just the network). Does it suppress/override /network settings? It should state this explicitly. ⑤ -tls_pinned_pubkey does not state the required format -- whether the fingerprint needs colon (:) separators or not, or whether it needs a 0x prefix. I omitted the 0x prefix and used colons and got lucky. ⑥ -host is written as “The hostname you would like to connect from.” That’s bizarre. A hasty user would easily supply the host they are connecting TO because it’s abnormal to need to disclose where you are coming FROM. FROM should be in all caps. And it should be explained a little more because I’ve seen it used for other purposes, like org names or “unaffiliated”. ⑦ -port is redundant. Perhaps it has a meaningful purpose but it’s unclear considering “[port]” is also a positional argument. The purpose of -port should be indicated. I can imagine it might be needed with “/server modify” because the positional parameter is likely needed to match the record being changed. But this should be indicated. And note that the synopsis “SERVER ADD|MODIFY” combines them, so it’s unclear how -port works in the ADD context. ⑧ -rawlog takes a filename as a parameter, but this is not mentioned. ---------------------------------------- /help network: ① -sasl_mechanism is vague. I believe plain means username and password auth. The “external” arg is certainly unexplained an non-intuitive. Web sources imply that it’s used for the pubkey auth. But this unclear from the /help docs. To worsen matters, IRSSI is tolerant of malconfigs. That is, it allows sasl_mechanism to be external while also supplying a username and password. ② -user and -nick default to the user on the localhost. It’s important to mention this because someone could inadvertently disclose sensitive info. -- System Information: Debian Release: 12.10 APT prefers stable-updates APT policy: (990, 'stable-updates'), (990, 'stable-security'), (990, 'stable'), (500, 'oldstable') Architecture: amd64 (x86_64) Foreign Architectures: i386 Kernel: Linux 5.10.0-28-amd64 (SMP w/2 CPU threads) Kernel taint flags: TAINT_OOT_MODULE, TAINT_UNSIGNED_MODULE Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8), LANGUAGE not set Shell: /bin/sh linked to /usr/bin/dash Init: systemd (via /run/systemd/system) LSM: AppArmor: enabled Versions of packages irssi depends on: ii libc6 2.36-9+deb12u10 ii libglib2.0-0 2.74.6-2+deb12u5 ii libperl5.36 5.36.0-7+deb12u1 ii libssl3 3.0.15-1~deb12u1 ii libtinfo6 6.4-4 ii perl 5.36.0-7+deb12u1 ii perl-base [perlapi-5.36.0] 5.36.0-7+deb12u1 irssi recommends no packages. Versions of packages irssi suggests: ii irssi-scripts 20220704 -- no debconf information
