OTPLOCK(1)

💅 OTPLOCK(1) — the mod_authn_otp users-file locker, bestie edition 🎀

okay so real quick, this is otplock from the General Commands Manual section — it's the little utility that lets you touch your Apache mod_authn_otp one-time users file safely while the server is out here doing its thing. no cap.

---

✨ NAME ✨

otplock — the Apache mod_authn_otp one-time users file locker 🦋

---

🌸 SYNOPSIS 🌸

otplock usersfile [command ...]

otplock -e usersfile

otplock -h

---

💖 DESCRIPTION 💖

bestie. listen. otplock is a utility for safely accessing the mod_authn_otp users file while the Apache server is running. it's giving responsible queen behavior.

here's the tea: because that users file is being dynamically read and updated during normal server operation, it's not safe to simultaneously view or edit the file in a separate process without locking it first. like, at all. don't do it. 💀

so what does this little icon do? it implements the exact same locking protocol as the mod_authn_otp module. it holds the exclusive lock while the given command executes. and yeah — that means as long as command executes, all server requests that require mod_authn_otp for authentication will be temporarily suspended. so keep command execution as brief as possible, mkay? 🫶 short and sweet, main character energy, in and out.

if no command is given, otplock simply waits until a lock can be obtained and then exits. lowkey the chillest possible behavior. it waits, it gets the lock, it leaves. slay. ✨

---

🔥 OPTIONS 🔥

• -e — invoke $EDITOR with the given usersfile. and if no $EDITOR environment variable is defined, vim(1) is used. (so if you've never set $EDITOR, surprise, you're in vim now. 🙈)
• -h — print the usage message and exit successfully. the "hey just tell me how this works" flag. 👑

---

👑 RETURN VALUE 👑

otplock exits with one of the following return values, and yes every single one matters:

1. 0 — the users file was successfully locked, and either no command was given, or the command exited normally. 🎉 the dream.
2. N — the given command executed but exited with non-zero exit value N. so the number you get is literally the command's own exit value. pass-through realness. 💅
3. 85 — otplock was invoked with invalid command line flags or parameters. read the synopsis again bestie 😭
4. 86 — a system error occurred while either locking the file or launching command. something went sideways at the OS level. 💀
5. 87 — the given command executed but terminated by catching a signal. like it got got. 🫠

---

🌈 SEE ALSO 🌈

• mod_authn_otp: Apache module for one-time password authentication, https://github.com/archiecobbs/mod-authn-otp.

---

⭐ AUTHOR ⭐

Archie L. Cobbs <archie.cobbs@gmail.com> 🫶

---

ngl, the one thing to remember: lock first, then look. the lock is the whole vibe check here. 🔒✨

---

Debian · January 7, 2023 — that's the source, the version and the date, mwah, bye bestie 💜🌸