x2gobroker-authservice(8)

💖 x2gobroker-authservice — bestie edition 💖

okay so real talk, this is the x2gobroker-authservice(8) page, part of the X2Go Session Broker fam, and honestly? she's doing the most important job in the whole group chat. let's get into it 🫶

✨ NAME ✨

x2gobroker-authservice — the PAM authentication service for X2Go Session Broker. she's the bouncer at the club. 💅

🌸 SYNOPSIS 🌸

x2gobroker-authservice [ options ]

🦋 DESCRIPTION 🦋

so here's the tea, bestie. x2gobroker-authservice is a PAM authentication service for the X2Go Session Broker. and the way this matters is: the X2Go Session Broker itself runs as a non-privileged user — either in standalone daemon mode, or as the system user of the also-non-privileged httpd server in WSGI mode. ✨

but here's the plot twist 😭 — authenticating against PAM needs root privileges in most cases (esp. for pam_unix.so). like, she simply cannot do it from a non-privileged seat. no cap.

so the PAM authentication got moved into a separate service — that's this one, hi hello 👋 — and the communication between the X2Go Session Broker and the PAM Authentication Service happens through a unix domain socket file:

<RUNDIR>/x2gobroker/x2gobroker-authservice.socket

this command is normally started through the host's init system. so you don't really launch her yourself, she just arrives, main character energy. 👑

🎀 COMMON OPTIONS 🎀

x2gobroker-authservice accepts the following common options:

• -h, --help — shows you a help with all the available command line options and dips. the "wait who are you" button.
• -D, --daemonize — forks this application to the background and detaches from the running terminal. she's leaving, and she's not saying bye. 💀
• -P, --pidfile — custom PID file location for when she daemonizes. default is <RUNDIR>/x2gobroker/x2gobroker-authservice.pid.
• -L, --logdir — the directory where stdout/stderr get redirected after she's daemonized. default is /var/log/x2gobroker/.
• -s <AUTHSOCKET>, --socket <AUTHSOCKET> — the file name of the unix domain socket file used for communication between broker and authentication service. this is the lil thread tying them together 🧚
• -o <OWNER>, --owner <OWNER> — user ownership of the <AUTHSOCKET> file.
• -g <GROUP>, --group <GROUP> — group ownership of the <AUTHSOCKET> file.
• -p <PERMISSIONS>, --permissions <PERMISSIONS> — set these file permissions for the <AUTHSOCKET> file. use numerical permissions (e.g. 0640).

🍓 FILES 🍓

• <RUNDIR>/x2gobroker/x2gobroker-authservice.socket

👑 AUTHOR 👑

this manual has been written for the X2Go project by Mike Gabriel <mike.gabriel@das-netzwerkteam.de>. iconic. we love a credited author. 💜

okay that's the whole page, you ate that. go be a privileged auth service about it. periodt. 🔥

Version 0.0.4.x 🌈 · Apr 2020 🌸 · that's the version-and-date sign-off bestie, we out 💖✨🎀