X-Git-Url: https://ruderich.org/simon/gitweb/?p=blhc%2Fblhc.git;a=blobdiff_plain;f=bin%2Fblhc;h=5e8e0181356613dca5de8afe591ce3ab24a5d684;hp=5443eef5a4226db9e3c64a315d602b0eb470131f;hb=f0ae7b1580cd26bcf44dc5b780f1c2e081314479;hpb=124a578b28479e28b9d801888f6a5c93666c24d3 diff --git a/bin/blhc b/bin/blhc index 5443eef..5e8e018 100755 --- a/bin/blhc +++ b/bin/blhc @@ -22,7 +22,6 @@ use strict; use warnings; use Getopt::Long (); -use Term::ANSIColor (); use Text::ParseWords (); our $VERSION = '0.01'; @@ -31,9 +30,18 @@ our $VERSION = '0.01'; # CONSTANTS/VARIABLES # Regex to catch compiler commands. -my $cc_regex = qr/(?:[a-z0-9_]+-(?:linux-|kfreebsd-)?gnu(?:eabi|eabihf)?-)? - (? 1 } ( ); my %extension = map { $_ => 1 } ( @source_no_preprocess, - @source_no_preprocess_compile, - @source_no_preprocess_compile_cpp, - @source_no_preprocess_no_compile, @header_preprocess, @source_preprocess, - @source_preprocess_compile, - @source_preprocess_compile_cpp, - @source_preprocess_no_compile, ); # Regexp to match file extensions. my $file_extension_regex = qr/ \s - \S+ # Filename without extension. + \S+ # Filename without extension. \. - ([^\\.\s]+) # File extension. - (?=\s|\\) # At end of word. Can't use \b because some files have non - # word characters at the end and because \b matches double - # extensions (like .cpp.o). Works always as all lines are - # terminated with "\n". + ([^\/\\.,;:\s]+)# File extension. + (?=\s|\\) # At end of word. Can't use \b because some files have non + # word characters at the end and because \b matches double + # extensions (like .cpp.o). Works always as all lines are + # terminated with "\n". /x; # Expected (hardening) flags. All flags are used as regexps. -my @cflags = ( +my @def_cflags = ( '-g', '-O(?:2|3)', ); -my @cflags_format = ( +my @def_cflags_format = ( '-Wformat', '-Wformat-security', '-Werror=format-security', ); -my @cflags_fortify = ( +my @def_cflags_fortify = ( # fortify needs at least -O1, but -O2 is recommended anyway ); -my @cflags_stack = ( +my @def_cflags_stack = ( '-fstack-protector', '--param=ssp-buffer-size=4', ); -my @cflags_pie = ( +my @def_cflags_pie = ( '-fPIE', ); -my @cxxflags = ( - '-g', - '-O(?:2|3)', +my @def_cxxflags = ( + @def_cflags, ); -# @cxxflags_* is the same as @cflags_*. -my @cppflags = (); -my @cppflags_fortify = ( +# @def_cxxflags_* is the same as @def_cflags_*. +my @def_cppflags = (); +my @def_cppflags_fortify = ( '-D_FORTIFY_SOURCE=2', ); -my @ldflags = (); -my @ldflags_relro = ( - '-Wl,(-z,)?relro', +my @def_ldflags = (); +my @def_ldflags_relro = ( + '-Wl,(?:-z,)?relro', ); -my @ldflags_bindnow = ( - '-Wl,(-z,)?now', +my @def_ldflags_bindnow = ( + '-Wl,(?:-z,)?now', ); -my @ldflags_pie = ( +my @def_ldflags_pie = ( '-fPIE', '-pie', ); -# Renaming rules for the output so the regex parts are not visible. +my @def_ldflags_pic = ( + '-fPIC', + '-fpic', + '-shared', +); +# References to all flags checked by the parser. +my @flag_refs = ( + \@def_cflags, + \@def_cflags_format, + \@def_cflags_fortify, + \@def_cflags_stack, + \@def_cflags_pie, + \@def_cxxflags, + \@def_cppflags, + \@def_cppflags_fortify, + \@def_ldflags, + \@def_ldflags_relro, + \@def_ldflags_bindnow, +); +# References to all used flags. +my @flag_refs_all = ( + @flag_refs, + \@def_ldflags_pie, + \@def_ldflags_pic, +); +# Renaming rules for the output so the regex parts are not visible. Also +# stores string values of flag regexps above, see compile_flag_regexp(). my %flag_renames = ( - '-O(?:2|3)' => '-O2', - '-Wl,(-z,)?relro' => '-Wl,-z,relro', - '-Wl,(-z,)?now' => '-Wl,-z,now', + '-O(?:2|3)' => '-O2', + '-Wl,(?:-z,)?relro' => '-Wl,-z,relro', + '-Wl,(?:-z,)?now' => '-Wl,-z,now', +); + +my %exit_code = ( + no_compiler_commands => 1 << 0, + # used by POD::Usage => 1 << 1, + non_verbose_build => 1 << 2, + flags_missing => 1 << 3, + hardening_wrapper => 1 << 4, + invalid_cmake => 1 << 5, +); + +# Statistics of missing flags and non-verbose build commands. Used for +# $option_buildd. +my %statistics = ( + preprocess => 0, + preprocess_missing => 0, + compile => 0, + compile_missing => 0, + compile_cpp => 0, + compile_cpp_missing => 0, + link => 0, + link_missing => 0, + commands => 0, + commands_nonverbose => 0, ); # Use colored (ANSI) output? @@ -200,12 +251,10 @@ my $option_color; sub error_flags { my ($message, $missing_flags_ref, $flag_renames_ref, $line) = @_; - # Rename flags if requested. + # Get string value of qr//-escaped regexps and if requested rename them. my @missing_flags = map { - (exists $flag_renames_ref->{$_}) - ? $flag_renames_ref->{$_} - : $_ - } @{$missing_flags_ref}; + $flag_renames_ref->{$_} + } @{$missing_flags_ref}; my $flags = join ' ', @missing_flags; printf "%s (%s)%s %s", @@ -220,6 +269,14 @@ sub error_non_verbose_build { error_color(':', 'yellow'), $line; } +sub error_invalid_cmake { + my ($version) = @_; + + printf "%s%s %s\n", + error_color('INVALID CMAKE', 'red'), + error_color(':', 'yellow'), + $version; +} sub error_hardening_wrapper { printf "%s%s %s\n", error_color('HARDENING WRAPPER', 'red'), @@ -240,7 +297,7 @@ sub any_flags_used { my ($line, @flags) = @_; foreach my $flag (@flags) { - return 1 if $line =~ /\s$flag(?:\s|\\)/; + return 1 if $line =~ /$flag/; } return 0; @@ -250,7 +307,7 @@ sub all_flags_used { my @missing_flags = (); foreach my $flag (@flags) { - if ($line !~ /\s$flag(?:\s|\\)/) { + if (not $line =~ /$flag/) { push @missing_flags, $flag; } } @@ -266,7 +323,7 @@ sub pic_pie_conflict { my ($line, $pie, $missing_flags_ref, @flags_pie) = @_; return 0 if not $pie; - return 0 if not any_flags_used($line, ('-fPIC', '-fpic')); + return 0 if not any_flags_used($line, @def_ldflags_pic); my %flags = map { $_ => 1 } @flags_pie; @@ -286,14 +343,24 @@ 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/ - or $line =~ /^\s*\[?(?:CC|CCLD|CXX|CXXLD|LD|LINK)\]?\s+(.+?)$/ + 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*\[[\d ]+%\] Building (?:C|CXX) object (.+?)$/)) { return 0; } + # False positives. + # + # 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+(.+?)(?:\.\.\.)?$/) { + # $file_extension_regex may need spaces around the filename. + return 0 if not " $1 " =~ /$file_extension_regex/o; + } + my $file = $1; # On the first pass we only check if this line is verbose or not. @@ -308,10 +375,10 @@ sub is_non_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{/([a-zA-Z0-9._-]+)$}; + $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; @@ -322,6 +389,24 @@ sub is_non_verbose_build { return 1; } +sub compile_flag_regexp { + my ($flag_renames_ref, @flags) = @_; + + my @result = (); + foreach my $flag (@flags) { + # Store flag name in replacement string for correct flags in messages + # with qr//ed flag regexps. + $flag_renames_ref->{qr/\s$flag(?:\s|\\)/} + = (exists $flag_renames_ref->{$flag}) + ? $flag_renames_ref->{$flag} + : $flag; + + # Compile flag regexp for faster execution. + push @result, qr/\s$flag(?:\s|\\)/; + } + return @result; +} + sub extension_found { my ($extensions_ref, @extensions) = @_; @@ -338,33 +423,35 @@ sub extension_found { # MAIN -# Hardening options. Not all architectures support all hardening options. -my $harden_format = 1; -my $harden_fortify = 1; -my $harden_stack = 1; -my $harden_relro = 1; -my $harden_bindnow = 0; -my $harden_pie = 0; - # Parse command line arguments. -my $option_help = 0; -my $option_version = 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_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' => \$harden_pie, - 'bindnow' => \$harden_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, - )) { + 'color' => \$option_color, + 'arch=s' => \$option_arch, + 'buildd' => \$option_buildd, + ) + or scalar @ARGV == 0) { require Pod::Usage; Pod::Usage::pod2usage(2); } @@ -391,109 +478,191 @@ along with this program. If not, see . exit 0; } +# Don't load Term::ANSIColor in buildd mode because Term::ANSIColor is not +# installed on Debian's buildds. +if (not $option_buildd) { + require Term::ANSIColor; +} + if ($option_all) { - $harden_pie = 1; - $harden_bindnow = 1; + $option_pie = 1; + $option_bindnow = 1; +} + +# 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}; + } +} + +# 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$/; } # Final exit code. my $exit = 0; -# Input lines, contain only the lines with compiler commands. -my @input = (); +FILE: +foreach my $file (@ARGV) { + print "checking '$file'...\n" if scalar @ARGV > 1; + + open my $fh, '<', $file or die "$!: $file"; + + # Architecture of this file. + my $arch = $option_arch; + + # Hardening options. Not all architectures support all hardening options. + my $harden_format = 1; + my $harden_fortify = 1; + my $harden_stack = 1; + my $harden_relro = 1; + my $harden_bindnow = $option_bindnow; # defaults to 0 + 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; + } -my $start = 0; -my $continuation = 0; -my $complete_line = undef; -while (my $line = <>) { - # 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 not $start - and $line =~ /^Toolchain package versions: /) { - require Dpkg::Version; - if ($line !~ /dpkg-dev_(\S+)/ - or Dpkg::Version::version_compare($1, '1.16.1') < 0) { - $harden_format = 0; - $harden_fortify = 0; - $harden_stack = 0; - $harden_relro = 0; - $harden_bindnow = 0; - $harden_pie = 0; + # 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 index($line, 'Toolchain package versions: ') == 0) { + require Dpkg::Version; + if (not $line =~ /\bdpkg-dev_(\S+)/ + or Dpkg::Version::version_compare($1, '1.16.1') < 0) { + $harden_format = 0; + $harden_fortify = 0; + $harden_stack = 0; + $harden_relro = 0; + $harden_bindnow = 0; + $harden_pie = 0; + } } - } - # If hardening wrapper is used (wraps calls to gcc and adds hardening - # flags automatically) we can't perform any checks, abort. - if (not $start and $line =~ /^Build-Depends: .*\bhardening-wrapper\b/) { - error_hardening_wrapper(); - $exit |= 1 << 4; - exit $exit; - } + # The following two versions of CMake in Debian obeyed CPPFLAGS, but + # this was later dropped because upstream rejected the patch. Thus + # build logs with these versions will have fortify hardening flags + # 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 (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"; + } + $exit |= $exit_code{invalid_cmake}; + } - # We skip over unimportant lines at the beginning of the log to prevent - # false positives. - $start = 1 if $line =~ /^dpkg-buildpackage:/; - next if not $start; - # 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. - last if $line =~ /^Build finished at \d{8}-\d{4}$/; - - # Detect architecture automatically unless overridden. - if (not $option_arch - and $line =~ /^dpkg-buildpackage: host architecture (.+)$/) { - $option_arch = $1; + # If hardening wrapper is used (wraps calls to gcc and adds hardening + # flags automatically) we can't perform any checks, abort. + 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"; + } + $exit |= $exit_code{hardening_wrapper}; + next FILE; + } + + # We skip over unimportant lines at the beginning of the log to + # prevent false positives. + last if index($line, 'dpkg-buildpackage: ') == 0; } - # Ignore compiler warnings for now. - next if $line =~ /$warning_regex/o; - - # Remove all ANSI color sequences which are sometimes used in non-verbose - # builds. - $line = Term::ANSIColor::colorstrip($line); - # Also strip '\0xf' (delete previous character), used by Elinks' build - # system. - $line =~ s/\x0f//g; - # And "ESC(B" which seems to be used on armhf and hurd (not sure what it - # does). - $line =~ s/\033\(B//g; - - # Check if this line indicates a non verbose build. - my $non_verbose = is_non_verbose_build($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 =~ /;/) - ? ($line) - : Text::ParseWords::parse_line(';', 1, $line); - foreach $line (@line) { - # Add newline, drop all other whitespace at the end of a line. - $line =~ s/\s+$//; - $line .= "\n"; - - if ($continuation) { - $continuation = 0; - - # Join lines, but leave the "\" in place so it's clear where the - # original line break was. - chomp $complete_line; - $complete_line .= ' ' . $line; + # Input lines, contain only the lines with compiler commands. + my @input = (); + + my $continuation = 0; + my $complete_line = undef; + while (my $line = <$fh>) { + # 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. + last if $line =~ /^Build finished at \d{8}-\d{4}$/; + + # Detect architecture automatically unless overridden. + if (not $arch + and $line =~ /^dpkg-buildpackage: host architecture (.+)$/) { + $arch = $1; } - # Line continuation, line ends with "\". - if ($line =~ /\\\s*$/) { - $continuation = 1; - # Start line continuation. - if (not defined $complete_line) { - $complete_line = $line; - } - next; + + # Ignore compiler warnings for now. + next if $line =~ /$warning_regex/o; + + 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); + # Also strip '\0xf' (delete previous character), used by Elinks' + # build system. + $line =~ s/\x0f//g; + # And "ESC(B" which seems to be used on armhf and hurd (not sure + # what it does). + $line =~ s/\033\(B//g; } - if (not $continuation) { + # Check if this line indicates a non verbose build. + my $non_verbose = is_non_verbose_build($line); + + # One line may contain multiple commands (";"). Treat each one as + # single line. parse_line() is slow, only use it when necessary. + my @line = (index($line, ';') == -1) + ? ($line) + : map { + # Ensure newline at the line end - necessary for + # correct parsing later. + $_ =~ s/\s+$//; + $_ .= "\n"; + } Text::ParseWords::parse_line(';', 1, $line); + foreach $line (@line) { + if ($continuation) { + $continuation = 0; + + # Join lines, but leave the "\" in place so it's clear where + # the original line break was. + chomp $complete_line; + $complete_line .= ' ' . $line; + } + # Line continuation, line ends with "\". + if ($line =~ /\\$/) { + $continuation = 1; + # Start line continuation. + if (not defined $complete_line) { + $complete_line = $line; + } + next; + } + # Use the complete line if a line continuation occurred. if (defined $complete_line) { $line = $complete_line; @@ -501,193 +670,309 @@ while (my $line = <>) { } # Ignore lines with no compiler commands. - next if $line !~ /\b$cc_regex(?:\s|\\)/o and not $non_verbose; + 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+ - $cc_regex - (?:\s-std=[a-z0-9:+]+)?\s*$ - /xo - or $line =~ /^\s*(?:- )?(?:HOST_)?(?:CC|CXX)\s*=\s*$cc_regex\s*$/o - or $line =~ /^\s*-- Check for working (?:C|CXX) compiler: / - or $line =~ /^\s*(?:echo )?Using [A-Z_]+\s*=\s*/; - # `make` output. - next if $line =~ /^Making [a-z]+ in \S+/; # e.g. "[...] in c++" + 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, @cflags_pie, @ldflags_pie); - $harden_bindnow = 1 if any_flags_used($line, @ldflags_bindnow); + $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; } } -} -if (scalar @input == 0) { - print "No compiler commands!\n"; - $exit |= 1; - exit $exit; -} - -# Option or auto detected. -if ($option_arch) { - # The following was partially copied from dpkg-dev 1.16.1.2 - # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()), - # copyright Raphaël Hertzog , Kees Cook - # , Canonical, Ltd. licensed under GPL version 2 or - # later. Keep it in sync. + close $fh; - require Dpkg::Arch; - my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($option_arch); + # 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; + } + } + } - # Disable unsupported hardening options. - if ($cpu =~ /^(ia64|alpha|mips|mipsel|hppa)$/ or $option_arch eq 'arm') { - $harden_stack = 0; + if (scalar @input == 0) { + if (not $option_buildd) { + print "No compiler commands!\n"; + } else { + print "W-no-compiler-commands\n"; + } + $exit |= $exit_code{no_compiler_commands}; + next FILE; } - if ($cpu =~ /^(ia64|hppa|avr32)$/) { - $harden_relro = 0; - $harden_bindnow = 0; + + if ($option_buildd) { + $statistics{commands} += scalar @input; } -} -# Check the specified hardening options, same order as dpkg-buildflags. -if ($harden_pie) { - @cflags = (@cflags, @cflags_pie); - @cxxflags = (@cxxflags, @cflags_pie); - @ldflags = (@ldflags, @ldflags_pie); -} -if ($harden_stack) { - @cflags = (@cflags, @cflags_stack); - @cxxflags = (@cxxflags, @cflags_stack); -} -if ($harden_fortify) { - @cflags = (@cflags, @cflags_fortify); - @cxxflags = (@cxxflags, @cflags_fortify); - @cppflags = (@cppflags, @cppflags_fortify); -} -if ($harden_format) { - @cflags = (@cflags, @cflags_format); - @cxxflags = (@cxxflags, @cflags_format); -} -if ($harden_relro) { - @ldflags = (@ldflags, @ldflags_relro); -} -if ($harden_bindnow) { - @ldflags = (@ldflags, @ldflags_bindnow); -} + # Option or auto detected. + if ($arch) { + # The following was partially copied from dpkg-dev 1.16.1.2 + # (/usr/share/perl5/Dpkg/Vendor/Debian.pm, add_hardening_flags()), + # copyright Raphaël Hertzog , Kees Cook + # , Canonical, Ltd. licensed under GPL version 2 or + # later. Keep it in sync. -for (my $i = 0; $i < scalar @input; $i++) { - my $line = $input[$i]; + require Dpkg::Arch; + my ($abi, $os, $cpu) = Dpkg::Arch::debarch_to_debtriplet($arch); - my $skip = 0; - if (is_non_verbose_build($line, $input[$i + 1], \$skip)) { - error_non_verbose_build($line); - $exit |= 1 << 2; - next; - } - # Even if it's a verbose build, we might have to skip this line. - next if $skip; - - # Remove everything until and including the compiler command. Makes checks - # easier and faster. - $line =~ s/^.*?$cc_regex//o; - - # Skip unnecessary tests when only preprocessing. - my $flag_preprocess = 0; - - my $preprocess = 0; - my $compile = 0; - my $link = 0; - - # Preprocess, compile, assemble. - if ($line =~ /\s(-E|-S|-c)\b/) { - $preprocess = 1; - $flag_preprocess = 1 if $1 eq '-E'; - $compile = 1 if $1 eq '-S' or $1 eq '-c'; - # Otherwise assume we are linking. - } else { - $link = 1; + # Disable unsupported hardening options. + if ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') { + $harden_stack = 0; + } + if ($cpu =~ /^(?:ia64|hppa|avr32)$/) { + $harden_relro = 0; + $harden_bindnow = 0; + } } - # Get all file extensions on this line. - my @extensions = $line =~ /$file_extension_regex/go; - # Ignore all unknown extensions to speedup the search below. - @extensions = grep { exists $extension{$_} } @extensions; - - # These file types don't require preprocessing. - if (extension_found(\%extensions_no_preprocess, @extensions)) { - $preprocess = 0; + # Default values. + my @cflags = @def_cflags; + my @cxxflags = @def_cxxflags; + my @cppflags = @def_cppflags; + my @ldflags = @def_ldflags; + # Check the specified hardening options, same order as dpkg-buildflags. + if ($harden_pie) { + @cflags = (@cflags, @def_cflags_pie); + @cxxflags = (@cxxflags, @def_cflags_pie); + @ldflags = (@ldflags, @def_ldflags_pie); + } + if ($harden_stack) { + @cflags = (@cflags, @def_cflags_stack); + @cxxflags = (@cxxflags, @def_cflags_stack); + } + if ($harden_fortify) { + @cflags = (@cflags, @def_cflags_fortify); + @cxxflags = (@cxxflags, @def_cflags_fortify); + @cppflags = (@cppflags, @def_cppflags_fortify); } - # These file types require preprocessing. - if (extension_found(\%extensions_preprocess, @extensions)) { - $preprocess = 1; + if ($harden_format) { + @cflags = (@cflags, @def_cflags_format); + @cxxflags = (@cxxflags, @def_cflags_format); } + if ($harden_relro) { + @ldflags = (@ldflags, @def_ldflags_relro); + } + if ($harden_bindnow) { + @ldflags = (@ldflags, @def_ldflags_bindnow); + } + +LINE: + for (my $i = 0; $i < scalar @input; $i++) { + my $line = $input[$i]; + + # Ignore line if requested. + foreach my $ignore (@option_ignore_line) { + next LINE if $line =~ /$ignore/; + } - # 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. + my $skip = 0; + if (is_non_verbose_build($line, $input[$i + 1], \$skip)) { + if (not $option_buildd) { + error_non_verbose_build($line); + } 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. + next if $skip; + + # Remove everything until and including the compiler command. Makes + # checks easier and faster. + $line =~ s/^.*?$cc_regex//o; + # "([...] test.c)" is not detected as 'test.c' - fix this by removing + # the brace and similar characters. + $line =~ s/['")]+$//; + + # Skip unnecessary tests when only preprocessing. + my $flag_preprocess = 0; + + my $dependency = 0; + my $preprocess = 0; + my $compile = 0; + my $link = 0; + + # Preprocess, compile, assemble. + if ($line =~ /\s(-E|-S|-c)\b/) { + $preprocess = 1; + $flag_preprocess = 1 if $1 eq '-E'; + $compile = 1 if $1 eq '-S' or $1 eq '-c'; + # Dependency generation for Makefiles. The other flags (-MF -MG -MP + # -MT -MQ) are always used with -M/-MM. + } elsif ($line =~ /\s(?:-M|-MM)\b/) { + $dependency = 1; + # Otherwise assume we are linking. } else { - $compile = 1; + $link = 1; + } + + # -MD/-MMD also cause dependency generation, but they don't imply -E! + if ($line =~ /\s(?:-MD|-MMD)\b/) { + $dependency = 0; + $flag_preprocess = 0; + } + + # Dependency generation for Makefiles, no preprocessing or other flags + # needed. + next if $dependency; + + # Get all file extensions on this line. + my @extensions = $line =~ /$file_extension_regex/go; + # Ignore all unknown extensions to speedup the search below. + @extensions = grep { exists $extension{$_} } @extensions; + + # These file types don't require preprocessing. + if (extension_found(\%extensions_no_preprocess, @extensions)) { + $preprocess = 0; + } + # These file types require preprocessing. + if (extension_found(\%extensions_preprocess, @extensions)) { + $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; + } + } + + # Assume CXXFLAGS are required when a C++ file is specified in the + # compiler line. + my $compile_cpp = 0; + if ($compile + and extension_found(\%extensions_compile_cpp, @extensions)) { + $compile = 0; + $compile_cpp = 1; + } + + if ($option_buildd) { + $statistics{preprocess}++ if $preprocess; + $statistics{compile}++ if $compile; + $statistics{compile_cpp}++ if $compile_cpp; + $statistics{link}++ if $link; } - } - # Assume CXXFLAGS are required when a C++ file is specified in the - # compiler line. - my $compile_cpp = 0; - if ($compile - and extension_found(\%extensions_compile_cpp, @extensions)) { - $compile = 0; - $compile_cpp = 1; + # Check hardening flags. + my @missing; + if ($compile 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 + # are missing. + and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie) + # 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]); + } 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 + # are missing. + and not pic_pie_conflict($line, $harden_pie, \@missing, @def_cflags_pie) + # 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]); + } else { + $statistics{compile_cpp_missing}++; + } + $exit |= $exit_code{flags_missing}; + } + if ($preprocess and not all_flags_used($line, \@missing, @cppflags) + # 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]); + } 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. + and not pic_pie_conflict($line, $harden_pie, \@missing, @def_ldflags_pie) + # 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]); + } else { + $statistics{link_missing}++; + } + $exit |= $exit_code{flags_missing}; + } } +} + +# Print statistics for buildd mode, only output in this mode. +if ($option_buildd) { + my @warning; - # Check hardening flags. - my @missing; - if ($compile 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 are missing. - and not pic_pie_conflict($line, $harden_pie, \@missing, @cflags_pie) - # Assume dpkg-buildflags returns the correct flags. - and not $line =~ /`dpkg-buildflags --get CFLAGS`/) { - error_flags('CFLAGS missing', \@missing, \%flag_renames, $input[$i]); - $exit |= 1 << 3; - } 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 are missing. - and not pic_pie_conflict($line, $harden_pie, \@missing, @cflags_pie) - # Assume dpkg-buildflags returns the correct flags. - and not $line =~ /`dpkg-buildflags --get CXXFLAGS`/) { - error_flags('CXXFLAGS missing', \@missing, \%flag_renames, $input[$i]); - $exit |= 1 << 3; + if ($statistics{preprocess_missing}) { + push @warning, sprintf "CPPFLAGS %d (of %d)", + $statistics{preprocess_missing}, + $statistics{preprocess}; + } + if ($statistics{compile_missing}) { + push @warning, sprintf "CFLAGS %d (of %d)", + $statistics{compile_missing}, + $statistics{compile}; + } + if ($statistics{compile_cpp_missing}) { + 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)", + $statistics{link_missing}, + $statistics{link}; } - if ($preprocess and not all_flags_used($line, \@missing, @cppflags) - # Assume dpkg-buildflags returns the correct flags. - and not $line =~ /`dpkg-buildflags --get CPPFLAGS`/) { - error_flags('CPPFLAGS missing', \@missing, \%flag_renames, $input[$i]); - $exit |= 1 << 3; + if (scalar @warning) { + local $" = ', '; # array join string + print "W-dpkg-buildflags-missing @warning missing\n"; } - if ($link and not all_flags_used($line, \@missing, @ldflags) - # Same here, -fPIC conflicts with -fPIE. - and not pic_pie_conflict($line, $harden_pie, \@missing, @ldflags_pie) - # Assume dpkg-buildflags returns the correct flags. - and not $line =~ /`dpkg-buildflags --get LDFLAGS`/) { - error_flags('LDFLAGS missing', \@missing, \%flag_renames, $input[$i]); - $exit |= 1 << 3; + + if ($statistics{commands_nonverbose}) { + printf "W-compiler-flags-hidden %d (of %d) hidden\n", + $statistics{commands_nonverbose}, + $statistics{commands}, } } + exit $exit; @@ -699,21 +984,16 @@ blhc - build log hardening check, checks build logs for missing hardening flags =head1 SYNOPSIS -B [options] - - --all force +all (+pie, +bindnow) check - --arch set architecture (autodetected) - --bindnow force +bindbow check - --buildd parser mode for buildds - --color use colored output - --pie force +pie check - --help available options - --version version number and license +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 @@ -724,7 +1004,7 @@ other important warnings. It's licensed under the GPL 3 or later. Force check for all +all (+pie, +bindnow) hardening flags. By default it's auto detected. -=item B<--arch> +=item B<--arch> I Set the specific architecture (e.g. amd64, armel, etc.), automatically disables hardening flags not available on this architecture. Is detected @@ -743,15 +1023,47 @@ changes are in effect: =item +Print tags instead of normal warnings, see L for a list of +possible tags. + +=item + Don't check hardening flags in old log files (if dpkg-dev << 1.16.1 is detected). +=item + +Don't require Term::ANSIColor. + =back =item B<--color> 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. +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. @@ -770,6 +1082,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 @@ -807,6 +1197,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 @@ -824,4 +1217,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