password.lua(8)

password.lua8

Bootloader password module

Overview

password.lua contains functionality for prompting for and checking passwords.

Before using the functionality provided by password.lua, it must be included with a statement such as the following:

local password = require("password")

The following functions are exported from password.lua:

password.read(prompt_length)

Read a password following a prompt. prompt_length is required so that the twiddle may be properly drawn as the user is typing.

password.check()

Drives the primary password checks done by the loader. The password.check() function will check bootlock_password, geom_eli_passphrase_prompt, and password and prompt the user for passwords as-needed. If password is set, the autoboot sequence will begin as the user is prompted for a password.

Releases

22 releases since FreeBSD 11.3-RELEASE; the text changed 9 times.

  1. 11.3
  2. 11.4
  3. 12.0
  4. 12.1
  5. 12.2
  6. 12.3
  7. 12.4
  8. 13.0–13.2
  9. 13.3–14.2
  10. 14.3–16.0

Authors

The password.lua file was originally written by Pedro Souza ⟨[email protected]⟩. Later work and this manual page was done by Kyle Evans ⟨[email protected]⟩.

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.