X-Git-Url: https://ruderich.org/simon/gitweb/?a=blobdiff_plain;f=bin%2Fblhc;h=59360fad514c785fb591b6869a71fc2a9b305562;hb=df33515631599ff32c01b6304332a70e6682522b;hp=88d1346d3a490849816f61af038753fb507859f1;hpb=5e53774f898b28715e2672b7d11ca822c65c6ae8;p=blhc%2Fblhc.git
diff --git a/bin/blhc b/bin/blhc
index 88d1346..59360fa 100755
--- a/bin/blhc
+++ b/bin/blhc
@@ -24,15 +24,17 @@ use warnings;
use Getopt::Long ();
use Text::ParseWords ();
-our $VERSION = '0.01';
+our $VERSION = '0.02';
# CONSTANTS/VARIABLES
# Regex to catch compiler commands.
my $cc_regex = qr/
- (? \$option_bindnow,
'all' => \$option_all,
# Ignore.
+ 'ignore-arch=s' => \@option_ignore_arch,
'ignore-flag=s' => \@option_ignore_flag,
'ignore-line=s' => \@option_ignore_line,
# Misc.
'color' => \$option_color,
'arch=s' => \$option_arch,
'buildd' => \$option_buildd,
- )
- or scalar @ARGV == 0) {
+ )) {
require Pod::Usage;
Pod::Usage::pod2usage(2);
}
@@ -474,6 +476,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) {
@@ -531,15 +539,25 @@ foreach my $file (@ARGV) {
my $harden_pie = $option_pie; # defaults to 0
while (my $line = <$fh>) {
+ # 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,
+ # etc.).
+ if (not $arch
+ and $line =~ /^Architecture: (.+)$/) {
+ $arch = $1;
+ }
+
# dpkg-buildflags only provides hardening flags since 1.16.1, don't
# check for hardening flags in buildd mode if an older dpkg-dev is
# used. Default flags (-g -O2) are still checked.
#
# Packages which were built before 1.16.1 but used their own hardening
# flags are not checked.
- if ($option_buildd and $line =~ /^Toolchain package versions: /) {
+ if ($option_buildd
+ and index($line, 'Toolchain package versions: ') == 0) {
require Dpkg::Version;
- if ($line !~ /\bdpkg-dev_(\S+)/
+ if (not $line =~ /\bdpkg-dev_(\S+)/
or Dpkg::Version::version_compare($1, '1.16.1') < 0) {
$harden_format = 0;
$harden_fortify = 0;
@@ -556,7 +574,7 @@ foreach my $file (@ARGV) {
# enabled, even though they may be not correctly set and are missing
# when build with later CMake versions. Thanks to Aron Xu for letting
# me know.
- if ($line =~ /^Package versions: /
+ if (index($line, 'Package versions: ') == 0
and $line =~ /\bcmake_(\S+)/
and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) {
if (not $option_buildd) {
@@ -569,7 +587,8 @@ foreach my $file (@ARGV) {
# If hardening wrapper is used (wraps calls to gcc and adds hardening
# flags automatically) we can't perform any checks, abort.
- if ($line =~ /^Build-Depends: .*\bhardening-wrapper\b/) {
+ if (index($line, 'Build-Depends: ') == 0
+ and $line =~ /\bhardening-wrapper\b/) {
if (not $option_buildd) {
error_hardening_wrapper();
} else {
@@ -581,7 +600,7 @@ foreach my $file (@ARGV) {
# We skip over unimportant lines at the beginning of the log to
# prevent false positives.
- last if $line =~ /^dpkg-buildpackage:/;
+ last if index($line, 'dpkg-buildpackage: ') == 0;
}
# Input lines, contain only the lines with compiler commands.
@@ -604,7 +623,7 @@ foreach my $file (@ARGV) {
# Ignore compiler warnings for now.
next if $line =~ /$warning_regex/o;
- if (not $option_buildd and $line =~ /\033/) { # esc
+ if (not $option_buildd and index($line, "\033") != -1) { # esc
# Remove all ANSI color sequences which are sometimes used in
# non-verbose builds.
$line = Term::ANSIColor::colorstrip($line);
@@ -621,7 +640,7 @@ foreach my $file (@ARGV) {
# One line may contain multiple commands (";"). Treat each one as
# single line. parse_line() is slow, only use it when necessary.
- my @line = (not $line =~ /;/)
+ my @line = (index($line, ';') == -1)
? ($line)
: map {
# Ensure newline at the line end - necessary for
@@ -629,7 +648,7 @@ foreach my $file (@ARGV) {
$_ =~ s/\s+$//;
$_ .= "\n";
} Text::ParseWords::parse_line(';', 1, $line);
- foreach $line (@line) {
+ foreach my $line (@line) {
if ($continuation) {
$continuation = 0;
@@ -639,7 +658,7 @@ foreach my $file (@ARGV) {
$complete_line .= ' ' . $line;
}
# Line continuation, line ends with "\".
- if ($line =~ /\\\s*$/) {
+ if ($line =~ /\\$/) {
$continuation = 1;
# Start line continuation.
if (not defined $complete_line) {
@@ -668,9 +687,9 @@ foreach my $file (@ARGV) {
#
# `./configure` output.
next if not $non_verbose
- and $line =~ /^(?:checking|(?:C|c)onfigure:) /;
+ and $line =~ /^(?:checking|[Cc]onfigure:) /;
next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
- (?:C|c)ompiler[\s.]*:?\s+
+ [Cc]ompiler[\s.]*:?\s+
/xo;
next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/o;
@@ -683,7 +702,17 @@ foreach my $file (@ARGV) {
}
}
- close $fh;
+ close $fh or die $!;
+
+ # Ignore arch if requested.
+ if (scalar @option_ignore_arch > 0 and $arch) {
+ foreach my $ignore (@option_ignore_arch) {
+ if ($arch eq $ignore) {
+ print "ignoring architecture '$arch'\n";
+ next FILE;
+ }
+ }
+ }
if (scalar @input == 0) {
if (not $option_buildd) {
@@ -711,10 +740,10 @@ foreach my $file (@ARGV) {
my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
# Disable unsupported hardening options.
- if ($cpu =~ /^(ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
+ if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') {
$harden_stack = 0;
}
- if ($cpu =~ /^(ia64|hppa|avr32)$/) {
+ if ($cpu =~ /^(?:ia64|hppa|avr32)$/) {
$harden_relro = 0;
$harden_bindnow = 0;
}
@@ -865,7 +894,7 @@ LINE:
# are missing.
and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
# Assume dpkg-buildflags returns the correct flags.
- and not $line =~ /`dpkg-buildflags --get CFLAGS`/) {
+ and index($line, '`dpkg-buildflags --get CFLAGS`') == -1) {
if (not $option_buildd) {
error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]);
} else {
@@ -878,7 +907,7 @@ LINE:
# are missing.
and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie)
# Assume dpkg-buildflags returns the correct flags.
- and not $line =~ /`dpkg-buildflags --get CXXFLAGS`/) {
+ and index($line, '`dpkg-buildflags --get CXXFLAGS`') == -1) {
if (not $option_buildd) {
error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]);
} else {
@@ -888,7 +917,7 @@ LINE:
}
if ($preprocess and not all_flags_used($line, \@missing, @cppflags)
# Assume dpkg-buildflags returns the correct flags.
- and not $line =~ /`dpkg-buildflags --get CPPFLAGS`/) {
+ and index($line, '`dpkg-buildflags --get CPPFLAGS`') == -1) {
if (not $option_buildd) {
error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]);
} else {
@@ -900,7 +929,7 @@ LINE:
# Same here, -fPIC conflicts with -fPIE.
and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie)
# Assume dpkg-buildflags returns the correct flags.
- and not $line =~ /`dpkg-buildflags --get LDFLAGS`/) {
+ and index($line, '`dpkg-buildflags --get LDFLAGS`') == -1) {
if (not $option_buildd) {
error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]);
} else {
@@ -916,22 +945,22 @@ if ($option_buildd) {
my @warning;
if ($statistics{preprocess_missing}) {
- push @warning, sprintf "CPPFLAGS %d (of %d)",
+ push @warning, sprintf 'CPPFLAGS %d (of %d)',
$statistics{preprocess_missing},
$statistics{preprocess};
}
if ($statistics{compile_missing}) {
- push @warning, sprintf "CFLAGS %d (of %d)",
+ push @warning, sprintf 'CFLAGS %d (of %d)',
$statistics{compile_missing},
$statistics{compile};
}
if ($statistics{compile_cpp_missing}) {
- push @warning, sprintf "CXXFLAGS %d (of %d)",
+ push @warning, sprintf 'CXXFLAGS %d (of %d)',
$statistics{compile_cpp_missing},
$statistics{compile_cpp};
}
if ($statistics{link_missing}) {
- push @warning, sprintf "LDFLAGS %d (of %d)",
+ push @warning, sprintf 'LDFLAGS %d (of %d)',
$statistics{link_missing},
$statistics{link};
}
@@ -963,8 +992,12 @@ B [I] Idpkg-buildpackage build log fileE..>
=head1 DESCRIPTION
-blhc is a small tool which checks build logs for missing hardening flags and
-other important warnings. It's licensed under the GPL 3 or later.
+blhc is a small tool which checks build logs for missing hardening flags. It's
+licensed under the GPL 3 or later.
+
+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.
=head1 OPTIONS
@@ -994,8 +1027,8 @@ changes are in effect:
=item
-Print tags instead of normal warnings, see README file for a list of possible
-tags.
+Print tags instead of normal warnings, see L"BUILDD TAGS"> for a list of
+possible tags.
=item
@@ -1012,6 +1045,12 @@ Don't require Term::ANSIColor.
Use colored (ANSI) output for warning messages.
+=item B<--ignore-arch> I
+
+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-flag> I
Don't print an error when the specific flag is missing in a compiler line.
@@ -1047,6 +1086,84 @@ Auto detection for B<--pie> and B<--bindnow> only works if at least one
command uses the required hardening flag (e.g. -fPIE). Then it's required for
all other commands as well.
+=head1 EXAMPLES
+
+Normal usage, parse a single log file.
+
+ blhc path/to/log/file
+
+Parse multiple log files. The exit code is ORed over all files.
+
+ blhc path/to/directory/with/log/files/*
+
+Don't treat missing C<-g> as error:
+
+ blhc --ignore-flag -g path/to/log/file
+
+Ignore lines consisting exactly of C<./script gcc file> which would cause a
+false positive.
+
+ blhc --ignore-line '\./script gcc file' path/to/log/file
+
+Ignore lines matching C<./script gcc file> somewhere in the line.
+
+ blhc --ignore-line '.*\./script gcc file.*' path/to/log/file
+
+Use blhc with pbuilder.
+
+ pbuilder path/to/package.dsc | tee path/log/file
+ blhc path/to/file || echo flags missing
+
+=head1 BUILDD TAGS
+
+The following tags are used in I<--buildd> mode. In braces the additional data
+which is displayed.
+
+=over 2
+
+=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)
+
+Build log contains lines which hide the real compiler flags. For example:
+
+ CC test-a.c
+ CC test-b.c
+ CC test-c.c
+ LD test
+
+Most of the time either C or C in
+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)
+
+CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
+
+=item
+
+B (version)
+
+=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).
+
+=back
+
=head1 EXIT STATUS
The exit status is a "bit mask", each listed status is ORed when the error
@@ -1084,6 +1201,9 @@ Hardening wrapper detected, no tests performed.
Simon Ruderich, Esimon@ruderich.orgE
+Thanks to to Bernhard R. Link Ebrlink@debian.orgE and Jaria Alto
+Ejari.aalto@cante.netE for their valuable input and suggestions.
+
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2012 by Simon Ruderich
@@ -1101,4 +1221,8 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
+=head1 SEE ALSO
+
+L, L
+
=cut