├── requirements.txt ├── img └── example.PNG ├── README.md ├── scan_spring.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | jawa 2 | -------------------------------------------------------------------------------- /img/example.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jfrog/jfrog-spring-tools/HEAD/img/example.PNG -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # spring-tools 2 | 3 | ### Overview 4 | 5 | The SpringShell (CVE-2022-22965) vulnerability may affect **some** web applications using Spring Framework, but requires a number of conditions to be exploitable. One specific condition which may be rather rare (and therefore render most applications non-exploitable in practice) is the existence of Spring endpoints which bind request parameters to a non-primitive (Java Bean) type. This tool can be used to scan **compiled** code and verify whether such endpoints exist in the codebase. 6 | 7 | Currently this alerts on all non-primitive arguments. As the precise list of vulnerable types becomes clearer, the tool will be updated. 8 | 9 | ------ 10 | 11 | ## Usage instructions 12 | 13 | ### `scan_spring.py` 14 | 15 | The tool requires Python 3. 16 | 17 | ##### Dependencies installation 18 | 19 | ``` 20 | pip install -r requirements.txt 21 | ``` 22 | 23 | ##### Usage 24 | 25 | ``` 26 | python scan_spring.py root-folder [-quiet] [-exclude folder1 folder2 ..] 27 | ``` 28 | 29 | or 30 | 31 | ``` 32 | python scan_spring.py root-archive [-quiet] [-exclude folder1 folder2 ..] 33 | ``` 34 | 35 | The tool will scan `root_folder` recursively for `.jar` and `.war` files; in each located archive the tool examines the `.class` files for methods annotated with `RequestMapping` / `GetMapping` /`PostMapping` etc., and reports the occurrence if the argument types of the method are not primitive. 36 | 37 | With `-quiet` flag, error messages (files not found/ archives failed to open/ password protected archives) are muted. 38 | 39 | Folders appearing after `-exclude` (optional) are skipped. 40 | 41 | example 42 | -------------------------------------------------------------------------------- /scan_spring.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | from collections import namedtuple 4 | from enum import Enum, IntEnum 5 | from zipfile import BadZipFile, ZipFile 6 | from tarfile import open as tar_open 7 | from tarfile import CompressionError, ReadError 8 | import zlib 9 | from io import BytesIO 10 | import struct 11 | from jawa.classloader import ClassFile 12 | 13 | RED = "\x1b[31m" 14 | GREEN = "\x1b[32m" 15 | YELLOW = "\x1b[33m" 16 | RESET_ALL = "\x1b[0m" 17 | 18 | ZIP_EXTENSIONS = {".jar", ".war", ".sar", ".ear", ".par", ".zip", ".apk"} 19 | TAR_EXTENSIONS = {".tar.gz", ".tar"} 20 | 21 | ANNOTATION_STRS = { 22 | b"annotation/RequestMapping", 23 | b"annotation/GetMapping", 24 | b"annotation/PostMapping", 25 | b"annotation/PutMapping", 26 | b"annotation/DeleteMapping", 27 | b"annotation/PatchMapping", 28 | } 29 | 30 | ANNOTATION_STRSs = {s.decode("utf-8") for s in ANNOTATION_STRS} 31 | 32 | ALLOWED_TYPES = { 33 | "java/lang/String", 34 | "boolean", 35 | "long", 36 | "int", 37 | "java/lang/CharSequence", 38 | "java/lang/Number", 39 | "java/time/temporal/Temporal", 40 | "java/time/DateTime", 41 | "java/util/ArrayList", 42 | "java/util/Locale", 43 | "java/net/URI", 44 | "java/net/URL", 45 | "org/springframework/web/context/request/NativeWebRequest", 46 | "org/springframework/web/context/request/WebRequest", 47 | "javax/servlet/http/HttpServletResponse", 48 | "javax/servlet/http/HttpServletRequest", 49 | "javax/servlet/http/HttpSession", 50 | "javax/servlet/http/PushBuilder", 51 | "java/security/Principal", 52 | "org/springframework/http/HttpMethod", 53 | "java/time/TimeZone", 54 | "java/time/ZoneId", 55 | "java/io/InputStream", 56 | "java/io/OutputStream", 57 | "java/io/Reader", 58 | "java/io/Writer", 59 | "java/util/Map", 60 | "org/springframework/ui/Model", 61 | "org/springframework/ui/ModelMap", 62 | } # TO BE UPDATED 63 | 64 | CLASSES_EXEMPTLIST = {"org/springframework/boot"} 65 | 66 | 67 | def get_annotation_constants(c): 68 | for const in c.constants: 69 | if hasattr(const, "value") and isinstance(const.value, str): 70 | if any( 71 | const.value.endswith(substr) or const.value.endswith(substr + ";") 72 | for substr in ANNOTATION_STRSs 73 | ): 74 | yield const.index 75 | 76 | 77 | def check_method_annotations(c, req_constants): 78 | for method in c.methods: 79 | for attr in method.attributes: 80 | if attr.name == "RuntimeVisibleAnnotations": 81 | index = struct.unpack(">H", attr.info[2:4])[0] 82 | if index in req_constants and method.args: 83 | yield (method.name.value, {arg.name for arg in method.args}) 84 | 85 | 86 | def examine_class(rel_path, file_name, content, silent_mode) -> bool: 87 | problem_found = False 88 | try: 89 | cl = ClassFile(BytesIO(content)) 90 | except: # IndexError, but I don't trust jawa not to throw someting else 91 | if not silent_mode: 92 | print("Could not open class: %s" % file_name) 93 | return False 94 | 95 | annotation_constants = list(get_annotation_constants(cl)) 96 | 97 | if not annotation_constants: 98 | return False 99 | 100 | for method_name, arg_type_names in check_method_annotations( 101 | cl, annotation_constants 102 | ): 103 | bad_arg_type_names = [ 104 | arg_type_name 105 | for arg_type_name in arg_type_names 106 | if arg_type_name not in ALLOWED_TYPES 107 | ] 108 | if bad_arg_type_names: 109 | problem_found = True 110 | print( 111 | "In %s/%s%s%s: endpoint method %s%s%s accepts %s\n\n" 112 | % ( 113 | rel_path, 114 | RED, 115 | file_name, 116 | RESET_ALL, 117 | RED, 118 | method_name, 119 | RESET_ALL, 120 | ", ".join(bad_arg_type_names), 121 | ) 122 | ) 123 | return problem_found 124 | 125 | 126 | def zip_file(file, rel_path: str, silent_mode: bool) -> bool: 127 | problem_found = False 128 | try: 129 | with ZipFile(file) as jarfile: 130 | for file_name in jarfile.namelist(): 131 | if acceptable_filename(file_name): 132 | with jarfile.open(file_name, "r") as next_file: 133 | problem_found |= test_file( 134 | next_file, os.path.join(rel_path, file_name), silent_mode 135 | ) 136 | continue 137 | if ( 138 | file_name.endswith(".class") 139 | and not file_name.endswith("module-info.class") 140 | and not any( 141 | file_name.startswith(exempt_class) 142 | for exempt_class in CLASSES_EXEMPTLIST 143 | ) 144 | ): 145 | content = jarfile.read(file_name) 146 | if any(substr in content for substr in ANNOTATION_STRS): 147 | problem_found |= examine_class( 148 | rel_path, file_name, content, silent_mode 149 | ) 150 | 151 | # went over all the files in the current layer; draw conclusions 152 | except (IOError, BadZipFile, UnicodeDecodeError, zlib.error, RuntimeError) as e: 153 | if not silent_mode: 154 | print(rel_path + ": " + str(e)) 155 | return problem_found 156 | 157 | 158 | def tar_file(file, rel_path: str, silent_mode: bool) -> bool: 159 | problem_found = False 160 | try: 161 | with tar_open(fileobj=file) as tarfile: 162 | for item in tarfile.getmembers(): 163 | if "../" in item.name: 164 | continue 165 | if item.isfile() and acceptable_filename(item.name): 166 | fileobj = tarfile.extractfile(item) 167 | new_path = rel_path + "/" + item.name 168 | problem_found |= test_file(fileobj, new_path, silent_mode) 169 | 170 | except ( 171 | IOError, 172 | FileExistsError, 173 | CompressionError, 174 | ReadError, 175 | RuntimeError, 176 | UnicodeDecodeError, 177 | zlib.error, 178 | ) as e: 179 | if not silent_mode: 180 | print(rel_path + ": " + str(e)) 181 | return False 182 | return problem_found 183 | 184 | 185 | def test_file(file, rel_path: str, silent_mode: bool) -> bool: 186 | if any(rel_path.endswith(ext) for ext in ZIP_EXTENSIONS): 187 | return zip_file(file, rel_path, silent_mode) 188 | 189 | elif any(rel_path.endswith(ext) for ext in TAR_EXTENSIONS): 190 | return tar_file(file, rel_path, silent_mode) 191 | return False 192 | 193 | def acceptable_filename(filename: str): 194 | return any(filename.endswith(ext) for ext in ZIP_EXTENSIONS | TAR_EXTENSIONS) 195 | 196 | 197 | def run_scanner(root_dir: str, exclude_dirs, silent_mode: bool) -> bool: 198 | problem_found = False 199 | if os.path.isdir(root_dir): 200 | for directory, dirs, files in os.walk(root_dir, topdown=True): 201 | [ 202 | dirs.remove(excluded_dir) 203 | for excluded_dir in list(dirs) 204 | if os.path.join(directory, excluded_dir) in exclude_dirs 205 | ] 206 | 207 | for filename in files: 208 | if acceptable_filename(filename): 209 | full_path = os.path.join(directory, filename) 210 | rel_path = os.path.relpath(full_path, root_dir) 211 | try: 212 | with open(full_path, "rb") as file: 213 | problem_found |= test_file(file, rel_path, silent_mode) 214 | except FileNotFoundError as fnf_error: 215 | if not silent_mode: 216 | print(fnf_error) 217 | elif os.path.isfile(root_dir): 218 | if acceptable_filename(root_dir): 219 | with open(root_dir, "rb") as file: 220 | if any(root_dir.endswith(ext) for ext in ZIP_EXTENSIONS): 221 | problem_found = zip_file(file, "", silent_mode) 222 | 223 | elif any(root_dir.endswith(ext) for ext in TAR_EXTENSIONS): 224 | problem_found = tar_file(file, "", silent_mode) 225 | return problem_found 226 | 227 | def print_usage(): 228 | print( 229 | "Usage: " 230 | + sys.argv[0] 231 | + " [-quiet] [-exclude ...]" 232 | ) 233 | print("or: " + sys.argv[0] + " [-quiet]") 234 | exit() 235 | 236 | 237 | def parse_command_line(): 238 | if len(sys.argv) < 2: 239 | print_usage() 240 | 241 | root_dir = sys.argv[1] 242 | exclude_folders = [] 243 | 244 | silent = len(sys.argv) > 2 and sys.argv[2] == "-quiet" 245 | exclude_start = 3 if silent else 2 246 | if len(sys.argv) > exclude_start: 247 | if not sys.argv[exclude_start] == "-exclude": 248 | print_usage() 249 | exclude_folders = sys.argv[exclude_start + 1 :] 250 | 251 | return root_dir, exclude_folders, silent 252 | 253 | 254 | if __name__ == "__main__": 255 | root_dir, exclude_dirs, silent_mode = parse_command_line() 256 | 257 | for dir_to_check in exclude_dirs: 258 | if not os.path.isdir(dir_to_check): 259 | print(dir_to_check + " is not a directory") 260 | print_usage() 261 | if not os.path.isdir(root_dir) and not ( 262 | os.path.isfile(root_dir) and acceptable_filename(root_dir) 263 | ): 264 | print(root_dir + " is not a directory or an archive") 265 | print_usage() 266 | 267 | print("Scanning " + root_dir) 268 | if exclude_dirs: 269 | print("Excluded: " + ", ".join(exclude_dirs)) 270 | 271 | problem_found = run_scanner(root_dir, set(exclude_dirs), silent_mode) 272 | if problem_found: 273 | sys.exit(1) 274 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. --------------------------------------------------------------------------------