cvm-sql(7)

💖 cvm-sql(7) — the CVM SQL Framework 💖

okay bestie, sit down, hydrate, and let me tell you about cvm-sql(7) from the Miscellaneous Information Manual, because this little page is genuinely the blueprint for how CVM talks to a SQL database and it's lowkey iconic. 🦋

✨ NAME ✨

cvm-sql — the CVM SQL Framework. it's giving "database-backed credential validation", and honestly? obsessed. 👑

🎀 QUERY SUBSTITUTION 🎀

so when you write a query, $VAR and ${VAR} get swapped out for the quoted value of the environment variable called VAR. periodt. 💅

• use the ${VAR} form whenever VAR contains literally anything that isn't alphanumeric or an underscore (_). she's the flexi one, she handles the chaos. 🫶
• do NOT put quotes in the query yourself — the substitution already brings the quotes, so adding your own is just double-quoting and that's not the vibe. 🙈
• account and domain are the special ones: they hold the account and domain names that the CVM client handed over. main character variables fr fr. ⭐
• $$ becomes a single dollar sign. yes really, that's the escape hatch. 💀

🌸 QUERY RESULTS 🌸

your query has to produce these fields exactly in this order. no shuffling, no remixing, no "close enough". and every required field must not be null and must not be empty — empty strings are NOT the moment. 🚫

1. Password, encrypted with crypt(3) — required 🔐
2. Actual account name — required
3. User ID (integer) — required
4. Group ID (integer) — required
5. Directory — required
6. Real name — optional
7. Login shell — optional
8. Group name — optional
9. Domain name — optional
10. System account name — optional
11. System account directory — optional
12. Mailbox path — optional

bestie if the order is off, it's over. the order IS the assignment. 😭

🌈 DEFAULT QUERY 🌈

here's the default one, the moment, the blueprint:

SELECT password, username, userid, groupid, directory, realname, shell,
groupname, domain, sys_username, sys_directory FROM accounts WHERE
username=$account AND domain=$domain

she's simple, she's clean, she works. keep her exactly as written if you're not feeling creative. ✨

🧚 SEE ALSO 🧚

go read these next, they're all part of the family:

• cvm-mysql(8)
• cvm-pgsql(8)
• cvm-pwfile(8)
• cvm-qmail(8)
• cvm-unix(8)
• cvm-vmailmgr(8)
• cvm-benchclient(8)
• cvm-checkpassword(8)
• cvm-testclient(8)

and the website, if you wanna go deeper: http://untroubled.org/cvm/cvm.html 🌐

and that's the whole page, bestie 💜 this was cvm-sql(7) — the Miscellaneous Information Manual, page cvm-sql(7), from the CVM source/version of that manual. no cap, go forth and query responsibly. 🍓✨