sbin/veriexec/veriexec.8

   1 .\"-
   2 .\" Copyright (c) 2018, Juniper Networks, Inc.
   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 COPYRIGHT HOLDERS AND CONTRIBUTORS
  14 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  15 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  16 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  17 .\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  18 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  19 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd February 14, 2022
  28 .Dt VERIEXEC 8
  29 .Os
  30 .Sh NAME
  31 .Nm veriexec
  32 .Nd manipulate state of mac_veriexec
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl v
  36 .Op Fl C Ar directory
  37 .Pa manifest
  38 .Nm
  39 .Fl z Ar state
  40 .Nm
  41 .Fl i Ar state
  42 .Nm
  43 .Fl x
  44 .Ar file ...
  45 .Sh DESCRIPTION
  46 .Nm
  47 is a utility to query or manipulate the state of
  48 .Xr mac_veriexec 4 .
  49 .Pp
  50 The first form is for loading a
  51 .Pa manifest .
  52 .Nm
  53 first verifies a digital signature of the
  54 .Ar manifest
  55 and if successful, parses it and feeds its content to kernel.
  56 .Pp
  57 The second form with
  58 .Fl z
  59 is used to modify the
  60 .Ar state ,
  61 and with
  62 .Fl i
  63 to query the current
  64 .Ar state .
  65 .Pp
  66 The final form with
  67 .Fl x
  68 is used to test whether
  69 .Ar file
  70 is verified or not.
  71 This requires
  72 .Xr mac_veriexec 4
  73 to be in the
  74 .Ql active
  75 or
  76 .Ql enforce
  77 state.
  78 .Pp
  79 The possible states
  80 are:
  81 .Bl -tag -width enforce
  82 .It Ar loaded
  83 set automatically when first
  84 .Pa manifest
  85 has been loaded.
  86 .It Ar active
  87 .Xr mac_veriexec 4
  88 will begin checking files.
  89 This state can only be entered from the
  90 .Ar loaded
  91 state.
  92 .It Ar enforce
  93 .Xr mac_veriexec 4
  94 will fail attempts to
  95 .Xr exec 2
  96 or
  97 .Xr open 2
  98 files with
  99 .Dv O_VERIFY
 100 unless verified.
 101 .It Ar locked
 102 prevent loading of any more manifests.
 103 .El
 104 .Pp
 105 When setting or querying the state, it is sufficient to provide
 106 a unique prefix of the desired state.
 107 So
 108 .Fl i
 109 .Ar a
 110 or
 111 .Fl z
 112 .Ar e
 113 are sufficient, but
 114 .Fl i
 115 .Ar loc
 116 is the minimum required to avoid confusion with
 117 .Ar loaded .
 118 .Sh MANIFESTS
 119 The manifest contains a mapping of relative pathnames to fingerprints
 120 with optional flags.
 121 For example:
 122 .Bd -literal -offset indent
 123 sbin/veriexec sha256=f22136...c0ff71 no_ptrace
 124 usr/bin/python sha256=5944d9...876525 indirect
 125 sbin/somedaemon sha256=77fc2f...63f5687 label=mod1/val1,mod2/val2
 126 .Ed
 127 The supported flags are:
 128 .Bl -tag -width indirect
 129 .It Ql indirect
 130 the executable cannot be run directly,
 131 but can be used as an interpreter for example via:
 132 .Bd -literal -offset indent
 133 #!/usr/bin/python
 134 .Ed
 135 .It Ql no_ptrace
 136 do not allow running executable under a debugger.
 137 Useful for any application critical to the security state of system.
 138 .El
 139 .Pp
 140 The
 141 .Ql label
 142 argument allows associating a
 143 .Xr maclabel 7
 144 with the executable.
 145 Neither
 146 .Nm
 147 nor
 148 .Xr mac_veriexec 4
 149 (if it supports labels)
 150 pay any attention to the content of the label
 151 they are provided for the use of other
 152 .Xr mac 4
 153 modules.
 154 .Sh HISTORY
 155 The Verified Exec system first appeared in
 156 .Nx .
 157 This utility derrives from the one found in Junos.
 158 The key difference is the requirement that manifest files
 159 be digitally signed.