https://github.com/sio/waitotp

Listen for a valid TOTP token and exit
https://github.com/sio/waitotp

Last synced: 12 months ago
JSON representation

Listen for a valid TOTP token and exit

• Host: GitHub
• URL: https://github.com/sio/waitotp
• Owner: sio
• License: apache-2.0
• Created: 2022-10-28T12:22:24.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-01T19:32:39.000Z (over 3 years ago)
• Last Synced: 2025-04-05T20:32:01.197Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Listen for a valid TOTP token and exit

This small program will wait for a valid TOTP token to be sent on a TCP port

and then will exit. This is useful for guarding low traffic single-user

services on Internet.

## Service lifecycle (systemd)

- Startup of the guarded service is delayed by a call to [waitotp], this is

  achieved by overriding parts of the unit file (see [waitotp.conf] for example)

- [waitotp] listens on the guarded service port but does not expose the service

  itself and does not reply to any incoming packets

- If a valid TOTP token is received, [waitotp] exits and lets the guarded

  service to proceed with startup

- Immediately after the guarded service becomes active, systemd launches

  related [inactivity-@.service]

- [inactivity.sh] tracks network usage of the guarded service and if it is

  inactive for a specified amount of time, [inactivity-@.service] restarts

- Systemd triggers a restart of guarded service unit which again ends up

  asking for a TOTP token before proceeding

[waitotp]: waitotp.go

[waitotp.conf]: waitotp.conf

[inactivity-@.service]: inactivity-@.service

[inactivity.sh]: inactivity.sh