# Build log hardening check, checks build logs for missing hardening flags.
-# Copyright (C) 2012-2017 Simon Ruderich
+# Copyright (C) 2012-2021 Simon Ruderich
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
use Getopt::Long ();
use Text::ParseWords ();
-our $VERSION = '0.07';
+our $VERSION = '0.12';
# CONSTANTS/VARIABLES
my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
# Regex to catch libtool commands and not lines which show commands executed
# by libtool (e.g. libtool: link: ...).
-my $libtool_regex = qr/\blibtool\s.*--mode=/;
+my $libtool_regex = qr/\blibtool["']?\s.*--mode=/;
my $libtool_link_regex = qr/\blibtool: link: /;
# List of source file extensions which require preprocessing.
# fortify needs at least -O1, but -O2 is recommended anyway
);
my @def_cflags_stack = (
- '-fstack-protector',
+ '-fstack-protector', # keep first, used by cflags_stack_broken()
'--param[= ]ssp-buffer-size=4',
);
my @def_cflags_stack_strong = (
- '-fstack-protector-strong',
+ '-fstack-protector-strong', # keep first, used by cflags_stack_broken()
+);
+my @def_cflags_stack_bad = (
+ # Blacklist all stack protector options for simplicity.
+ '-fno-stack-protector',
+ '-fno-stack-protector-all',
+ '-fno-stack-protector-strong',
);
my @def_cflags_pie = (
'-fPIE',
\@def_cflags_fortify,
\@def_cflags_stack,
\@def_cflags_stack_strong,
+ \@def_cflags_stack_bad,
\@def_cflags_pie,
\@def_cxxflags,
\@def_cppflags,
# FUNCTIONS
-# Only works for single-level arrays with no undef values. Thanks to perlfaq4.
-sub array_equal {
- my ($first_ref, $second_ref) = @_;
-
- return 0 if scalar @{$first_ref} != scalar @{$second_ref};
+sub split_line {
+ my ($line) = @_;
- my $length = scalar @{$first_ref};
- for (my $i = 0; $i < $length; $i++) {
- return 0 if $first_ref->[$i] ne $second_ref->[$i];
+ my @work = ($line);
+ foreach my $delim (';', '&&', '||') {
+ my @x;
+ foreach (@work) {
+ push @x, Text::ParseWords::parse_line(qr/\Q$delim\E/, 1, $_);
+ }
+ @work = @x;
}
- return 1;
+ return map {
+ # Ensure newline at the line end - necessary for
+ # correct parsing later.
+ $_ =~ s/\s+$//;
+ $_ .= "\n";
+ } @work;
}
sub error_flags {
- my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_;
+ my ($message, $missing_flags_ref, $flag_renames_ref, $line, $number) = @_;
# Get string value of qr//-escaped regexps and if requested rename them.
my @missing_flags = map {
} @{$missing_flags_ref};
my $flags = join ' ', @missing_flags;
+ printf '%d:', $number if defined $number;
printf '%s (%s)%s %s',
error_color($message, 'red'), $flags, error_color(':', 'yellow'),
$line;
return;
}
sub error_non_verbose_build {
- my ($line) = @_;
+ my ($line, $number) = @_;
+ printf '%d:', $number if defined $number;
printf '%s%s %s',
error_color('NONVERBOSE BUILD', 'red'),
error_color(':', 'yellow'),
@{$missing_flags_ref} = @missing_flags;
return 0;
}
+# Check if any of \@bad_flags occurs after $good_flag. Doesn't check if
+# $good_flag is present.
+sub flag_overwritten {
+ my ($line, $good_flag, $bad_flags) = @_;
+
+ if (not any_flags_used($line, @{$bad_flags})) {
+ return 0;
+ }
+
+ my $bad_pos = 0;
+ foreach my $flag (@{$bad_flags}) {
+ while ($line =~ /$flag/g) {
+ if ($bad_pos < $+[0]) {
+ $bad_pos = $+[0];
+ }
+ }
+ }
+ my $good_pos = 0;
+ while ($line =~ /$good_flag/g) {
+ $good_pos = $+[0];
+ }
+ if ($good_pos > $bad_pos) {
+ return 0;
+ }
+ return 1;
+}
sub cppflags_fortify_broken {
my ($line, $missing_flags) = @_;
- # This doesn't take the position into account, but is a simple solution.
- # And if the build system tries to force -D_FORTIFY_SOURCE=0/1, something
- # is wrong anyway.
+ # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
+ my $fortify_source = $def_cppflags_fortify[0];
- if (any_flags_used($line, @def_cppflags_fortify_bad)) {
- # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2!
- push @{$missing_flags}, $def_cppflags_fortify[0];
- return 1;
+ # Some build systems enable/disable fortify source multiple times, check
+ # the final result.
+ if (not flag_overwritten($line,
+ $fortify_source,
+ \@def_cppflags_fortify_bad)) {
+ return 0;
}
+ push @{$missing_flags}, $fortify_source;
+ return 1;
+}
- return 0;
+sub cflags_stack_broken {
+ my ($line, $missing_flags, $strong) = @_;
+
+ my $flag = $strong ? $def_cflags_stack_strong[0]
+ : $def_cflags_stack[0];
+
+ if (not flag_overwritten($line, $flag, \@def_cflags_stack_bad)) {
+ return 0;
+ }
+ push @{$missing_flags}, $flag;
+ return 1;
}
# Modifies $missing_flags_ref array.
if (not (index($line, 'checking if you want to see long compiling messages... no') == 0
or $line =~ /^\s*\[?(?:CC|CCLD|C\+\+|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/
- or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
+ or $line =~ /^\s*[][\/0-9 ]*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
return 0;
return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/;
# "Compiling" non binary files.
- return 0 if $line =~ /^\s*Compiling \S+\.(?:py|el)['"]?\s*(?:\.\.\.)?$/;
+ return 0 if $line =~ /^\s*Compiling \S+\.(?:py|pyx|el)['"]?\s*(?:\.\.\.|because it changed\.)?$/;
+ return 0 if $line =~ /^\s*[Cc]ompiling catalog \S+\.po\b/;
# "Compiling" with no file name.
if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
# $file_extension_regex may need spaces around the filename.
my @result = ();
foreach my $flag (@flags) {
# Compile flag regexp for faster execution.
- my $regex = qr/\s$flag(?:\s|\\)/;
+ my $regex = qr/\s(['"]?)$flag\1(?:\s|\\)/;
# Store flag name in replacement string for correct flags in messages
# with qr//ed flag regexps.
my $option_buildd = 0;
my $option_debian = 0;
$option_color = 0;
+my $option_line_numbers = 0;
if (not Getopt::Long::GetOptions(
'help|h|?' => \$option_help,
'version' => \$option_version,
'arch=s' => \$option_arch,
'buildd' => \$option_buildd,
'debian' => \$option_debian,
+ 'line-numbers' => \$option_line_numbers,
)) {
require Pod::Usage;
Pod::Usage::pod2usage(2);
}
if ($option_version) {
print <<"EOF";
-blhc $VERSION Copyright (C) 2012-2017 Simon Ruderich
+blhc $VERSION Copyright (C) 2012-2021 Simon Ruderich
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
}
# Precompile ignore line regexps, also anchor at beginning and end of line.
+# Additional entries are also extracted from the build log, see below.
foreach my $ignore (@option_ignore_line) {
$ignore = qr/^$ignore$/;
}
my $harden_bindnow = $option_bindnow; # defaults to 0
my $harden_pie = $option_pie; # defaults to 0
- # Does this build log use ada? Ada also uses gcc as compiler but uses
- # different CFLAGS. But only perform ada checks if an ada compiler is used
- # for performance reasons.
- my $ada = 0;
- # Fortran also requires different CFLAGS.
- my $fortran = 0;
-
# Number of parallel jobs to prevent false positives when detecting
# non-verbose builds. As not all jobs declare the number of parallel jobs
# use a large enough default.
$disable_harden_pie = 1;
}
+ my $number = 0;
while (my $line = <$fh>) {
+ $number++;
+
# Detect architecture automatically unless overridden. For buildd logs
# only, doesn't use the dpkg-buildpackage header. Necessary to ignore
# build logs which aren't built (wrong architecture, build error,
}
next FILE;
}
-
- # Ada compiler.
- if ($line =~ /\bgnat\b/) {
- $ada = 1;
- }
- # Fortran compiler.
- if ($line =~ /\bgfortran\b/) {
- $fortran = 1;
- }
}
# This flags is not always available, but if it is use it.
if ($line =~ /^DEB_BUILD_OPTIONS=.*\bparallel=(\d+)/) {
- $parallel = $1;
+ $parallel = $1 * 2;
}
# We skip over unimportant lines at the beginning of the log to
# is_non_verbose_build() (which is quite slow) in the second loop when
# it's already clear if a line is non-verbose or not.
my @input_nonverbose = ();
+ # Input line number.
+ my @input_number = ();
my $continuation = 0;
my $complete_line = undef;
my $non_verbose;
while (my $line = <$fh>) {
+ $number++;
+
# And stop at the end of the build log. Package details (reported by
# the buildd logs) are not important for us. This also prevents false
# positives.
# Detect architecture automatically unless overridden.
if (not $arch
+ and index($line, 'dpkg-buildpackage: info: host architecture ') == 0) {
+ $arch = substr $line, 43, -1; # -1 to ignore '\n' at the end
+ # Older versions of dpkg-buildpackage
+ } elsif (not $arch
and index($line, 'dpkg-buildpackage: host architecture ') == 0) {
$arch = substr $line, 37, -1; # -1 to ignore '\n' at the end
}
}
+ # Permit dynamic excludes from within the build log to ignore false
+ # positives. Cannot use a separate config file as we often only have
+ # the build log itself.
+ if (index($line, 'blhc: ignore-line-regexp: ') == 0) {
+ my $ignore = substr $line, 26, -1; # -1 to ignore '\n' at the end
+ push @option_ignore_line, qr/^$ignore$/;
+ next;
+ }
+
next if $line =~ /^\s*#/;
# Ignore compiler warnings for now.
next if $line =~ /$warning_regex/o;
$non_verbose |= is_non_verbose_build($line, \$skip);
next if $skip;
- # One line may contain multiple commands (";"). Treat each one as
- # single line. parse_line() is slow, only use it when necessary.
- my @line = (index($line, ';') == -1)
+ # Treat each command as a single line so we don't ignore valid
+ # commands when handling false positives. split_line() is slow, only
+ # use it when necessary.
+ my @line = ($line !~ /(?:;|&&|\|\|)/)
? ($line)
- : map {
- # Ensure newline at the line end - necessary for
- # correct parsing later.
- $_ =~ s/\s+$//;
- $_ .= "\n";
- } Text::ParseWords::parse_line(';', 1, $line);
+ : split_line($line);
foreach my $line (@line) {
if ($continuation) {
$continuation = 0;
# optional compiler options, don't allow
# "everything" here to prevent false negatives
\s*(?:\s-\S+)*\s*$}xo;
+ # `echo` is never a compiler command
+ next if $line =~ /^\s*echo\s/;
+ # Ignore calls to `make` because they can contain environment
+ # variables which look like compiler commands, e.g. CC=).
+ next if $line =~ /^\s*make\s/;
# `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command
# line (or similar for other architectures) which gets recognized
# as a compiler line, but `moc-qt*` is only a preprocessor for Qt
# look like a compiler executable thus causing the line to be
# treated as a normal compiler line.
next if $line =~ m{^\s*rm\s+};
+ next if $line =~ m{^\s*dwz\s+};
# Some build systems emit "gcc > file".
- next if $line =~ m{$cc_regex_normal\s*>\s*\S+};
+ next if $line =~ m{$cc_regex_normal\s*>\s*\S+}o;
+ # Hex output may contain "cc".
+ next if $line =~ m#(?:\b[0-9a-fA-F]{2,}\b\s*){5}#;
+ # Meson build output
+ next if $line =~ /^C\+\+ linker for the host machine: /;
+ # Embedded `gcc -print-*` commands
+ next if $line =~ /`$cc_regex_normal\s*[^`]*-print-\S+`/;
+ # cmake checking for compiler flags without setting CPPFLAGS
+ next if $line =~ m{^\s*/usr/(bin|lib)/(ccache/)?c\+\+ -dM -E -c /usr/share/cmake-\S+/Modules/CMakeCXXCompilerABI\.cpp};
# Check if additional hardening options were used. Used to ensure
# they are used for the complete build.
push @input, $line;
push @input_nonverbose, $non_verbose;
+ push @input_number, $number if $option_line_numbers;
}
}
# Option or auto detected.
if ($arch) {
- # The following was partially copied from dpkg-dev 1.18.24
- # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, _add_hardening_flags()),
- # copyright Raphaël Hertzog <hertzog@debian.org>, Kees Cook
- # <kees@debian.org>, Canonical, Ltd. licensed under GPL version 2 or
- # later. Keep it in sync.
+ # The following was partially copied from dpkg-dev 1.20.5
+ # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, _add_build_flags()),
+ # copyright Raphaël Hertzog <hertzog@debian.org>, Guillem Jover
+ # <guillem@debian.org>, Kees Cook <kees@debian.org>, Canonical, Ltd.
+ # licensed under GPL version 2 or later. Keep it in sync.
require Dpkg::Arch;
my ($os, $cpu);
}
my %builtin_pie_arch = map { $_ => 1 } qw(
- amd64 arm64 armel armhf i386 kfreebsd-amd64 kfreebsd-i386
- mips mipsel mips64el ppc64el s390x sparc sparc64
+ amd64
+ arm64
+ armel
+ armhf
+ hurd-i386
+ i386
+ kfreebsd-amd64
+ kfreebsd-i386
+ mips
+ mipsel
+ mips64el
+ powerpc
+ ppc64
+ ppc64el
+ riscv64
+ s390x
+ sparc
+ sparc64
);
# Disable unsupported hardening options.
}
# Ada doesn't support format hardening flags, see #680117 for more
- # information. Same for fortran. Filter them out if either language is
- # used.
+ # information. Same for fortran.
my @cflags_backup;
- my @cflags_noformat;
- if (($ada or $fortran) and $harden_format) {
- @cflags_noformat = grep {
- my $ok = 1;
- foreach my $flag (@def_cflags_format) {
- $ok = 0 if $_ eq $flag;
- }
- $ok;
- } @cflags;
- }
+ my @cflags_noformat = grep {
+ my $ok = 1;
+ foreach my $flag (@def_cflags_format) {
+ $ok = 0 if $_ eq $flag;
+ }
+ $ok;
+ } @cflags;
# Hack to fix cppflags_fortify_broken() if --ignore-flag
# -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
and is_non_verbose_build($line, \$skip,
\@input, $i, $parallel)) {
if (not $option_buildd) {
- error_non_verbose_build($line);
+ error_non_verbose_build($line, $input_number[$i]);
$exit |= $exit_code{non_verbose_build};
} else {
$statistics{commands_nonverbose}++;
and extension_found(\%extensions_compile_cpp, @extensions)) {
$compile = 0;
$compile_cpp = 1;
- # Ada needs special CFLAGS, use them if only ada files are compiled.
- } elsif ($ada
- and extension_found(\%extensions_ada, @extensions)) {
+ # Ada needs special CFLAGS
+ } elsif (extension_found(\%extensions_ada, @extensions)) {
$restore_cflags = 1;
$preprocess = 0; # Ada uses no CPPFLAGS
@cflags_backup = @cflags;
@cflags = @cflags_noformat;
- # Same for fortran.
- } elsif ($fortran
- and extension_found(\%extensions_fortran, @extensions)) {
+ # Same for fortran
+ } elsif (extension_found(\%extensions_fortran, @extensions)) {
$restore_cflags = 1;
@cflags_backup = @cflags;
@cflags = @cflags_noformat;
# Check hardening flags.
my @missing;
- if ($compile and not all_flags_used($line, \@missing, @cflags)
+ if ($compile and (not all_flags_used($line, \@missing, @cflags)
+ or (($harden_stack or $harden_stack_strong)
+ and cflags_stack_broken($line, \@missing,
+ $harden_stack_strong)))
# Libraries linked with -fPIC don't have to (and can't) be
# linked with -fPIE as well. It's no error if only PIE flags
# are missing.
# Assume dpkg-buildflags returns the correct flags.
and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
if (not $option_buildd) {
- error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
+ error_flags('CFLAGS missing', \@missing, \%flag_renames,
+ $input[$i], $input_number[$i]);
$exit |= $exit_code{flags_missing};
} else {
$statistics{compile_missing}++;
# Assume dpkg-buildflags returns the correct flags.
and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
if (not $option_buildd) {
- error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
+ error_flags('CXXFLAGS missing', \@missing, \%flag_renames,
+ $input[$i], $input_number[$i]);
$exit |= $exit_code{flags_missing};
} else {
$statistics{compile_cpp_missing}++;
# Assume dpkg-buildflags returns the correct flags.
and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
if (not $option_buildd) {
- error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
+ error_flags('CPPFLAGS missing', \@missing, \%flag_renames,
+ $input[$i], $input_number[$i]);
$exit |= $exit_code{flags_missing};
} else {
$statistics{preprocess_missing}++;
# Assume dpkg-buildflags returns the correct flags.
and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
if (not $option_buildd) {
- error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
+ error_flags('LDFLAGS missing', \@missing, \%flag_renames,
+ $input[$i], $input_number[$i]);
$exit |= $exit_code{flags_missing};
} else {
$statistics{link_missing}++;
See F<README> for details about performed checks, auto-detection and
limitations.
+=head1 FALSE POSITIVES
+
+To suppress false positives you can embed the following string in the build
+log:
+
+ blhc: ignore-line-regexp: REGEXP
+
+All lines fully matching REGEXP (see B<--ignore-line> for details) will be
+ignored.
+
+Please use this feature sparingly so that missing flags are not overlooked. If
+you find false positives which affect more packages please report a bug.
+
+To generate this string simply use echo in C<debian/rules>; make sure to use @
+to suppress the echo command itself as it could also trigger a false positive.
+If the build process takes a long time edit the C<.build> file in place and
+tweak the ignore string until B<blhc --all --debian package.build> no longer
+reports any false positives.
+
=head1 OPTIONS
=over 8
Use colored (ANSI) output for warning messages.
+=item B<--line-numbers>
+
+Display line numbers.
+
=item B<--ignore-arch> I<arch>
Ignore build logs from architectures matching I<arch>. I<arch> is a string.
pbuilder path/to/package.dsc | tee path/log/file
blhc path/to/file || echo flags missing
+Assume this build log was created on a Debian system and thus don't warn about
+missing PIE flags if the current architecture injects them automatically (this
+is enabled in buildd mode per default). C<--arch> is necessary if the build
+log contains no architecture information as written by dpkg-buildpackage.
+
+ blhc --debian --all --arch=amd64 path/to/log/file
+
=head1 BUILDD TAGS
The following tags are used in I<--buildd> mode. In braces the additional data
=head1 LICENSE AND COPYRIGHT
-Copyright (C) 2012-2017 by Simon Ruderich
+Copyright (C) 2012-2020 by Simon Ruderich
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by