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

   1 .\" Copyright (c) 2011 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 May 18, 2011
  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 prevent booting without the proper password.
  37 The commands of
  38 .Nm
  39 by themselves are not enough for most uses.
  40 Please refer to the
  41 examples below for the most common situations, and to
  42 .Xr loader 8
  43 for additional commands.
  44 .Pp
  45 Before using any of the commands provided in
  46 .Nm ,
  47 it must be included
  48 through the command:
  49 .Pp
  50 .Dl include check-password.4th
  51 .Pp
  52 This line is present in
  53 .Pa /boot/loader.4th
  54 file, so it is not needed (and should not be re-issued) in a normal setup.
  55 .Pp
  56 The commands provided by it are:
  57 .Pp
  58 .Bl -tag -width disable-module_module -compact -offset indent
  59 .It Ic check-password
  60 Once called, the user cannot continue until the correct password is entered.
  61 If the user enters the correct password the function returns.
  62 .Pp
  63 The password that is required is configured by setting the
  64 .Ic password
  65 variable in
  66 .Xr loader.conf 5 .
  67 .Pp
  68 Subsequent calls after a successful password
  69 has been entered will not cause reprompting
  70 \(em the function will silently return.
  71 .El
  72 .Pp
  73 The environment variables that effect its behavior are:
  74 .Bl -tag -width bootfile -offset indent
  75 .It Va password
  76 Sets the password (up to 16 characters long) that is required by
  77 .Ic check-password
  78 to be entered before the system is allowed to boot. If unset (default) or NULL,
  79 .Ic check-password
  80 will silently abort.
  81 .El
  82 .Sh FILES
  83 .Bl -tag -width /boot/loader.4th -compact
  84 .It Pa /boot/loader
  85 The
  86 .Xr loader 8 .
  87 .It Pa /boot/check-password.4th
  88 .Nm
  89 itself.
  90 .It Pa /boot/loader.rc
  91 .Xr loader 8
  92 bootstrapping script.
  93 .El
  94 .Sh EXAMPLES
  95 Standard i386
  96 .Pa /boot/loader.rc :
  97 .Pp
  98 .Bd -literal -offset indent -compact
  99 include /boot/loader.4th
 100 check-password
 101 .Ed
 102 .Pp
 103 Set a password in
 104 .Xr loader.conf 5 :
 105 .Pp
 106 .Bd -literal -offset indent -compact
 107 password="abc123"
 108 .Ed
 109 .Sh SEE ALSO
 110 .Xr loader.conf 5 ,
 111 .Xr loader 8 ,
 112 .Xr loader.4th 8
 113 .Sh HISTORY
 114 The
 115 .Nm
 116 set of commands first appeared in
 117 .Fx 9.0 .
 118 .Sh AUTHORS
 119 The
 120 .Nm
 121 set of commands was written by
 122 .An -nosplit
 123 .An Devin Teske Aq devinteske@hotmail.com .