git / moonbite-core / contrib/devtools/symbol-check.py · raw
#!/usr/bin/env python3# Copyright (c) 2014 Wladimir J. van der Laan# Distributed under the MIT software license, see the accompanying# file COPYING or http://www.opensource.org/licenses/mit-license.php.'''A script to check that the executables produced by gitian only containcertain symbols and are only linked against allowed libraries.Example usage: find ../gitian-builder/build -type f -executable | xargs python3 contrib/devtools/symbol-check.py'''import subprocessimport reimport sysimport osfrom typing import List, Optional, Tuple# Debian 8 (Jessie) EOL: 2020. https://wiki.debian.org/DebianReleases#Production_Releases## - g++ version 4.9.2 (https://packages.debian.org/search?suite=jessie&arch=any&searchon=names&keywords=g%2B%2B)# - libc version 2.19 (https://packages.debian.org/search?suite=jessie&arch=any&searchon=names&keywords=libc6)## Ubuntu 16.04 (Xenial) EOL: 2024. https://wiki.ubuntu.com/Releases## - g++ version 5.3.1 (https://packages.ubuntu.com/search?keywords=g%2B%2B&searchon=names&suite=xenial§ion=all)# - libc version 2.23.0 (https://packages.ubuntu.com/search?keywords=libc6&searchon=names&suite=xenial§ion=all)## CentOS 7 EOL: 2024. https://wiki.centos.org/FAQ/General## - g++ version 4.8.5 (http://mirror.centos.org/centos/7/os/x86_64/Packages/)# - libc version 2.17 (http://mirror.centos.org/centos/7/os/x86_64/Packages/)## Taking the minimum of these as our target.## According to GNU ABI document (https://gcc.gnu.org/onlinedocs/libstdc++/manual/abi.html) this corresponds to:# GCC 4.8.5: GCC_4.8.0# (glibc) GLIBC_2_17#MAX_VERSIONS = {'GCC': (4,8,0),'GLIBC': (2,17),'LIBATOMIC': (1,0)}# See here for a description of _IO_stdin_used:# https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=634261#109# Ignore symbols that are exported as part of every executableIGNORE_EXPORTS = {'_edata', '_end', '__end__', '_init', '__bss_start', '__bss_start__', '_bss_end__', '__bss_end__', '_fini', '_IO_stdin_used', 'stdin', 'stdout', 'stderr','environ', '_environ', '__environ',}READELF_CMD = os.getenv('READELF', '/usr/bin/readelf')CPPFILT_CMD = os.getenv('CPPFILT', '/usr/bin/c++filt')OBJDUMP_CMD = os.getenv('OBJDUMP', '/usr/bin/objdump')OTOOL_CMD = os.getenv('OTOOL', '/usr/bin/otool')# Allowed NEEDED librariesELF_ALLOWED_LIBRARIES = {# bitcoind and bitcoin-qt'libgcc_s.so.1', # GCC base support'libc.so.6', # C library'libpthread.so.0', # threading'libm.so.6', # math library'librt.so.1', # real-time (clock)'libatomic.so.1','ld-linux-x86-64.so.2', # 64-bit dynamic linker'ld-linux.so.2', # 32-bit dynamic linker'ld-linux-aarch64.so.1', # 64-bit ARM dynamic linker'ld-linux-armhf.so.3', # 32-bit ARM dynamic linker'ld-linux-riscv64-lp64d.so.1', # 64-bit RISC-V dynamic linker# bitcoin-qt only'libxcb.so.1', # part of X11'libfontconfig.so.1', # font support'libfreetype.so.6', # font parsing'libdl.so.2' # programming interface to dynamic linker}ARCH_MIN_GLIBC_VER = {'80386': (2,1),'X86-64': (2,2,5),'ARM': (2,4),'AArch64':(2,17),'RISC-V': (2,27)}MACHO_ALLOWED_LIBRARIES = {# bitcoind and bitcoin-qt'libc++.1.dylib', # C++ Standard Library'libSystem.B.dylib', # libc, libm, libpthread, libinfo# bitcoin-qt only'AppKit', # user interface'ApplicationServices', # common application tasks.'Carbon', # deprecated c back-compat API'CoreFoundation', # low level func, data types'CoreGraphics', # 2D rendering'CoreServices', # operating system services'CoreText', # interface for laying out text and handling fonts.'Foundation', # base layer functionality for apps/frameworks'ImageIO', # read and write image file formats.'IOKit', # user-space access to hardware devices and drivers.'libobjc.A.dylib', # Objective-C runtime library'Security',}PE_ALLOWED_LIBRARIES = {'ADVAPI32.dll', # security & registry'IPHLPAPI.DLL', # IP helper API'KERNEL32.dll', # win32 base APIs'msvcrt.dll', # C standard library for MSVC'SHELL32.dll', # shell API'USER32.dll', # user interface'WS2_32.dll', # sockets# bitcoin-qt only'dwmapi.dll', # desktop window manager'GDI32.dll', # graphics device interface'IMM32.dll', # input method editor'ole32.dll', # component object model'OLEAUT32.dll', # OLE Automation API'SHLWAPI.dll', # light weight shell API'UxTheme.dll','VERSION.dll', # version checking'WINMM.dll', # WinMM audio API}class CPPFilt(object): ''' Demangle C++ symbol names. Use a pipe to the 'c++filt' command. ''' def __init__(self): self.proc = subprocess.Popen(CPPFILT_CMD, stdin=subprocess.PIPE, stdout=subprocess.PIPE, universal_newlines=True) def __call__(self, mangled): self.proc.stdin.write(mangled + '\n') self.proc.stdin.flush() return self.proc.stdout.readline().rstrip() def close(self): self.proc.stdin.close() self.proc.stdout.close() self.proc.wait()def read_symbols(executable, imports=True) -> List[Tuple[str, str, str]]: ''' Parse an ELF executable and return a list of (symbol,version, arch) tuples for dynamic, imported symbols. ''' p = subprocess.Popen([READELF_CMD, '--dyn-syms', '-W', '-h', executable], stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE, universal_newlines=True) (stdout, stderr) = p.communicate() if p.returncode: raise IOError('Could not read symbols for {}: {}'.format(executable, stderr.strip())) syms = [] for line in stdout.splitlines(): line = line.split() if 'Machine:' in line: arch = line[-1] if len(line)>7 and re.match('[0-9]+:$', line[0]): (sym, _, version) = line[7].partition('@') is_import = line[6] == 'UND' if version.startswith('@'): version = version[1:] if is_import == imports: syms.append((sym, version, arch)) return symsdef check_version(max_versions, version, arch) -> bool: if '_' in version: (lib, _, ver) = version.rpartition('_') else: lib = version ver = '0' ver = tuple([int(x) for x in ver.split('.')]) if not lib in max_versions: return False return ver <= max_versions[lib] or lib == 'GLIBC' and ver <= ARCH_MIN_GLIBC_VER[arch]def elf_read_libraries(filename) -> List[str]: p = subprocess.Popen([READELF_CMD, '-d', '-W', filename], stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE, universal_newlines=True) (stdout, stderr) = p.communicate() if p.returncode: raise IOError('Error opening file') libraries = [] for line in stdout.splitlines(): tokens = line.split() if len(tokens)>2 and tokens[1] == '(NEEDED)': match = re.match(r'^Shared library: \[(.*)\]$', ' '.join(tokens[2:])) if match: libraries.append(match.group(1)) else: raise ValueError('Unparseable (NEEDED) specification') return librariesdef check_imported_symbols(filename) -> bool: cppfilt = CPPFilt() ok = True for sym, version, arch in read_symbols(filename, True): if version and not check_version(MAX_VERSIONS, version, arch): print('{}: symbol {} from unsupported version {}'.format(filename, cppfilt(sym), version)) ok = False return okdef check_exported_symbols(filename) -> bool: cppfilt = CPPFilt() ok = True for sym,version,arch in read_symbols(filename, False): if arch == 'RISC-V' or sym in IGNORE_EXPORTS: continue print('{}: export of symbol {} not allowed'.format(filename, cppfilt(sym))) ok = False return okdef check_ELF_libraries(filename) -> bool: ok = True for library_name in elf_read_libraries(filename): if library_name not in ELF_ALLOWED_LIBRARIES: print('{}: NEEDED library {} is not allowed'.format(filename, library_name)) ok = False return okdef macho_read_libraries(filename) -> List[str]: p = subprocess.Popen([OTOOL_CMD, '-L', filename], stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE, universal_newlines=True) (stdout, stderr) = p.communicate() if p.returncode: raise IOError('Error opening file') libraries = [] for line in stdout.splitlines(): tokens = line.split() if len(tokens) == 1: # skip executable name continue libraries.append(tokens[0].split('/')[-1]) return librariesdef check_MACHO_libraries(filename) -> bool: ok = True for dylib in macho_read_libraries(filename): if dylib not in MACHO_ALLOWED_LIBRARIES: print('{} is not in ALLOWED_LIBRARIES!'.format(dylib)) ok = False return okdef pe_read_libraries(filename) -> List[str]: p = subprocess.Popen([OBJDUMP_CMD, '-x', filename], stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE, universal_newlines=True) (stdout, stderr) = p.communicate() if p.returncode: raise IOError('Error opening file') libraries = [] for line in stdout.splitlines(): if 'DLL Name:' in line: tokens = line.split(': ') libraries.append(tokens[1]) return librariesdef check_PE_libraries(filename) -> bool: ok = True for dylib in pe_read_libraries(filename): if dylib not in PE_ALLOWED_LIBRARIES: print('{} is not in ALLOWED_LIBRARIES!'.format(dylib)) ok = False return okCHECKS = {'ELF': [ ('IMPORTED_SYMBOLS', check_imported_symbols), ('EXPORTED_SYMBOLS', check_exported_symbols), ('LIBRARY_DEPENDENCIES', check_ELF_libraries)],'MACHO': [ ('DYNAMIC_LIBRARIES', check_MACHO_libraries)],'PE' : [ ('DYNAMIC_LIBRARIES', check_PE_libraries)]}def identify_executable(executable) -> Optional[str]: with open(filename, 'rb') as f: magic = f.read(4) if magic.startswith(b'MZ'): return 'PE' elif magic.startswith(b'\x7fELF'): return 'ELF' elif magic.startswith(b'\xcf\xfa'): return 'MACHO' return Noneif __name__ == '__main__': retval = 0 for filename in sys.argv[1:]: try: etype = identify_executable(filename) if etype is None: print('{}: unknown format'.format(filename)) retval = 1 continue failed = [] for (name, func) in CHECKS[etype]: if not func(filename): failed.append(name) if failed: print('{}: failed {}'.format(filename, ' '.join(failed))) retval = 1 except IOError: print('{}: cannot open'.format(filename)) retval = 1 sys.exit(retval)