X-Git-Url: https://ruderich.org/simon/gitweb/?a=blobdiff_plain;f=bin%2Fblhc;h=d2a4cc31c2cd1b72eb8153eaf68cf13ac36d4e5d;hb=c494af03207cb214ba87057bf296c195e357686e;hp=7416df6f69e6632263bda34ceff5994cf1dd905f;hpb=309aba1b1f578a2824d91b9e1b93c045afe38e8f;p=blhc%2Fblhc.git
diff --git a/bin/blhc b/bin/blhc
index 7416df6..d2a4cc3 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/
- (? 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 = (
@@ -255,14 +264,14 @@ sub error_flags {
} @{$missing_flags_ref};
my $flags = join ' ', @missing_flags;
- printf "%s (%s)%s %s",
+ printf '%s (%s)%s %s',
error_color($message, 'red'), $flags, error_color(':', 'yellow'),
$line;
}
sub error_non_verbose_build {
my ($line) = @_;
- printf "%s%s %s",
+ printf '%s%s %s',
error_color('NONVERBOSE BUILD', 'red'),
error_color(':', 'yellow'),
$line;
@@ -341,10 +350,10 @@ sub pic_pie_conflict {
sub is_non_verbose_build {
my ($line, $next_line, $skip_ref) = @_;
- if (not ($line =~ /^checking if you want to see long compiling messages\.\.\. no/
+ 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*(?:C|c)ompiling\s+(.+?)(?:\.\.\.)?$/
- or $line =~ /^\s*(?:B|b)uilding (?:program|shared library)\s+(.+?)$/
+ or $line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/
+ or $line =~ /^\s*[Bb]uilding (?:program|shared library)\s+(.+?)$/
or $line =~ /^\s*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) {
return 0;
}
@@ -354,7 +363,7 @@ sub is_non_verbose_build {
# C++ compiler setting.
return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/;
# "Compiling" with no file name.
- if ($line =~ /^\s*(?:C|c)ompiling\s+(.+?)(?:\.\.\.)?$/) {
+ if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) {
# $file_extension_regex may need spaces around the filename.
return 0 if not " $1 " =~ /$file_extension_regex/o;
}
@@ -376,7 +385,7 @@ sub is_non_verbose_build {
$file =~ m{/([^/\s]+)$};
$file = $1;
- if ($next_line =~ /\Q$file\E/ and $next_line =~ /$cc_regex/o) {
+ if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
# We still have to skip the current line as it doesn't contain any
# compiler commands.
${$skip_ref} = 1;
@@ -387,6 +396,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) = @_;
@@ -422,27 +446,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_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-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);
}
@@ -469,6 +503,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) {
@@ -480,19 +520,64 @@ 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) {
+ 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;
+ }
+}
+
# Precompile all flag regexps. any_flags_used(), all_flags_used() get a lot
# faster with this.
foreach my $flags (@flag_refs_all) {
@{$flags} = compile_flag_regexp(\%flag_renames, @{$flags});
}
+# Precompile ignore line regexps, also anchor at beginning and end of line.
+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;
-FILE: foreach my $file (@ARGV) {
+FILE:
+foreach my $file (@ARGV) {
print "checking '$file'...\n" if scalar @ARGV > 1;
- open my $fh, '<', $file or die "$!: $file";
+ open my $fh, '<', $file or die $!;
# Architecture of this file.
my $arch = $option_arch;
@@ -506,15 +591,25 @@ FILE: 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;
@@ -531,24 +626,25 @@ FILE: 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) {
error_invalid_cmake($1);
} 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
# 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 {
- print "I-hardening-wrapper-used\n";
+ print "$buildd_tag{hardening_wrapper}\n";
}
$exit |= $exit_code{hardening_wrapper};
next FILE;
@@ -556,7 +652,7 @@ FILE: 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.
@@ -579,7 +675,7 @@ FILE: 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);
@@ -596,7 +692,7 @@ FILE: 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
@@ -604,7 +700,7 @@ FILE: foreach my $file (@ARGV) {
$_ =~ s/\s+$//;
$_ .= "\n";
} Text::ParseWords::parse_line(';', 1, $line);
- foreach $line (@line) {
+ foreach my $line (@line) {
if ($continuation) {
$continuation = 0;
@@ -614,7 +710,7 @@ FILE: 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) {
@@ -623,48 +719,58 @@ FILE: foreach my $file (@ARGV) {
next;
}
- # Use the complete line if a line continuation occurred.
- if (defined $complete_line) {
- $line = $complete_line;
- $complete_line = undef;
- }
+ # Use the complete line if a line continuation occurred.
+ if (defined $complete_line) {
+ $line = $complete_line;
+ $complete_line = undef;
+ }
- # Ignore lines with no compiler commands.
- next if not $non_verbose
- and not $line =~ /\b$cc_regex(?:\s|\\)/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 commands which are detected.
- next if not $non_verbose
- and not $line =~ /$file_extension_regex/o;
-
- # Ignore false positives.
- #
- # `./configure` output.
- next if not $non_verbose
- and $line =~ /^(?:checking|(?:C|c)onfigure:) /;
- next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
- (?:C|c)ompiler[\s.]*:?\s+
- /xo;
- next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/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_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
-
- push @input, $line;
+ # Ignore lines with no compiler commands.
+ next if not $non_verbose
+ and not $line =~ /\b$cc_regex(?:\s|\\)/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
+ # commands which are detected.
+ next if not $non_verbose
+ and not $line =~ /$file_extension_regex/o;
+
+ # Ignore false positives.
+ #
+ # `./configure` output.
+ next if not $non_verbose
+ and $line =~ /^(?:checking|[Cc]onfigure:) /;
+ next if $line =~ /^\s*(?:Host\s+)?(?:C(?:\+\+)?\s+)?
+ [Cc]ompiler[\s.]*:?\s+
+ /xo;
+ next if $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex_full\s*$/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_bindnow = 1 if any_flags_used($line, @def_ldflags_bindnow);
+
+ push @input, $line;
}
}
- 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) {
print "No compiler commands!\n";
} else {
- print "W-no-compiler-commands\n";
+ print "$buildd_tag{no_compiler_commands}\n";
}
$exit |= $exit_code{no_compiler_commands};
next FILE;
@@ -686,10 +792,10 @@ FILE: 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;
}
@@ -726,9 +832,30 @@ FILE: foreach my $file (@ARGV) {
@ldflags = (@ldflags, @def_ldflags_bindnow);
}
+ # 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 (@ignore_line) {
+ next LINE if $line =~ /$ignore/;
+ }
+
my $skip = 0;
if (is_non_verbose_build($line, $input[$i + 1], \$skip)) {
if (not $option_buildd) {
@@ -834,7 +961,7 @@ FILE: foreach my $file (@ARGV) {
# 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 {
@@ -847,7 +974,7 @@ FILE: foreach my $file (@ARGV) {
# 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 {
@@ -857,7 +984,7 @@ FILE: foreach my $file (@ARGV) {
}
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 {
@@ -869,7 +996,7 @@ FILE: foreach my $file (@ARGV) {
# 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 {
@@ -885,32 +1012,32 @@ 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};
}
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},
}
@@ -928,12 +1055,16 @@ 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
-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
@@ -961,17 +1092,17 @@ changes are in effect:
=over 2
-=item
+=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
+=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.
@@ -981,6 +1112,37 @@ 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-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.
+I is a string.
+
+Used to prevent false positives. This option can be specified multiple times.
+
+=item B<--ignore-line> I
+
+Ignore lines matching the given Perl regex. I is automatically anchored
+at the beginning and end of the line to prevent false negatives.
+
+B: Not the input lines are checked, but the lines which are displayed in
+warnings (which have line continuation resolved).
+
+Used to prevent false positives. This option can be specified multiple times.
+
=item B<--pie>
Force check for all +pie hardening flags. By default it's auto detected.
@@ -999,6 +1161,85 @@ 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
+
+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.
+
+ 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)
+
+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.
+
+=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
@@ -1030,12 +1271,20 @@ 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
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
@@ -1053,4 +1302,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