75 lines
2.6 KiB
Groff
75 lines
2.6 KiB
Groff
.\"
|
|
.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
.\"
|
|
.\" Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd August 19, 2018
|
|
.Dt PASSWORD.LUA 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm password.lua
|
|
.Nd FreeBSD password module
|
|
.Sh DESCRIPTION
|
|
.Nm
|
|
contains functionality for prompting for and checking passwords.
|
|
.Pp
|
|
Before using the functionality provided by
|
|
.Nm ,
|
|
it must be included with a statement such as the following:
|
|
.Pp
|
|
.Dl local password = require("password")
|
|
.Pp
|
|
The following functions are exported from
|
|
.Nm :
|
|
.Bl -tag -width "Fn password.read prompt_length" -offset indent
|
|
.It Fn password.read prompt_length
|
|
Read a password following a prompt.
|
|
.Fa prompt_length
|
|
is required so that the twiddle may be properly drawn as the user is typing.
|
|
.It Fn password.check
|
|
Drives the primary password checks done by the loader.
|
|
The
|
|
.Fn password.check
|
|
function will check
|
|
.Ev bootlock_password ,
|
|
.Ev geom_eli_passphrase_prompt ,
|
|
and
|
|
.Ev password
|
|
and prompt the user for passwords as-needed.
|
|
If
|
|
.Ev password
|
|
is set, the autoboot sequence will begin as the user is prompted for a password.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr screen.lua 8
|
|
.Sh AUTHORS
|
|
The
|
|
.Nm
|
|
file was originally written by
|
|
.An Pedro Souza Aq Mt pedrosouza@FreeBSD.org .
|
|
Later work and this manual page was done by
|
|
.An Kyle Evans Aq Mt kevans@FreeBSD.org .
|