1 .\" Copyright (c) 2011-2012 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 either prevent booting or prevent modification
37 of boot options without an appropriately configured password.
40 by themselves are not enough for most uses.
42 examples below for the most common situations, and to
44 for additional commands.
46 Before using any of the commands provided in
51 .Dl include check-password.4th
53 This line is present in
55 file, so it is not needed (and should not be re-issued) in a normal setup.
57 The commands provided by it are:
59 .Bl -tag -width disable-module_module -compact -offset indent
61 Dual-purpose function that can either protect the interactive boot menu or
62 prevent boot without password (separately).
66 and if-set, the user cannot continue until the correct password is entered.
72 and only prompts for password on failure or user-interrupt.
75 for additional information.
78 The environment variables that effect its behavior are:
79 .Bl -tag -width bootlock_password -offset indent
80 .It Va bootlock_password
81 Sets the bootlock password (up to 16 characters long) that is required by
83 to be entered before the system is allowed to boot.
85 Sets the password (up to 16 characters long) that is required by
87 before the user is allowed to visit the boot menu.
90 .Bl -tag -width /boot/check-password.4th -compact
94 .It Pa /boot/check-password.4th
97 .It Pa /boot/loader.rc
103 .Pa /boot/loader.rc :
105 .Bd -literal -offset indent -compact
106 include /boot/loader.4th
112 to prevent modification of boot options:
114 .Bd -literal -offset indent -compact
120 to prevent booting without password:
122 .Bd -literal -offset indent -compact
123 bootlock_password="boot"
132 set of commands first appeared in
137 set of commands was written by
139 .An Devin Teske Aq dteske@FreeBSD.org .