]> ruderich.org/simon Gitweb - blhc/blhc.git/commitdiff
README: Explain hardening flags.
authorSimon Ruderich <simon@ruderich.org>
Fri, 13 Apr 2012 13:51:10 +0000 (15:51 +0200)
committerSimon Ruderich <simon@ruderich.org>
Fri, 13 Apr 2012 13:52:05 +0000 (15:52 +0200)
README

diff --git a/README b/README
index a2adcb8adb761092146c17ee0b2b7350a9a04269..08b6879401ddd67b2c8abf9261d220c7b1ee9e0b 100644 (file)
--- a/README
+++ b/README
@@ -4,12 +4,20 @@ README
 blhc (build log hardening check) is a small tool which checks build logs for
 missing hardening flags. It's licensed under the GPL 3 or later.
 
+Hardening flags enable additional security features in the compiler to prevent
+e.g. stack overflows, format string vulnerabilities, GOT overwrites, etc.
+
+Because most build systems are quite complicated there are many places where
+compiler flags from the environment might be ignored. The parser verifies that
+all compiler commands use the correct hardening flags and thus all hardening
+features are correctly used.
+
 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.
 
 At the moment it works only on Debian and derivatives but it should be easily
-extendable for other systems as well.
+extendable to other systems as well. Patches are welcome.
 
 For more information about hardening flags have a look at [1].