3 # Build log hardening check, checks build logs for missing hardening flags.
5 # Copyright (C) 2012-2024 Simon Ruderich
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25 use Text::ParseWords ();
27 our $VERSION = '0.13';
32 # Regex to catch compiler commands.
34 (?<!\s-) # ignore options, e.g. "-c++" [sic!] (used by swig)
35 (?<!\.) # ignore file names, e.g. "test.gcc"
36 (?:cc|gcc|g\+\+|c\+\+|gfortran|mpicc|mpicxx|mpifort)
37 (?:-[\d.]+)? # version suffix, e.g. "gcc-4.6"
39 # Full regex which matches the complete compiler name. Used in a few places to
40 # prevent false negatives.
41 my $cc_regex_full_prefix = qr/
42 [a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?
44 my $cc_regex_full = qr/
45 (?:$cc_regex_full_prefix-)?
48 # Regex to check if a line contains a compiler command.
49 my $cc_regex_normal = qr/
55 # Regex to catch (GCC) compiler warnings.
56 my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
57 # Regex to catch libtool commands and not lines which show commands executed
58 # by libtool (e.g. libtool: link: ...).
59 my $libtool_regex = qr/\blibtool["']?\s.*--mode=/;
60 my $libtool_link_regex = qr/\blibtool: link: /;
62 # List of source file extensions which require preprocessing.
63 my @source_preprocess_compile_cpp = (
65 qw( cc cp cxx cpp CPP c++ C ),
69 my @source_preprocess_compile_fortran = (
71 qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
73 my @source_preprocess_compile = (
79 @source_preprocess_compile_cpp,
81 @source_preprocess_compile_fortran,
83 my @source_preprocess_no_compile = (
87 my @source_preprocess = (
88 @source_preprocess_compile,
89 @source_preprocess_no_compile,
91 # List of source file extensions which don't require preprocessing.
92 my @source_no_preprocess_compile_cpp = (
98 my @source_no_preprocess_compile_ada = (
104 my @source_no_preprocess_compile_fortran = (
106 qw( f for ftn f90 f95 f03 f08 ),
108 my @source_no_preprocess_compile = (
112 @source_no_preprocess_compile_cpp,
116 @source_no_preprocess_compile_fortran,
118 @source_no_preprocess_compile_ada,
120 my @source_no_preprocess_no_compile_ada = (
124 my @source_no_preprocess_no_compile = (
128 @source_no_preprocess_no_compile_ada,
130 my @source_no_preprocess = (
131 @source_no_preprocess_compile,
132 @source_no_preprocess_no_compile,
134 # List of header file extensions which require preprocessing.
135 my @header_preprocess = (
136 # C, C++, Objective-C, Objective-C++
139 qw( hh H hp hxx hpp HPP h++ tcc ),
143 # Normal object files.
145 # Libtool object files.
147 # Dynamic libraries. bzip2 uses .sho.
153 # Hashes for fast extensions lookup to check if a file falls in one of these
155 my %extensions_no_preprocess = map { $_ => 1 } (
156 # There's no @header_no_preprocess.
157 @source_no_preprocess,
159 my %extensions_preprocess = map { $_ => 1 } (
163 my %extensions_compile_link = map { $_ => 1 } (
165 @source_no_preprocess,
167 my %extensions_compile = map { $_ => 1 } (
168 @source_preprocess_compile,
169 @source_no_preprocess_compile,
171 my %extensions_no_compile = map { $_ => 1 } (
172 @source_preprocess_no_compile,
173 @source_no_preprocess_no_compile,
175 my %extensions_compile_cpp = map { $_ => 1 } (
176 @source_preprocess_compile_cpp,
177 @source_no_preprocess_compile_cpp,
179 my %extensions_ada = map { $_ => 1 } (
180 @source_no_preprocess_compile_ada,
181 @source_no_preprocess_no_compile_ada,
183 my %extensions_fortran = map { $_ => 1 } (
184 @source_no_preprocess_compile_fortran,
185 @source_preprocess_compile_fortran,
187 my %extensions_object = map { $_ => 1 } (
190 my %extension = map { $_ => 1 } (
191 @source_no_preprocess,
197 # Regexp to match file extensions.
198 my $file_extension_regex = qr/
200 \S+ # Filename without extension.
202 ([^\/\\.,;:\s]+)# File extension.
203 (?=\s|\\) # At end of word. Can't use \b because some files have non
204 # word characters at the end and because \b matches double
205 # extensions (like .cpp.o). Works always as all lines are
206 # terminated with "\n".
209 # Expected (hardening) flags. All flags are used as regexps (and compiled to
210 # real regexps below for better execution speed).
213 '-O(?:2|3)', # keep at index 1, search for @def_cflags_debug to change it
215 my @def_cflags_debug = (
216 # These flags indicate a debug build which disables checks for -O2.
220 my @def_cflags_format = (
221 '-Wformat(?:=2)?', # -Wformat=2 implies -Wformat, accept it too
222 '-Werror=format-security', # implies -Wformat-security
224 my @def_cflags_fortify = (
225 # fortify needs at least -O1, but -O2 is recommended anyway
227 my @def_cflags_stack = (
228 '-fstack-protector', # keep first, used by cflags_stack_broken()
229 '--param[= ]ssp-buffer-size=4',
231 my @def_cflags_stack_strong = (
232 '-fstack-protector-strong', # keep first, used by cflags_stack_broken()
234 my @def_cflags_stack_bad = (
235 # Blacklist all stack protector options for simplicity.
236 '-fno-stack-protector',
237 '-fno-stack-protector-all',
238 '-fno-stack-protector-strong',
240 my @def_cflags_pie = (
246 # @def_cxxflags_* is the same as @def_cflags_*.
247 my @def_cppflags = ();
248 my @def_cppflags_fortify = (
249 '-D_FORTIFY_SOURCE=[23]', # must be first, see cppflags_fortify_broken()
250 # If you add another flag fix hack below (search for "Hack to fix") and
251 # $def_cppflags_fortify[0].
253 my @def_cppflags_fortify_bad = (
254 # These flags may overwrite -D_FORTIFY_SOURCE=2.
256 '-D_FORTIFY_SOURCE=0',
257 '-D_FORTIFY_SOURCE=1',
259 my @def_ldflags = ();
260 my @def_ldflags_relro = (
263 my @def_ldflags_bindnow = (
266 my @def_ldflags_pie = (
270 my @def_ldflags_pic = (
275 # References to all flags checked by the flag checker.
279 \@def_cflags_fortify,
281 \@def_cflags_stack_strong,
282 \@def_cflags_stack_bad,
286 \@def_cppflags_fortify,
289 \@def_ldflags_bindnow,
292 # References to all used flags.
293 my @flag_refs_all = (
296 \@def_cppflags_fortify_bad,
299 # Renaming rules for the output so the regex parts are not visible. Also
300 # stores string values of flag regexps above, see compile_flag_regexp().
303 '-O(?:2|3)' => '-O2',
304 '-Wformat(?:=2)?' => '-Wformat',
305 '--param[= ]ssp-buffer-size=4' => '--param=ssp-buffer-size=4',
306 '-D_FORTIFY_SOURCE=[23]' => '-D_FORTIFY_SOURCE=2',
307 '-Wl,(?:-z,)?relro' => '-Wl,-z,relro',
308 '-Wl,(?:-z,)?now' => '-Wl,-z,now',
312 no_compiler_commands => 1 << 0,
313 # used by POD::Usage => 1 << 1,
314 non_verbose_build => 1 << 2,
315 flags_missing => 1 << 3,
316 hardening_wrapper => 1 << 4,
317 invalid_cmake => 1 << 5,
321 no_compiler_commands => 'I-no-compiler-commands',
322 non_verbose_build => 'W-compiler-flags-hidden',
323 flags_missing => 'W-dpkg-buildflags-missing',
324 hardening_wrapper => 'I-hardening-wrapper-used',
325 invalid_cmake => 'I-invalid-cmake-used',
328 # Statistics of missing flags and non-verbose build commands. Used for
332 preprocess_missing => 0,
334 compile_missing => 0,
336 compile_cpp_missing => 0,
340 commands_nonverbose => 0,
343 # Use colored (ANSI) output?
353 foreach my $delim (';', '&&', '||') {
356 push @x, Text::ParseWords::parse_line(qr/\Q$delim\E/, 1, $_);
362 # Ensure newline at the line end - necessary for
363 # correct parsing later.
370 my ($message, $missing_flags_ref, $flag_renames_ref, $line, $number) = @_;
372 # Get string value of qr//-escaped regexps and if requested rename them.
373 my @missing_flags = map {
374 $flag_renames_ref->{$_}
375 } @{$missing_flags_ref};
377 my $flags = join ' ', @missing_flags;
378 printf '%d:', $number if defined $number;
379 printf '%s (%s)%s %s',
380 error_color($message, 'red'), $flags, error_color(':', 'yellow'),
385 sub error_non_verbose_build {
386 my ($line, $number) = @_;
388 printf '%d:', $number if defined $number;
390 error_color('NONVERBOSE BUILD', 'red'),
391 error_color(':', 'yellow'),
396 sub error_invalid_cmake {
400 error_color('INVALID CMAKE', 'red'),
401 error_color(':', 'yellow'),
406 sub error_hardening_wrapper {
408 error_color('HARDENING WRAPPER', 'red'),
409 error_color(':', 'yellow'),
410 'no checks possible, aborting';
415 my ($message, $color) = @_;
418 return Term::ANSIColor::colored($message, $color);
425 my ($line, @flags) = @_;
427 foreach my $flag (@flags) {
428 return 1 if $line =~ /$flag/;
434 my ($line, $missing_flags_ref, @flags) = @_;
436 my @missing_flags = ();
437 foreach my $flag (@flags) {
438 if (not $line =~ /$flag/) {
439 push @missing_flags, $flag;
443 return 1 if scalar @missing_flags == 0;
445 @{$missing_flags_ref} = @missing_flags;
448 # Check if any of \@bad_flags occurs after $good_flag. Doesn't check if
449 # $good_flag is present.
450 sub flag_overwritten {
451 my ($line, $good_flag, $bad_flags) = @_;
453 if (not any_flags_used($line, @{$bad_flags})) {
458 foreach my $flag (@{$bad_flags}) {
459 while ($line =~ /$flag/g) {
460 if ($bad_pos < $+[0]) {
466 while ($line =~ /$good_flag/g) {
469 if ($good_pos > $bad_pos) {
475 sub cppflags_fortify_broken {
476 my ($line, $missing_flags) = @_;
478 # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
479 my $fortify_source = $def_cppflags_fortify[0];
481 # Some build systems enable/disable fortify source multiple times, check
483 if (not flag_overwritten($line,
485 \@def_cppflags_fortify_bad)) {
488 push @{$missing_flags}, $fortify_source;
492 sub cflags_stack_broken {
493 my ($line, $missing_flags, $strong) = @_;
495 my $flag = $strong ? $def_cflags_stack_strong[0]
496 : $def_cflags_stack[0];
498 if (not flag_overwritten($line, $flag, \@def_cflags_stack_bad)) {
501 push @{$missing_flags}, $flag;
505 # Modifies $missing_flags_ref array.
506 sub pic_pie_conflict {
507 my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
509 return 0 if not $pie;
510 return 0 if not any_flags_used($line, @def_ldflags_pic);
512 my %flags = map { $_ => 1 } @flags_pie;
514 # Remove all PIE flags from @missing_flags as they are not required with
517 not exists $flags{$_}
518 } @{$missing_flags_ref};
519 @{$missing_flags_ref} = @result;
521 # We got a conflict when no flags are left, thus only PIE flags were
522 # missing. If other flags were missing abort because the conflict is not
524 return scalar @result == 0;
527 sub is_non_verbose_build {
528 my ($line, $cargo, $skip_ref, $input_ref, $line_offset, $line_count) = @_;
530 if ($line =~ /$libtool_regex/o) {
531 # libtool's --silent hides the real compiler flags.
532 if ($line =~ /\s--silent/) {
534 # If --silent is not present, skip this line as some compiler flags
535 # might be missing (e.g. -fPIE) which are handled correctly by libtool
536 # internally. libtool displays the real compiler command on the next
537 # line, so the flags are checked as usual.
544 if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
545 or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
546 or $line =~ /^\s*[][\/0-9 ]*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
547 or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
548 or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
554 # C++ compiler setting.
555 return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
556 return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/;
557 # "Compiling" non binary files.
558 return 0 if $line =~ /^\s*Compiling \S+\.(?:py|pyx|el)['"]?\s*(?:\.\.\.|because it changed\.)?$/;
559 return 0 if $line =~ /^\s*[Cc]ompiling catalog \S+\.po\b/;
561 return 0 if $cargo and $line =~ m{^\s*Compiling\s+\S+\s+v\S+(?:\s+\(/<<PKGBUILDDIR>>\))?$};
562 # "Compiling" with no file name.
563 if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
564 # $file_extension_regex may need spaces around the filename.
565 return 0 if not " $1 " =~ /$file_extension_regex/o;
570 # On the first pass we only check if this line is verbose or not.
571 return 1 if not defined $input_ref;
573 # Second pass, we have access to the next lines.
576 # CMake and other build systems print the non-verbose messages also when
577 # building verbose. If a compiler and the file name occurs in the next
578 # lines, treat it as verbose build.
580 # Get filename, we can't use the complete path as only parts of it are
581 # used in the real compiler command.
582 $file =~ m{/([^/\s]+)$};
585 for (my $i = 1; $i <= $line_count; $i++) {
586 my $next_line = $input_ref->[$line_offset + $i];
587 last unless defined $next_line;
589 if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
590 # Not a non-verbose line, but we still have to skip the
591 # current line as it doesn't contain any compiler commands.
601 # Remove @flags from $flag_refs_ref, uses $flag_renames_ref as reference.
603 my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
605 my %removes = map { $_ => 1 } @flags;
606 foreach my $flags (@{$flag_refs_ref}) {
608 # Flag found as string.
609 not exists $removes{$_}
610 # Flag found as string representation of regexp.
611 and (not defined $flag_renames_ref->{$_}
612 or not exists $removes{$flag_renames_ref->{$_}})
619 # Modifies $flag_renames_ref hash.
620 sub compile_flag_regexp {
621 my ($flag_renames_ref, @flags) = @_;
624 foreach my $flag (@flags) {
625 # Compile flag regexp for faster execution.
626 my $regex = qr/\s(['"]?)$flag\1(?:\s|\\)/;
628 # Store flag name in replacement string for correct flags in messages
629 # with qr//ed flag regexps.
630 $flag_renames_ref->{$regex}
631 = (exists $flag_renames_ref->{$flag})
632 ? $flag_renames_ref->{$flag}
635 push @result, $regex;
640 # Does any extension in @extensions exist in %{$extensions_ref}?
641 sub extension_found {
642 my ($extensions_ref, @extensions) = @_;
644 foreach my $extension (@extensions) {
645 if (exists $extensions_ref->{$extension}) {
655 # Parse command line arguments.
657 my $option_version = 0;
659 my $option_bindnow = 0;
660 my @option_ignore_arch = ();
661 my @option_ignore_flag = ();
662 my @option_ignore_arch_flag = ();
663 my @option_ignore_line = ();
664 my @option_ignore_arch_line = ();
666 my $option_arch = undef;
667 my $option_buildd = 0;
668 my $option_debian = 0;
670 my $option_line_numbers = 0;
671 if (not Getopt::Long::GetOptions(
672 'help|h|?' => \$option_help,
673 'version' => \$option_version,
675 'pie' => \$option_pie,
676 'bindnow' => \$option_bindnow,
677 'all' => \$option_all,
679 'ignore-arch=s' => \@option_ignore_arch,
680 'ignore-flag=s' => \@option_ignore_flag,
681 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
682 'ignore-line=s' => \@option_ignore_line,
683 'ignore-arch-line=s' => \@option_ignore_arch_line,
685 'color' => \$option_color,
686 'arch=s' => \$option_arch,
687 'buildd' => \$option_buildd,
688 'debian' => \$option_debian,
689 'line-numbers' => \$option_line_numbers,
692 Pod::Usage::pod2usage(2);
696 Pod::Usage::pod2usage(1);
698 if ($option_version) {
700 blhc $VERSION Copyright (C) 2012-2024 Simon Ruderich
702 This program is free software: you can redistribute it and/or modify
703 it under the terms of the GNU General Public License as published by
704 the Free Software Foundation, either version 3 of the License, or
705 (at your option) any later version.
707 This program is distributed in the hope that it will be useful,
708 but WITHOUT ANY WARRANTY; without even the implied warranty of
709 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
710 GNU General Public License for more details.
712 You should have received a copy of the GNU General Public License
713 along with this program. If not, see <http://www.gnu.org/licenses/>.
719 if (scalar @ARGV == 0) {
721 Pod::Usage::pod2usage(2);
724 # Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
725 # installed on Debian's buildds.
726 if (not $option_buildd) {
727 require Term::ANSIColor;
735 # Precompiled ignores for faster lookup.
736 my %option_ignore_arch_flag = ();
737 my %option_ignore_arch_line = ();
739 # Strip flags which should be ignored.
740 if (scalar @option_ignore_flag > 0) {
741 remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
743 # Same for arch specific ignore flags, but only prepare here.
744 if (scalar @option_ignore_arch_flag > 0) {
745 foreach my $ignore (@option_ignore_arch_flag) {
746 my ($ignore_arch, $ignore_flag) = split /:/, $ignore, 2;
748 if (not $ignore_arch or not $ignore_flag) {
749 printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
750 . '("arch:flag" expected)' . "\n", $ignore;
752 Pod::Usage::pod2usage(2);
755 push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
759 # Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
761 foreach my $flags (@flag_refs_all) {
762 @{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
765 # Precompile ignore line regexps, also anchor at beginning and end of line.
766 # Additional entries are also extracted from the build log, see below.
767 foreach my $ignore (@option_ignore_line) {
768 $ignore = qr/^$ignore$/;
770 # Same for arch specific ignore lines.
771 if (scalar @option_ignore_arch_line > 0) {
772 foreach my $ignore (@option_ignore_arch_line) {
773 my ($ignore_arch, $ignore_line) = split /:/, $ignore, 2;
775 if (not $ignore_arch or not $ignore_line) {
776 printf STDERR 'Value "%s" invalid for option ignore-arch-line '
777 . '("arch:line" expected)' . "\n", $ignore;
779 Pod::Usage::pod2usage(2);
782 push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
790 foreach my $file (@ARGV) {
791 print "checking '$file'...\n" if scalar @ARGV > 1;
793 -f $file or die "No such file: $file";
795 open my $fh, '<', $file or die $!;
797 # Architecture of this file.
798 my $arch = $option_arch;
800 # Hardening options. Not all architectures support all hardening options.
801 my $harden_format = 1;
802 my $harden_fortify = 1;
803 my $harden_stack = 1;
804 my $harden_stack_strong = 1;
805 my $harden_relro = 1;
806 my $harden_bindnow = $option_bindnow; # defaults to 0
807 my $harden_pie = $option_pie; # defaults to 0
809 # Number of parallel jobs to prevent false positives when detecting
810 # non-verbose builds. As not all jobs declare the number of parallel jobs
811 # use a large enough default.
814 # Don't check for PIE flags if automatically applied by the compiler. Only
815 # used in buildd and Debian mode.
816 my $disable_harden_pie = 0;
817 if ($option_debian) {
818 $disable_harden_pie = 1;
821 # Ignore additional false positives if cargo/rust is used
825 while (my $line = <$fh>) {
828 # Detect architecture automatically unless overridden. For buildd logs
829 # only, doesn't use the dpkg-buildpackage header. Necessary to ignore
830 # build logs which aren't built (wrong architecture, build error,
833 if (index($line, 'Build Architecture: ') == 0) {
834 $arch = substr $line, 20, -1; # -1 to ignore '\n' at the end
835 # For old logs (sbuild << 0.63.0-1).
836 } elsif (index($line, 'Architecture: ') == 0) {
837 $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end
841 # dpkg-buildflags only provides hardening flags since 1.16.1, don't
842 # check for hardening flags in buildd mode if an older dpkg-dev is
843 # used. Default flags (-g -O2) are still checked.
845 # Packages which were built before 1.16.1 but used their own hardening
846 # flags are not checked.
848 # Strong stack protector is used since dpkg 1.17.11.
850 # Recent GCC versions automatically use PIE (only on supported
851 # architectures) and dpkg respects this properly since 1.18.15 and
852 # doesn't pass PIE flags manually.
854 and index($line, 'Toolchain package versions: ') == 0) {
855 require Dpkg::Version;
858 my $disable_strong = 1;
860 if ($line =~ /\bdpkg-dev_(\S+)/) {
861 if (Dpkg::Version::version_compare($1, '1.16.1') >= 0) {
864 if (Dpkg::Version::version_compare($1, '1.17.11') >= 0) {
867 if (Dpkg::Version::version_compare($1, '1.18.15') >= 0) {
868 $disable_harden_pie = 1;
880 if ($disable_strong) {
881 $harden_stack_strong = 0;
885 # The following two versions of CMake in Debian obeyed CPPFLAGS, but
886 # this was later dropped because upstream rejected the patch. Thus
887 # build logs with these versions will have fortify hardening flags
888 # enabled, even though they may be not correctly set and are missing
889 # when build with later CMake versions. Thanks to Aron Xu for letting
891 if (index($line, 'Package versions: ') == 0
892 and $line =~ /\bcmake_(\S+)/
893 and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
894 if (not $option_buildd) {
895 error_invalid_cmake($1);
896 $exit |= $exit_code{invalid_cmake};
898 print "$buildd_tag{invalid_cmake}|$1|\n";
902 # Debian's build daemons use "Filtered Build-Depends:" (or just
903 # "Build-Depends:" in older versions) for the build dependencies, but
904 # pbuilder uses "Depends:"; support both.
905 if (index($line, 'Filtered Build-Depends: ') == 0
906 or index($line, 'Build-Depends: ') == 0
907 or index($line, 'Depends: ') == 0) {
908 # If hardening wrapper is used (wraps calls to gcc and adds
909 # hardening flags automatically) we can't perform any checks,
911 if ($line =~ /\bhardening-wrapper\b/) {
912 if (not $option_buildd) {
913 error_hardening_wrapper();
914 $exit |= $exit_code{hardening_wrapper};
916 print "$buildd_tag{hardening_wrapper}||\n";
921 if ($line =~ /\bcargo\b/) {
926 # This flags is not always available, but if it is use it.
927 if ($line =~ /^DEB_BUILD_OPTIONS=.*\bparallel=(\d+)/) {
931 # We skip over unimportant lines at the beginning of the log to
932 # prevent false positives.
933 last if index($line, 'dpkg-buildpackage: ') == 0;
936 # Input lines, contain only the lines with compiler commands.
938 # Non-verbose lines in the input. Used to reduce calls to
939 # is_non_verbose_build() (which is quite slow) in the second loop when
940 # it's already clear if a line is non-verbose or not.
941 my @input_nonverbose = ();
943 my @input_number = ();
945 my $continuation = 0;
946 my $complete_line = undef;
948 while (my $line = <$fh>) {
951 # And stop at the end of the build log. Package details (reported by
952 # the buildd logs) are not important for us. This also prevents false
954 last if index($line, 'Build finished at ') == 0
955 and $line =~ /^Build finished at \d{8}-\d{4}$/;
957 if (not $continuation) {
961 # Detect architecture automatically unless overridden.
963 and index($line, 'dpkg-buildpackage: info: host architecture ') == 0) {
964 $arch = substr $line, 43, -1; # -1 to ignore '\n' at the end
965 # Older versions of dpkg-buildpackage
967 and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
968 $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
970 # Old buildd logs use e.g. "host architecture is alpha", remove
971 # the "is", otherwise debarch_to_debtriplet() will not detect the
973 if (index($arch, 'is ') == 0) {
974 $arch = substr $arch, 3;
978 # Permit dynamic excludes from within the build log to ignore false
979 # positives. Cannot use a separate config file as we often only have
980 # the build log itself.
981 if (index($line, 'blhc: ignore-line-regexp: ') == 0) {
982 my $ignore = substr $line, 26, -1; # -1 to ignore '\n' at the end
983 push @option_ignore_line, qr/^$ignore$/;
987 next if $line =~ /^\s*#/;
988 # Ignore compiler warnings for now.
989 next if $line =~ /$warning_regex/o;
991 if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc
992 # Remove all ANSI color sequences which are sometimes used in
993 # non-verbose builds.
994 $line = Term::ANSIColor::colorstrip($line);
995 # Also strip '\0xf' (delete previous character), used by Elinks'
998 # And "ESC(B" which seems to be used on armhf and hurd (not sure
1000 $line =~ s/\033\(B//g;
1003 # Check if this line indicates a non verbose build.
1005 $non_verbose |= is_non_verbose_build($line, $cargo, \$skip);
1008 # Treat each command as a single line so we don't ignore valid
1009 # commands when handling false positives. split_line() is slow, only
1010 # use it when necessary.
1011 my @line = ($line !~ /(?:;|&&|\|\|)/)
1013 : split_line($line);
1014 foreach my $line (@line) {
1015 if ($continuation) {
1018 # Join lines, but leave the "\" in place so it's clear where
1019 # the original line break was.
1020 chomp $complete_line;
1021 $complete_line .= ' ' . $line;
1023 # Line continuation, line ends with "\".
1024 if ($line =~ /\\$/) {
1026 # Start line continuation.
1027 if (not defined $complete_line) {
1028 $complete_line = $line;
1033 # Use the complete line if a line continuation occurred.
1034 if (defined $complete_line) {
1035 $line = $complete_line;
1036 $complete_line = undef;
1040 # Strip (basic) environment variables for compiler detection. This
1041 # prevents false positives when environment variables contain
1042 # compiler binaries. Nested quotes, command substitution, etc. is
1047 [a-zA-Z_]+ # environment variable name
1050 [^\s"'\$`\\]+ # non-quoted string
1052 '[^"'\$`\\]*' # single-quoted string
1054 "[^"'\$`\\]*" # double-quoted string
1059 # Ignore lines with no compiler commands.
1060 next if not $non_verbose
1061 and not $noenv =~ /$cc_regex_normal/o;
1062 # Ignore lines with no filenames with extensions. May miss some
1063 # non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
1064 # a problem as the log will most likely contain other non-verbose
1065 # commands which are detected.
1066 next if not $non_verbose
1067 and not $line =~ /$file_extension_regex/o;
1069 # Ignore false positives.
1071 # `./configure` output.
1072 next if not $non_verbose
1073 and $line =~ /^(?:checking|[Cc]onfigure:) /;
1074 next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
1075 [Cc]ompiler[\s.]*:?\s+
1077 next if $line =~ m{^\s*(?:-\s)?(?:HOST_)?(?:CC|CXX)
1078 \s*=\s*$cc_regex_full
1079 # optional compiler options, don't allow
1080 # "everything" here to prevent false negatives
1081 \s*(?:\s-\S+)*\s*$}xo;
1082 # `echo` is never a compiler command
1083 next if $line =~ /^\s*echo\s/;
1084 # Ignore calls to `make` because they can contain environment
1085 # variables which look like compiler commands, e.g. CC=).
1086 next if $line =~ /^\s*make\s/;
1087 # `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command
1088 # line (or similar for other architectures) which gets recognized
1089 # as a compiler line, but `moc-qt*` is only a preprocessor for Qt
1090 # C++ files. No hardening flags are relevant during this step,
1091 # thus ignore `moc-qt*` lines. The resulting files will be
1092 # compiled in a separate step (and therefore checked).
1093 next if $line =~ m{^\S+(?:/bin/moc(?:-qt[45])?|/lib/qt6/libexec/moc)
1095 -I\S+/mkspecs/[a-z]+-g\++(?:-64)?
1097 # nvcc is not a regular C compiler
1098 next if $line =~ m{^\S+/bin/nvcc\s};
1099 # Ignore false positives when the line contains only CC=gcc but no
1100 # other gcc command.
1101 if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
1104 next if not $before =~ /$cc_regex_normal/o
1105 and not $after =~ /$cc_regex_normal/o;
1107 # Ignore false positives caused by gcc -v. It outputs a line
1108 # looking like a normal compiler line but which is sometimes
1109 # missing hardening flags, although the normal compiler line
1111 next if $line =~ m{^\s+/usr/lib/gcc/$cc_regex_full_prefix/
1112 [0-9.]+/cc1(?:plus)?}xo;
1113 # Ignore false positive with `rm` which may remove files which
1114 # look like a compiler executable thus causing the line to be
1115 # treated as a normal compiler line.
1116 next if $line =~ m{^\s*rm\s+};
1117 next if $line =~ m{^\s*dwz\s+};
1118 # Some build systems emit "gcc > file".
1119 next if $line =~ m{$cc_regex_normal\s*>\s*\S+}o;
1120 # Hex output may contain "cc".
1121 next if $line =~ m#(?:\b[0-9a-fA-F]{2,}\b\s*){5}#;
1122 # Meson build output
1123 next if $line =~ /^C\+\+ linker for the host machine: /;
1124 # Embedded `gcc -print-*` commands
1125 next if $line =~ /`$cc_regex_normal\s*[^`]*-print-\S+`/;
1126 # cmake checking for compiler flags without setting CPPFLAGS
1127 next if $line =~ m{^\s*/usr/(bin|lib)/(ccache/)?c\+\+ -dM -E -c /usr/share/cmake-\S+/Modules/CMakeCXXCompilerABI\.cpp};
1128 # Some rustc lines look like linker commands
1129 next if $cargo and $line =~ /$rustc_regex/o;
1131 # Check if additional hardening options were used. Used to ensure
1132 # they are used for the complete build.
1133 $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
1135 $harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
1138 push @input_nonverbose, $non_verbose;
1139 push @input_number, $number if $option_line_numbers;
1143 close $fh or die $!;
1145 # Ignore arch if requested.
1146 if (scalar @option_ignore_arch > 0 and $arch) {
1147 foreach my $ignore (@option_ignore_arch) {
1148 if ($arch eq $ignore) {
1149 print "ignoring architecture '$arch'\n";
1155 if (scalar @input == 0) {
1156 if (not $option_buildd) {
1157 print "No compiler commands!\n";
1158 $exit |= $exit_code{no_compiler_commands};
1160 print "$buildd_tag{no_compiler_commands}||\n";
1165 if ($option_buildd) {
1166 $statistics{commands} += scalar @input;
1169 # Option or auto detected.
1171 # The following was partially copied from dpkg-dev 1.22.0
1172 # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, set_build_features and
1173 # _add_build_flags()), copyright Raphaël Hertzog <hertzog@debian.org>,
1174 # Guillem Jover <guillem@debian.org>, Kees Cook <kees@debian.org>,
1175 # Canonical, Ltd. licensed under GPL version 2 or later. Keep it in
1180 # Recent dpkg versions use a quadruplet for arch. Support both.
1182 (undef, undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtuple($arch);
1185 (undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
1188 my %builtin_pie_arch = map { $_ => 1 } qw(
1219 # Disable unsupported hardening options.
1220 if ($os !~ /^(?:linux|kfreebsd|knetbsd|hurd)$/ or $cpu eq 'hppa') {
1223 if ($cpu =~ /^(?:ia64|alpha|hppa|nios2)$/ or $arch eq 'arm') {
1225 $harden_stack_strong = 0;
1227 if ($cpu =~ /^(?:ia64|hppa)$/) {
1229 $harden_bindnow = 0;
1232 if ($disable_harden_pie and exists $builtin_pie_arch{$arch}) {
1238 my @cflags = @def_cflags;
1239 my @cxxflags = @def_cxxflags;
1240 my @cppflags = @def_cppflags;
1241 my @ldflags = @def_ldflags;
1242 # Check the specified hardening options, same order as dpkg-buildflags.
1244 @cflags = (@cflags, @def_cflags_pie);
1245 @cxxflags = (@cxxflags, @def_cflags_pie);
1246 @ldflags = (@ldflags, @def_ldflags_pie);
1248 if ($harden_stack_strong) {
1249 @cflags = (@cflags, @def_cflags_stack_strong);
1250 @cxxflags = (@cxxflags, @def_cflags_stack_strong);
1251 } elsif ($harden_stack) {
1252 @cflags = (@cflags, @def_cflags_stack);
1253 @cxxflags = (@cxxflags, @def_cflags_stack);
1255 if ($harden_fortify) {
1256 @cflags = (@cflags, @def_cflags_fortify);
1257 @cxxflags = (@cxxflags, @def_cflags_fortify);
1258 @cppflags = (@cppflags, @def_cppflags_fortify);
1260 if ($harden_format) {
1261 @cflags = (@cflags, @def_cflags_format);
1262 @cxxflags = (@cxxflags, @def_cflags_format);
1264 if ($harden_relro) {
1265 @ldflags = (@ldflags, @def_ldflags_relro);
1267 if ($harden_bindnow) {
1268 @ldflags = (@ldflags, @def_ldflags_bindnow);
1271 # Ada doesn't support format hardening flags, see #680117 for more
1272 # information. Same for fortran.
1274 my @cflags_noformat = grep {
1276 foreach my $flag (@def_cflags_format) {
1277 $ok = 0 if $_ eq $flag;
1282 # Hack to fix cppflags_fortify_broken() if --ignore-flag
1283 # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
1284 # as long as @def_cppflags_fortify contains only one variable.
1285 if (scalar @def_cppflags_fortify == 0) {
1286 $harden_fortify = 0;
1289 # Ignore flags for this arch if requested.
1290 if ($arch and exists $option_ignore_arch_flag{$arch}) {
1291 my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
1293 remove_flags(\@local_flag_refs,
1295 @{$option_ignore_arch_flag{$arch}});
1298 my @ignore_line = @option_ignore_line;
1299 # Ignore lines for this arch if requested.
1300 if ($arch and exists $option_ignore_arch_line{$arch}) {
1301 @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
1305 for (my $i = 0; $i < scalar @input; $i++) {
1306 my $line = $input[$i];
1308 # Ignore line if requested.
1309 foreach my $ignore (@ignore_line) {
1310 next LINE if $line =~ /$ignore/;
1314 if ($input_nonverbose[$i]
1315 and is_non_verbose_build($line, $cargo, \$skip,
1316 \@input, $i, $parallel)) {
1317 if (not $option_buildd) {
1318 error_non_verbose_build($line, $input_number[$i]);
1319 $exit |= $exit_code{non_verbose_build};
1321 $statistics{commands_nonverbose}++;
1325 # Even if it's a verbose build, we might have to skip this line (see
1326 # is_non_verbose_build()).
1329 my $orig_line = $line;
1331 # Remove everything until and including the compiler command. Makes
1332 # checks easier and faster.
1333 $line =~ s/^.*?$cc_regex//o;
1334 # "([...] test.c)" is not detected as 'test.c' - fix this by removing
1335 # the brace and similar characters at the line end.
1336 $line =~ s/['")]+$//;
1338 # Skip unnecessary tests when only preprocessing.
1339 my $flag_preprocess = 0;
1346 # Preprocess, compile, assemble.
1347 if ($line =~ /\s(-E|-S|-c)\b/) {
1349 $flag_preprocess = 1 if $1 eq '-E';
1350 $compile = 1 if $1 eq '-S' or $1 eq '-c';
1351 # Dependency generation for Makefiles. The other flags (-MF -MG -MP
1352 # -MT -MQ) are always used with -M/-MM.
1353 } elsif ($line =~ /\s(?:-M|-MM)\b/) {
1355 # Otherwise assume we are linking.
1360 # -MD/-MMD also cause dependency generation, but they don't imply -E!
1361 if ($line =~ /\s(?:-MD|-MMD)\b/) {
1363 $flag_preprocess = 0;
1366 # Dependency generation for Makefiles, no preprocessing or other flags
1368 next if $dependency;
1370 # Get all file extensions on this line.
1371 my @extensions = $line =~ /$file_extension_regex/go;
1372 # Ignore all unknown extensions to speedup the search below.
1373 @extensions = grep { exists $extension{$_} } @extensions;
1375 # These file types don't require preprocessing.
1376 if (extension_found(\%extensions_no_preprocess, @extensions)) {
1379 # These file types require preprocessing.
1380 if (extension_found(\%extensions_preprocess, @extensions)) {
1381 # Prevent false positives with "libtool: link: g++ -include test.h
1382 # .." compiler lines.
1383 if ($orig_line !~ /$libtool_link_regex/o) {
1388 if (not $flag_preprocess) {
1389 # If there are source files then it's compiling/linking in one
1390 # step and we must check both. We only check for source files
1391 # here, because header files cause too many false positives.
1392 if (extension_found(\%extensions_compile_link, @extensions)) {
1393 # Assembly files don't need CFLAGS.
1394 if (not extension_found(\%extensions_compile, @extensions)
1395 and extension_found(\%extensions_no_compile, @extensions)) {
1397 # But the rest does.
1401 # No compilable extensions found, either linking or compiling
1404 # If there are also no object files we are just compiling headers
1405 # (.h -> .h.gch). Don't check for linker flags in this case. Due
1406 # to our liberal checks for compiler lines, this also reduces the
1407 # number of false positives considerably.
1409 and not extension_found(\%extensions_object, @extensions)) {
1414 my $compile_cpp = 0;
1415 my $restore_cflags = 0;
1416 # Assume CXXFLAGS are required when a C++ file is specified in the
1419 and extension_found(\%extensions_compile_cpp, @extensions)) {
1422 # Ada needs special CFLAGS
1423 } elsif (extension_found(\%extensions_ada, @extensions)) {
1424 $restore_cflags = 1;
1425 $preprocess = 0; # Ada uses no CPPFLAGS
1426 @cflags_backup = @cflags;
1427 @cflags = @cflags_noformat;
1429 } elsif (extension_found(\%extensions_fortran, @extensions)) {
1430 $restore_cflags = 1;
1431 @cflags_backup = @cflags;
1432 @cflags = @cflags_noformat;
1435 if ($option_buildd) {
1436 $statistics{preprocess}++ if $preprocess;
1437 $statistics{compile}++ if $compile;
1438 $statistics{compile_cpp}++ if $compile_cpp;
1439 $statistics{link}++ if $link;
1442 # Check if there are flags indicating a debug build. If that's true,
1443 # skip the check for -O2. This prevents fortification, but that's fine
1444 # for a debug build.
1445 if (any_flags_used($line, @def_cflags_debug)) {
1446 remove_flags([\@cflags], \%flag_renames, $def_cflags[1]);
1447 remove_flags([\@cppflags], \%flag_renames, $def_cppflags_fortify[0]);
1450 # Check hardening flags.
1452 if ($compile and (not all_flags_used($line, \@missing, @cflags)
1453 or (($harden_stack or $harden_stack_strong)
1454 and cflags_stack_broken($line, \@missing,
1455 $harden_stack_strong)))
1456 # Libraries linked with -fPIC don't have to (and can't) be
1457 # linked with -fPIE as well. It's no error if only PIE flags
1459 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1460 # Assume dpkg-buildflags returns the correct flags.
1461 and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
1462 if (not $option_buildd) {
1463 error_flags('CFLAGS missing', \@missing, \%flag_renames,
1464 $input[$i], $input_number[$i]);
1465 $exit |= $exit_code{flags_missing};
1467 $statistics{compile_missing}++;
1469 } elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
1470 # Libraries linked with -fPIC don't have to (and can't) be
1471 # linked with -fPIE as well. It's no error if only PIE flags
1473 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
1474 # Assume dpkg-buildflags returns the correct flags.
1475 and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
1476 if (not $option_buildd) {
1477 error_flags('CXXFLAGS missing', \@missing, \%flag_renames,
1478 $input[$i], $input_number[$i]);
1479 $exit |= $exit_code{flags_missing};
1481 $statistics{compile_cpp_missing}++;
1485 and (not all_flags_used($line, \@missing, @cppflags)
1486 # The fortify flag might be overwritten, detect that.
1488 and cppflags_fortify_broken($line, \@missing)))
1489 # Assume dpkg-buildflags returns the correct flags.
1490 and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
1491 if (not $option_buildd) {
1492 error_flags('CPPFLAGS missing', \@missing, \%flag_renames,
1493 $input[$i], $input_number[$i]);
1494 $exit |= $exit_code{flags_missing};
1496 $statistics{preprocess_missing}++;
1499 if ($link and not all_flags_used($line, \@missing, @ldflags)
1500 # Same here, -fPIC conflicts with -fPIE.
1501 and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
1502 # Assume dpkg-buildflags returns the correct flags.
1503 and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
1504 if (not $option_buildd) {
1505 error_flags('LDFLAGS missing', \@missing, \%flag_renames,
1506 $input[$i], $input_number[$i]);
1507 $exit |= $exit_code{flags_missing};
1509 $statistics{link_missing}++;
1513 # Restore normal CFLAGS.
1514 if ($restore_cflags) {
1515 @cflags = @cflags_backup;
1520 # Print statistics for buildd mode, only output in this mode.
1521 if ($option_buildd) {
1524 if ($statistics{preprocess_missing}) {
1525 push @warning, sprintf 'CPPFLAGS %d (of %d)',
1526 $statistics{preprocess_missing},
1527 $statistics{preprocess};
1529 if ($statistics{compile_missing}) {
1530 push @warning, sprintf 'CFLAGS %d (of %d)',
1531 $statistics{compile_missing},
1532 $statistics{compile};
1534 if ($statistics{compile_cpp_missing}) {
1535 push @warning, sprintf 'CXXFLAGS %d (of %d)',
1536 $statistics{compile_cpp_missing},
1537 $statistics{compile_cpp};
1539 if ($statistics{link_missing}) {
1540 push @warning, sprintf 'LDFLAGS %d (of %d)',
1541 $statistics{link_missing},
1544 if (scalar @warning) {
1545 local $" = ', '; # array join string
1546 print "$buildd_tag{flags_missing}|@warning missing|\n";
1549 if ($statistics{commands_nonverbose}) {
1550 printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
1551 $statistics{commands_nonverbose},
1552 $statistics{commands},
1564 blhc - build log hardening check, checks build logs for missing hardening flags
1568 B<blhc> [I<options>] I<< <dpkg-buildpackage build log file>.. >>
1572 blhc is a small tool which checks build logs for missing hardening flags. It's
1573 licensed under the GPL 3 or later.
1575 It's designed to check build logs generated by Debian's dpkg-buildpackage (or
1576 tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the
1577 official buildd build logs)) to help maintainers detect missing hardening
1578 flags in their packages.
1580 Only gcc is detected as compiler at the moment. If other compilers support
1581 hardening flags as well, please report them.
1583 If there's no output, no flags are missing and the build log is fine.
1585 See F<README> for details about performed checks, auto-detection and
1588 =head1 FALSE POSITIVES
1590 To suppress false positives you can embed the following string in the build
1593 blhc: ignore-line-regexp: REGEXP
1595 All lines fully matching REGEXP (see B<--ignore-line> for details) will be
1596 ignored. The string can be embedded multiple times to ignore different
1599 Please use this feature sparingly so that missing flags are not overlooked. If
1600 you find false positives which affect more packages please report a bug.
1602 To generate this string simply use echo in C<debian/rules>; make sure to use @
1603 to suppress the echo command itself as it could also trigger a false positive.
1604 If the build process takes a long time edit the C<.build> file in place and
1605 tweak the ignore string until B<blhc --all --debian package.build> no longer
1606 reports any false positives.
1614 Force check for all +all (+pie, +bindnow) hardening flags. By default it's
1617 =item B<--arch> I<architecture>
1619 Set the specific architecture (e.g. amd64, armel, etc.), automatically
1620 disables hardening flags not available on this architecture. Is detected
1621 automatically if dpkg-buildpackage is used.
1625 Force check for all +bindnow hardening flags. By default it's auto detected.
1629 Special mode for buildds when automatically parsing log files. The following
1630 changes are in effect:
1636 Print tags instead of normal warnings, see L</"BUILDD TAGS"> for a list of
1641 Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
1646 Don't require Term::ANSIColor.
1650 Return exit code 0, unless there was a error (-I, -W messages don't count as
1657 Apply Debian-specific settings. At the moment this only disables checking for
1658 PIE which is automatically applied by Debian's GCC and no longer requires a
1659 compiler command line argument.
1663 Use colored (ANSI) output for warning messages.
1665 =item B<--line-numbers>
1667 Display line numbers.
1669 =item B<--ignore-arch> I<arch>
1671 Ignore build logs from architectures matching I<arch>. I<arch> is a string.
1673 Used to prevent false positives. This option can be specified multiple times.
1675 =item B<--ignore-arch-flag> I<arch>:I<flag>
1677 Like B<--ignore-flag>, but only ignore flag on I<arch>.
1679 =item B<--ignore-arch-line> I<arch>:I<line>
1681 Like B<--ignore-line>, but only ignore line on I<arch>.
1683 =item B<--ignore-flag> I<flag>
1685 Don't print an error when the specific flag is missing in a compiler line.
1686 I<flag> is a string.
1688 Used to prevent false positives. This option can be specified multiple times.
1690 =item B<--ignore-line> I<regex>
1692 Ignore lines matching the given Perl regex. I<regex> is automatically anchored
1693 at the beginning and end of the line to prevent false negatives.
1695 B<NOTE>: Not the input lines are checked, but the lines which are displayed in
1696 warnings (which have line continuation resolved).
1698 Used to prevent false positives. This option can be specified multiple times.
1702 Force check for all +pie hardening flags. By default it's auto detected.
1704 =item B<-h -? --help>
1706 Print available options.
1710 Print version number and license.
1714 Auto detection for B<--pie> and B<--bindnow> only works if at least one
1715 command uses the required hardening flag (e.g. -fPIE). Then it's required for
1716 all other commands as well.
1720 Normal usage, parse a single log file.
1722 blhc path/to/log/file
1724 If there's no output, no flags are missing and the build log is fine.
1726 Parse multiple log files. The exit code is ORed over all files.
1728 blhc path/to/directory/with/log/files/*
1730 Don't treat missing C<-g> as error:
1732 blhc --ignore-flag -g path/to/log/file
1734 Don't treat missing C<-pie> on kfreebsd-amd64 as error:
1736 blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
1738 Ignore lines consisting exactly of C<./script gcc file> which would cause a
1741 blhc --ignore-line '\./script gcc file' path/to/log/file
1743 Ignore lines matching C<./script gcc file> somewhere in the line.
1745 blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
1747 Use blhc with pbuilder.
1749 pbuilder path/to/package.dsc | tee path/log/file
1750 blhc path/to/file || echo flags missing
1752 Assume this build log was created on a Debian system and thus don't warn about
1753 missing PIE flags if the current architecture injects them automatically (this
1754 is enabled in buildd mode per default). C<--arch> is necessary if the build
1755 log contains no architecture information as written by dpkg-buildpackage.
1757 blhc --debian --all --arch=amd64 path/to/log/file
1761 The following tags are used in I<--buildd> mode. In braces the additional data
1766 =item B<I-hardening-wrapper-used>
1768 The package uses hardening-wrapper which intercepts calls to gcc and adds
1769 hardening flags. The build log doesn't contain any hardening flags and thus
1770 can't be checked by blhc.
1772 =item B<W-compiler-flags-hidden> (summary of hidden lines)
1774 Build log contains lines which hide the real compiler flags. For example:
1781 Most of the time either C<export V=1> or C<export verbose=1> in
1782 F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
1783 in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
1784 patched to remove the C<@>s hiding the real compiler commands.
1786 =item B<W-dpkg-buildflags-missing> (summary of missing flags)
1788 CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
1790 =item B<I-invalid-cmake-used> (version)
1792 By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
1793 patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
1794 patch was rejected by upstream and later reverted in Debian. Thus those two
1795 versions show correct usage of CPPFLAGS even if the package doesn't correctly
1796 handle them (for example by passing them to CFLAGS). To prevent false
1797 negatives just blacklist those two versions.
1799 =item B<I-no-compiler-commands>
1801 No compiler commands were detected. Either the log contains none or they were
1802 not correctly detected by blhc (please report the bug in this case).
1808 The exit status is a "bit mask", each listed status is ORed when the error
1809 condition occurs to get the result.
1819 No compiler commands were found.
1823 Invalid arguments/options given to blhc.
1831 Missing hardening flags.
1835 Hardening wrapper detected, no tests performed.
1839 Invalid CMake version used. See B<I-invalid-cmake-used> under L</"BUILDD
1840 TAGS"> for a detailed explanation.
1846 Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
1848 Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
1849 E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
1851 =head1 LICENSE AND COPYRIGHT
1853 Copyright (C) 2012-2024 by Simon Ruderich
1855 This program is free software: you can redistribute it and/or modify
1856 it under the terms of the GNU General Public License as published by
1857 the Free Software Foundation, either version 3 of the License, or
1858 (at your option) any later version.
1860 This program is distributed in the hope that it will be useful,
1861 but WITHOUT ANY WARRANTY; without even the implied warranty of
1862 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1863 GNU General Public License for more details.
1865 You should have received a copy of the GNU General Public License
1866 along with this program. If not, see <http://www.gnu.org/licenses/>.
1870 L<hardening-check(1)>, L<dpkg-buildflags(1)>