NIPAP-PASSWD(1)

💅 NAME 💅

nipap-passwd — the little utility that runs the user accounts in your local (SQLite) database so the NIPAP backend can actually log people in ✨

---

🎀 SYNOPSIS 🎀

nipap-passwd action [options...]

---

🦋 DESCRIPTION 🦋

okay so bestie, picture this: the NIPAP backend can be set up to use a "local" authentication backend, right? and that backend is literally just a SQLite database. that's it. that's the whole vibe. 🗄️

nipap-passwd is the tool that administrates user accounts in that local (SQLite) database. it gives you a genuinely easy way to add, remove or change users in a database like that — no cap, that's the entire job 💖

and by default? nipap-passwd reads the NIPAP config file (/etc/nipap/nipap.conf) to figure out where the SQLite database even lives. iconic behaviour honestly 👑

---

✨ OPTIONS ✨

nipapd-passwd accepts the following command-line arguments. (yep, the original spells it that way — keeping it fr fr, no edits 🙈)

🌸 positional arguments:

• action — one of {list, add, delete, test-user, create-database, upgrade-database, latest-version}. this literally defines which action to execute, so pick one bestie 💅
  • list — list all the users in the SQLite database 📋
  • add — add a user to the database. username comes from -u, password comes from -p 🔐
  • delete — delete the user with the username specified with -u from the database 🗑️
  • modify — modify an existing user. who you're modifying is specified with -u. and heads up: it is not possible to change the username of an existing user — that's a hard no, sorry 🚫
  • test-user — try to authenticate with the user specified with the option -u and the password specified with -p. the program will return exit code 2 if the user doesn't exist or the password is wrong. so if you see a 2, that login did not slay 😭
  • create-database — create an empty SqliteAuth database in the path specified in the config, or by option -f 🏗️
  • upgrade-database — upgrade the SQLite database to the latest version ⬆️
  • latest-version — check if the SQLite database is of the latest version 👀

🧚 optional arguments:

• -h, --help — show a help message 🫶
• -u USER, --user=USER — in combination with action add, the username of the user will be set to USER. in combination with option test-user, the authentication will be tested with USER. in combination with action delete, the user USER will be deleted. multitasking queen 💅
• -p PASSWORD, --password=PASSWORD — in combination with action add, the password of the user will be set to PASSWORD. in combination with option test-user, the authentication will be tested with PASSWORD 🔑
• -n NAME, --name=NAME — set the user's name to NAME 📝
• -t, --trusted — mark the user as trusted. a trusted user will be able to impersonate other users 👀✨
• --no-trusted — mark the user as not trusted. this is typically used to negate --trusted when modifying an existing user 🙅‍♀️
• -r, --readonly — give the user read-only permissions, i.e. the user is not able to edit anything 🔒
• --no-readonly — mark the user as not readonly. this is typically used to negate --readonly when modifying an existing user 💫
• -f DB_FILE, --file=DB_FILE — use the specified file as the SQLite database file [default: read from config] 📁
• -c CONFIG, --config=CONFIG — read configuration from the configuration file CONFIG [default: /etc/nipap/nipap.conf] ⚙️
• --version — show the program's version number and exit 🏷️

---

💀 RETURN CODES 💀

the program will either return one of the following codes:

• 0 on success 🎉
• 1 on error 😬
• 2 if the authentication with option --test-user failed 💔

ngl, that 2 is the one you'll be staring at when someone swears their password is right and it absolutely is not 🙈

---

👑 COPYRIGHT 👑

Kristian Larsson, Lukas Garberg 2011-2015

---

and that's the whole page bestie 🫶 it's nipap-passwd(1) — same title up top, same title down at the bottom, no date stamp, no version line, just vibes and the manual name doing a little mirror moment. go forth and manage those users, you absolute main character 🌈💖