# Regex to catch compiler commands.
my $cc_regex = qr/
- (?<!\.)(?:cc|gcc|g\+\+|c\+\+)
- (?:-[\d.]+)?
+ (?<!\s-) # ignore options, e.g. "-c++" [sic!] (used by swig)
+ (?<!\.) # ignore file names, e.g. "test.gcc"
+ (?:cc|gcc|g\+\+|c\+\+)
+ (?:-[\d.]+)? # version suffix, e.g. "gcc-4.6"
/x;
# Full regex which matches the complete compiler name. Used in a few places to
# prevent false negatives.
$cc_regex
/x;
# Regex to catch (GCC) compiler warnings.
-my $warning_regex = qr/^(.+?):([0-9]+):[0-9]+: warning: (.+?) \[(.+?)\]$/;
+my $warning_regex = qr/^(.+?):(\d+):\d+: warning: (.+?) \[(.+?)\]$/;
# List of source file extensions which require preprocessing.
my @source_preprocess_compile_cpp = (
);
my @def_cflags_format = (
'-Wformat',
- '-Wformat-security',
- '-Werror=format-security',
+ '-Werror=format-security', # implies -Wformat-security
);
my @def_cflags_fortify = (
# fortify needs at least -O1, but -O2 is recommended anyway
} @{$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;
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;
}
# 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;
}
$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;
# MAIN
# Parse command line arguments.
-my $option_help = 0;
-my $option_version = 0;
-my $option_pie = 0;
-my $option_bindnow = 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_line = ();
-my $option_all = 0;
-my $option_arch = undef;
-my $option_buildd = 0;
- $option_color = 0;
+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,
# 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);
}
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) {
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;
# 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) {
# 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 {
# 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.
# 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);
# 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
$_ =~ s/\s+$//;
$_ .= "\n";
} Text::ParseWords::parse_line(';', 1, $line);
- foreach $line (@line) {
+ foreach my $line (@line) {
if ($continuation) {
$continuation = 0;
$complete_line .= ' ' . $line;
}
# Line continuation, line ends with "\".
- if ($line =~ /\\\s*$/) {
+ if ($line =~ /\\$/) {
$continuation = 1;
# Start line continuation.
if (not defined $complete_line) {
#
# `./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;
}
}
- 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) {
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;
}
# 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 {
# 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 {
}
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 {
# 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 {
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};
}
=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
=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
Use colored (ANSI) output for warning messages.
+=item B<--ignore-arch> I<arch>
+
+Ignore build logs from architectures matching I<arch>. I<arch> is a string.
+
+Used to prevent false positives. This option can be specified multiple times.
+
=item B<--ignore-flag> I<flag>
Don't print an error when the specific flag is missing in a compiler line.
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<I-hardening-wrapper-used>
+
+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<W-compiler-flags-hidden> (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<export V=1> or C<export verbose=1> in
+F<debian/rules> fixes builds with hidden compiler flags. Sometimes C<.SILENT>
+in a F<Makefile> must be removed. And as last resort the F<Makefile> must be
+patched to remove the C<@>s hiding the real compiler commands.
+
+=item
+
+B<W-dpkg-buildflags-missing> (summary of missing flags)
+
+CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing.
+
+=item
+
+B<W-invalid-cmake-used> (version)
+
+=item
+
+B<W-no-compiler-commands>
+
+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
Simon Ruderich, E<lt>simon@ruderich.orgE<gt>
+Thanks to to Bernhard R. Link E<lt>brlink@debian.orgE<gt> and Jaria Alto
+E<lt>jari.aalto@cante.netE<gt> for their valuable input and suggestions.
+
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2012 by Simon Ruderich
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
+=head1 SEE ALSO
+
+L<hardening-check(1)>, L<dpkg-buildflags(1)>
+
=cut
ruderich.org/simon / blhc / blhc.git / blobdiff