1 .\" Copyright (c) 2011-2018 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 do one or more of the following:
38 .Dl o Prevent booting without password
39 .Dl o Prevent modification of boot options without password
40 .Dl o Provide a password to mount geli(8) encrypted root disk(s)
44 by themselves are not enough for most uses.
46 examples below for the most common situations, and to
48 for additional commands.
50 Before using any of the commands provided in
55 .Dl include check-password.4th
57 This line is present in
59 file, so it is not needed (and should not be re-issued) in a normal setup.
61 The commands provided by it are:
63 .Bl -tag -width disable-module_module -compact -offset indent
65 Multi-purpose function that can protect the interactive boot menu,
66 prevent boot without password, or prompt for geli(8) passphrase
67 .Pq depending on Xr loader.conf 5 settings .
71 and if-set, the user cannot continue until the correct password is entered.
74 .Va geom_eli_passphrase_prompt
78 prompts the user to enter their GELI password for later mounting of the root
79 device(s) during boot.
85 and only prompts for password on failure or user-interrupt.
88 for additional information.
91 The environment variables that effect its behavior are:
92 .Bl -tag -width bootlock_password -offset indent
93 .It Va bootlock_password
94 Sets the bootlock password (up to 255 characters long) that is required by
96 to be entered before the system is allowed to boot.
97 .It Va geom_eli_passphrase_prompt
98 Selects whether loader(8) will prompt for GELI credentials, handing-off to the
99 kernel for later mounting of
101 encrypted root device(s).
103 Sets the password (up to 255 characters long) that is required by
105 before the user is allowed to visit the boot menu.
108 .Bl -tag -width /boot/check-password.4th -compact
112 .It Pa /boot/check-password.4th
115 .It Pa /boot/loader.rc
117 bootstrapping script.
121 .Pa /boot/loader.rc :
123 .Bd -literal -offset indent -compact
124 include /boot/loader.4th
130 to prevent modification of boot options:
132 .Bd -literal -offset indent -compact
138 to prevent booting without password:
140 .Bd -literal -offset indent -compact
141 bootlock_password="boot"
146 to generate a prompt at boot to collect GELI credentials for mounting
148 encrypted root device(s):
150 .Bd -literal -offset indent -compact
151 geom_eli_passphrase_prompt="YES"
160 set of commands first appeared in
165 set of commands was written by
167 .An Devin Teske Aq dteske@FreeBSD.org .