X-Git-Url: https://ruderich.org/simon/gitweb/?a=blobdiff_plain;ds=sidebyside;f=bin%2Fblhc;h=89cde257f5a7e5c39619759578a06b6ee88d0280;hb=93afe23c678d5fdc749a07c94e7ee9ddb4d5e9bb;hp=12b7eab8832d965c3d84053f62b21cf153513f59;hpb=2d45d7a5feaaaf28b0ab42be148e675835759c11;p=blhc%2Fblhc.git
diff --git a/bin/blhc b/bin/blhc
index 12b7eab..89cde25 100755
--- a/bin/blhc
+++ b/bin/blhc
@@ -24,7 +24,7 @@ use warnings;
use Getopt::Long ();
use Text::ParseWords ();
-our $VERSION = '0.01';
+our $VERSION = '0.03';
# CONSTANTS/VARIABLES
@@ -42,6 +42,10 @@ my $cc_regex_full = qr/
(?:[a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?-)?
$cc_regex
/x;
+# Regex to check if a line contains a compiler command.
+my $cc_regex_normal = qr/
+ \b$cc_regex(?:\s|\\)
+ /x;
# Regex to catch (GCC) compiler warnings.
my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
@@ -102,10 +106,22 @@ my @header_preprocess = (
# C++
qw( hh H hp hxx hpp HPP h++ tcc ),
);
+# Object files.
+my @object = (
+ # Normal object files.
+ qw ( o ),
+ # Libtool object files.
+ qw ( lo la ),
+ # Dynamic libraries. bzip2 uses .sho.
+ qw ( so sho ),
+ # Static libraries.
+ qw ( a ),
+);
# Hashes for fast extensions lookup to check if a file falls in one of these
# categories.
my %extensions_no_preprocess = map { $_ => 1 } (
+ # There's no @header_no_preprocess.
@source_no_preprocess,
);
my %extensions_preprocess = map { $_ => 1 } (
@@ -128,10 +144,14 @@ my %extensions_compile_cpp = map { $_ => 1 } (
@source_preprocess_compile_cpp,
@source_no_preprocess_compile_cpp,
);
+my %extensions_object = map { $_ => 1 } (
+ @object,
+);
my %extension = map { $_ => 1 } (
@source_no_preprocess,
@header_preprocess,
@source_preprocess,
+ @object,
);
# Regexp to match file extensions.
@@ -171,7 +191,14 @@ my @def_cxxflags = (
# @def_cxxflags_* is the same as @def_cflags_*.
my @def_cppflags = ();
my @def_cppflags_fortify = (
- '-D_FORTIFY_SOURCE=2',
+ '-D_FORTIFY_SOURCE=2', # must be first, see cppflags_fortify_broken()
+ # If you add another flag fix hack below (search for "Hack to fix").
+);
+my @def_cppflags_fortify_bad = (
+ # These flags may overwrite -D_FORTIFY_SOURCE=2.
+ '-U_FORTIFY_SOURCE',
+ '-D_FORTIFY_SOURCE=0',
+ '-D_FORTIFY_SOURCE=1',
);
my @def_ldflags = ();
my @def_ldflags_relro = (
@@ -189,7 +216,7 @@ my @def_ldflags_pic = (
'-fpic',
'-shared',
);
-# References to all flags checked by the parser.
+# References to all flags checked by the flag checker.
my @flag_refs = (
\@def_cflags,
\@def_cflags_format,
@@ -202,11 +229,12 @@ my @flag_refs = (
\@def_ldflags,
\@def_ldflags_relro,
\@def_ldflags_bindnow,
+ \@def_ldflags_pie,
);
# References to all used flags.
my @flag_refs_all = (
@flag_refs,
- \@def_ldflags_pie,
+ \@def_cppflags_fortify_bad,
\@def_ldflags_pic,
);
# Renaming rules for the output so the regex parts are not visible. Also
@@ -226,6 +254,14 @@ my %exit_code = (
invalid_cmake => 1 << 5,
);
+my %buildd_tag = (
+ no_compiler_commands => 'I-no-compiler-commands',
+ non_verbose_build => 'W-compiler-flags-hidden',
+ flags_missing => 'W-dpkg-buildflags-missing',
+ hardening_wrapper => 'I-hardening-wrapper-used',
+ invalid_cmake => 'I-invalid-cmake-used',
+);
+
# Statistics of missing flags and non-verbose build commands. Used for
# $option_buildd.
my %statistics = (
@@ -317,6 +353,22 @@ sub all_flags_used {
return 0;
}
+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.
+
+ 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;
+ }
+
+ return 0;
+}
+
# Modifies $missing_flags_ref array.
sub pic_pie_conflict {
my ($line, $pie, $missing_flags_ref, @flags_pie) = @_;
@@ -388,6 +440,21 @@ sub is_non_verbose_build {
return 1;
}
+sub remove_flags {
+ my ($flag_refs_ref, $flag_renames_ref, @flags) = @_;
+
+ my %removes = map { $_ => 1 } @flags;
+ foreach my $flags (@{$flag_refs_ref}) {
+ @{$flags} = grep {
+ # Flag found as string.
+ not exists $removes{$_}
+ # Flag found as string representation of regexp.
+ and (not defined $flag_renames_ref->{$_}
+ or not exists $removes{$flag_renames_ref->{$_}})
+ } @{$flags};
+ }
+}
+
sub compile_flag_regexp {
my ($flag_renames_ref, @flags) = @_;
@@ -423,34 +490,37 @@ sub extension_found {
# MAIN
# Parse command line arguments.
-my $option_help = 0;
-my $option_version = 0;
-my $option_pie = 0;
-my $option_bindnow = 0;
-my @option_ignore_arch = ();
-my @option_ignore_flag = ();
-my @option_ignore_line = ();
-my $option_all = 0;
-my $option_arch = undef;
-my $option_buildd = 0;
- $option_color = 0;
+my $option_help = 0;
+my $option_version = 0;
+my $option_pie = 0;
+my $option_bindnow = 0;
+my @option_ignore_arch = ();
+my @option_ignore_flag = ();
+my @option_ignore_arch_flag = ();
+my @option_ignore_line = ();
+my @option_ignore_arch_line = ();
+my $option_all = 0;
+my $option_arch = undef;
+my $option_buildd = 0;
+ $option_color = 0;
if (not Getopt::Long::GetOptions(
- 'help|h|?' => \$option_help,
- 'version' => \$option_version,
+ 'help|h|?' => \$option_help,
+ 'version' => \$option_version,
# Hardening options.
- 'pie' => \$option_pie,
- 'bindnow' => \$option_bindnow,
- 'all' => \$option_all,
+ 'pie' => \$option_pie,
+ 'bindnow' => \$option_bindnow,
+ 'all' => \$option_all,
# Ignore.
- 'ignore-arch=s' => \@option_ignore_arch,
- 'ignore-flag=s' => \@option_ignore_flag,
- 'ignore-line=s' => \@option_ignore_line,
+ 'ignore-arch=s' => \@option_ignore_arch,
+ 'ignore-flag=s' => \@option_ignore_flag,
+ 'ignore-arch-flag=s' => \@option_ignore_arch_flag,
+ 'ignore-line=s' => \@option_ignore_line,
+ 'ignore-arch-line=s' => \@option_ignore_arch_line,
# Misc.
- 'color' => \$option_color,
- 'arch=s' => \$option_arch,
- 'buildd' => \$option_buildd,
- )
- or scalar @ARGV == 0) {
+ 'color' => \$option_color,
+ 'arch=s' => \$option_arch,
+ 'buildd' => \$option_buildd,
+ )) {
require Pod::Usage;
Pod::Usage::pod2usage(2);
}
@@ -477,6 +547,12 @@ along with this program. If not, see .
exit 0;
}
+# Arguments missing.
+if (scalar @ARGV == 0) {
+ require Pod::Usage;
+ Pod::Usage::pod2usage(2);
+}
+
# Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not
# installed on Debian's buildds.
if (not $option_buildd) {
@@ -488,17 +564,27 @@ if ($option_all) {
$option_bindnow = 1;
}
+# Precompiled ignores for faster lookup.
+my %option_ignore_arch_flag = ();
+my %option_ignore_arch_line = ();
+
# Strip flags which should be ignored.
if (scalar @option_ignore_flag > 0) {
- my %ignores = map { $_ => 1 } @option_ignore_flag;
- foreach my $flags (@flag_refs) {
- @{$flags} = grep {
- # Flag found as string.
- not exists $ignores{$_}
- # Flag found as string representation of regexp.
- and (not defined $flag_renames{$_}
- or not exists $ignores{$flag_renames{$_}})
- } @{$flags};
+ remove_flags(\@flag_refs, \%flag_renames, @option_ignore_flag);
+}
+# Same for arch specific ignore flags, but only prepare here.
+if (scalar @option_ignore_arch_flag > 0) {
+ foreach my $ignore (@option_ignore_arch_flag) {
+ my ($ignore_arch, $ignore_flag) = split ':', $ignore, 2;
+
+ if (not $ignore_arch or not $ignore_flag) {
+ printf STDERR 'Value "%s" invalid for option ignore-arch-flag '
+ . '("arch:flag" expected)' . "\n", $ignore;
+ require Pod::Usage;
+ Pod::Usage::pod2usage(2);
+ }
+
+ push @{$option_ignore_arch_flag{$ignore_arch}}, $ignore_flag;
}
}
@@ -512,6 +598,21 @@ foreach my $flags (@flag_refs_all) {
foreach my $ignore (@option_ignore_line) {
$ignore = qr/^$ignore$/;
}
+# Same for arch specific ignore lines.
+if (scalar @option_ignore_arch_line > 0) {
+ foreach my $ignore (@option_ignore_arch_line) {
+ my ($ignore_arch, $ignore_line) = split ':', $ignore, 2;
+
+ if (not $ignore_arch or not $ignore_line) {
+ printf STDERR 'Value "%s" invalid for option ignore-arch-line '
+ . '("arch:line" expected)' . "\n", $ignore;
+ require Pod::Usage;
+ Pod::Usage::pod2usage(2);
+ }
+
+ push @{$option_ignore_arch_line{$ignore_arch}}, qr/^$ignore_line$/;
+ }
+}
# Final exit code.
my $exit = 0;
@@ -520,7 +621,9 @@ FILE:
foreach my $file (@ARGV) {
print "checking '$file'...\n" if scalar @ARGV > 1;
- open my $fh, '<', $file or die "$!: $file";
+ -f $file or die "No such file: $file";
+
+ open my $fh, '<', $file or die $!;
# Architecture of this file.
my $arch = $option_arch;
@@ -574,10 +677,10 @@ foreach my $file (@ARGV) {
and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
if (not $option_buildd) {
error_invalid_cmake($1);
+ $exit |= $exit_code{invalid_cmake};
} else {
- print "W-invalid-cmake-used $1\n";
+ print "$buildd_tag{invalid_cmake}|$1|\n";
}
- $exit |= $exit_code{invalid_cmake};
}
# If hardening wrapper is used (wraps calls to gcc and adds hardening
@@ -586,10 +689,10 @@ foreach my $file (@ARGV) {
and $line =~ /\bhardening-wrapper\b/) {
if (not $option_buildd) {
error_hardening_wrapper();
+ $exit |= $exit_code{hardening_wrapper};
} else {
- print "I-hardening-wrapper-used\n";
+ print "$buildd_tag{hardening_wrapper}||\n";
}
- $exit |= $exit_code{hardening_wrapper};
next FILE;
}
@@ -670,7 +773,7 @@ foreach my $file (@ARGV) {
# Ignore lines with no compiler commands.
next if not $non_verbose
- and not $line =~ /\b$cc_regex(?:\s|\\)/o;
+ and not $line =~ /$cc_regex_normal/o;
# Ignore lines with no filenames with extensions. May miss some
# non-verbose builds (e.g. "gcc -o test" [sic!]), but shouldn't be
# a problem as the log will most likely contain other non-verbose
@@ -687,10 +790,26 @@ foreach my $file (@ARGV) {
[Cc]ompiler[\s.]*:?\s+
/xo;
next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
+ # `moc-qt4`, contains '-I/usr/share/qt4/mkspecs/linux-g++' (or
+ # similar for other architectures) which gets recognized as a
+ # compiler line. Ignore it.
+ next if $line =~ m{^/usr/bin/moc-qt4
+ \s.+\s
+ -I/usr/share/qt4/mkspecs/[a-z]+-g\++(?:-64)?
+ \s}x;
+ # Ignore false positives when the line contains only CC=gcc but no
+ # other gcc command.
+ if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) {
+ my $before = $1;
+ my $after = $2;
+ next if not $before =~ /$cc_regex_normal/o
+ and not $after =~ /$cc_regex_normal/o;
+ }
# Check if additional hardening options were used. Used to ensure
# they are used for the complete build.
- $harden_pie = 1 if any_flags_used($line, @def_cflags_pie, @def_ldflags_pie);
+ $harden_pie = 1 if any_flags_used($line, @def_cflags_pie,
+ @def_ldflags_pie);
$harden_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
push @input, $line;
@@ -712,10 +831,10 @@ foreach my $file (@ARGV) {
if (scalar @input == 0) {
if (not $option_buildd) {
print "No compiler commands!\n";
+ $exit |= $exit_code{no_compiler_commands};
} else {
- print "W-no-compiler-commands\n";
+ print "$buildd_tag{no_compiler_commands}||\n";
}
- $exit |= $exit_code{no_compiler_commands};
next FILE;
}
@@ -775,12 +894,34 @@ foreach my $file (@ARGV) {
@ldflags = (@ldflags, @def_ldflags_bindnow);
}
+ # Hack to fix cppflags_fortify_broken() if --ignore-flag
+ # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works
+ # as long as @def_cppflags_fortify contains only one variable.
+ if (scalar @def_cppflags_fortify == 0) {
+ $harden_fortify = 0;
+ }
+
+ # Ignore flags for this arch if requested.
+ if ($arch and exists $option_ignore_arch_flag{$arch}) {
+ my @flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags);
+
+ remove_flags(\@flag_refs,
+ \%flag_renames,
+ @{$option_ignore_arch_flag{$arch}});
+ }
+
+ my @ignore_line = @option_ignore_line;
+ # Ignore lines for this arch if requested.
+ if ($arch and exists $option_ignore_arch_line{$arch}) {
+ @ignore_line = (@ignore_line, @{$option_ignore_arch_line{$arch}});
+ }
+
LINE:
for (my $i = 0; $i < scalar @input; $i++) {
my $line = $input[$i];
# Ignore line if requested.
- foreach my $ignore (@option_ignore_line) {
+ foreach my $ignore (@ignore_line) {
next LINE if $line =~ /$ignore/;
}
@@ -788,10 +929,10 @@ LINE:
if (is_non_verbose_build($line, $input[$i + 1], \$skip)) {
if (not $option_buildd) {
error_non_verbose_build($line);
+ $exit |= $exit_code{non_verbose_build};
} else {
$statistics{commands_nonverbose}++;
}
- $exit |= $exit_code{non_verbose_build};
next;
}
# Even if it's a verbose build, we might have to skip this line.
@@ -850,18 +991,29 @@ LINE:
$preprocess = 1;
}
- # If there are source files then it's compiling/linking in one step
- # and we must check both. We only check for source files here, because
- # header files cause too many false positives.
- if (not $flag_preprocess
- and extension_found(\%extensions_compile_link, @extensions)) {
- # Assembly files don't need CFLAGS.
- if (not extension_found(\%extensions_compile, @extensions)
- and extension_found(\%extensions_no_compile, @extensions)) {
- $compile = 0;
- # But the rest does.
- } else {
- $compile = 1;
+ if (not $flag_preprocess) {
+ # If there are source files then it's compiling/linking in one
+ # step and we must check both. We only check for source files
+ # here, because header files cause too many false positives.
+ if (extension_found(\%extensions_compile_link, @extensions)) {
+ # Assembly files don't need CFLAGS.
+ if (not extension_found(\%extensions_compile, @extensions)
+ and extension_found(\%extensions_no_compile, @extensions)) {
+ $compile = 0;
+ # But the rest does.
+ } else {
+ $compile = 1;
+ }
+ # No compilable extensions found, either linking or compiling
+ # header flags.
+ #
+ # If there are also no object files we are just compiling headers
+ # (.h -> .h.gch). Don't check for linker flags in this case. Due
+ # to our liberal checks for compiler lines, this also reduces the
+ # number of false positives considerably.
+ } elsif ($link
+ and not extension_found(\%extensions_object, @extensions)) {
+ $link = 0;
}
}
@@ -892,10 +1044,10 @@ LINE:
and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
if (not $option_buildd) {
error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
+ $exit |= $exit_code{flags_missing};
} else {
$statistics{compile_missing}++;
}
- $exit |= $exit_code{flags_missing};
} elsif ($compile_cpp and not all_flags_used($line, \@missing, @cflags)
# 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
@@ -905,20 +1057,24 @@ LINE:
and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
if (not $option_buildd) {
error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
+ $exit |= $exit_code{flags_missing};
} else {
$statistics{compile_cpp_missing}++;
}
- $exit |= $exit_code{flags_missing};
}
- if ($preprocess and not all_flags_used($line, \@missing, @cppflags)
+ if ($preprocess
+ and (not all_flags_used($line, \@missing, @cppflags)
+ # The fortify flag might be overwritten, detect that.
+ or ($harden_fortify
+ and cppflags_fortify_broken($line, \@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]);
+ $exit |= $exit_code{flags_missing};
} else {
$statistics{preprocess_missing}++;
}
- $exit |= $exit_code{flags_missing};
}
if ($link and not all_flags_used($line, \@missing, @ldflags)
# Same here, -fPIC conflicts with -fPIE.
@@ -927,10 +1083,10 @@ LINE:
and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
if (not $option_buildd) {
error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
+ $exit |= $exit_code{flags_missing};
} else {
$statistics{link_missing}++;
}
- $exit |= $exit_code{flags_missing};
}
}
}
@@ -961,11 +1117,11 @@ if ($option_buildd) {
}
if (scalar @warning) {
local $" = ', '; # array join string
- print "W-dpkg-buildflags-missing @warning missing\n";
+ print "$buildd_tag{flags_missing}|@warning missing|\n";
}
if ($statistics{commands_nonverbose}) {
- printf "W-compiler-flags-hidden %d (of %d) hidden\n",
+ printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n",
$statistics{commands_nonverbose},
$statistics{commands},
}
@@ -983,7 +1139,7 @@ blhc - build log hardening check, checks build logs for missing hardening flags
=head1 SYNOPSIS
-B [I] Idpkg-buildpackage build log fileE..>
+B [I] I<< .. >>
=head1 DESCRIPTION
@@ -994,6 +1150,11 @@ It's designed to check build logs generated by Debian's dpkg-buildpackage (or
tools using dpkg-buildpackage like pbuilder or the official buildd build logs)
to help maintainers detect missing hardening flags in their packages.
+Only gcc is detected as compiler at the moment. If other compilers support
+hardening flags as well, please report them.
+
+If there's no output, no flags are missing and the build log is fine.
+
=head1 OPTIONS
=over 8
@@ -1020,20 +1181,25 @@ changes are in effect:
=over 2
-=item
+=item *
Print tags instead of normal warnings, see L"BUILDD TAGS"> for a list of
possible tags.
-=item
+=item *
Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is
detected).
-=item
+=item *
Don't require Term::ANSIColor.
+=item *
+
+Return exit code 0, unless there was a error (-I, -W messages don't count as
+error).
+
=back
=item B<--color>
@@ -1046,6 +1212,14 @@ Ignore build logs from architectures matching I. I is a string.
Used to prevent false positives. This option can be specified multiple times.
+=item B<--ignore-arch-flag> I:I
+
+Like B<--ignore-flag>, but only ignore flag on I.
+
+=item B<--ignore-arch-line> I:I
+
+Like B<--ignore-line>, but only ignore line on I.
+
=item B<--ignore-flag> I
Don't print an error when the specific flag is missing in a compiler line.
@@ -1087,6 +1261,8 @@ Normal usage, parse a single log file.
blhc path/to/log/file
+If there's no output, no flags are missing and the build log is fine.
+
Parse multiple log files. The exit code is ORed over all files.
blhc path/to/directory/with/log/files/*
@@ -1095,6 +1271,10 @@ Don't treat missing C<-g> as error:
blhc --ignore-flag -g path/to/log/file
+Don't treat missing C<-pie> on kfreebsd-amd64 as error:
+
+ blhc --ignore-arch-flag kfreebsd-amd64:-pie path/to/log/file
+
Ignore lines consisting exactly of C<./script gcc file> which would cause a
false positive.
@@ -1116,17 +1296,13 @@ which is displayed.
=over 2
-=item
-
-B
+=item B
The package uses hardening-wrapper which intercepts calls to gcc and adds
hardening flags. The build log doesn't contain any hardening flags and thus
can't be checked by blhc.
-=item
-
-B (summary of hidden lines)
+=item B (summary of hidden lines)
Build log contains lines which hide the real compiler flags. For example:
@@ -1140,19 +1316,20 @@ F fixes builds with hidden compiler flags. Sometimes C<.SILENT>
in a F must be removed. And as last resort the F must be
patched to remove the C<@>s hiding the real compiler commands.
-=item
-
-B (summary of missing flags)
+=item B (summary of missing flags)
CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
-=item
-
-B (version)
+=item B (version)
-=item
+By default CMake ignores CPPFLAGS thus missing those hardening flags. Debian
+patched CMake in versions 2.8.7-1 and 2.8.7-2 to respect CPPFLAGS, but this
+patch was rejected by upstream and later reverted in Debian. Thus those two
+versions show correct usage of CPPFLAGS even if the package doesn't correctly
+handle them (for example by passing them to CFLAGS). To prevent false
+negatives just blacklist those two versions.
-B
+=item B
No compiler commands were detected. Either the log contains none or they were
not correctly detected by blhc (please report the bug in this case).
@@ -1190,6 +1367,11 @@ Missing hardening flags.
Hardening wrapper detected, no tests performed.
+=item B<32>
+
+Invalid CMake version used. See B under L"BUILDD
+TAGS"> for a detailed explanation.
+
=back
=head1 AUTHOR