AusweisApp2(1)

📦
version 1.26.2 · 2 versions
, in debian bookworm

AusweisApp2(1) · General Commands Manual 🎀

✨ NAME ✨

AusweisApp2 — the official authentication app for German ID cards and residence permits 💅

🧚 SYNOPSIS 🧚

AusweisApp2 [-h|--help]
AusweisApp2 [--help-all]
AusweisApp2 [-v|--version]
AusweisApp2 [--show]
AusweisApp2 [--keep] [--no-logfile] [--no-loghandler] [--show] [--no-proxy] [--ui { qml|websocket }] [--port PORT] [--address ADDRESS]

💖 DESCRIPTION 💖

okay so AusweisApp2 lets you log into websites using your German ID card and residence permits. it's giving official and it's giving secure 🔥

you'll need:

  • an ID card that's enabled for online identification 🪪
  • a compatible NFC device (most NFC readers should work, and NFC-enabled phones can also be used 📱)
  • AusweisApp2
  • a browser
  • a website that supports authentication via German ID card

when you visit a site like that, AusweisApp2 gets triggered and asks if you want to authenticate against the website. no cap, it's literally that easy 🦋

this program also runs a local webserver so your browser can talk to it 🌸

👑 OPTIONS 👑

  • -h, --help — shows a short help message 💅
  • --help-all — shows help, including the Qt specific options 🌈
  • -v, --version — shows version information ✨
  • --keep — by default, AusweisApp2 writes a log to a file matching ${TMP}/AusweisApp2.*.log, and it gets deleted when the program terminates. this setting stops that deletion 🫶
  • --no-logfile — suppresses writing the log file to ${TMP}/AusweisApp2.*.log. logs still show up on STDOUT 🙈
  • --no-loghandler — disables the default log handler. this turns off logging to STDOUT 💀
  • --show — shows the window on startup 🌟
  • --no-proxy — disables the system proxy 🍓
  • --ui { qml|webservice|websocket } — this one allows multiple values, periodt 🎀
    • "qml" — starts the program with a visible UI 👀
    • "websocket" — lets it start in the background as an SDK. this is only useful when you're integrating AusweisApp2 into other programs 🧚
    • "webservice" — starts listening on the given port/address 🦋

The default is "qml,webservice,websocket" ✨

  • --port PORT — changes the listening port for the WebSocket. the default is 24727. selecting "0" is a special case: AusweisApp2 picks a random port and writes the port number to a file at ${TMP}/AusweisApp2.<PID>.port 💜
  • --address ADDRESS — uses the given addresses for interface binding. normally AusweisApp2 is bound to localhost only, because that's a security requirement. this is only for testing, and it allows multiple values 🔥
⚠️ heads up: the --address option is meant for testing only. normally AusweisApp2 stays on localhost for security, so don't go changing that for everyday use 💀

🌸 RETURN VALUE 🌸

AusweisApp2 returns 0 when it successfully terminates 🥰

🌈 ENVIRONMENT 🌈

  • QT_QPA_PLATFORM={ wayland|X11 } — you can force the session type to wayland or X11. this is only needed for debugging purposes. XDG_SESSION_TYPE gets ignored on gnome, so don't be confused when it doesn't listen 🙈

🍓 FILES 🍓

  • ~/.config/AusweisApp2_CE/AusweisApp2.conf — this is where your user config gets saved 📁

💀 CAVEATS 💀

🚨 currently there's no way to terminate the program on gnome, because the TrayIcon is mandatory. not me being dramatic, it's just the vibe rn 😭

🎀 AUTHOR 🎀

This man page was written by Lee Garrett (debian@rocketjump.eu) for Debian, but others are welcome to use it too 🫶

🦋 SEE ALSO 🦋

That's the whole tea on AusweisApp2(1), bestie 💖✨ go authenticate like the main character you are 💅🫶

📦 where this page comes from