├── screen.gif ├── __init__.py ├── .github └── workflows │ └── build.yml ├── README.md ├── plugin.json ├── teloader.py ├── headers ├── efi_pei_services_64.h └── efi_system_table_64.h ├── helper.py └── .pylintrc /screen.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zznop/bn-uefi-helper/HEAD/screen.gif -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- 1 | # pylint: disable=missing-docstring 2 | 3 | from binaryninja import PluginCommand 4 | from .helper import run_uefi_helper 5 | from .teloader import TerseExecutableView 6 | 7 | PluginCommand.register('UEFI Helper', 'Run UEFI Helper analysis', run_uefi_helper) 8 | TerseExecutableView.register() 9 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: pylint 2 | on: [push, pull_request] 3 | 4 | jobs: 5 | pylint: 6 | name: Python Lint 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v2 10 | 11 | - name: Install pylint 12 | run: pip install pylint 13 | 14 | - name: Run pylint 15 | run: pylint --reports=y --rcfile .pylintrc *.py 16 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bn-uefi-helper ![Python Lint](https://github.com/zznop/bn-uefi-helper/workflows/pylint/badge.svg) 2 | 3 | **ATTENTION: This plugin has been deprecated. See** [EFI Resolver](https://github.com/Vector35/efi-resolver.git) 4 | 5 | ## Description 6 | 7 | Helper plugin for analyzing UEFI firmware. This plugin contains the following features: 8 | 9 | * Apply the correct prototype to the entry point function 10 | * Fix segments so all segments are RWX and have the correct semantics 11 | * This allows for global function pointers to be rendered correctly 12 | * Apply types for core UEFI services (from EDK-II) 13 | * Locate known protocol GUIDs and assign the GUID type and a symbol 14 | * Locate global assigments in entry and initialization functions and assign types 15 | * `EFI_SYSTEM_TABLE`, `EFI_RUNTIME_SERVICES`, `EFI_BOOT_SERVICES`, etc... 16 | * Loader for Terse Executables 17 | 18 | ![demo bn-uefi-helper](screen.gif) 19 | 20 | ## Minimum Version 21 | 22 | Tested on 2.3.2660 23 | 24 | ## License 25 | 26 | This plugin is released under a MIT license. 27 | 28 | ## Related Projects 29 | 30 | * [ghidra-firmware-utils](https://github.com/al3xtjames/ghidra-firmware-utils) 31 | * [efiXplorer](https://github.com/binarly-io/efiXplorer) 32 | -------------------------------------------------------------------------------- /plugin.json: -------------------------------------------------------------------------------- 1 | { 2 | "pluginmetadataversion": 2, 3 | "name": "bn-uefi-helper", 4 | "author": "Brandon Miller (zznop)", 5 | "type": [ 6 | "helper" 7 | ], 8 | "api": [ 9 | "python3" 10 | ], 11 | "description": "Helper plugin for analyzing UEFI firmware", 12 | "longdescription": "", 13 | "license": { 14 | "name": "MIT", 15 | "text": "Copyright 2021 Brandon Miller (zznop)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE." 16 | }, 17 | "platforms": [ 18 | "Darwin", 19 | "Windows", 20 | "Linux" 21 | ], 22 | "installinstructions": { 23 | "Darwin": "", 24 | "Windows": "", 25 | "Linux": "" 26 | }, 27 | "version": "0.3", 28 | "minimumbinaryninjaversion": 2660 29 | } 30 | -------------------------------------------------------------------------------- /teloader.py: -------------------------------------------------------------------------------- 1 | """BinaryView for UEFI Terse Executables 2 | """ 3 | 4 | import glob 5 | import os 6 | import struct 7 | from binaryninja import BinaryView, platform, SegmentFlag, SectionSemantics, Symbol, SymbolType 8 | 9 | TERSE_IMAGE_HEADER_SIZE = 40 10 | SECTION_HEADER_SIZE = 40 11 | 12 | class TerseExecutableView(BinaryView): 13 | """This class implements the BinaryView for Terse Executables 14 | """ 15 | 16 | name = 'TE' 17 | long_name = 'Terse Executable' 18 | 19 | def __init__(self, data: bytes): 20 | BinaryView.__init__(self, parent_view=data, file_metadata=data.file) 21 | self.raw = data 22 | self.platform = None 23 | 24 | @classmethod 25 | def is_valid_for_data(cls, data: bytes) -> bool: 26 | """Determine if the loaded binary is a Terse Executable 27 | 28 | :param data: Raw binary data 29 | :return: True if the binary is a TE, otherwise False 30 | """ 31 | 32 | if data.length < TERSE_IMAGE_HEADER_SIZE: 33 | return False 34 | 35 | if data[0:2].decode('utf-8', 'replace') != 'VZ': 36 | return False 37 | 38 | return True 39 | 40 | def _set_platform(self, machine_type: int): 41 | """Set platform/architecture from machine type 42 | 43 | :param machine_type: Machine type from TE header 44 | """ 45 | 46 | if machine_type == 332: 47 | self.platform = platform.Platform['windows-x86'] 48 | elif machine_type == -31132: 49 | self.platform = platform.Platform['windows-x86_64'] 50 | elif machine_type == -21916: 51 | self.platform = platform.Platform['windows-aarch64'] 52 | 53 | def _create_segments(self, image_base: int, num_of_sections: int): 54 | """There's really only one segment in a TE and it's RWX. However, we set the header to read only jsut to make 55 | sure it isn't disassembled as code. 56 | 57 | :param image_base: Virtual base address 58 | :param num_of_sections: Number of sections (for header region size calculation) 59 | """ 60 | 61 | headers_size = TERSE_IMAGE_HEADER_SIZE + num_of_sections * SECTION_HEADER_SIZE 62 | self.add_auto_segment(image_base, headers_size, 0, headers_size, SegmentFlag.SegmentReadable) 63 | code_region_size = len(self.raw)-headers_size 64 | self.add_auto_segment(image_base+headers_size, code_region_size, headers_size, code_region_size, 65 | SegmentFlag.SegmentReadable|SegmentFlag.SegmentWritable|SegmentFlag.SegmentExecutable) 66 | 67 | def _create_sections(self, image_base: int, num_of_sections: int): 68 | """Create sections 69 | 70 | :param image_base: Virtual base address 71 | :param num_of_sections: Number of sections 72 | """ 73 | 74 | base = TERSE_IMAGE_HEADER_SIZE 75 | for _ in range(0, num_of_sections): 76 | name = self.raw[base:base+8].decode('utf-8') 77 | virtual_size = struct.unpack(' bool: 183 | """Terse Executables are executable, return true 184 | 185 | :return: True 186 | """ 187 | 188 | return True 189 | 190 | def perform_get_entry_point(self) -> int: 191 | """Determine the address of the entry point function 192 | 193 | :return: Address of the entry point 194 | """ 195 | image_base = struct.unpack(' str: 101 | """Check if the GUID is in guids.csv and if it is, return the name 102 | 103 | :param guid: GUID bytes 104 | :return str: Name of the GUID 105 | """ 106 | 107 | names_list = list(self.guids.keys()) 108 | guids_list = list(self.guids.values()) 109 | try: 110 | return names_list[guids_list.index(guid)] 111 | except ValueError: 112 | return None 113 | 114 | 115 | def _find_known_guids(self): 116 | """Search for known GUIDs and apply names to matches not within a function 117 | """ 118 | 119 | for seg in self.bv.segments: 120 | for i in range(seg.start, seg.end): 121 | self.br.seek(i) 122 | data = self.br.read(16) 123 | if not data or len(data) != 16: 124 | continue 125 | 126 | found_name = self._check_guid_and_get_name(data) 127 | if found_name: 128 | self._apply_guid_name_if_data(found_name, i) 129 | 130 | def _set_if_uefi_core_type(self, instr: HighLevelILInstruction): 131 | """Using HLIL, scrutinize the instruction to determine if it's a move of a local variable to a global variable. 132 | If it is, check if the source operand type is a UEFI core type and apply the type to the destination global 133 | variable. 134 | 135 | :param instr: High level IL instruction object 136 | """ 137 | 138 | if instr.operation != HighLevelILOperation.HLIL_ASSIGN: 139 | return 140 | 141 | if instr.dest.operation != HighLevelILOperation.HLIL_DEREF: 142 | return 143 | 144 | if instr.dest.src.operation != HighLevelILOperation.HLIL_CONST_PTR: 145 | return 146 | 147 | if instr.src.operation != HighLevelILOperation.HLIL_VAR: 148 | return 149 | 150 | _type = instr.src.var.type 151 | if len(_type.tokens) == 1 and str(_type.tokens[0]) == 'EFI_HANDLE': 152 | self.bv.define_user_symbol(Symbol(SymbolType.DataSymbol, instr.dest.src.constant, 'gHandle')) 153 | elif len(_type.tokens) > 2 and str(_type.tokens[2]) == 'EFI_BOOT_SERVICES': 154 | self.bv.define_user_symbol(Symbol(SymbolType.DataSymbol, instr.dest.src.constant, 'gBS')) 155 | self.gbs_assignments.append(instr.dest.src.constant) 156 | elif len(_type.tokens) > 2 and str(_type.tokens[2]) == 'EFI_RUNTIME_SERVICES': 157 | self.bv.define_user_symbol(Symbol(SymbolType.DataSymbol, instr.dest.src.constant, 'gRS')) 158 | elif len(_type.tokens) > 2 and str(_type.tokens[2]) == 'EFI_SYSTEM_TABLE': 159 | self.bv.define_user_symbol(Symbol(SymbolType.DataSymbol, instr.dest.src.constant, 'gST')) 160 | elif len(_type.tokens) == 1 and str(_type.tokens[0]) == 'EFI_PEI_FILE_HANDLE': 161 | self.bv.define_user_symbol(Symbol(SymbolType.DataSymbol, instr.dest.src.constant, 'gHandle')) 162 | elif len(_type.tokens) > 2 and str(_type.tokens[2]) == 'EFI_PEI_SERVICES': 163 | self.bv.define_user_symbol(Symbol(SymbolType.DataSymbol, instr.dest.src.constant, 'gPeiServices')) 164 | else: 165 | return 166 | 167 | self.bv.define_user_data_var(instr.dest.src.constant, instr.src.var.type) 168 | print(f'Found global assignment - offset:{hex(instr.dest.src.constant)} type:{instr.src.var.type}') 169 | 170 | def _check_and_prop_types_on_call(self, instr: HighLevelILInstruction): 171 | """Most UEFI modules don't assign globals in the entry function and instead call a initialization routine and 172 | pass the system table to it where global assignments are made. This function ensures that the types are applied 173 | to the initialization function params so that we can catch global assignments outside of the module entry 174 | 175 | :param instr: High level IL instruction object 176 | """ 177 | 178 | if instr.operation not in [HighLevelILOperation.HLIL_TAILCALL, HighLevelILOperation.HLIL_CALL]: 179 | return 180 | 181 | if instr.dest.operation != HighLevelILOperation.HLIL_CONST_PTR: 182 | return 183 | 184 | argv_is_passed = False 185 | for arg in instr.params: 186 | if any(typestr in str(arg) for typestr in ['ImageHandle', 'SystemTable', 'FileHandle', 'PeiServices']): 187 | argv_is_passed = True 188 | break 189 | 190 | if not argv_is_passed: 191 | return 192 | 193 | func = self.bv.get_function_at(instr.dest.constant) 194 | old = func.type 195 | call_args = instr.params 196 | new_params = [] 197 | for arg, param in zip(call_args, old.parameters): 198 | if hasattr(arg, 'var'): 199 | new_type = arg.var.type 200 | else: 201 | new_type = param.type 202 | new_type.confidence = 256 203 | new_params.append(FunctionParameter(new_type, param.name)) 204 | 205 | # TODO: this is a hack to account for odd behavior. func.type should be able to set directly to 206 | # Type.Function(...). However, during testing this isn't the case. I am only able to get it to work if I 207 | # set type to a string and update analysis. 208 | gross_hack = str( 209 | Type.function(old.return_value, new_params, old.calling_convention, 210 | old.has_variable_arguments, old.stack_adjustment) 211 | ).replace('(', '{}('.format(func.name)) 212 | try: 213 | func.type = gross_hack 214 | self.bv.update_analysis_and_wait() 215 | except SyntaxError: 216 | pass # BN can't parse int48_t and other types despite that it uses it. Ran into this from a sidt instruction 217 | 218 | def _set_global_variables(self): 219 | """On entry, UEFI modules usually set global variables for EFI_BOOT_SERVICES, EFI_RUNTIME_SERIVCES, and 220 | EFI_SYSTEM_TABLE. This function attempts to identify these assignments and apply types. 221 | """ 222 | 223 | func = self.bv.get_function_at(self.bv.entry_point) 224 | for block in func.high_level_il: 225 | for instr in block: 226 | self._check_and_prop_types_on_call(instr) 227 | 228 | for func in self.bv.functions: 229 | for block in func.high_level_il: 230 | for instr in block: 231 | self._set_if_uefi_core_type(instr) 232 | 233 | def _name_proto_from_guid(self, guid_addr: int, var_addr: int): 234 | """Read the GUID, look it up in guids.csv, and derive the var name from the GUID name 235 | 236 | :param guid_addr: Address of GUID 237 | :param var_addr: Address to create the symbol 238 | """ 239 | 240 | self.br.seek(guid_addr) 241 | guid = self.br.read(16) 242 | if len(guid) != 16: 243 | return 244 | 245 | name = self._check_guid_and_get_name(guid) 246 | if not name: 247 | return 248 | 249 | if name.endswith('Guid'): 250 | name = name.replace('Guid', '') 251 | print(f'Found {name} at {hex(var_addr)}') 252 | self.bv.define_user_symbol(Symbol(SymbolType.DataSymbol, var_addr, name)) 253 | 254 | def _name_protocol_var(self, instr: HighLevelILInstruction, guid_idx: int, proto_idx: int): 255 | """Set the global protocol variable name by analyzing the call to gBS->LocateProtocol, 256 | gBS->InstallMultipleProtocolInterfaces, or gBS->InstallProtocol 257 | 258 | :param instr: HLIL instruction 259 | :param guid_idx: Param index for the GUID pointer 260 | :param proto_idx: Param index for the protocol variable pointer 261 | """ 262 | 263 | # Get the largest param index and make sure it doesn't exceed the instruction param count 264 | param_indices = [guid_idx, proto_idx] 265 | param_indices.sort() 266 | if len(instr.params) < param_indices[-1]: 267 | return 268 | 269 | if instr.params[guid_idx].operation != HighLevelILOperation.HLIL_CONST_PTR: 270 | return 271 | 272 | if instr.params[proto_idx].operation != HighLevelILOperation.HLIL_CONST_PTR: 273 | return 274 | 275 | self._name_proto_from_guid(instr.params[guid_idx].constant, instr.params[proto_idx].constant) 276 | 277 | def _name_protocol_vars(self): 278 | """Iterate xref's for EFI_BOOT_SERVICES global variables, find calls to gBS->LocateProtocol and 279 | gBS->InstallMultipleProtocolInterfaces, and apply a name and type based on the GUID (if known) 280 | """ 281 | 282 | for assignment in self.gbs_assignments: 283 | for xref in self.bv.get_code_refs(assignment): 284 | funcs = self.bv.get_functions_containing(xref.address) 285 | if not funcs: 286 | continue 287 | 288 | for block in funcs[0].high_level_il: 289 | for instr in block: 290 | if instr.operation != HighLevelILOperation.HLIL_CALL: 291 | continue 292 | 293 | if instr.dest.operation != HighLevelILOperation.HLIL_DEREF_FIELD: 294 | continue 295 | 296 | # Could also use the structure offset or member index here 297 | if str(instr.dest).endswith('->LocateProtocol'): 298 | self._name_protocol_var(instr, 0, 2) 299 | elif str(instr.dest).endswith('->InstallMultipleProtocolInterfaces'): 300 | self._name_protocol_var(instr, 1, 2) 301 | elif str(instr.dest).endswith('->InstallProtocolInterface'): 302 | self._name_protocol_var(instr, 1, 3) 303 | 304 | def run(self): 305 | """Run the task in the background 306 | """ 307 | 308 | self.progress = "UEFI Helper: Fixing up segments, applying types, and searching for known GUIDs ..." 309 | self._fix_segments() 310 | self._import_types_from_headers() 311 | self._set_entry_point_prototype() 312 | self._find_known_guids() 313 | self.progress = "UEFI Helper: searching for global assignments for UEFI core services ..." 314 | self._set_global_variables() 315 | self.bv.update_analysis_and_wait() 316 | self.progress = "UEFI Helper: searching for global protocols ..." 317 | self._name_protocol_vars() 318 | print('UEFI Helper completed successfully!') 319 | 320 | def run_uefi_helper(bv: BinaryView): 321 | """Run UEFI helper utilities in the background 322 | 323 | :param bv: BinaryView 324 | """ 325 | 326 | task = UEFIHelper(bv) 327 | task.start() 328 | -------------------------------------------------------------------------------- /.pylintrc: -------------------------------------------------------------------------------- 1 | [MAIN] 2 | 3 | # Analyse import fallback blocks. This can be used to support both Python 2 and 4 | # 3 compatible code, which means that the block might have code that exists 5 | # only in one or another interpreter, leading to false positives when analysed. 6 | analyse-fallback-blocks=no 7 | 8 | # Clear in-memory caches upon conclusion of linting. Useful if running pylint 9 | # in a server-like mode. 10 | clear-cache-post-run=no 11 | 12 | # Load and enable all available extensions. Use --list-extensions to see a list 13 | # all available extensions. 14 | #enable-all-extensions= 15 | 16 | # In error mode, messages with a category besides ERROR or FATAL are 17 | # suppressed, and no reports are done by default. Error mode is compatible with 18 | # disabling specific errors. 19 | #errors-only= 20 | 21 | # Always return a 0 (non-error) status code, even if lint errors are found. 22 | # This is primarily useful in continuous integration scripts. 23 | #exit-zero= 24 | 25 | # A comma-separated list of package or module names from where C extensions may 26 | # be loaded. Extensions are loading into the active Python interpreter and may 27 | # run arbitrary code. 28 | extension-pkg-allow-list= 29 | 30 | # A comma-separated list of package or module names from where C extensions may 31 | # be loaded. Extensions are loading into the active Python interpreter and may 32 | # run arbitrary code. (This is an alternative name to extension-pkg-allow-list 33 | # for backward compatibility.) 34 | extension-pkg-whitelist= 35 | 36 | # Return non-zero exit code if any of these messages/categories are detected, 37 | # even if score is above --fail-under value. Syntax same as enable. Messages 38 | # specified are enabled, while categories only check already-enabled messages. 39 | fail-on= 40 | 41 | # Specify a score threshold under which the program will exit with error. 42 | fail-under=10 43 | 44 | # Interpret the stdin as a python script, whose filename needs to be passed as 45 | # the module_or_package argument. 46 | #from-stdin= 47 | 48 | # Files or directories to be skipped. They should be base names, not paths. 49 | ignore=CVS 50 | 51 | # Add files or directories matching the regular expressions patterns to the 52 | # ignore-list. The regex matches against paths and can be in Posix or Windows 53 | # format. Because '\\' represents the directory delimiter on Windows systems, 54 | # it can't be used as an escape character. 55 | ignore-paths= 56 | 57 | # Files or directories matching the regular expression patterns are skipped. 58 | # The regex matches against base names, not paths. The default value ignores 59 | # Emacs file locks 60 | ignore-patterns=^\.# 61 | 62 | # List of module names for which member attributes should not be checked 63 | # (useful for modules/projects where namespaces are manipulated during runtime 64 | # and thus existing member attributes cannot be deduced by static analysis). It 65 | # supports qualified module names, as well as Unix pattern matching. 66 | ignored-modules= 67 | 68 | # Python code to execute, usually for sys.path manipulation such as 69 | # pygtk.require(). 70 | #init-hook= 71 | 72 | # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the 73 | # number of processors available to use, and will cap the count on Windows to 74 | # avoid hangs. 75 | jobs=1 76 | 77 | # Control the amount of potential inferred values when inferring a single 78 | # object. This can help the performance when dealing with large functions or 79 | # complex, nested conditions. 80 | limit-inference-results=100 81 | 82 | # List of plugins (as comma separated values of python module names) to load, 83 | # usually to register additional checkers. 84 | load-plugins= 85 | 86 | # Pickle collected data for later comparisons. 87 | persistent=yes 88 | 89 | # Minimum Python version to use for version dependent checks. Will default to 90 | # the version used to run pylint. 91 | py-version=3.7 92 | 93 | # Discover python modules and packages in the file system subtree. 94 | recursive=no 95 | 96 | # Add paths to the list of the source roots. Supports globbing patterns. The 97 | # source root is an absolute path or a path relative to the current working 98 | # directory used to determine a package namespace for modules located under the 99 | # source root. 100 | source-roots= 101 | 102 | # When enabled, pylint would attempt to guess common misconfiguration and emit 103 | # user-friendly hints instead of false-positive error messages. 104 | suggestion-mode=yes 105 | 106 | # Allow loading of arbitrary C extensions. Extensions are imported into the 107 | # active Python interpreter and may run arbitrary code. 108 | unsafe-load-any-extension=no 109 | 110 | # In verbose mode, extra non-checker-related info will be displayed. 111 | #verbose= 112 | 113 | 114 | [BASIC] 115 | 116 | # Naming style matching correct argument names. 117 | argument-naming-style=snake_case 118 | 119 | # Regular expression matching correct argument names. Overrides argument- 120 | # naming-style. If left empty, argument names will be checked with the set 121 | # naming style. 122 | #argument-rgx= 123 | 124 | # Naming style matching correct attribute names. 125 | attr-naming-style=snake_case 126 | 127 | # Regular expression matching correct attribute names. Overrides attr-naming- 128 | # style. If left empty, attribute names will be checked with the set naming 129 | # style. 130 | #attr-rgx= 131 | 132 | # Bad variable names which should always be refused, separated by a comma. 133 | bad-names=foo, 134 | bar, 135 | baz, 136 | toto, 137 | tutu, 138 | tata 139 | 140 | # Bad variable names regexes, separated by a comma. If names match any regex, 141 | # they will always be refused 142 | bad-names-rgxs= 143 | 144 | # Naming style matching correct class attribute names. 145 | class-attribute-naming-style=any 146 | 147 | # Regular expression matching correct class attribute names. Overrides class- 148 | # attribute-naming-style. If left empty, class attribute names will be checked 149 | # with the set naming style. 150 | #class-attribute-rgx= 151 | 152 | # Naming style matching correct class constant names. 153 | class-const-naming-style=UPPER_CASE 154 | 155 | # Regular expression matching correct class constant names. Overrides class- 156 | # const-naming-style. If left empty, class constant names will be checked with 157 | # the set naming style. 158 | #class-const-rgx= 159 | 160 | # Naming style matching correct class names. 161 | class-naming-style=PascalCase 162 | 163 | # Regular expression matching correct class names. Overrides class-naming- 164 | # style. If left empty, class names will be checked with the set naming style. 165 | #class-rgx= 166 | 167 | # Naming style matching correct constant names. 168 | const-naming-style=UPPER_CASE 169 | 170 | # Regular expression matching correct constant names. Overrides const-naming- 171 | # style. If left empty, constant names will be checked with the set naming 172 | # style. 173 | #const-rgx= 174 | 175 | # Minimum line length for functions/classes that require docstrings, shorter 176 | # ones are exempt. 177 | docstring-min-length=-1 178 | 179 | # Naming style matching correct function names. 180 | function-naming-style=snake_case 181 | 182 | # Regular expression matching correct function names. Overrides function- 183 | # naming-style. If left empty, function names will be checked with the set 184 | # naming style. 185 | #function-rgx= 186 | 187 | # Good variable names which should always be accepted, separated by a comma. 188 | good-names=i, 189 | j, 190 | k, 191 | ex, 192 | Run, 193 | _ 194 | 195 | # Good variable names regexes, separated by a comma. If names match any regex, 196 | # they will always be accepted 197 | good-names-rgxs= 198 | 199 | # Include a hint for the correct naming format with invalid-name. 200 | include-naming-hint=no 201 | 202 | # Naming style matching correct inline iteration names. 203 | inlinevar-naming-style=any 204 | 205 | # Regular expression matching correct inline iteration names. Overrides 206 | # inlinevar-naming-style. If left empty, inline iteration names will be checked 207 | # with the set naming style. 208 | #inlinevar-rgx= 209 | 210 | # Naming style matching correct method names. 211 | method-naming-style=snake_case 212 | 213 | # Regular expression matching correct method names. Overrides method-naming- 214 | # style. If left empty, method names will be checked with the set naming style. 215 | #method-rgx= 216 | 217 | # Naming style matching correct module names. 218 | module-naming-style=snake_case 219 | 220 | # Regular expression matching correct module names. Overrides module-naming- 221 | # style. If left empty, module names will be checked with the set naming style. 222 | #module-rgx= 223 | 224 | # Colon-delimited sets of names that determine each other's naming style when 225 | # the name regexes allow several styles. 226 | name-group= 227 | 228 | # Regular expression which should only match function or class names that do 229 | # not require a docstring. 230 | no-docstring-rgx=^_ 231 | 232 | # List of decorators that produce properties, such as abc.abstractproperty. Add 233 | # to this list to register other decorators that produce valid properties. 234 | # These decorators are taken in consideration only for invalid-name. 235 | property-classes=abc.abstractproperty 236 | 237 | # Regular expression matching correct type alias names. If left empty, type 238 | # alias names will be checked with the set naming style. 239 | #typealias-rgx= 240 | 241 | # Regular expression matching correct type variable names. If left empty, type 242 | # variable names will be checked with the set naming style. 243 | #typevar-rgx= 244 | 245 | # Naming style matching correct variable names. 246 | variable-naming-style=snake_case 247 | 248 | # Regular expression matching correct variable names. Overrides variable- 249 | # naming-style. If left empty, variable names will be checked with the set 250 | # naming style. 251 | #variable-rgx= 252 | 253 | 254 | [CLASSES] 255 | 256 | # Warn about protected attribute access inside special methods 257 | check-protected-access-in-special-methods=no 258 | 259 | # List of method names used to declare (i.e. assign) instance attributes. 260 | defining-attr-methods=__init__, 261 | __new__, 262 | setUp, 263 | asyncSetUp, 264 | __post_init__ 265 | 266 | # List of member names, which should be excluded from the protected access 267 | # warning. 268 | exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit 269 | 270 | # List of valid names for the first argument in a class method. 271 | valid-classmethod-first-arg=cls 272 | 273 | # List of valid names for the first argument in a metaclass class method. 274 | valid-metaclass-classmethod-first-arg=mcs 275 | 276 | 277 | [DESIGN] 278 | 279 | # List of regular expressions of class ancestor names to ignore when counting 280 | # public methods (see R0903) 281 | exclude-too-few-public-methods= 282 | 283 | # List of qualified class names to ignore when counting class parents (see 284 | # R0901) 285 | ignored-parents= 286 | 287 | # Maximum number of arguments for function / method. 288 | max-args=5 289 | 290 | # Maximum number of attributes for a class (see R0902). 291 | max-attributes=7 292 | 293 | # Maximum number of boolean expressions in an if statement (see R0916). 294 | max-bool-expr=5 295 | 296 | # Maximum number of branch for function / method body. 297 | max-branches=12 298 | 299 | # Maximum number of locals for function / method body. 300 | max-locals=15 301 | 302 | # Maximum number of parents for a class (see R0901). 303 | max-parents=7 304 | 305 | # Maximum number of public methods for a class (see R0904). 306 | max-public-methods=20 307 | 308 | # Maximum number of return / yield for function / method body. 309 | max-returns=6 310 | 311 | # Maximum number of statements in function / method body. 312 | max-statements=50 313 | 314 | # Minimum number of public methods for a class (see R0903). 315 | min-public-methods=2 316 | 317 | 318 | [EXCEPTIONS] 319 | 320 | # Exceptions that will emit a warning when caught. 321 | overgeneral-exceptions=builtins.BaseException,builtins.Exception 322 | 323 | 324 | [FORMAT] 325 | 326 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. 327 | expected-line-ending-format= 328 | 329 | # Regexp for a line that is allowed to be longer than the limit. 330 | ignore-long-lines=^\s*(# )??$ 331 | 332 | # Number of spaces of indent required inside a hanging or continued line. 333 | indent-after-paren=4 334 | 335 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 336 | # tab). 337 | indent-string=' ' 338 | 339 | # Maximum number of characters on a single line. 340 | max-line-length=120 341 | 342 | # Maximum number of lines in a module. 343 | max-module-lines=1000 344 | 345 | # Allow the body of a class to be on the same line as the declaration if body 346 | # contains single statement. 347 | single-line-class-stmt=no 348 | 349 | # Allow the body of an if to be on the same line as the test if there is no 350 | # else. 351 | single-line-if-stmt=no 352 | 353 | 354 | [IMPORTS] 355 | 356 | # List of modules that can be imported at any level, not just the top level 357 | # one. 358 | allow-any-import-level= 359 | 360 | # Allow explicit reexports by alias from a package __init__. 361 | allow-reexport-from-package=no 362 | 363 | # Allow wildcard imports from modules that define __all__. 364 | allow-wildcard-with-all=no 365 | 366 | # Deprecated modules which should not be used, separated by a comma. 367 | deprecated-modules= 368 | 369 | # Output a graph (.gv or any supported image format) of external dependencies 370 | # to the given file (report RP0402 must not be disabled). 371 | ext-import-graph= 372 | 373 | # Output a graph (.gv or any supported image format) of all (i.e. internal and 374 | # external) dependencies to the given file (report RP0402 must not be 375 | # disabled). 376 | import-graph= 377 | 378 | # Output a graph (.gv or any supported image format) of internal dependencies 379 | # to the given file (report RP0402 must not be disabled). 380 | int-import-graph= 381 | 382 | # Force import order to recognize a module as part of the standard 383 | # compatibility libraries. 384 | known-standard-library= 385 | 386 | # Force import order to recognize a module as part of a third party library. 387 | known-third-party=enchant 388 | 389 | # Couples of modules and preferred modules, separated by a comma. 390 | preferred-modules= 391 | 392 | 393 | [LOGGING] 394 | 395 | # The type of string formatting that logging methods do. `old` means using % 396 | # formatting, `new` is for `{}` formatting. 397 | logging-format-style=old 398 | 399 | # Logging modules to check that the string format arguments are in logging 400 | # function parameter format. 401 | logging-modules=logging 402 | 403 | 404 | [MESSAGES CONTROL] 405 | 406 | # Only show warnings with the listed confidence levels. Leave empty to show 407 | # all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, 408 | # UNDEFINED. 409 | confidence=HIGH, 410 | CONTROL_FLOW, 411 | INFERENCE, 412 | INFERENCE_FAILURE, 413 | UNDEFINED 414 | 415 | # Disable the message, report, category or checker with the given id(s). You 416 | # can either give multiple identifiers separated by comma (,) or put this 417 | # option multiple times (only on the command line, not in the configuration 418 | # file where it should appear only once). You can also use "--disable=all" to 419 | # disable everything first and then re-enable specific checks. For example, if 420 | # you want to run only the similarities checker, you can use "--disable=all 421 | # --enable=similarities". If you want to run only the classes checker, but have 422 | # no Warning level messages displayed, use "--disable=all --enable=classes 423 | # --disable=W". 424 | disable=raw-checker-failed, 425 | bad-inline-option, 426 | locally-disabled, 427 | file-ignored, 428 | suppressed-message, 429 | useless-suppression, 430 | deprecated-pragma, 431 | use-symbolic-message-instead 432 | 433 | # Enable the message, report, category or checker with the given id(s). You can 434 | # either give multiple identifier separated by comma (,) or put this option 435 | # multiple time (only on the command line, not in the configuration file where 436 | # it should appear only once). See also the "--disable" option for examples. 437 | enable=c-extension-no-member 438 | 439 | 440 | [METHOD_ARGS] 441 | 442 | # List of qualified names (i.e., library.method) which require a timeout 443 | # parameter e.g. 'requests.api.get,requests.api.post' 444 | timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request 445 | 446 | 447 | [MISCELLANEOUS] 448 | 449 | # List of note tags to take in consideration, separated by a comma. 450 | notes=FIXME, 451 | XXX, 452 | TODO 453 | 454 | # Regular expression of note tags to take in consideration. 455 | notes-rgx= 456 | 457 | 458 | [REFACTORING] 459 | 460 | # Maximum number of nested blocks for function / method body 461 | max-nested-blocks=5 462 | 463 | # Complete name of functions that never returns. When checking for 464 | # inconsistent-return-statements if a never returning function is called then 465 | # it will be considered as an explicit return statement and no message will be 466 | # printed. 467 | never-returning-functions=sys.exit,argparse.parse_error 468 | 469 | 470 | [REPORTS] 471 | 472 | # Python expression which should return a score less than or equal to 10. You 473 | # have access to the variables 'fatal', 'error', 'warning', 'refactor', 474 | # 'convention', and 'info' which contain the number of messages in each 475 | # category, as well as 'statement' which is the total number of statements 476 | # analyzed. This score is used by the global evaluation report (RP0004). 477 | evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) 478 | 479 | # Template used to display messages. This is a python new-style format string 480 | # used to format the message information. See doc for all details. 481 | msg-template= 482 | 483 | # Set the output format. Available formats are text, parseable, colorized, json 484 | # and msvs (visual studio). You can also give a reporter class, e.g. 485 | # mypackage.mymodule.MyReporterClass. 486 | #output-format= 487 | 488 | # Tells whether to display a full report or only the messages. 489 | reports=no 490 | 491 | # Activate the evaluation score. 492 | score=yes 493 | 494 | 495 | [SIMILARITIES] 496 | 497 | # Comments are removed from the similarity computation 498 | ignore-comments=yes 499 | 500 | # Docstrings are removed from the similarity computation 501 | ignore-docstrings=yes 502 | 503 | # Imports are removed from the similarity computation 504 | ignore-imports=yes 505 | 506 | # Signatures are removed from the similarity computation 507 | ignore-signatures=yes 508 | 509 | # Minimum lines number of a similarity. 510 | min-similarity-lines=4 511 | 512 | 513 | [SPELLING] 514 | 515 | # Limits count of emitted suggestions for spelling mistakes. 516 | max-spelling-suggestions=4 517 | 518 | # Spelling dictionary name. No available dictionaries : You need to install 519 | # both the python package and the system dependency for enchant to work.. 520 | spelling-dict= 521 | 522 | # List of comma separated words that should be considered directives if they 523 | # appear at the beginning of a comment and should not be checked. 524 | spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: 525 | 526 | # List of comma separated words that should not be checked. 527 | spelling-ignore-words= 528 | 529 | # A path to a file that contains the private dictionary; one word per line. 530 | spelling-private-dict-file= 531 | 532 | # Tells whether to store unknown words to the private dictionary (see the 533 | # --spelling-private-dict-file option) instead of raising a message. 534 | spelling-store-unknown-words=no 535 | 536 | 537 | [STRING] 538 | 539 | # This flag controls whether inconsistent-quotes generates a warning when the 540 | # character used as a quote delimiter is used inconsistently within a module. 541 | check-quote-consistency=no 542 | 543 | # This flag controls whether the implicit-str-concat should generate a warning 544 | # on implicit string concatenation in sequences defined over several lines. 545 | check-str-concat-over-line-jumps=no 546 | 547 | 548 | [TYPECHECK] 549 | 550 | # List of decorators that produce context managers, such as 551 | # contextlib.contextmanager. Add to this list to register other decorators that 552 | # produce valid context managers. 553 | contextmanager-decorators=contextlib.contextmanager 554 | 555 | # List of members which are set dynamically and missed by pylint inference 556 | # system, and so shouldn't trigger E1101 when accessed. Python regular 557 | # expressions are accepted. 558 | generated-members= 559 | 560 | # Tells whether to warn about missing members when the owner of the attribute 561 | # is inferred to be None. 562 | ignore-none=yes 563 | 564 | # This flag controls whether pylint should warn about no-member and similar 565 | # checks whenever an opaque object is returned when inferring. The inference 566 | # can return multiple potential results while evaluating a Python object, but 567 | # some branches might not be evaluated, which results in partial inference. In 568 | # that case, it might be useful to still emit no-member and other checks for 569 | # the rest of the inferred objects. 570 | ignore-on-opaque-inference=yes 571 | 572 | # List of symbolic message names to ignore for Mixin members. 573 | ignored-checks-for-mixins=no-member, 574 | not-async-context-manager, 575 | not-context-manager, 576 | attribute-defined-outside-init 577 | 578 | # List of class names for which member attributes should not be checked (useful 579 | # for classes with dynamically set attributes). This supports the use of 580 | # qualified names. 581 | ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace 582 | 583 | # Show a hint with possible names when a member name was not found. The aspect 584 | # of finding the hint is based on edit distance. 585 | missing-member-hint=yes 586 | 587 | # The minimum edit distance a name should have in order to be considered a 588 | # similar match for a missing member name. 589 | missing-member-hint-distance=1 590 | 591 | # The total number of similar names that should be taken in consideration when 592 | # showing a hint for a missing member. 593 | missing-member-max-choices=1 594 | 595 | # Regex pattern to define which classes are considered mixins. 596 | mixin-class-rgx=.*[Mm]ixin 597 | 598 | # List of decorators that change the signature of a decorated function. 599 | signature-mutators= 600 | 601 | 602 | [VARIABLES] 603 | 604 | # List of additional names supposed to be defined in builtins. Remember that 605 | # you should avoid defining new builtins when possible. 606 | additional-builtins= 607 | 608 | # Tells whether unused global variables should be treated as a violation. 609 | allow-global-unused-variables=yes 610 | 611 | # List of names allowed to shadow builtins 612 | allowed-redefined-builtins= 613 | 614 | # List of strings which can identify a callback function by name. A callback 615 | # name must start or end with one of those strings. 616 | callbacks=cb_, 617 | _cb 618 | 619 | # A regular expression matching the name of dummy variables (i.e. expected to 620 | # not be used). 621 | dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ 622 | 623 | # Argument names that match this expression will be ignored. 624 | ignored-argument-names=_.*|^ignored_|^unused_ 625 | 626 | # Tells whether we should check for unused import in __init__ files. 627 | init-import=no 628 | 629 | # List of qualified module names which can have objects that can redefine 630 | # builtins. 631 | redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io 632 | 633 | disable=W0511, C0103, C0209, W0223, E0401, R0903 634 | --------------------------------------------------------------------------------