README

   1 README
   2 ======
   3
   4 blhc (build log hardening check) is a small tool which checks build logs for
   5 missing hardening flags. It's licensed under the GPL 3 or later.
   6
   7 Hardening flags enable additional security features in the compiler to prevent
   8 e.g. stack overflows, format string vulnerabilities, GOT overwrites, etc.
   9
  10 Because most build systems are quite complicated there are many places where
  11 compiler flags from the environment might be ignored. The parser verifies that
  12 all compiler commands use the correct hardening flags and thus all hardening
  13 features are correctly used.
  14
  15 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
  16 tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
  17 to help maintainers detect missing hardening flags in their packages.
  18
  19 At the moment it works only on Debian and derivatives but it should be easily
  20 extendable to other systems as well. Patches are welcome.
  21
  22 Only gcc is detected as compiler at the moment. If other compilers support
  23 hardening flags as well, please report them.
  24
  25 For more information about hardening flags have a look at [1].
  26
  27 [1]: https://wiki.debian.org/Hardening
  28
  29
  30 DEPENDENCIES
  31 ------------
  32
  33 - Perl
  34   - Dpkg::Arch
  35   - Dpkg::Version
  36
  37
  38 USAGE
  39 -----
  40
  41     blhc path/to/log/file
  42
  43 blhc can be run directly from the source tree (`bin/blhc`) or copied anywhere
  44 on the system. It doesn't have to be explicitly installed. To read the man
  45 page use `perldoc bin/blhc`.
  46
  47 If there's no output, no flags are missing and the build log is fine.
  48
  49 For more examples see the man page.
  50
  51
  52 CHECKS
  53 ------
  54
  55 blhc checks all compiler lines (lines matching `gcc`) for hardening flags
  56 (same as set by `dpkg-buildflags`). If a compiler flag is missing a warning
  57 with the missing flags is printed.
  58
  59 Consider the following compiler line:
  60
  61     gcc -g -O2 -o test test.c
  62
  63 blhc generates the following warnings because all hardening flags are missing:
  64
  65     CFLAGS missing (-fstack-protector --param=ssp-buffer-size=4 -Wformat -Wformat-security -Werror=format-security): gcc -g -O2 -o test test.c
  66     CPPFLAGS missing (-D_FORTIFY_SOURCE=2): gcc -g -O2 -o test test.c
  67     LDFLAGS missing (-Wl,-z,relro): gcc -g -O2 -o test test.c
  68
  69 Preprocessing, linking and compiling is automatically detected:
  70
  71     gcc -MM test.c > test.d
  72     gcc -E test.c
  73     gcc -o test test.o
  74
  75     CPPFLAGS missing (-D_FORTIFY_SOURCE=2): gcc -E test.c
  76     LDFLAGS missing (-Wl,-z,relro): gcc -o test test.o
  77
  78 blhc differentiates the following flags:
  79
  80     - CPPFLAGS: preprocessor flags
  81     - CFLAGS:   C compiler flags
  82     - CXXFLAGS: C++ compiler flags
  83     - LDFLAGS:  linker flags
  84
  85 Both '-O2' and '-O3' are recognized as valid, even though only '-O2' is
  86 printed in warnings.
  87
  88 It handles all file extensions as documented by gcc regarding preprocessing,
  89 linking, compiling.
  90
  91 The architecture of the build log is automatically detected by looking for the
  92 following line (output of dpkg-buildpackage):
  93
  94     dpkg-buildpackage: host architecture <architecture>
  95
  96 The available hardening flags are adapted to the architecture because some
  97 architectures don't support certain hardening options.
  98
  99
 100 LIMITATIONS
 101 -----------
 102
 103 The build log must contain the following line which marks the beginning of the
 104 real compile process (output of dpkg-buildpackage):
 105
 106     dpkg-buildpackage: ...
 107
 108 If it's not present no compiler commands are detected. In case you don't use
 109 dpkp-buildpackage but still want to check a build log adding it as first line
 110 should work fine.
 111
 112 The following non-verbose builds can't be detected:
 113
 114     gcc -o test
 115
 116 This is not detected because `test` has no file extension. A file extension is
 117 required on a compiler line to prevent many false positives. As the build will
 118 most likely contain other non-verbose build commands (e.g. `gcc test.c`) which
 119 are correctly detected as non-verbose this shouldn't be a problem.
 120
 121 Some CMake non-verbose linker commands are also not correctly detected at the
 122 moment.
 123
 124 blhc still creates a few false positives. Patches to fix them are very welcome
 125 as long as they won't cause any false negatives.
 126
 127
 128 BUILDD MODE
 129 -----------
 130
 131 Buildd mode is enabled if '--buildd' is used. It's designed to check build
 132 logs from Debian's buildds.
 133
 134 Instead of normal warning messages only tags are printed at the end of the
 135 check. See the man page for possible tags.
 136
 137
 138 BUGS
 139 ----
 140
 141 If you find any bugs not mentioned in this document please report them to
 142 <simon@ruderich.org> with blhc in the subject.
 143
 144
 145 AUTHORS
 146 -------
 147
 148 Written by Simon Ruderich <simon@ruderich.org>.
 149
 150 Thanks to Bernhard R. Link <brlink@debian.org> and Jaria Alto
 151 <jari.aalto@cante.net> for their valuable input and suggestions.
 152
 153
 154 LICENSE
 155 -------
 156
 157 blhc is licensed under GPL version 3 or later.
 158
 159 Copyright (C) 2012  Simon Ruderich
 160
 161 This program is free software: you can redistribute it and/or modify
 162 it under the terms of the GNU General Public License as published by
 163 the Free Software Foundation, either version 3 of the License, or
 164 (at your option) any later version.
 165
 166 This program is distributed in the hope that it will be useful,
 167 but WITHOUT ANY WARRANTY; without even the implied warranty of
 168 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 169 GNU General Public License for more details.
 170
 171 You should have received a copy of the GNU General Public License
 172 along with this program.  If not, see <http://www.gnu.org/licenses/>.