---
name: "password.lua"
section: "8"
platform: "freebsd"
package: "base"
version: "16.0-CURRENT-20261027-61c70dc16a79"
release: "FreeBSD 16.0-CURRENT (2026-10-27)"
platforms: ["freebsd"]
url: "https://new.carta.tech/password.lua"
---

# password.lua(8)

bootloader password module

## NAME

**password.lua** – bootloader password module

## DESCRIPTION

**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.

## SEE ALSO

[screen.lua(8)](/screen.lua/8.md)

## AUTHORS

The **password.lua** file was originally written by Pedro Souza ⟨*pedrosouza@FreeBSD.org*⟩. Later work and this manual page was done by Kyle Evans ⟨*kevans@FreeBSD.org*⟩.