# Build log hardening check, checks build logs for missing hardening flags.
-# Copyright (C) 2012-2015 Simon Ruderich
+# Copyright (C) 2012-2018 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.05';
+our $VERSION = '0.08';
# CONSTANTS/VARIABLES
my $cc_regex = qr/
(?<!\s-) # ignore options, e.g. "-c++" [sic!] (used by swig)
(?<!\.) # ignore file names, e.g. "test.gcc"
- (?:cc|gcc|g\+\+|c\+\+)
+ (?:cc|gcc|g\+\+|c\+\+|gfortran|mpicc|mpicxx|mpifort)
(?:-[\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.
+my $cc_regex_full_prefix = qr/
+ [a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?
+ /x;
my $cc_regex_full = qr/
- (?:[a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?-)?
+ (?:$cc_regex_full_prefix-)?
$cc_regex
/x;
# Regex to check if a line contains a compiler command.
# Objective-C++
qw( mm M ),
);
+my @source_preprocess_compile_fortran = (
+ # Fortran
+ qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
+);
my @source_preprocess_compile = (
# C
qw( c ),
# (Objective-)C++
@source_preprocess_compile_cpp,
# Fortran
- qw( F FOR fpp FPP FTN F90 F95 F03 F08 ),
+ @source_preprocess_compile_fortran,
);
my @source_preprocess_no_compile = (
# Assembly
qw( mii ),
);
my @source_no_preprocess_compile_ada = (
+ # Ada source
+ qw( ada ),
# Ada body
qw( adb ),
- # If you add another file, fix use of @source_no_preprocess_compile_ada
- # below (search for $compile_ada).
+);
+my @source_no_preprocess_compile_fortran = (
+ # Fortran
+ qw( f for ftn f90 f95 f03 f08 ),
);
my @source_no_preprocess_compile = (
# C
# Objective-C
qw( mi ),
# Fortran
- qw( f for ftn f90 f95 f03 f08 ),
+ @source_no_preprocess_compile_fortran,
# Ada
@source_no_preprocess_compile_ada,
);
+my @source_no_preprocess_no_compile_ada = (
+ # Ada specification
+ qw( ads ),
+);
my @source_no_preprocess_no_compile = (
# Assembly
qw( s ),
- # Ada specification
- qw( ads ),
+ # Ada
+ @source_no_preprocess_no_compile_ada,
);
my @source_no_preprocess = (
@source_no_preprocess_compile,
@source_preprocess_compile_cpp,
@source_no_preprocess_compile_cpp,
);
+my %extensions_ada = map { $_ => 1 } (
+ @source_no_preprocess_compile_ada,
+ @source_no_preprocess_no_compile_ada,
+);
+my %extensions_fortran = map { $_ => 1 } (
+ @source_no_preprocess_compile_fortran,
+ @source_preprocess_compile_fortran,
+);
my %extensions_object = map { $_ => 1 } (
@object,
);
}
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'),
}
sub is_non_verbose_build {
- my ($line, $next_line, $skip_ref) = @_;
+ my ($line, $skip_ref, $input_ref, $line_offset, $line_count) = @_;
if ($line =~ /$libtool_regex/o) {
# libtool's --silent hides the real compiler flags.
my $file = $1;
# On the first pass we only check if this line is verbose or not.
- return 1 if not defined $next_line;
+ return 1 if not defined $input_ref;
- # Second pass, we have access to the next line.
+ # Second pass, we have access to the next lines.
${$skip_ref} = 0;
# CMake and other build systems print the non-verbose messages also when
# building verbose. If a compiler and the file name occurs in the next
- # line, treat it as verbose build.
+ # lines, treat it as verbose build.
if (defined $file) {
# Get filename, we can't use the complete path as only parts of it are
# used in the real compiler command.
$file =~ m{/([^/\s]+)$};
$file = $1;
- if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
- # Not a non-verbose line, but we still have to skip the current line
- # as it doesn't contain any compiler commands.
- ${$skip_ref} = 1;
- return 0;
+ for (my $i = 1; $i <= $line_count; $i++) {
+ my $next_line = $input_ref->[$line_offset + $i];
+ last unless defined $next_line;
+
+ if (index($next_line, $file) != -1 and $next_line =~ /$cc_regex/o) {
+ # Not a non-verbose line, but we still have to skip the
+ # current line as it doesn't contain any compiler commands.
+ ${$skip_ref} = 1;
+ return 0;
+ }
}
}
my $option_all = 0;
my $option_arch = undef;
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,
'color' => \$option_color,
'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-2015 Simon Ruderich
+blhc $VERSION Copyright (C) 2012-2018 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
# 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.
+ my $parallel = 10;
+
+ # Don't check for PIE flags if automatically applied by the compiler. Only
+ # used in buildd and Debian mode.
+ my $disable_harden_pie = 0;
+ if ($option_debian) {
+ $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,
# flags are not checked.
#
# Strong stack protector is used since dpkg 1.17.11.
+ #
+ # Recent GCC versions automatically use PIE (only on supported
+ # architectures) and dpkg respects this properly since 1.18.15 and
+ # doesn't pass PIE flags manually.
if ($option_buildd
and index($line, 'Toolchain package versions: ') == 0) {
require Dpkg::Version;
if (Dpkg::Version::version_compare($1, '1.17.11') >= 0) {
$disable_strong = 0;
}
+ if (Dpkg::Version::version_compare($1, '1.18.15') >= 0) {
+ $disable_harden_pie = 1;
+ }
}
if ($disable) {
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 * 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.
}
}
+ next if $line =~ /^\s*#/;
# Ignore compiler warnings for now.
next if $line =~ /$warning_regex/o;
# Check if this line indicates a non verbose build.
my $skip = 0;
- $non_verbose |= is_non_verbose_build($line, undef, \$skip);
+ $non_verbose |= is_non_verbose_build($line, \$skip);
next if $skip;
# One line may contain multiple commands (";"). Treat each one as
next if not $before =~ /$cc_regex_normal/o
and not $after =~ /$cc_regex_normal/o;
}
+ # Ignore false positives caused by gcc -v. It outputs a line
+ # looking like a normal compiler line but which is sometimes
+ # missing hardening flags, although the normal compiler line
+ # contains them.
+ next if $line =~ m{^\s+/usr/lib/gcc/$cc_regex_full_prefix/
+ [0-9.]+/cc1(?:plus)?}xo;
+ # Ignore false positive with `rm` which may remove files which
+ # look like a compiler executable thus causing the line to be
+ # treated as a normal compiler line.
+ next if $line =~ m{^\s*rm\s+};
+ # Some build systems emit "gcc > file".
+ next if $line =~ m{$cc_regex_normal\s*>\s*\S+};
# 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.2
- # (/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.19.0.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 ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
+ my ($os, $cpu);
+ # Recent dpkg versions use a quadruplet for arch. Support both.
+ eval {
+ (undef, undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtuple($arch);
+ };
+ if ($@) {
+ (undef, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch);
+ }
+
+ my %builtin_pie_arch = map { $_ => 1 } qw(
+ amd64 arm64 armel armhf hurd-i386 i386 kfreebsd-amd64 kfreebsd-i386
+ mips mipsel mips64el powerpc ppc64 ppc64el s390x sparc sparc64
+ );
# Disable unsupported hardening options.
- if ($os !~ /^(?:linux|knetbsd|hurd)$/ or $cpu =~ /^(?:hppa|avr32)$/) {
+ if ($os !~ /^(?:linux|kfreebsd|knetbsd|hurd)$/
+ or $cpu =~ /^(?:hppa|avr32)$/) {
$harden_pie = 0;
}
- if ($cpu =~ /^(?:ia64|alpha|hppa)$/ or $arch eq 'arm') {
+ if ($cpu =~ /^(?:ia64|alpha|hppa|nios2)$/ or $arch eq 'arm') {
$harden_stack = 0;
$harden_stack_strong = 0;
}
$harden_relro = 0;
$harden_bindnow = 0;
}
+
+ if ($disable_harden_pie and exists $builtin_pie_arch{$arch}) {
+ $harden_pie = 0;
+ }
}
# Default values.
@ldflags = (@ldflags, @def_ldflags_bindnow);
}
- # Stores normal CFLAGS when @cflags_ada are temporarily used.
- my @cflags_backup;
- # Ada CFLAGS, only set if ada is used.
- my @cflags_ada;
# Ada doesn't support format hardening flags, see #680117 for more
- # information. Filter them out if ada is used.
- if ($ada and $harden_format) {
- @cflags_ada = grep {
+ # information. Same for fortran. Filter them out if either language is
+ # used.
+ 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;
my $skip = 0;
if ($input_nonverbose[$i]
- and is_non_verbose_build($line, $input[$i + 1], \$skip)) {
+ 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}++;
}
my $compile_cpp = 0;
- my $compile_ada = 0;
+ my $restore_cflags = 0;
# Assume CXXFLAGS are required when a C++ file is specified in the
# compiler line.
if ($compile
$compile_cpp = 1;
# Ada needs special CFLAGS, use them if only ada files are compiled.
} elsif ($ada
- and $compile
- and array_equal(\@extensions,
- \@source_no_preprocess_compile_ada)) {
- $compile_ada = 1;
+ and 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)) {
+ $restore_cflags = 1;
@cflags_backup = @cflags;
- @cflags = @cflags_ada;
+ @cflags = @cflags_noformat;
}
if ($option_buildd) {
# 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}++;
}
# Restore normal CFLAGS.
- if ($compile_ada) {
+ if ($restore_cflags) {
@cflags = @cflags_backup;
}
}
=back
+=item B<--debian>
+
+Apply Debian-specific settings. At the moment this only disables checking for
+PIE which is automatically applied by Debian's GCC and no longer requires a
+compiler command line argument.
+
=item B<--color>
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-2015 by Simon Ruderich
+Copyright (C) 2012-2018 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
ruderich.org/simon / blhc / blhc.git / blobdiff