YUBISERVER-ADMIN(1)

👑 YUBISERVER-ADMIN — the group chat guide 💅

okay so bestie, welcome to yubiserver-admin, section 1 of the General Commands Manual. this is literally the admin tool for the yubiserver Yubikey OTP and HOTP/OATH validation server and i'm gonna walk you through it like we're texting at 2am. no cap. 🦋

---

✨ NAME ✨

yubiserver-admin — the Administration tool for the yubiserver Yubikey OTP and HOTP/OATH validation server. that's the whole vibe. 💖

---

🌸 SYNOPSIS 🌸

yubiserver-admin [[-b FILE]] [table] [options]

yeah. that's the shape of it. a FILE, a table, some options. simple, clean, iconic. ✨

---

🎀 DESCRIPTION 🎀

so yubiserver-admin is a free tool that exists purely to let you admin the simple and lightweight OTP and HOTP/OATH validation server. that's it, that's the job, and it does it. lowkey obsessed with how unbothered this little program is. 🫶

---

💅 OPTIONS 💅

these programs follow the usual GNU command line syntax, bestie — long options start with two dashes (`-`). here's the full rundown, no skips, no shortcuts:

• -y, --yubikey — pick the Yubikey Token table. 🗝️
• -o, --oath — pick the OATH Token table.
• -p, --api — pick the API Key table.
• -a N [P S [A]], --add N [P S [A]] — add a Yubikey/OATH token or API Key N user, where N is the username, P is the Public Token ID, S is the Secret ID, and A is the AES Key. the deets, and you GOTTA get these right: N must be 16 characters max, P must be 12 characters for Yubikey and HOTP/OATH. S must be 12 characters for Yubikey and 40 for OATH, and the AES key must be 32 characters. adding a user to API keys requires a username and an API Key 20 characters long. ✨
• -x, --delete — delete the Yubikey/OATH token or API Key N user. bye bestie 👋
• -e, --enable — enable the Yubikey/OATH token N user.
• -d, --disable — disable the Yubikey/OATH token N user. not mad, just disappointed. 🙈
• -l, --list — list Yubikey/OATH token or API Key.
• -d, --database — use this SQLite3 database file (optional). (yes, -d really does show up twice in this house. i don't make the rules, i just report them. 💀)
• -h, --help — show summary of options. your safe space. 🫶
• -V, --version — show version of program.

---

🌈 Examples 🌈

adding a new user for Yubikey OTP authentication

• yubiserver-admin -y -a nanakos ccicdcfehlvv c6963f285d78 108e504f37fef82s3b6gb3a45708405c
• yubiserver-admin -b yubiserver.sqlite -y -a nanakos ccicdcfehlvv c6963f285d78 108e504f37fef82s3b6gb3a45708405c

adding a new user for Yubikey HOTP/OATH authentication

• yubiserver-admin -o -a nanakos ccicdcfehlvv 7b02bee356c98c4c7488af9e54vve710de33e9f7
• yubiserver-admin -b yubiserver.sqlite -o -a nanakos ccicdcfehlvv 7b02bee356c98c4c7488af9e54vve710de33e9f7

adding a new API Key user — needed for enabling your user to validate to the server

• yubiserver-admin -p -a nanakos `base64 --wrap=0 /dev/urandom | head -c 20`
• yubiserver-admin -b yubiserver.sqlite -p -a nanakos `base64 --wrap=0 /dev/urandom | head -c 20`

⭐ quick reminder bestie: those API key examples pipe /dev/urandom through base64 --wrap=0 and take the first 20 chars. keep it exact, keep it cute. 💖

---

👀 SEE ALSO 👀

yubiserver (1). go read that one next, it's the sibling, it's giving main character energy. ✨

---

💜 AUTHOR 💜

this manual page was written by Nanakos Chrysostomos <nanakos@wired-net.gr> for the Debian GNU/Linux system (and may be used by others). permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version published by the Free Software Foundation.

on Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. 📜

---

and that's the whole page, fr fr — this was YUBISERVER-ADMIN(1) from the General Commands Manual, signed off with that little footer stamp 🎀 slay, go admin something, ily 💅✨