1 .\" Copyright (c) 2011 Devin Teske
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .Dt CHECK-PASSWORD.4TH 8
31 .Nm check-password.4th
32 .Nd FreeBSD password-checking boot module.
34 The file that goes by the name of
36 is a set of commands designed to prevent booting without the proper password.
39 by themselves are not enough for most uses.
41 examples below for the most common situations, and to
43 for additional commands.
45 Before using any of the commands provided in
50 .Dl include check-password.4th
52 This line is present in
54 file, so it is not needed (and should not be re-issued) in a normal setup.
56 The commands provided by it are:
58 .Bl -tag -width disable-module_module -compact -offset indent
60 Once called, the user cannot continue until the correct password is entered.
61 If the user enters the correct password the function returns.
63 The password that is required is configured by setting the
68 Subsequent calls after a successful password
69 has been entered will not cause reprompting
70 \(em the function will silently return.
73 The environment variables that effect its behavior are:
74 .Bl -tag -width bootfile -offset indent
76 Sets the password (up to 16 characters long) that is required by
78 to be entered before the system is allowed to boot. If unset (default) or NULL,
83 .Bl -tag -width /boot/loader.4th -compact
87 .It Pa /boot/check-password.4th
90 .It Pa /boot/loader.rc
98 .Bd -literal -offset indent -compact
99 include /boot/loader.4th
106 .Bd -literal -offset indent -compact
116 set of commands first appeared in
121 set of commands was written by
123 .An Devin Teske Aq devinteske@hotmail.com .