├── .gitignore ├── LICENSE ├── README.md └── keysword.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /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 2019 Mike Mackintosh 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. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Keysword 2 | Automated method of retrieving Filevault2 keys from JAMF 3 | 4 | ### Usage: 5 | 6 | There are two search methods for returning a filevault key, using a computer ID or a computer name: 7 | 8 | python3 keysword.py -id 9 | python3 keysword.py -name 10 | 11 | ### Configuring 12 | 13 | There are three fields required to be exported in your environment in order to authenticate: 14 | 15 | - `JAMF_HOST`: Should be the URL to the JAMF host, ex: `https://examplejss.com` 16 | - `JAMF_USERNAME`: Should be the username to the JAMF host 17 | - `JAMF_PASSWORD`: Should be the password to the JAMF host 18 | 19 | Additionally, there is a dependency on the `requests` library, simply use pip or [pipenv](http://pipenv.org/) to install: 20 | 21 | ``` {.sourceCode .bash} 22 | $ pip install requests 23 | ``` 24 | -------------------------------------------------------------------------------- /keysword.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | Keysword is a utility for extracting Filevault2 keys from JAMF JSS 5 | ~~~~~~~~~~~~ 6 | This module implements the Requests API. 7 | :copyright: (c) 2019 by Mike Mackintosh. 8 | :license: Apache2, see LICENSE for more details. 9 | """ 10 | 11 | import requests 12 | from http.cookiejar import CookieJar 13 | import argparse 14 | import re 15 | from os import getenv 16 | from xml.dom.minidom import parseString 17 | 18 | __VERSION__ = "1.0" 19 | 20 | JAMF_HOST = getenv("JAMF_HOST") 21 | JAMF_USERNAME = getenv("JAMF_USERNAME") 22 | JAMF_PASSWORD = getenv("JAMF_PASSWORD") 23 | 24 | """ 25 | getComputerID 26 | ------------- 27 | Converts a computer name to a computer ID using the JAMF API 28 | :param name string 29 | :return id string 30 | """ 31 | def getComputerID(name): 32 | auth = requests.auth.HTTPBasicAuth(JAMF_USERNAME, JAMF_PASSWORD) 33 | headers = {"Accept": "application/json"} 34 | resp = requests.get("{}/JSSResource/computers/name/{}".format(JAMF_HOST, name), auth=auth, headers=headers) 35 | 36 | # TODO: add error checking here 37 | return resp.json()["computer"]["general"]["id"] 38 | 39 | 40 | """ 41 | getSessionToken 42 | ------------- 43 | Gets a session token from the legacy pages to get access to the ajax API 44 | :param s requests.Session 45 | :param jar cookie jar 46 | :param id 47 | :return token string 48 | """ 49 | def getSessionToken(s, jar, id): 50 | resp = s.post('{}/?failover'.format(JAMF_HOST), cookies=jar, data={'username':JAMF_USERNAME, 'password':JAMF_PASSWORD, 'resetUsername':''}) 51 | if resp.status_code != 200: 52 | print("Look's like you failed to authenticate") 53 | exit(1) 54 | 55 | params = {"id": id, "o": "r", "v": "inventory"} 56 | resp = s.get('{}/legacy/computers.html'.format(JAMF_HOST), params=params, cookies=jar) 57 | if resp.status_code == 404: 58 | print("No device for that ID") 59 | exit() 60 | session_token = "" 61 | 62 | # TODO: add error checking here 63 | for line in resp.content.splitlines(): 64 | linestr = str(line) 65 | if "session-token" in linestr: 66 | replaced = str(linestr.encode('utf-8')).replace('<', "").replace('>', "").replace('"', "").replace('\\', "").replace("'", "") 67 | return replaced.split('=')[-1] 68 | 69 | 70 | """ 71 | getFilevaultKeyID 72 | ------------- 73 | Gets the Filevault key ID stored on the legacy computers.html 74 | :param s requests.Session 75 | :param jar cookie jar 76 | :param id 77 | :return token string 78 | """ 79 | def getFilevaultKeyID(s, jar, id): 80 | params = {"id": id, "o": "r", "v": "inventory"} 81 | resp = s.get('{}/legacy/computers.html'.format(JAMF_HOST), params=params, cookies=jar) 82 | for line in resp.content.splitlines(): 83 | if "SHOW_KEY" in str(line): 84 | return re.search('retrieveFV2Key(([0-9]+),', str(line)).group(1) 85 | 86 | return 87 | 88 | """ 89 | main 90 | ------------- 91 | Connects to the JAMF JSS API and extracts a filevault key for the provided device ID 92 | :param id string 93 | :param name string 94 | """ 95 | def main(id, name): 96 | """ Create the cookie jar and session for requests """ 97 | jar = CookieJar() 98 | s = requests.Session() 99 | s.cookies = jar 100 | 101 | """ Get the computer id if a hostname was provided """ 102 | if len(name) > 0: 103 | id = getComputerID(name) 104 | 105 | """ Get the session token """ 106 | session_token = getSessionToken(s, jar, id) 107 | if session_token is None or len(session_token) == 0: 108 | print("Unable to find session token") 109 | exit() 110 | 111 | """ Get the Filevault key ID """ 112 | key_ID = getFilevaultKeyID(s, jar, id) 113 | if key_ID is None or len(key_ID) == 0: 114 | print("Unable to find Filevault key ID") 115 | exit() 116 | 117 | """ Make the request against the computers.ajax endpoint """ 118 | data = "&fileVaultKeyId={}&fileVaultKeyType=individualKey&identifier=FIELD_FILEVAULT2_INDIVIDUAL_KEY&ajaxAction=AJAX_ACTION_READ_FILE_VAULT_2_KEY&session-token={}".format(key_ID, session_token) 119 | resp = s.post('{}/computers.ajax?id={}&o=r'.format(JAMF_HOST, id), data="{}".format(data), cookies=jar, headers={ 120 | "X-Requested-With": "XMLHttpRequest", 121 | "Origin": JAMF_HOST, 122 | "Content-Type": "application/x-www-form-urlencoded; charset=UTF-8", 123 | "Accept": "*/*", 124 | "Content-Length": "{}".format(len(data)), 125 | "Accept-Encoding": "gzip, deflate, br", 126 | "Accept-Language": "en-US,en;q=0.9", 127 | "Connection": "keep-alive", 128 | "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.81 Safari/537.36", 129 | "Referer": "{}/legacy/computers.html?id={}&o=r".format(JAMF_HOST, id) 130 | }) 131 | 132 | # TODO: add error checking here 133 | e = parseString(resp.content) 134 | if len(e.getElementsByTagName("individualKey")) > 0: 135 | for n in e.getElementsByTagName("individualKey")[0].childNodes: 136 | if n.nodeType == n.TEXT_NODE: 137 | print(n.data) 138 | return 139 | print("Unable to find filevault key") 140 | 141 | 142 | """ main """ 143 | if __name__ == "__main__": 144 | 145 | """ Create Argparser """ 146 | parser = argparse.ArgumentParser(prog='keysword') 147 | parser.add_argument('-id', action="store", default="", dest="id") 148 | parser.add_argument('-name', action="store", default="", dest="name") 149 | parser.add_argument('--version', action='version', version='%(prog)s {}'.format(__VERSION__)) 150 | results = parser.parse_args() 151 | 152 | """ Quick validation of arguments """ 153 | if len(results.id) == 0 and len(results.name) == 0: 154 | print("Please provide a computer id with -id or computer name with -name") 155 | exit() 156 | 157 | elif len(results.id) != 0 and len(results.name) != 0: 158 | print("Please provide only one computer id with -id or with -name, but not both") 159 | exit() 160 | 161 | if len(getenv("JAMF_USERNAME")) == 0 \ 162 | or len(getenv("JAMF_USERNAME")) == 0 \ 163 | or len(getenv("JAMF_HOST")) == 0: 164 | print("Please set your environment variables appropriately") 165 | exit() 166 | 167 | """ run main """ 168 | main(results.id, results.name) 169 | --------------------------------------------------------------------------------