xref: /freebsd/stand/lua/password.lua.8 (revision 4d846d260e2b9a3d4d0a701462568268cbfe7a5b)
175658c96SKyle Evans.\"
2*4d846d26SWarner Losh.\" SPDX-License-Identifier: BSD-2-Clause
375658c96SKyle Evans.\"
475658c96SKyle Evans.\" Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
575658c96SKyle Evans.\"
675658c96SKyle Evans.\" Redistribution and use in source and binary forms, with or without
775658c96SKyle Evans.\" modification, are permitted provided that the following conditions
875658c96SKyle Evans.\" are met:
975658c96SKyle Evans.\" 1. Redistributions of source code must retain the above copyright
1075658c96SKyle Evans.\"    notice, this list of conditions and the following disclaimer.
1175658c96SKyle Evans.\" 2. Redistributions in binary form must reproduce the above copyright
1275658c96SKyle Evans.\"    notice, this list of conditions and the following disclaimer in the
1375658c96SKyle Evans.\"    documentation and/or other materials provided with the distribution.
1475658c96SKyle Evans.\"
1575658c96SKyle Evans.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1675658c96SKyle Evans.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1775658c96SKyle Evans.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1875658c96SKyle Evans.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1975658c96SKyle Evans.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2075658c96SKyle Evans.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2175658c96SKyle Evans.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2275658c96SKyle Evans.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2375658c96SKyle Evans.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2475658c96SKyle Evans.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2575658c96SKyle Evans.\" SUCH DAMAGE.
2675658c96SKyle Evans.\"
2775658c96SKyle Evans.\" $FreeBSD$
2875658c96SKyle Evans.\"
2975658c96SKyle Evans.Dd August 19, 2018
3075658c96SKyle Evans.Dt PASSWORD.LUA 8
3175658c96SKyle Evans.Os
3275658c96SKyle Evans.Sh NAME
3375658c96SKyle Evans.Nm password.lua
3475658c96SKyle Evans.Nd FreeBSD password module
3575658c96SKyle Evans.Sh DESCRIPTION
3675658c96SKyle Evans.Nm
3775658c96SKyle Evanscontains functionality for prompting for and checking passwords.
3875658c96SKyle Evans.Pp
3975658c96SKyle EvansBefore using the functionality provided by
4075658c96SKyle Evans.Nm ,
4175658c96SKyle Evansit must be included with a statement such as the following:
4275658c96SKyle Evans.Pp
4375658c96SKyle Evans.Dl local password = require("password")
4475658c96SKyle Evans.Pp
4575658c96SKyle EvansThe following functions are exported from
4675658c96SKyle Evans.Nm :
4775658c96SKyle Evans.Bl -tag -width "Fn password.read prompt_length" -offset indent
4875658c96SKyle Evans.It Fn password.read prompt_length
4975658c96SKyle EvansRead a password following a prompt.
5075658c96SKyle Evans.Fa prompt_length
5175658c96SKyle Evansis required so that the twiddle may be properly drawn as the user is typing.
5275658c96SKyle Evans.It Fn password.check
5375658c96SKyle EvansDrives the primary password checks done by the loader.
5475658c96SKyle EvansThe
5575658c96SKyle Evans.Fn password.check
5675658c96SKyle Evansfunction will check
5775658c96SKyle Evans.Ev bootlock_password ,
5875658c96SKyle Evans.Ev geom_eli_passphrase_prompt ,
5975658c96SKyle Evansand
6075658c96SKyle Evans.Ev password
6175658c96SKyle Evansand prompt the user for passwords as-needed.
6275658c96SKyle EvansIf
6375658c96SKyle Evans.Ev password
6475658c96SKyle Evansis set, the autoboot sequence will begin as the user is prompted for a password.
6575658c96SKyle Evans.El
6675658c96SKyle Evans.Sh SEE ALSO
6775658c96SKyle Evans.Xr screen.lua 8
6875658c96SKyle Evans.Sh AUTHORS
6975658c96SKyle EvansThe
7075658c96SKyle Evans.Nm
7175658c96SKyle Evansfile was originally written by
7275658c96SKyle Evans.An Pedro Souza Aq Mt pedrosouza@FreeBSD.org .
7375658c96SKyle EvansLater work and this manual page was done by
7475658c96SKyle Evans.An Kyle Evans Aq Mt kevans@FreeBSD.org .
75