├── .gitignore ├── LICENSE ├── README.md └── clearpass-api-auth ├── README.md ├── clearpassauth.py └── config └── params.cfg /.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 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 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 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | 103 | # OS generated files # 104 | ###################### 105 | .DS_Store 106 | ehthumbs.db 107 | Icon 108 | Thumbs.db 109 | .tmtags 110 | .idea 111 | tags 112 | vendor.tags 113 | tmtagsHistory 114 | *.sublime-project 115 | *.sublime-workspace 116 | .bundle 117 | *.cfgdev 118 | -------------------------------------------------------------------------------- /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. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # clearpass-api-python-snippets 2 | This repo is for small snippets of Python sample code for interfacing with the ClearPass REST API. 3 | -------------------------------------------------------------------------------- /clearpass-api-auth/README.md: -------------------------------------------------------------------------------- 1 | 2 | # clearpass-api-auth 3 | 4 | ![version 2017.03](https://img.shields.io/badge/Version-2017.03-brightgreen.svg "version 2017.03") [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Aruba Security Group](https://img.shields.io/badge/Source-Aruba_Security-orange.svg "Aruba Security Group") 5 | 6 | 7 | ## Overview 8 | This is a Python3 code snippet for obtaining an OAuth 2.0 access token for accessing the ClearPass REST API. 9 | 10 | ## Current Version 11 | 2017.03 (2017-12-26) 12 | 13 | ## Change Log 14 | ### 2017.03 (2017-12-26) 15 | * Added docstrings to functions 16 | * Script no longer directly returns result, call the function with desired variable, ex: clearpassauth.access_token 17 | * Access role and privilieges are now pulled for the session, use: clearpassauth.api_privs or clearpassauth.api_role 18 | * Fix path to params.cfg 19 | ### 2017.02 (2017-10-07) 20 | * Parsed out access_token, token_type, token_expires_in, and scope 21 | ### 2017.01 (2017-07-28) 22 | * Initial Release 23 | 24 | ## Pre-requisites 25 | * An API client must be defined in ClearPass Guest under Administration » API Services » API Clients 26 | * An authentication service must be created in ClearPass Policy Manager to handle the OAuth 2.0 request 27 | 28 | ## Usage 29 | Configure the required parameters in config/params.cfg: 30 | * clearpass_fqdn 31 | * grant_type 32 | 33 | The remaining parameters vary by grant type. 34 | 35 | Import the script as a function 36 | 37 | > `import clearpassauth` 38 | 39 | > `token = clearpassauth.access_token` 40 | > `my_privs = clearpassauth.api_privs` 41 | 42 | ## License 43 | Copyright (c) Hewlett Packard Enterprise Development LP. All Rights Reserved. 44 | 45 | Licensed under the Apache License, Version 2.0 (the "License"). 46 | 47 | ## Other Information 48 | Author: @timcappalli, Aruba Security Group 49 | 50 | Organization: Aruba, a Hewlett Packard Enterprise company 51 | -------------------------------------------------------------------------------- /clearpass-api-auth/clearpassauth.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | #------------------------------------------------------------------------------ 3 | # 4 | # Author: @timcappalli, Aruba Security Group 5 | # Organization: Aruba, a Hewlett Packard Enterprise company 6 | # 7 | # Version: 2017.03 8 | # 9 | # 10 | # Copyright (c) Hewlett Packard Enterprise Development LP 11 | # All Rights Reserved 12 | # 13 | # Licensed under the Apache License, Version 2.0 (the "License"); 14 | # you may not use this file except in compliance with the License. 15 | # You may obtain a copy of the License at 16 | # 17 | # http://www.apache.org/licenses/LICENSE-2.0 18 | # 19 | # Unless required by applicable law or agreed to in writing, 20 | # software distributed under the License is distributed on an 21 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 22 | # KIND, either express or implied. See the License for the 23 | # specific language governing permissions and limitations 24 | # under the License. 25 | # 26 | #------------------------------------------------------------------------------ 27 | 28 | import requests 29 | import json 30 | from configparser import ConfigParser 31 | import os 32 | 33 | # configuration file parameters 34 | params = os.path.join(os.path.dirname(__file__), "config/params.cfg") 35 | config = ConfigParser() 36 | config.read(params) 37 | 38 | clearpass_fqdn = config.get('ClearPass', 'clearpass_fqdn') 39 | oauth_grant_type = config.get('OAuth2', 'grant_type') 40 | oauth_client_id = config.get('OAuth2', 'client_id') 41 | oauth_client_secret = config.get('OAuth2', 'client_secret') 42 | oauth_username = config.get('OAuth2', 'username') 43 | oauth_password = config.get('OAuth2', 'password') 44 | 45 | 46 | # validate config 47 | def check_config(clearpass_fqdn, oauth_grant_type, oauth_client_id, oauth_client_secret, oauth_username, oauth_password): 48 | """Validate the OAuth 2.0 configuration from the params.cfg file.""" 49 | 50 | if not clearpass_fqdn: 51 | print('Error: ClearPass FQDN must be defined in config file (config/params.cfg)') 52 | exit(1) 53 | if not oauth_grant_type: 54 | print('Error: grant_type must be defined in config file (config/params.cfg)') 55 | exit(1) 56 | if not oauth_client_id: 57 | print('Error: client_id must be defined in config file (config/params.cfg)') 58 | exit(1) 59 | if oauth_grant_type == "password" and (not oauth_username or not oauth_password): 60 | print('Error: username and password must be defined in config file for password grant type (config/params.cfg)') 61 | exit(1) 62 | 63 | 64 | def get_access_token(clearpass_fqdn, oauth_grant_type, oauth_client_id, oauth_client_secret, oauth_username, oauth_password): 65 | """Get OAuth 2.0 access token with config from params.cfg""" 66 | 67 | url = "https://" + clearpass_fqdn + "/api/oauth" 68 | 69 | headers = {'Content-Type':'application/json'} 70 | 71 | # grant_type: password 72 | if oauth_grant_type == "password": 73 | payload = {'grant_type':oauth_grant_type, 'username':oauth_username, 'password':oauth_password, 'client_id':oauth_client_id, 'client_secret':oauth_client_secret} 74 | 75 | try: 76 | r = requests.post(url, headers=headers, json=payload) 77 | r.raise_for_status() 78 | except Exception as e: 79 | print(e) 80 | exit(1) 81 | 82 | json_response = json.loads(r.text) 83 | 84 | return json_response 85 | 86 | # grant_type: password public client 87 | if oauth_grant_type == "password" and not oauth_client_secret: 88 | payload = {'grant_type':oauth_grant_type, 'username':oauth_username, 'password':oauth_password, 'client_id':oauth_client_id} 89 | 90 | try: 91 | r = requests.post(url, headers=headers, json=payload) 92 | r.raise_for_status() 93 | except Exception as e: 94 | print(e) 95 | exit(1) 96 | 97 | json_response = json.loads(r.text) 98 | 99 | return json_response 100 | 101 | # grant_type: client_credentials 102 | if oauth_grant_type == "client_credentials": 103 | payload = {'grant_type': oauth_grant_type, 'client_id': oauth_client_id, 'client_secret': oauth_client_secret} 104 | 105 | try: 106 | r = requests.post(url, headers=headers, json=payload) 107 | r.raise_for_status() 108 | except Exception as e: 109 | print(e) 110 | exit(1) 111 | 112 | json_response = json.loads(r.text) 113 | 114 | return json_response 115 | 116 | def get_api_role(clearpass_fqdn, token_type, access_token): 117 | """Get the current ClearPass operator profile name""" 118 | 119 | url = "https://" + clearpass_fqdn + "/api/oauth/me" 120 | 121 | headers = {'Content-Type':'application/json', "Authorization": "{} {}".format(token_type, access_token)} 122 | 123 | try: 124 | r = requests.get(url, headers=headers) 125 | r.raise_for_status() 126 | except Exception as e: 127 | print(e) 128 | exit(1) 129 | 130 | json_response = json.loads(r.text) 131 | 132 | return json_response 133 | 134 | 135 | def get_privs(clearpass_fqdn, token_type, access_token): 136 | """Get the current access privileges""" 137 | 138 | url = "https://" + clearpass_fqdn + "/api/oauth/privileges" 139 | 140 | headers = {'Content-Type':'application/json', "Authorization": "{} {}".format(token_type, access_token)} 141 | 142 | try: 143 | r = requests.get(url, headers=headers) 144 | r.raise_for_status() 145 | except Exception as e: 146 | print(e) 147 | exit(1) 148 | 149 | json_response = json.loads(r.text) 150 | 151 | return json_response 152 | 153 | 154 | check_config(clearpass_fqdn, oauth_grant_type, oauth_client_id, oauth_client_secret, oauth_username, oauth_password) 155 | 156 | token_response = get_access_token(clearpass_fqdn, oauth_grant_type, oauth_client_id, oauth_client_secret, oauth_username, oauth_password) 157 | access_token = token_response['access_token'] 158 | token_type = token_response['token_type'] 159 | token_expires_in = token_response['expires_in'] 160 | scope = token_response['scope'] 161 | 162 | get_api_role_response = get_api_role(clearpass_fqdn, token_type, access_token) 163 | api_role = get_api_role_response['info'] 164 | 165 | get_privs_response = get_privs(clearpass_fqdn, token_type, access_token) 166 | api_privs = get_privs_response['privileges'] -------------------------------------------------------------------------------- /clearpass-api-auth/config/params.cfg: -------------------------------------------------------------------------------- 1 | ### Configuration File for clearpassauth.py 2 | 3 | [ClearPass] 4 | 5 | # ClearPass FQDN ex: clearpass.arubanetworks.com 6 | clearpass_fqdn = 7 | 8 | 9 | [OAuth2] 10 | 11 | # client_credentials or password 12 | grant_type = 13 | 14 | # client_id required for all grant types 15 | client_id = 16 | 17 | # required for password and client_credentials 18 | # leave blank for password public client 19 | client_secret = 20 | 21 | # username/password only required for password flow 22 | username = 23 | password = --------------------------------------------------------------------------------