about summary refs log tree commit diff
path: root/README.7 (unfollow)
Commit message (Collapse)Author
2021-06-11Open save file with "a+"June McEnroe
Avoids another small TOCTOU. Rewind before loading since "a+" sets the file position at the end. Remove unnecessary fseek after truncation, since "a+" always writes at the end of the file.
2021-06-11OpenBSD: Drop now unneeded file system access for save fileKlemens Nanni
All opening happens before unveil/pledge and the file handle is kept open read/write so it can be used without any pledge. Simpler/less code and less chances to write other files (accidentially).
2021-06-11Open save file once in uiLoad() and keep it open until uiSave()Klemens Nanni
Opening the same file *path* twice is a TOCTOU, although not a critical one: worst case we load from one file and save to another - the impact depends on how and when catgirl is started the next anyway. More importantly, keeping the file handle open at runtime allows us to drop all filesystem related promises for `-s/save' on OpenBSD. uiLoad() now opens "r+", meaning "Open for reading and writing." up front so uiSave() can write to it. In the case of a nonexistent save file, it now opens with "w" meaning "Open for writing. The file is created if it does not exist.", i.e. the same write/create semantics as "w" except uiLoad() no longer truncates. existing files. uiSave() now truncates the save file to avoid appending in general.
2021-06-11Rename file to saveFileKlemens Nanni
Separate churn from actual change in upcoming diff, no functional change.
2021-06-11OpenBSD: Hoist loading save file to drop filesystem read-accessKlemens Nanni
After TLS cert/key files, the save file is the only file being read from; do so before pleding and drop the "rpath" promise all together: log files will only be created and written to.
2021-06-11Match gemini URLsJune McEnroe
2021-06-10Avoid trailing comma in whois channels listsJune McEnroe
The format of the reply is defined as "<nick> :{[@|+]<channel><space>}".
2021-06-10Move unveilAll back into mainJune McEnroe
It doesn't do as much anymore, so move it back inline.
2021-06-10Only explicitly load the default CA file on OpenBSDJune McEnroe
2021-06-10OpenBSD: Drop now unneeded promise from initial pledgeKlemens Nanni
Both ssl(8) as well as ncurses(3) related files are now read completely by the time of ircConfig() and uiInitEarly() respectively, so read access to the filesystem is no longer needed at all unless the "log" or "save" options are used.
2021-06-10OpenBSD: Remove now obsolete unveil codeKlemens Nanni
Previous tls_default_ca_cert_file(3) hoisting makes this possible: all TLS related files are fully loaded into memory by ircConfig() such that ircConnect() will not do any file I/O. Call ircConfig() before pledge(2) in the `-o' "print cert" case so this works out -- that order should have been preserved in the previous a989e15 "OpenBSD: hoist -o/printCert code to simplify" but fixing it now nicely demonstrates the achivement even more so.
2021-06-10Hoist loading default root certificates into ircConfig()Klemens Nanni
tls_connect_socket(3) in ircConnect() does that by default already unless tls_config_set_ca_file(3) was used. Loading CA certificates before connecting makes no practical difference except on OpenBSD where this allows for tighter unveil und pledge setups now that all required (TLS related) file I/O is finished by the time ircConnect() gets to do network I/O. In case of the hidden `-!' insecure flag which is implied by `-o' to print server certificates and exit, loading root certificates is not required at all; likewise, using explicit self signed server certificates will not involve certificate authorities either, hence load them only if needed.
2021-06-09Avoid creating out-of-bounds pointer when checking for seprintf truncationMichael Forney
It is technically undefined behavior (see C11 6.5.6p8) to construct a pointer more than one past the end of an array. To prevent this, compare n with the remaining space in the array before adding to ptr.
2021-06-09Remove catfJune McEnroe
2021-06-09Replace catf with seprintfJune McEnroe
2021-06-09Add seprintfJune McEnroe
Based on seprint(2) from Plan 9. I'm not sure if my return value exactly matches Plan 9's in the case of truncation. seprint(2) is described only as returning a pointer to the terminating '\0', but if it does so even in the case of truncation, it is awkward for the caller to detect. This implementation returns end in the truncation case, so that (ptr == end) indicates truncation.
2021-06-09OpenBSD: pledge minimum promises from the startKlemens Nanni
catgirl needs: - "stdio tty" at all times - "rpath inet dns" once at startup for terminfo(5) and ssl(8) - "proc exec" iff -R/restrict options is disabled - "rpath wpath cpath" iff -s/save or -l/log options is enabled Status quo: catgirl starts with the superset of all possible promises "stdio rpath wpath cpath inet dns tty proc exec", drops offline with "stdio rpath wpath cpath tty proc exec" and possibly drops to either of "stdio rpath wpath cpath tty", "stdio tty proc exec" or "stdio tty" depending on the options used. Such step-by-step reduction is straight forward and easy to model along the process runtime, but it comes with the drawback of starting with too broad promises right from the beginning, i.e. `catgirl -R -h host' is able to execute code and write to filesystems even though it must never do so according the (un)used options. Lay out required promises up front and pledge in two stages: 1. initial setup, i.e. fixed "stdio tty" plus temporary "rpath inet dns" plus potential "rpath wpath cpath" plus potential "proc exec" 2. final rutime, i.e. fixed "stdio tty" plus potential "rpath wpath cpath" plus potential "proc exec" This way the above mentioned usage example can never execute or write files, hence less potential for bugs and more accurate modelling of catgirl's runtime -- dropping "inet dns" alone in between also becomes obsolete with this approach.
2021-06-09OpenBSD: unveil after ncurses(3) init to support TERMINFOKlemens Nanni
initscr(3) in uiInitEarly() attempts more than /usr/share/terminfo/, see `mandoc -O tag=TERMINFO ncurses`. Even though non-default terminfo handling seems rare and it is unlikely to have ever caused a problem for catgirl users on OpenBSD, the current is still wrong by oversimplifying it. Avoid the entire curses/unveil clash by setting up the screen before unveiling.
2021-06-09OpenBSD: hoist -o/printCert code to simplifyKlemens Nanni
Nothing but the TLS handshake is required, so skip all other setup. On OpenBSD, unveil() handling needs fixing which will involve code reshuffling -- this is the first related but standalone step. Also pledge this one-off code path individually such with simpler and tighter promises while here.
2021-06-06Pad kiosk username with zero, not spaceJune McEnroe
Oops!
2021-06-06OpenBSD: unveil XDG directories only when neededKlemens Nanni
The (not perfectly obvious) way catgirl crafts directories gets triggered by unveilAll() even if no passed option requires filesystem access: $ env -i TERM=xterm ./catgirl -h irc.hackint.eu -R -n nobody catgirl: HOME unset Here unveil(2) is used due to the "restrict" option, but besides terminfo(5) and certificates catgirl does not need any other files, yet it tries to init the data path -- passing XDG_DATA_HOME=/var/empty makes above invocation work showing how the then successful path setup is not required. Fix this by not unveiling the unneeded data path in the first place.
2021-06-05Nickname defaults to system's username not IRC usernameKlemens Nanni
"username" alone is ambiguous and without jumping to ENVIRONMENT explaining the use of USER, catgirl's user- and nickname options read like pointing at each other: -n nick | nick = nick Set nickname to nick. The default nickname is the user's name. [...] -u user | user = user Set username to user. The default username is the same as the nickname. Clarify that `-n' does *not* default to `-u's value.
2021-06-05Avoid writing past the end of the status barMichael Forney
When waddnstr is called with a string that would extend past the end of the window, the string is truncated, the cursor remains at the last column, and ERR is returned. If this error is ignored and the loop continues, the next call to waddnstr overwrites the character at this column, resulting in a slight visual artifact. When the window is too small to fit the full status line, it is effectively truncated by one space on the right, since the string shown for each channel begins with a space. Additionally, if the last window is the current window, the space is shown with a colored background. To fix this, when waddnstr returns ERR, exit the loop in styleAdd() early return -1 to propogate this error down to the caller.
2021-05-28List windows with /window 1.8June McEnroe
Reuse the /window command to preserve /wi abbreviation.
2021-05-28Improve missing param behavior for /msg, /whois, /ns, /csJune McEnroe
2021-05-28Use | for /window | /num commandJune McEnroe
2021-05-28Prefix = for options with No in manualJune McEnroe
Without, the mandoc HTML output includes the space and equals in the class="Cm" element and generates a permalink of #hash_= for example.
2021-05-27Tag config options in manualKlemens Nanni
E.g. ":t debug" will now jump right to the definition just like ":t v" already did -- at least with mandoc(1) from OpenBSD.
2021-05-27Document channel key parametersJune McEnroe
2021-05-27Set username from SSH_CLIENT in chrootJune McEnroe
2021-05-27Hash the username in kiosk modeJune McEnroe
So that the first part of $SSH_CLIENT can be passed as username.
2021-05-27Log nick and ssh connection in chroot-promptJune McEnroe
2021-05-25Clarify -H hash optionJune McEnroe
2021-05-25Use reverse video not colors for topic change when disabledKlemens Nanni
`-H 0,0`/"hash = 0,0" makes catgirl mostly colorless which is great, but topic changes still hardcode brown/green colors to show differences which is usually not desired by users (like me) disabling colors. Go for a less eye stressing topic change message that shows both old and new in reverse video with default terminal colors. This isn't perfect, other parts of catgirl still hardcode colors and `-H 0,0`/"hash = 0,0" was never meant to disable colors completely, but topics change often enough that avoiding less readable^Waccessible topic diffs seems sensible enough. NB: parseHash() is brittle and "0,0" is not the only value disabling colors...
2021-05-25Use color enum instead of hardcoded valueKlemens Nanni
2021-05-20Don't require 4 parameters to ERR_USERONCHANNELJune McEnroe
It should have 4, but the handler only uses 3.
2021-05-19Replace freenode with tilde.chatJune McEnroe
2021-05-04Remove no longer needed advice about mandirJune McEnroe
2021-05-04Ignore messages in reply to previously ignored messagesJune McEnroe
Using the +draft/reply client tag, which is supported by BitBot. This hides the bot's replies to ignored users or ignored bot command messages. This commit is dedicated to the land of Estonia.
2021-05-04Add support for BINDIR, fix default MANDIR, use LDADD varsJune McEnroe
I avoided defaulting MANDIR to /usr/local/man because I thought it didn't work on GNU/Linux and users would be confused, but it turns out man-db's default configuration includes both /usr/local/man and /usr/man, so ${PREFIX}/man is a sensical default.
2021-04-27Reset formatting after realnamesJune McEnroe
2021-04-16Set id color from completion in /msgJune McEnroe
In the same way that /query copies the id color from completion. Also make both first check that a color isn't already set.
2021-04-16Always show 341 RPL_INVITINGJune McEnroe
At least in InspIRCd's implementation, you only get invite-notify INVITEs if you are op, so inviting with no op (where allowed by a channel mode) results in only a 341. On the other hand, inviting as an op produces both a 341 and an INVITE, so will be displayed twice, but showing something sometimes twice is better than not showing it at all.
2021-04-02Skip STATUSMSG prefixesJune McEnroe
This feature is rarely used, so just skip STATUSMSG prefixes in the target so messages get routed correctly.
2021-03-18Fix README typo 1.7June McEnroe
How long has this been here?
2021-03-17Add C-z keys for directly inserting most color codesJune McEnroe
So you don't have to remember those dang numbers whose order makes no sense!
2021-03-17Reset style after newline in inputJune McEnroe
Reflect what will actually be sent.
2021-03-17Show where too-long-messages will be automatically splitJune McEnroe
2021-03-14Allow multi-line /me and split long /me messagesJune McEnroe
/me shouldn't behave differently from a regular message.
2021-03-13Refer to glob(7) not sh(1)Klemens Nanni
Those patterns are not specific to the shell, many commands support them. Notes: glob(7) does not exist on FreeBSD, but I'm going to consider that a documentation bug on FreeBSD's part. The page exists in OpenBSD, NetBSD and even Linux!