ikisite-wrapper(1)

📦 version 0.20220717, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 ikisite-wrapper — from the General Commands Manual girlies 💖

okay so bestie, we're talking about ikisite-wrapper today and honestly? she's giving bouncer-at-the-club energy. let me put you on. ✨

✨ NAME ✨

ikisite-wrapper — the suid wrapper for ikisite, no cap 👑

🌸 SYNOPSIS 🌸

ikisite-wrapper subcommand options

like yes that's literally it, you hand her a subcommand and some options and she handles the rest 💅

🦋 DESCRIPTION 🦋

so ikisite-wrapper is a wrapper around ikisite, periodt. the whole point of her existence is that she's designed to be safely made suid root — though ngl, she is not currently suid by default, so don't come for me, that's just the facts 🙈

now here's the tea. a few ikisite subcommands can be run through the wrapper with zero authorisation at all, like no questions asked, walk right in:

  • create
  • branch
  • list
  • sitelookup
  • checklock
  • updatecustomersite
  • enabledns
  • enable

so making the wrapper suid means any user can create a site. anyone. the whole group chat. wild, I know 😭

but the other ikisite subcommands? those are gatekept 🔒 you can only run them through the wrapper if you specify a nonce in the IKISITE_NONCE environment variable. and those subcommands are:

  • delete
  • changesetup
  • domains
  • deletenonce

a site's current nonces are stored in its .ikisite-nonce file, iykyk. a nonce can be generated by root or by the site's user using the createnonce subcommand — but fr fr, it's usually generated by passing --createnonce to the create or branch subcommands. and why do we love that? because it lets anyone create or branch a site and then use the nonce to allow further configuration of it — and yes, to delete it too, if something goes wrong 🫶 messy but functional.

⚠️ okay important one: subcommands that can be called by the wrapper — whether without a nonce or with one — should be sure to fully validate their inputs. like, fully fully. do not skip that step bestie, it's not optional 💀

🌈 SEE ALSO 🌈

👑 AUTHOR 👑

Joey Hess <joey@ikiwiki.info> — the icon who wrote her 💜

and that's the whole vibe check babes. this page came to you from the General Commands Manual crew, filed under ikisite-wrapper(1) — go forth, wrap responsibly, and remember: validate your inputs bestie 🎀💖✨

📦 where this page comes from