X-Git-Url: https://ruderich.org/simon/gitweb/?p=blhc%2Fblhc.git;a=blobdiff_plain;f=bin%2Fblhc;h=168a1699c21744707ff22708aebd49e7c44ef20d;hp=6156b7d1a9b47616e6391b1887ade3cf2453c6c0;hb=47eb461331046250bbe1b2d39f73266a25bb5315;hpb=737a0dd159dfba58a7e66fef5e49b731e3d9bbb2 diff --git a/bin/blhc b/bin/blhc index 6156b7d..168a169 100755 --- a/bin/blhc +++ b/bin/blhc @@ -2,7 +2,7 @@ # Build log hardening check, checks build logs for missing hardening flags. -# Copyright (C) 2012 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 @@ -24,7 +24,7 @@ use warnings; use Getopt::Long (); use Text::ParseWords (); -our $VERSION = '0.02'; +our $VERSION = '0.08'; # CONSTANTS/VARIABLES @@ -33,17 +33,28 @@ our $VERSION = '0.02'; my $cc_regex = qr/ (? 1 } ( + # There's no @header_no_preprocess. @source_no_preprocess, ); my %extensions_preprocess = map { $_ => 1 } ( @@ -128,10 +173,22 @@ my %extensions_compile_cpp = map { $_ => 1 } ( @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, +); my %extension = map { $_ => 1 } ( @source_no_preprocess, @header_preprocess, @source_preprocess, + @object, ); # Regexp to match file extensions. @@ -146,13 +203,19 @@ my $file_extension_regex = qr/ # terminated with "\n". /x; -# Expected (hardening) flags. All flags are used as regexps. +# Expected (hardening) flags. All flags are used as regexps (and compiled to +# real regexps below for better execution speed). my @def_cflags = ( '-g', - '-O(?:2|3)', + '-O(?:2|3)', # keep at index 1, search for @def_cflags_debug to change it +); +my @def_cflags_debug = ( + # These flags indicate a debug build which disables checks for -O2. + '-O0', + '-Og', ); my @def_cflags_format = ( - '-Wformat', + '-Wformat(?:=2)?', # -Wformat=2 implies -Wformat, accept it too '-Werror=format-security', # implies -Wformat-security ); my @def_cflags_fortify = ( @@ -160,7 +223,10 @@ my @def_cflags_fortify = ( ); my @def_cflags_stack = ( '-fstack-protector', - '--param=ssp-buffer-size=4', + '--param[= ]ssp-buffer-size=4', +); +my @def_cflags_stack_strong = ( + '-fstack-protector-strong', ); my @def_cflags_pie = ( '-fPIE', @@ -171,7 +237,15 @@ my @def_cxxflags = ( # @def_cxxflags_* is the same as @def_cflags_*. my @def_cppflags = (); my @def_cppflags_fortify = ( - '-D_FORTIFY_SOURCE=2', + '-D_FORTIFY_SOURCE=2', # must be first, see cppflags_fortify_broken() + # If you add another flag fix hack below (search for "Hack to fix") and + # $def_cppflags_fortify[0]. +); +my @def_cppflags_fortify_bad = ( + # These flags may overwrite -D_FORTIFY_SOURCE=2. + '-U_FORTIFY_SOURCE', + '-D_FORTIFY_SOURCE=0', + '-D_FORTIFY_SOURCE=1', ); my @def_ldflags = (); my @def_ldflags_relro = ( @@ -189,12 +263,13 @@ my @def_ldflags_pic = ( '-fpic', '-shared', ); -# References to all flags checked by the parser. +# References to all flags checked by the flag checker. my @flag_refs = ( \@def_cflags, \@def_cflags_format, \@def_cflags_fortify, \@def_cflags_stack, + \@def_cflags_stack_strong, \@def_cflags_pie, \@def_cxxflags, \@def_cppflags, @@ -202,19 +277,23 @@ my @flag_refs = ( \@def_ldflags, \@def_ldflags_relro, \@def_ldflags_bindnow, + \@def_ldflags_pie, ); # References to all used flags. my @flag_refs_all = ( @flag_refs, - \@def_ldflags_pie, + \@def_cflags_debug, + \@def_cppflags_fortify_bad, \@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', + '-Wformat(?:=2)?' => '-Wformat', + '--param[= ]ssp-buffer-size=4' => '--param=ssp-buffer-size=4', + '-Wl,(?:-z,)?relro' => '-Wl,-z,relro', + '-Wl,(?:-z,)?now' => '-Wl,-z,now', ); my %exit_code = ( @@ -255,8 +334,22 @@ my $option_color; # FUNCTIONS +# Only works for single-level arrays with no undef values. Thanks to perlfaq4. +sub array_equal { + my ($first_ref, $second_ref) = @_; + + return 0 if scalar @{$first_ref} != scalar @{$second_ref}; + + my $length = scalar @{$first_ref}; + for (my $i = 0; $i < $length; $i++) { + return 0 if $first_ref->[$i] ne $second_ref->[$i]; + } + + return 1; +} + 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 { @@ -264,17 +357,23 @@ sub error_flags { } @{$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'), $line; + + return; } sub error_invalid_cmake { my ($version) = @_; @@ -283,12 +382,16 @@ sub error_invalid_cmake { error_color('INVALID CMAKE', 'red'), error_color(':', 'yellow'), $version; + + return; } sub error_hardening_wrapper { printf "%s%s %s\n", error_color('HARDENING WRAPPER', 'red'), error_color(':', 'yellow'), 'no checks possible, aborting'; + + return; } sub error_color { my ($message, $color) = @_; @@ -325,6 +428,22 @@ sub all_flags_used { return 0; } +sub cppflags_fortify_broken { + my ($line, $missing_flags) = @_; + + # This doesn't take the position into account, but is a simple solution. + # And if the build system tries to force -D_FORTIFY_SOURCE=0/1, something + # is wrong anyway. + + if (any_flags_used($line, @def_cppflags_fortify_bad)) { + # $def_cppflags_fortify[0] must be -D_FORTIFY_SOURCE=2! + push @{$missing_flags}, $def_cppflags_fortify[0]; + return 1; + } + + return 0; +} + # Modifies $missing_flags_ref array. sub pic_pie_conflict { my ($line, $pie, $missing_flags_ref, @flags_pie) = @_; @@ -348,7 +467,21 @@ sub pic_pie_conflict { } 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. + if ($line =~ /\s--silent/) { + return 1; + # If --silent is not present, skip this line as some compiler flags + # might be missing (e.g. -fPIE) which are handled correctly by libtool + # internally. libtool displays the real compiler command on the next + # line, so the flags are checked as usual. + } else { + ${$skip_ref} = 1; + return 0; + } + } 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+(.+?)$/ @@ -362,6 +495,9 @@ sub is_non_verbose_build { # # C++ compiler setting. return 0 if $line =~ /^\s*C\+\+.+?:\s+(?:yes|no)\s*$/; + return 0 if $line =~ /^\s*C\+\+ Library: stdc\+\+$/; + # "Compiling" non binary files. + return 0 if $line =~ /^\s*Compiling \S+\.(?:py|el)['"]?\s*(?:\.\.\.)?$/; # "Compiling" with no file name. if ($line =~ /^\s*[Cc]ompiling\s+(.+?)(?:\.\.\.)?$/) { # $file_extension_regex may need spaces around the filename. @@ -371,92 +507,125 @@ sub is_non_verbose_build { 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) { - # 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; + } } } return 1; } +# Remove @flags from $flag_refs_ref, uses $flag_renames_ref as reference. +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}; + } + + return; +} + +# Modifies $flag_renames_ref hash. sub compile_flag_regexp { my ($flag_renames_ref, @flags) = @_; my @result = (); foreach my $flag (@flags) { + # Compile flag regexp for faster execution. + my $regex = qr/\s$flag(?:\s|\\)/; + # Store flag name in replacement string for correct flags in messages # with qr//ed flag regexps. - $flag_renames_ref->{qr/\s$flag(?:\s|\\)/} + $flag_renames_ref->{$regex} = (exists $flag_renames_ref->{$flag}) ? $flag_renames_ref->{$flag} : $flag; - # Compile flag regexp for faster execution. - push @result, qr/\s$flag(?:\s|\\)/; + push @result, $regex; } return @result; } +# Does any extension in @extensions exist in %{$extensions_ref}? sub extension_found { my ($extensions_ref, @extensions) = @_; - my $found = 0; foreach my $extension (@extensions) { if (exists $extensions_ref->{$extension}) { - $found = 1; - last; + return 1; } } - return $found; + return 0; } # MAIN # Parse command line arguments. -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_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; +my $option_debian = 0; + $option_color = 0; +my $option_line_numbers = 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, + '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, + '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); @@ -466,7 +635,8 @@ if ($option_help) { Pod::Usage::pod2usage(1); } if ($option_version) { - print "blhc $VERSION Copyright (C) 2012 Simon Ruderich + print <<"EOF"; +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 @@ -480,7 +650,7 @@ 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 . -"; +EOF exit 0; } @@ -501,17 +671,27 @@ 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) { - 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}; + 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; } } @@ -525,6 +705,21 @@ foreach my $flags (@flag_refs_all) { 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; @@ -533,7 +728,9 @@ FILE: foreach my $file (@ARGV) { print "checking '$file'...\n" if scalar @ARGV > 1; - open my $fh, '<', $file or die "$!: $file"; + -f $file or die "No such file: $file"; + + open my $fh, '<', $file or die $!; # Architecture of this file. my $arch = $option_arch; @@ -542,18 +739,45 @@ foreach my $file (@ARGV) { my $harden_format = 1; my $harden_fortify = 1; my $harden_stack = 1; + my $harden_stack_strong = 1; my $harden_relro = 1; my $harden_bindnow = $option_bindnow; # defaults to 0 my $harden_pie = $option_pie; # defaults to 0 + # Does this build log use ada? Ada also uses gcc as compiler but uses + # 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, # etc.). - if (not $arch - and $line =~ /^Architecture: (.+)$/) { - $arch = $1; + if (not $arch) { + if (index($line, 'Build Architecture: ') == 0) { + $arch = substr $line, 20, -1; # -1 to ignore '\n' at the end + # For old logs (sbuild << 0.63.0-1). + } elsif (index($line, 'Architecture: ') == 0) { + $arch = substr $line, 14, -1; # -1 to ignore '\n' at the end + } } # dpkg-buildflags only provides hardening flags since 1.16.1, don't @@ -562,11 +786,32 @@ foreach my $file (@ARGV) { # # Packages which were built before 1.16.1 but used their own hardening # 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 (not $line =~ /\bdpkg-dev_(\S+)/ - or Dpkg::Version::version_compare($1, '1.16.1') < 0) { + + my $disable = 1; + my $disable_strong = 1; + + if ($line =~ /\bdpkg-dev_(\S+)/) { + if (Dpkg::Version::version_compare($1, '1.16.1') >= 0) { + $disable = 0; + } + 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) { $harden_format = 0; $harden_fortify = 0; $harden_stack = 0; @@ -574,6 +819,9 @@ foreach my $file (@ARGV) { $harden_bindnow = 0; $harden_pie = 0; } + if ($disable_strong) { + $harden_stack_strong = 0; + } } # The following two versions of CMake in Debian obeyed CPPFLAGS, but @@ -587,23 +835,44 @@ foreach my $file (@ARGV) { and ($1 eq '2.8.7-1' or $1 eq '2.8.7-2')) { if (not $option_buildd) { error_invalid_cmake($1); + $exit |= $exit_code{invalid_cmake}; } else { - print "$buildd_tag{invalid_cmake} $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 (index($line, 'Build-Depends: ') == 0 - and $line =~ /\bhardening-wrapper\b/) { - if (not $option_buildd) { - error_hardening_wrapper(); - } else { - print "$buildd_tag{hardening_wrapper}\n"; + # Debian's build daemons use "Filtered Build-Depends:" (or just + # "Build-Depends:" in older versions) for the build dependencies, but + # pbuilder uses "Depends:"; support both. + if (index($line, 'Filtered Build-Depends: ') == 0 + or index($line, 'Build-Depends: ') == 0 + or index($line, 'Depends: ') == 0) { + # If hardening wrapper is used (wraps calls to gcc and adds + # hardening flags automatically) we can't perform any checks, + # abort. + if ($line =~ /\bhardening-wrapper\b/) { + if (not $option_buildd) { + error_hardening_wrapper(); + $exit |= $exit_code{hardening_wrapper}; + } else { + print "$buildd_tag{hardening_wrapper}||\n"; + } + next FILE; } - $exit |= $exit_code{hardening_wrapper}; - next FILE; + + # Ada compiler. + 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 @@ -613,25 +882,47 @@ foreach my $file (@ARGV) { # Input lines, contain only the lines with compiler commands. my @input = (); + # Non-verbose lines in the input. Used to reduce calls 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. - last if $line =~ /^Build finished at \d{8}-\d{4}$/; + last if index($line, 'Build finished at ') == 0 + and $line =~ /^Build finished at \d{8}-\d{4}$/; + + if (not $continuation) { + $non_verbose = 0; + } # Detect architecture automatically unless overridden. if (not $arch - and $line =~ /^dpkg-buildpackage: host architecture (.+)$/) { - $arch = $1; + and index($line, 'dpkg-buildpackage: host architecture ') == 0) { + $arch = substr $line, 37, -1; # -1 to ignore '\n' at the end + + # Old buildd logs use e.g. "host architecture is alpha", remove + # the "is", otherwise debarch_to_debtriplet() will not detect the + # architecture. + if (index($arch, 'is ') == 0) { + $arch = substr $arch, 3; + } } + next if $line =~ /^\s*#/; # Ignore compiler warnings for now. next if $line =~ /$warning_regex/o; - if (not $option_buildd and index($line, "\033") != -1) { # esc + if (not $option_buildd and index($line, "\033") != -1) { # \033 = esc # Remove all ANSI color sequences which are sometimes used in # non-verbose builds. $line = Term::ANSIColor::colorstrip($line); @@ -644,7 +935,9 @@ foreach my $file (@ARGV) { } # Check if this line indicates a non verbose build. - my $non_verbose = is_non_verbose_build($line); + my $skip = 0; + $non_verbose |= is_non_verbose_build($line, \$skip); + next if $skip; # One line may contain multiple commands (";"). Treat each one as # single line. parse_line() is slow, only use it when necessary. @@ -683,7 +976,7 @@ foreach my $file (@ARGV) { # Ignore lines with no compiler commands. next if not $non_verbose - and not $line =~ /\b$cc_regex(?:\s|\\)/o; + and not $line =~ /$cc_regex_normal/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 @@ -698,15 +991,52 @@ foreach my $file (@ARGV) { 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; + /x; + next if $line =~ m{^\s*(?:-\s)?(?:HOST_)?(?:CC|CXX) + \s*=\s*$cc_regex_full + # optional compiler options, don't allow + # "everything" here to prevent false negatives + \s*(?:\s-\S+)*\s*$}xo; + # `moc-qt4`/`moc-qt5` contain '-I.../linux-g++' in their command + # line (or similar for other architectures) which gets recognized + # as a compiler line, but `moc-qt*` is only a preprocessor for Qt + # C++ files. No hardening flags are relevant during this step, + # thus ignore `moc-qt*` lines. The resulting files will be + # compiled in a separate step (and therefore checked). + next if $line =~ m{^\S+/bin/moc(?:-qt[45])? + \s.+\s + -I\S+/mkspecs/[a-z]+-g\++(?:-64)? + \s}x; + # Ignore false positives when the line contains only CC=gcc but no + # other gcc command. + if ($line =~ /(.*)CC=$cc_regex_full(.*)/o) { + my $before = $1; + my $after = $2; + 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. - $harden_pie = 1 if any_flags_used($line, @def_cflags_pie, @def_ldflags_pie); + $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; + push @input_nonverbose, $non_verbose; + push @input_number, $number if $option_line_numbers; } } @@ -725,10 +1055,10 @@ foreach my $file (@ARGV) { if (scalar @input == 0) { if (not $option_buildd) { print "No compiler commands!\n"; + $exit |= $exit_code{no_compiler_commands}; } else { - print "$buildd_tag{no_compiler_commands}\n"; + print "$buildd_tag{no_compiler_commands}||\n"; } - $exit |= $exit_code{no_compiler_commands}; next FILE; } @@ -738,23 +1068,44 @@ foreach my $file (@ARGV) { # 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. + # 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 , Guillem Jover + # , Kees Cook , 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 ($cpu =~ /^(?:ia64|alpha|mips|mipsel|hppa)$/ or $arch eq 'arm') { + if ($os !~ /^(?:linux|kfreebsd|knetbsd|hurd)$/ + or $cpu =~ /^(?:hppa|avr32)$/) { + $harden_pie = 0; + } + if ($cpu =~ /^(?:ia64|alpha|hppa|nios2)$/ or $arch eq 'arm') { $harden_stack = 0; + $harden_stack_strong = 0; } if ($cpu =~ /^(?:ia64|hppa|avr32)$/) { $harden_relro = 0; $harden_bindnow = 0; } + + if ($disable_harden_pie and exists $builtin_pie_arch{$arch}) { + $harden_pie = 0; + } } # Default values. @@ -768,7 +1119,10 @@ foreach my $file (@ARGV) { @cxxflags = (@cxxflags, @def_cflags_pie); @ldflags = (@ldflags, @def_ldflags_pie); } - if ($harden_stack) { + if ($harden_stack_strong) { + @cflags = (@cflags, @def_cflags_stack_strong); + @cxxflags = (@cxxflags, @def_cflags_stack_strong); + } elsif ($harden_stack) { @cflags = (@cflags, @def_cflags_stack); @cxxflags = (@cxxflags, @def_cflags_stack); } @@ -788,33 +1142,75 @@ foreach my $file (@ARGV) { @ldflags = (@ldflags, @def_ldflags_bindnow); } + # Ada doesn't support format hardening flags, see #680117 for more + # 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; + } + $ok; + } @cflags; + } + + # Hack to fix cppflags_fortify_broken() if --ignore-flag + # -D_FORTIFY_SOURCE=2 is used to ignore missing fortification. Only works + # as long as @def_cppflags_fortify contains only one variable. + if (scalar @def_cppflags_fortify == 0) { + $harden_fortify = 0; + } + + # Ignore flags for this arch if requested. + if ($arch and exists $option_ignore_arch_flag{$arch}) { + my @local_flag_refs = (\@cflags, \@cxxflags, \@cppflags, \@ldflags); + + remove_flags(\@local_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 (@option_ignore_line) { + foreach my $ignore (@ignore_line) { next LINE if $line =~ /$ignore/; } my $skip = 0; - if (is_non_verbose_build($line, $input[$i + 1], \$skip)) { + if ($input_nonverbose[$i] + 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}++; } - $exit |= $exit_code{non_verbose_build}; next; } - # Even if it's a verbose build, we might have to skip this line. + # Even if it's a verbose build, we might have to skip this line (see + # is_non_verbose_build()). next if $skip; + my $orig_line = $line; + # 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. + # the brace and similar characters at the line end. $line =~ s/['")]+$//; # Skip unnecessary tests when only preprocessing. @@ -860,31 +1256,60 @@ LINE: } # These file types require preprocessing. if (extension_found(\%extensions_preprocess, @extensions)) { - $preprocess = 1; + # Prevent false positives with "libtool: link: g++ -include test.h + # .." compiler lines. + if ($orig_line !~ /$libtool_link_regex/o) { + $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; + if (not $flag_preprocess) { + # 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 (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; + } + # No compilable extensions found, either linking or compiling + # header flags. + # + # If there are also no object files we are just compiling headers + # (.h -> .h.gch). Don't check for linker flags in this case. Due + # to our liberal checks for compiler lines, this also reduces the + # number of false positives considerably. + } elsif ($link + and not extension_found(\%extensions_object, @extensions)) { + $link = 0; } } + my $compile_cpp = 0; + my $restore_cflags = 0; # 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; + # Ada needs special CFLAGS, use them if only ada files are compiled. + } elsif ($ada + 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_noformat; } if ($option_buildd) { @@ -894,6 +1319,14 @@ LINE: $statistics{link}++ if $link; } + # Check if there are flags indicating a debug build. If that's true, + # skip the check for -O2. This prevents fortification, but that's fine + # for a debug build. + if (any_flags_used($line, @def_cflags_debug)) { + remove_flags([\@cflags], \%flag_renames, $def_cflags[1]); + remove_flags([\@cppflags], \%flag_renames, $def_cppflags_fortify[0]); + } + # Check hardening flags. my @missing; if ($compile and not all_flags_used($line, \@missing, @cflags) @@ -904,11 +1337,12 @@ LINE: # 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}++; } - $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 @@ -917,21 +1351,27 @@ LINE: # 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}++; } - $exit |= $exit_code{flags_missing}; } - if ($preprocess and not all_flags_used($line, \@missing, @cppflags) + if ($preprocess + and (not all_flags_used($line, \@missing, @cppflags) + # The fortify flag might be overwritten, detect that. + or ($harden_fortify + and cppflags_fortify_broken($line, \@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}++; } - $exit |= $exit_code{flags_missing}; } if ($link and not all_flags_used($line, \@missing, @ldflags) # Same here, -fPIC conflicts with -fPIE. @@ -939,11 +1379,17 @@ LINE: # 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}++; } - $exit |= $exit_code{flags_missing}; + } + + # Restore normal CFLAGS. + if ($restore_cflags) { + @cflags = @cflags_backup; } } } @@ -974,11 +1420,11 @@ if ($option_buildd) { } if (scalar @warning) { local $" = ', '; # array join string - print "$buildd_tag{flags_missing} @warning missing\n"; + print "$buildd_tag{flags_missing}|@warning missing|\n"; } if ($statistics{commands_nonverbose}) { - printf "$buildd_tag{non_verbose_build} %d (of %d) hidden\n", + printf "$buildd_tag{non_verbose_build}|%d (of %d) hidden|\n", $statistics{commands_nonverbose}, $statistics{commands}, } @@ -996,7 +1442,7 @@ 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 @@ -1004,8 +1450,17 @@ 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. +tools using dpkg-buildpackage like pbuilder or sbuild (which is used for the +official buildd build logs)) to help maintainers detect missing hardening +flags in their packages. + +Only gcc is detected as compiler at the moment. If other compilers support +hardening flags as well, please report them. + +If there's no output, no flags are missing and the build log is fine. + +See F for details about performed checks, auto-detection and +limitations. =head1 OPTIONS @@ -1033,32 +1488,55 @@ changes are in effect: =over 2 -=item +=item * Print tags instead of normal warnings, see L 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. +=item * + +Return exit code 0, unless there was a error (-I, -W messages don't count as +error). + =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 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. @@ -1100,6 +1578,8 @@ Normal usage, parse a single log file. blhc path/to/log/file +If there's no output, no flags are missing and the build log is fine. + Parse multiple log files. The exit code is ORed over all files. blhc path/to/directory/with/log/files/* @@ -1108,6 +1588,10 @@ 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. @@ -1122,6 +1606,13 @@ Use blhc with pbuilder. 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 @@ -1129,17 +1620,13 @@ which is displayed. =over 2 -=item - -B +=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) +=item B (summary of hidden lines) Build log contains lines which hide the real compiler flags. For example: @@ -1153,19 +1640,20 @@ 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) +=item B (summary of missing flags) CPPFLAGS, CFLAGS, CXXFLAGS, LDFLAGS missing. -=item - -B (version) +=item B (version) -=item +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. -B +=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). @@ -1203,6 +1691,11 @@ Missing hardening flags. Hardening wrapper detected, no tests performed. +=item B<32> + +Invalid CMake version used. See B under L for a detailed explanation. + =back =head1 AUTHOR @@ -1212,9 +1705,9 @@ 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 +=head1 LICENSE AND COPYRIGHT -Copyright (C) 2012 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