twoftpd-auth(1)

📦 version 1.42, in ubuntu jammy

💖 twoftpd-auth — the manual page, bestie edition 💖

okay so you're reading the twoftpd-auth page from the General Commands Manual (it's twoftpd-auth(1), iykyk) and honestly? it's giving "small program, big responsibilities." let's get into it 🫶

✨ NAME ✨

twoftpd-auth — the TwoFTPD authentication front-end. she's the bouncer at the door, fr fr 💅

🌸 SYNOPSIS 🌸

twoftpd-auth cvmodule twoftpd-xfer

🦋 DESCRIPTION 🦋

okay so here's the whole vibe: twoftpd-auth reads a username and a password straight off the network, and authenticates them using the CVM module called cvmodule. that's the job. that's the whole job. 👑

and if the authentication succeeds? that's when things get exciting, bestie. it sets these environment variables to the user's actual info:

  • UID — the user's UID
  • GID — the user's GID
  • HOME — the user's home directory
  • USER — the user's login name

...and then it executes twoftpd-xfer. main character handoff energy. ✨

it also sets:

  • GROUP — but only if the CVM reports a group name (so it's conditional, not guaranteed, don't come for me)
  • AUTHENTICATED — set to 1. and lowkey this one matters because both twoftpd-auth and twoftpd-xfer look for this variable to figure out what startup banner code to use. so it's not decorative. it's load-bearing. 💀

🎀 ENVIRONMENT 🎀

the environment variables, in order, no skips, no cuts:

  • AUTH_ATTEMPTS — the maximum number of authentication attempts to allow before dropping the connection. basically how many tries you get before the door just closes on you. 🙈
  • AUTH_TIMEOUT — the maximum number of seconds to wait for successful authentication. the clock is ticking, babe ⏰
  • LOGINBANNER — if set, the contents of this variable will be sent as extra responses before the user logs in. a little pre-roll, a little trailer, a little hello before the actual hello. 🎬
  • TIMEOUT — the maximum number of seconds to wait for command input. different timer, same "don't take forever" energy. ⭐

💜 SEE ALSO 💜

okay that's the page!! huge shoutout to twoftpd-auth(1) for being the moment, and the whole thing is filed under General Commands Manual. go read twoftpd-xfer(1) next, bestie, they're a package deal 🫶💖🎀

📦 where this page comes from