sys/boot/forth/check-password.4th.8

   1 .\" Copyright (c) 2011-2012 Devin Teske
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 10, 2012
  28 .Dt CHECK-PASSWORD.4TH 8
  29 .Os
  30 .Sh NAME
  31 .Nm check-password.4th
  32 .Nd FreeBSD password-checking boot module
  33 .Sh DESCRIPTION
  34 The file that goes by the name of
  35 .Nm
  36 is a set of commands designed to either prevent booting or prevent modification
  37 of boot options without an appropriately configured password.
  38 The commands of
  39 .Nm
  40 by themselves are not enough for most uses.
  41 Please refer to the
  42 examples below for the most common situations, and to
  43 .Xr loader 8
  44 for additional commands.
  45 .Pp
  46 Before using any of the commands provided in
  47 .Nm ,
  48 it must be included
  49 through the command:
  50 .Pp
  51 .Dl include check-password.4th
  52 .Pp
  53 This line is present in
  54 .Pa /boot/loader.4th
  55 file, so it is not needed (and should not be re-issued) in a normal setup.
  56 .Pp
  57 The commands provided by it are:
  58 .Pp
  59 .Bl -tag -width disable-module_module -compact -offset indent
  60 .It Ic check-password
  61 Dual-purpose function that can either protect the interactive boot menu or
  62 prevent boot without password (separately).
  63 .Pp
  64 First checks
  65 .Va bootlock_password
  66 and if-set, the user cannot continue until the correct password is entered.
  67 .Pp
  68 Next checks
  69 .Va password
  70 and if-set, tries to
  71 .Ic autoboot
  72 and only prompts for password on failure or user-interrupt.
  73 See
  74 .Xr loader.conf 5
  75 for additional information.
  76 .El
  77 .Pp
  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
  82 .Ic check-password
  83 to be entered before the system is allowed to boot.
  84 .It Va password
  85 Sets the password (up to 16 characters long) that is required by
  86 .Ic check-password
  87 before the user is allowed to visit the boot menu.
  88 .El
  89 .Sh FILES
  90 .Bl -tag -width /boot/check-password.4th -compact
  91 .It Pa /boot/loader
  92 The
  93 .Xr loader 8 .
  94 .It Pa /boot/check-password.4th
  95 .Nm
  96 itself.
  97 .It Pa /boot/loader.rc
  98 .Xr loader 8
  99 bootstrapping script.
 100 .El
 101 .Sh EXAMPLES
 102 Standard i386
 103 .Pa /boot/loader.rc :
 104 .Pp
 105 .Bd -literal -offset indent -compact
 106 include /boot/loader.4th
 107 check-password
 108 .Ed
 109 .Pp
 110 Set a password in
 111 .Xr loader.conf 5
 112 to prevent modification of boot options:
 113 .Pp
 114 .Bd -literal -offset indent -compact
 115 password="abc123"
 116 .Ed
 117 .Pp
 118 Set a password in
 119 .Xr loader.conf 5
 120 to prevent booting without password:
 121 .Pp
 122 .Bd -literal -offset indent -compact
 123 bootlock_password="boot"
 124 .Ed
 125 .Sh SEE ALSO
 126 .Xr loader.conf 5 ,
 127 .Xr loader 8 ,
 128 .Xr loader.4th 8
 129 .Sh HISTORY
 130 The
 131 .Nm
 132 set of commands first appeared in
 133 .Fx 9.0 .
 134 .Sh AUTHORS
 135 The
 136 .Nm
 137 set of commands was written by
 138 .An -nosplit
 139 .An Devin Teske Aq dteske@FreeBSD.org .