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