# BB Class inspired by ebuild.sh # # This class will test files after installation for certain # security issues and other kind of issues. # # Checks we do: # -Check the ownership and permissions # -Check the RUNTIME path for the $TMPDIR # -Check if .la files wrongly point to workdir # -Check if .pc files wrongly point to workdir # -Check if packages contains .debug directories or .so files # where they should be in -dev or -dbg # -Check if config.log contains traces to broken autoconf tests # # We need to have the scanelf utility as soon as # possible and this is contained within the pax-utils-native. # The package.bbclass can help us here. # inherit package PACKAGE_DEPENDS += "pax-utils-native desktop-file-utils-native" PACKAGEFUNCS += " do_package_qa " # # dictionary for elf headers # # feel free to add and correct. # # TARGET_OS TARGET_ARCH MACHINE, OSABI, ABIVERSION, Little Endian, 32bit? def package_qa_get_machine_dict(): return { "darwin9" : { "arm" : (40, 0, 0, True, True), }, "linux" : { "arm" : (40, 97, 0, True, True), "armeb": (40, 97, 0, False, True), "powerpc": (20, 0, 0, False, True), "i386": ( 3, 0, 0, True, True), "i486": ( 3, 0, 0, True, True), "i586": ( 3, 0, 0, True, True), "i686": ( 3, 0, 0, True, True), "x86_64": (62, 0, 0, True, False), "ia64": (50, 0, 0, True, False), "alpha": (36902, 0, 0, True, False), "hppa": (15, 3, 0, False, True), "m68k": ( 4, 0, 0, False, True), "mips": ( 8, 0, 0, False, True), "mipsel": ( 8, 0, 0, True, True), "s390": (22, 0, 0, False, True), "sh4": (42, 0, 0, True, True), "sparc": ( 2, 0, 0, False, True), }, "linux-uclibc" : { "arm" : ( 40, 97, 0, True, True), "armeb": ( 40, 97, 0, False, True), "powerpc": ( 20, 0, 0, False, True), "i386": ( 3, 0, 0, True, True), "i486": ( 3, 0, 0, True, True), "i586": ( 3, 0, 0, True, True), "i686": ( 3, 0, 0, True, True), "x86_64": ( 62, 0, 0, True, False), "mips": ( 8, 0, 0, False, True), "mipsel": ( 8, 0, 0, True, True), "avr32": (6317, 0, 0, False, True), "sh4": (42, 0, 0, True, True), }, "uclinux-uclibc" : { "bfin": ( 106, 0, 0, True, True), }, "linux-gnueabi" : { "arm" : (40, 0, 0, True, True), "armeb" : (40, 0, 0, False, True), }, "linux-uclibcgnueabi" : { "arm" : (40, 0, 0, True, True), "armeb" : (40, 0, 0, False, True), }, "linux-gnuspe" : { "powerpc": (20, 0, 0, False, True), }, "linux-uclibcspe" : { "powerpc": (20, 0, 0, False, True), }, } # Known Error classes # 0 - non dev contains .so # 1 - package contains a dangerous RPATH # 2 - package depends on debug package # 3 - non dbg contains .so # 4 - wrong architecture # 5 - .la contains installed=yes or reference to the workdir # 6 - .pc contains reference to /usr/include or workdir # 7 - the desktop file is not valid # 8 - .la contains reference to the workdir # 9 - LDFLAGS ignored # 10 - Build paths in binaries def package_qa_clean_path(path,d): """ Remove the common prefix from the path. In this case it is the TMPDIR""" return path.replace(bb.data.getVar('TMPDIR',d,True),"") def package_qa_make_fatal_error(error_class, name, path,d): """ decide if an error is fatal TODO: Load a whitelist of known errors """ return False return not error_class in [0, 5, 7, 8, 9] def package_qa_write_error(error_class, name, path, d): """ Log the error """ ERROR_NAMES =[ "non dev contains .so", "package contains RPATH", "package depends on debug package", "non dbg contains .debug", "wrong architecture", "evil hides inside the .la", "evil hides inside the .pc", "the desktop file is not valid", ".la contains reference to the workdir", "LDFLAGS ignored", "package contains reference to tmpdir paths", ] log_path = os.path.join( bb.data.getVar('T', d, True), "log.qa_package" ) f = file( log_path, "a+") print >> f, "%s, %s, %s" % \ (ERROR_NAMES[error_class], name, package_qa_clean_path(path,d)) f.close() logfile = bb.data.getVar('QA_LOGFILE', d, True) if logfile: p = bb.data.getVar('P', d, True) f = file( logfile, "a+") print >> f, "%s, %s, %s, %s" % \ (p, ERROR_NAMES[error_class], name, package_qa_clean_path(path,d)) f.close() def package_qa_handle_error(error_class, error_msg, name, path, d): fatal = package_qa_make_fatal_error(error_class, name, path, d) if fatal: bb.error("QA Issue: %s" % error_msg) else: # Use bb.warn here when it works bb.note("QA Issue: %s" % error_msg) package_qa_write_error(error_class, name, path, d) return not fatal def package_qa_check_rpath(file,name,d, elf): """ Check for dangerous RPATHs """ if not elf: return True sane = True scanelf = os.path.join(bb.data.getVar('STAGING_BINDIR_NATIVE',d,True),'scanelf') bad_dirs = [bb.data.getVar('TMPDIR', d, True) + "/work", bb.data.getVar('STAGING_DIR_TARGET', d, True)] bad_dir_test = bb.data.getVar('TMPDIR', d, True) if not os.path.exists(scanelf): bb.fatal("Can not check RPATH, scanelf (part of pax-utils-native) not found") if not bad_dirs[0] in bb.data.getVar('WORKDIR', d, True): bb.fatal("This class assumed that WORKDIR is ${TMPDIR}/work... Not doing any check") output = os.popen("%s -B -F%%r#F '%s'" % (scanelf,file)) txt = output.readline().split() for line in txt: for dir in bad_dirs: if dir in line: error_msg = "package %s contains bad RPATH %s in file %s" % (name, line, file) sane = sane + package_qa_handle_error(1, error_msg, name, file, d) return sane def package_qa_check_dev(path, name,d, elf): """ Check for ".so" library symlinks in non-dev packages """ sane = True if not name.endswith("-dev") and path.endswith(".so") and os.path.islink(path): error_msg = "non -dev package contains symlink .so: %s path '%s'" % \ (name, package_qa_clean_path(path,d)) sane = package_qa_handle_error(0, error_msg, name, path, d) return sane def package_qa_check_dbg(path, name,d, elf): """ Check for ".debug" files or directories outside of the dbg package """ sane = True if not "-dbg" in name: if '.debug' in path.split(os.path.sep): error_msg = "non debug package contains .debug directory: %s path %s" % \ (name, package_qa_clean_path(path,d)) sane = package_qa_handle_error(3, error_msg, name, path, d) return sane def package_qa_check_perm(path,name,d, elf): """ Check the permission of files """ sane = True return sane def package_qa_check_arch(path,name,d, elf): """ Check if archs are compatible """ if not elf: return True sane = True target_os = bb.data.getVar('TARGET_OS', d, True) target_arch = bb.data.getVar('TARGET_ARCH', d, True) # FIXME: Cross package confuse this check, so just skip them for s in ['cross', 'nativesdk', 'cross-canadian']: if bb.data.inherits_class(s, d): return True # avoid following links to /usr/bin (e.g. on udev builds) # we will check the files pointed to anyway... if os.path.islink(path): return True #if this will throw an exception, then fix the dict above (machine, osabi, abiversion, littleendian, bits32) \ = package_qa_get_machine_dict()[target_os][target_arch] # Check the architecture and endiannes of the binary if not machine == elf.machine(): error_msg = "Architecture did not match (%d to %d) on %s" % \ (machine, elf.machine(), package_qa_clean_path(path,d)) sane = package_qa_handle_error(4, error_msg, name, path, d) elif not littleendian == elf.isLittleEndian(): error_msg = "Endiannes did not match (%d to %d) on %s" % \ (littleendian, elf.isLittleEndian(), package_qa_clean_path(path,d)) sane = package_qa_handle_error(4, error_msg, name, path, d) return sane def package_qa_check_desktop(path, name, d, elf): """ Run all desktop files through desktop-file-validate. """ sane = True if path.endswith(".desktop"): desktop_file_validate = os.path.join(bb.data.getVar('STAGING_BINDIR_NATIVE',d,True),'desktop-file-validate') output = os.popen("%s %s" % (desktop_file_validate, path)) # This only produces output on errors for l in output: sane = package_qa_handle_error(7, l.strip(), name, path, d) return sane def package_qa_hash_style(path, name, d, elf): """ Check if the binary has the right hash style... """ if not elf: return True if os.path.islink(path): return True gnu_hash = "--hash-style=gnu" in bb.data.getVar('LDFLAGS', d, True) if not gnu_hash: gnu_hash = "--hash-style=both" in bb.data.getVar('LDFLAGS', d, True) if not gnu_hash: return True objdump = bb.data.getVar('OBJDUMP', d, True) env_path = bb.data.getVar('PATH', d, True) sane = True elf = False # A bit hacky. We do not know if path is an elf binary or not # we will search for 'NEEDED' or 'INIT' as this should be printed... # and come before the HASH section (guess!!!) and works on split out # debug symbols too for line in os.popen("LC_ALL=C PATH=%s %s -p '%s' 2> /dev/null" % (env_path, objdump, path), "r"): if "NEEDED" in line or "INIT" in line: sane = False elf = True if "GNU_HASH" in line: sane = True if "[mips32]" in line or "[mips64]" in line: sane = True if elf and not sane: error_msg = "No GNU_HASH in the elf binary: '%s'" % path return package_qa_handle_error(9, error_msg, name, path, d) return True def package_qa_check_buildpaths(path, name, d, elf): """ Check for build paths inside target files and error if not found in the whitelist """ sane = True # Ignore .debug files, not interesting if path.find(".debug") != -1: return True # Ignore symlinks if os.path.islink(path): return True tmpdir = bb.data.getVar('TMPDIR', d, True) file_content = open(path).read() if tmpdir in file_content: error_msg = "File %s in package contained reference to tmpdir" % package_qa_clean_path(path,d) sane = package_qa_handle_error(10, error_msg, name, path, d) return sane def package_qa_check_license(workdir, d): """ Check for changes in the license files """ import tempfile sane = True lic_files = bb.data.getVar('LIC_FILES_CHKSUM', d, True) pn = bb.data.getVar('PN', d, True) if not lic_files: # just throw a warning now. Once licensing data in entered for enough of the recipes, # this will be converted into error and False will be returned. bb.warn(pn + ": Recipe file does not have license file information (LIC_FILES_CHKSUM)") return True srcdir = bb.data.getVar('S', d, True) for url in lic_files.split(): (type, host, path, user, pswd, parm) = bb.decodeurl(url) srclicfile = os.path.join(srcdir, path) if not os.path.isfile(srclicfile): raise bb.build.FuncFailed( "LIC_FILES_CHKSUM points to invalid file: " + path) if 'md5' not in parm: bb.error("md5 checksum is not specified for ", url) return False beginline, endline = 0, 0 if 'beginline' in parm: beginline = int(parm['beginline']) if 'endline' in parm: endline = int(parm['endline']) if (not beginline) and (not endline): md5chksum = bb.utils.md5_file(srclicfile) else: fi = open(srclicfile, 'r') fo = tempfile.NamedTemporaryFile(mode='wb', prefix='poky.', suffix='.tmp', delete=False) tmplicfile = fo.name; lineno = 0 linesout = 0 for line in fi: lineno += 1 if (lineno >= beginline): if ((lineno <= endline) or not endline): fo.write(line) linesout += 1 else: break fo.flush() fo.close() fi.close() md5chksum = bb.utils.md5_file(tmplicfile) os.unlink(tmplicfile) if parm['md5'] == md5chksum: bb.note ("md5 checksum matched for ", url) else: bb.error ("md5 data is not matching for ", url) bb.note ("The new md5 checksum is ", md5chksum) bb.note ("Check if the license information has changed, and if it has update the .bb file with correct license") sane = False return sane def package_qa_check_staged(path,d): """ Check staged la and pc files for sanity -e.g. installed being false As this is run after every stage we should be able to find the one responsible for the errors easily even if we look at every .pc and .la file """ sane = True tmpdir = bb.data.getVar('TMPDIR', d, True) workdir = os.path.join(tmpdir, "work") installed = "installed=yes" if bb.data.inherits_class("native", d) or bb.data.inherits_class("cross", d): pkgconfigcheck = workdir else: pkgconfigcheck = tmpdir # find all .la and .pc files # read the content # and check for stuff that looks wrong for root, dirs, files in os.walk(path): for file in files: path = os.path.join(root,file) if file.endswith(".la"): file_content = open(path).read() # Don't check installed status for native/cross packages if not bb.data.inherits_class("native", d) and not bb.data.inherits_class("cross", d): if installed in file_content: error_msg = "%s failed sanity test (installed) in path %s" % (file,root) sane = package_qa_handle_error(5, error_msg, "staging", path, d) if workdir in file_content: error_msg = "%s failed sanity test (workdir) in path %s" % (file,root) sane = package_qa_handle_error(8, error_msg, "staging", path, d) elif file.endswith(".pc"): file_content = open(path).read() if pkgconfigcheck in file_content: error_msg = "%s failed sanity test (tmpdir) in path %s" % (file,root) sane = package_qa_handle_error(6, error_msg, "staging", path, d) return sane # Walk over all files in a directory and call func def package_qa_walk(path, funcs, package,d): import oe.qa #if this will throw an exception, then fix t2014-03-05ppp: upgrade to 2.4.6Hongxu Jia 2014-02-28autotools-brokensep: Mark recipes with broken separate build dir supportRichard Purdie 2014-02-02Revert "Add missing RDEPENDS of initscripts-functions"Chen Qi 2014-01-06Add missing RDEPENDS of initscripts-functionsChen Qi 2014-01-02Replace one-line DESCRIPTION with SUMMARYPaul Eggleton 2013-11-08ppp: Fix compilation errors in MakefileLu Chong 2013-11-04ppp: Add two structures in if_pppol2tp.hLu Chong 2013-06-10PPP: add default configuration file and fix hard-coded CFLAGSRoy.Li 2012-07-28ppp: bump PR to rebuild against libpcap1 instead libpcapMartin Jansa 2012-05-24ppp: avoid host contaminationAndreas Oberritter 2012-03-24PPP: Remove leftover reference to "nylon" distro from PPP recipe.Robert P. J. Day 2012-03-23ppp: drop unneeded pkg-postinstAndreas Oberritter 2012-03-13ppp: Clean up PACKAGES vs. variable mismatch and drop unused RDEPENDSRichard Purdie 2012-03-13ppp: Fix unpackaged files warningsRichard Purdie 2012-02-23ppp: Fix rp-pppoe plugin compilationYauhen Kharuzhy 2011-07-01ppp: sync packaging with OE .devKoen Kooi 2011-05-27License Field Cleanup: Non-standard field namesBeth Flanagan 2011-05-04Remove distro-specific metadata for distros not in oe-corePaul Eggleton 2010-12-09SRC_URI Checksums AdditionalsSaul Wold 2010-10-11recipes-connectivity: Cleanup package descriptions and summariesMark Hatle 2010-09-01packages: Separate out most of the remaining packages into recipesRichard Purdie