2 .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 .\" Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .Nd FreeBSD password module
37 contains functionality for prompting for and checking passwords.
39 Before using the functionality provided by
41 it must be included with a statement such as the following:
43 .Dl local password = require("password")
45 The following functions are exported from
47 .Bl -tag -width "Fn password.read prompt_length" -offset indent
48 .It Fn password.read prompt_length
49 Read a password following a prompt.
51 is required so that the twiddle may be properly drawn as the user is typing.
53 Drives the primary password checks done by the loader.
57 .Ev bootlock_password ,
58 .Ev geom_eli_passphrase_prompt ,
61 and prompt the user for passwords as-needed.
64 is set, the autoboot sequence will begin as the user is prompted for a password.
71 file was originally written by
72 .An Pedro Souza Aq Mt pedrosouza@FreeBSD.org .
73 Later work and this manual page was done by
74 .An Kyle Evans Aq Mt kevans@FreeBSD.org .