Skip to content

Rubber Stamp Guide

boltgolt edited this page Jan 26, 2021 · 4 revisions

Introduction

By default Howdy will authenticate you the moment you have been successfully recognized. However, a lot of users want to have more control over the authentication flow.

Stamp rules

Stamp rules consist of several elements, seperated by one or more whitespace characters:

  • Rules always start with a whitespace character, preferably a space. This signals to the INI parser that the line is still part of the stamp_rules config variable.
  • Next is the name of the rubber stamp to run. This should be the same as the folder containing the rubber stamp code. For our example this will be the "click" rubber stamp.
  • The timeout length comes after that. This is the maximum amount of time in seconds the stamp is allowed to run. It is expressed as a float, optionally followed by a "s" to help recognize the number as the timeout. Currently the timeout can only be set in seconds.
  • Then comes the failure mode. This can either be "failsafe" or "faildeadly", if another string is given the rule will default to failsafe. Setting the failure mode to failsafe will cause the entire authentication to fail on timeout, unless the user explicitly approves it. Faildeadly is the exact opposite, authentication is approved on timeout unless a user explicitly prevents it.
  • The last part is optional and contains special settings that are different for every stamp type. Check the documentation for the specific stamp you are using to see what settings are available. The format is the name of the setting followed by an equal sign and the value you want to set the setting to.

The simplest rule possible would be:

 click 5s failsafe

Clone this wiki locally