stand/lua/password.lua.8

   1 .\"
   2 .\" SPDX-License-Identifier: BSD-2-Clause
   3 .\"
   4 .\" Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   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.
  14 .\"
  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
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .Dd August 19, 2018
  28 .Dt PASSWORD.LUA 8
  29 .Os
  30 .Sh NAME
  31 .Nm password.lua
  32 .Nd FreeBSD password module
  33 .Sh DESCRIPTION
  34 .Nm
  35 contains functionality for prompting for and checking passwords.
  36 .Pp
  37 Before using the functionality provided by
  38 .Nm ,
  39 it must be included with a statement such as the following:
  40 .Pp
  41 .Dl local password = require("password")
  42 .Pp
  43 The following functions are exported from
  44 .Nm :
  45 .Bl -tag -width "Fn password.read prompt_length" -offset indent
  46 .It Fn password.read prompt_length
  47 Read a password following a prompt.
  48 .Fa prompt_length
  49 is required so that the twiddle may be properly drawn as the user is typing.
  50 .It Fn password.check
  51 Drives the primary password checks done by the loader.
  52 The
  53 .Fn password.check
  54 function will check
  55 .Ev bootlock_password ,
  56 .Ev geom_eli_passphrase_prompt ,
  57 and
  58 .Ev password
  59 and prompt the user for passwords as-needed.
  60 If
  61 .Ev password
  62 is set, the autoboot sequence will begin as the user is prompted for a password.
  63 .El
  64 .Sh SEE ALSO
  65 .Xr screen.lua 8
  66 .Sh AUTHORS
  67 The
  68 .Nm
  69 file was originally written by
  70 .An Pedro Souza Aq Mt pedrosouza@FreeBSD.org .
  71 Later work and this manual page was done by
  72 .An Kyle Evans Aq Mt kevans@FreeBSD.org .