xref: /freebsd/stand/lua/password.lua.8 (revision 75658c965ce860beb7bed9b0afa003df93bba877)
1*75658c96SKyle Evans.\"
2*75658c96SKyle Evans.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3*75658c96SKyle Evans.\"
4*75658c96SKyle Evans.\" Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
5*75658c96SKyle Evans.\"
6*75658c96SKyle Evans.\" Redistribution and use in source and binary forms, with or without
7*75658c96SKyle Evans.\" modification, are permitted provided that the following conditions
8*75658c96SKyle Evans.\" are met:
9*75658c96SKyle Evans.\" 1. Redistributions of source code must retain the above copyright
10*75658c96SKyle Evans.\"    notice, this list of conditions and the following disclaimer.
11*75658c96SKyle Evans.\" 2. Redistributions in binary form must reproduce the above copyright
12*75658c96SKyle Evans.\"    notice, this list of conditions and the following disclaimer in the
13*75658c96SKyle Evans.\"    documentation and/or other materials provided with the distribution.
14*75658c96SKyle Evans.\"
15*75658c96SKyle Evans.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*75658c96SKyle Evans.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*75658c96SKyle Evans.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*75658c96SKyle Evans.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*75658c96SKyle Evans.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*75658c96SKyle Evans.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*75658c96SKyle Evans.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*75658c96SKyle Evans.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*75658c96SKyle Evans.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*75658c96SKyle Evans.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*75658c96SKyle Evans.\" SUCH DAMAGE.
26*75658c96SKyle Evans.\"
27*75658c96SKyle Evans.\" $FreeBSD$
28*75658c96SKyle Evans.\"
29*75658c96SKyle Evans.Dd August 19, 2018
30*75658c96SKyle Evans.Dt PASSWORD.LUA 8
31*75658c96SKyle Evans.Os
32*75658c96SKyle Evans.Sh NAME
33*75658c96SKyle Evans.Nm password.lua
34*75658c96SKyle Evans.Nd FreeBSD password module
35*75658c96SKyle Evans.Sh DESCRIPTION
36*75658c96SKyle Evans.Nm
37*75658c96SKyle Evanscontains functionality for prompting for and checking passwords.
38*75658c96SKyle Evans.Pp
39*75658c96SKyle EvansBefore using the functionality provided by
40*75658c96SKyle Evans.Nm ,
41*75658c96SKyle Evansit must be included with a statement such as the following:
42*75658c96SKyle Evans.Pp
43*75658c96SKyle Evans.Dl local password = require("password")
44*75658c96SKyle Evans.Pp
45*75658c96SKyle EvansThe following functions are exported from
46*75658c96SKyle Evans.Nm :
47*75658c96SKyle Evans.Bl -tag -width "Fn password.read prompt_length" -offset indent
48*75658c96SKyle Evans.It Fn password.read prompt_length
49*75658c96SKyle EvansRead a password following a prompt.
50*75658c96SKyle Evans.Fa prompt_length
51*75658c96SKyle Evansis required so that the twiddle may be properly drawn as the user is typing.
52*75658c96SKyle Evans.It Fn password.check
53*75658c96SKyle EvansDrives the primary password checks done by the loader.
54*75658c96SKyle EvansThe
55*75658c96SKyle Evans.Fn password.check
56*75658c96SKyle Evansfunction will check
57*75658c96SKyle Evans.Ev bootlock_password ,
58*75658c96SKyle Evans.Ev geom_eli_passphrase_prompt ,
59*75658c96SKyle Evansand
60*75658c96SKyle Evans.Ev password
61*75658c96SKyle Evansand prompt the user for passwords as-needed.
62*75658c96SKyle EvansIf
63*75658c96SKyle Evans.Ev password
64*75658c96SKyle Evansis set, the autoboot sequence will begin as the user is prompted for a password.
65*75658c96SKyle Evans.El
66*75658c96SKyle Evans.Sh SEE ALSO
67*75658c96SKyle Evans.Xr screen.lua 8
68*75658c96SKyle Evans.Sh AUTHORS
69*75658c96SKyle EvansThe
70*75658c96SKyle Evans.Nm
71*75658c96SKyle Evansfile was originally written by
72*75658c96SKyle Evans.An Pedro Souza Aq Mt pedrosouza@FreeBSD.org .
73*75658c96SKyle EvansLater work and this manual page was done by
74*75658c96SKyle Evans.An Kyle Evans Aq Mt kevans@FreeBSD.org .
75