├── .gitignore ├── requirements.txt ├── .github └── dependabot.yml ├── fortipy ├── __init__.py ├── fortianalyzer.py ├── forti.py └── fortimanager.py ├── README.md ├── setup.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .ropeproject/ 3 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests==2.28.1 2 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "pip" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | -------------------------------------------------------------------------------- /fortipy/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | from .fortimanager import FortiManager 3 | from .fortianalyzer import FortiAnalyzer 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 🚮 Archived! 2 | 3 | If you're interested in maintaining this package please get in touch with me at: 4 | 5 | https://github.com/pschmitt/contact/issues/new 6 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup 2 | 3 | setup( 4 | name='fortipy', 5 | version='0.2.6', 6 | description='FortiManger API bindings for Python', 7 | author='Philipp Schmitt', 8 | author_email='philipp.schmitt@post.lu', 9 | url='https://github.com/pschmitt/fortipy', 10 | packages=['fortipy'], 11 | install_requires=['requests'] 12 | ) 13 | -------------------------------------------------------------------------------- /fortipy/fortianalyzer.py: -------------------------------------------------------------------------------- 1 | ''' 2 | FortiAnalyzer 3 | Author: Philipp Schmitt 4 | URLs: https://fndn.fortinet.net/index.php?/topic/52-an-incomplete-list-of-url-parameters-for-use-with-the-json-api/ 5 | ''' 6 | 7 | from __future__ import absolute_import 8 | from __future__ import print_function 9 | from .forti import Forti 10 | import ssl 11 | from suds.client import Client 12 | 13 | 14 | # Disable SSL verification for suds 15 | ssl._create_default_https_context = ssl._create_unverified_context 16 | 17 | 18 | class FortiAnalyzer(Forti): 19 | def _run(self, url, data, request_id): 20 | return self._request( 21 | method='run', 22 | data=data, 23 | url=url, 24 | request_id=request_id 25 | ) 26 | 27 | def _fetch(self, url, data, request_id): 28 | return self._request( 29 | method='fetch', 30 | data=data, 31 | url=url, 32 | request_id=request_id 33 | ) 34 | 35 | def _cancel(self, url, data, request_id): 36 | return self._request( 37 | method='cancel', 38 | data=data, 39 | url=url, 40 | request_id=request_id 41 | ) 42 | 43 | def fetch_result(self, adom, count, period=None, filters=None, 44 | filter_logic='all', devices=None, interim_result=False, 45 | logtype='content', compact_result=False, sort=None): 46 | data = { 47 | 'adom': adom, 48 | 'count': count 49 | } 50 | return self._fetch( 51 | data=data, 52 | url='faz/fortiview', 53 | request_id=3321 54 | ) 55 | 56 | def import_report_config(self): 57 | return self._add( 58 | url='/faz/report/report_config' 59 | ) 60 | 61 | def xml_fetch_report(): 62 | client = Client('https://192.168.10.130:8080/') 63 | -------------------------------------------------------------------------------- /fortipy/forti.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Forti 3 | Author: Philipp Schmitt 4 | URLs: https://fndn.fortinet.net/index.php?/topic/52-an-incomplete-list-of-url-parameters-for-use-with-the-json-api/ 5 | ''' 6 | 7 | from __future__ import print_function 8 | from collections import namedtuple 9 | import atexit 10 | import datetime 11 | import json 12 | import logging 13 | import requests 14 | 15 | 16 | logging.basicConfig(level=logging.DEBUG) 17 | logger = logging.getLogger(__name__) 18 | 19 | 20 | # How long a token should be considered valid (in minutes) 21 | TOKEN_TIMEOUT = 2 22 | 23 | 24 | def kwargs_to_json_handler(kwargs): 25 | ''' 26 | Necessary for python args and API params name conflict resolution. 27 | e.g. for table "get_used" -> "get used" or "filter_" -> "filter". 28 | ''' 29 | return {k.strip('_').replace('_', ' '): v for k, v in kwargs.items()} 30 | 31 | 32 | def commonerrorhandler(f): 33 | ''' 34 | Centralized exception handling for common errors such as invalid 35 | credentials or connection timeouts 36 | Credits: http://stackoverflow.com/a/7589537 37 | ''' 38 | def wrapped(*args, **kw): 39 | ''' 40 | Wrapper function 41 | ''' 42 | try: 43 | result = f(*args, **kw) 44 | # if result.errorMsg.errorCode != 0: 45 | # print(f.__name__, ': Something went wrong!', 46 | # result.errorMsg.errorMsg, file=sys.stderr) 47 | # else: 48 | # print('Success!') 49 | return result 50 | except Exception as e: 51 | logger.error('Caught exception: {}'.format(e)) 52 | return wrapped 53 | 54 | 55 | def login_required(f): 56 | ''' 57 | Definition decorator for all function requiring an auth token 58 | Credit: http://stackoverflow.com/a/7590709 59 | ''' 60 | def _wrapper(self, *args, **kwargs): 61 | ''' 62 | Function to be applied on top of all decorated methods 63 | ''' 64 | if self._token_age: 65 | timediff = self._token_age - datetime.datetime.now() 66 | if timediff.total_seconds() / 60 > TOKEN_TIMEOUT: 67 | logger.info('Token timeout has been reached. Let\'s login again') 68 | self.logout() # Log out to invalidate previous token 69 | self.login() # Request new token 70 | else: 71 | self.login() 72 | return f(self, *args, **kwargs) 73 | return _wrapper 74 | 75 | 76 | class Forti(object): 77 | ''' 78 | Forti class (JSON API) 79 | ''' 80 | 81 | def __init__(self, host, port=443, username=None, password=None, 82 | verify=True): 83 | self.json_url = 'https://{}:{}/jsonrpc'.format(host, port) 84 | self.token = None 85 | credentials = namedtuple('Credentials', 'userID password') 86 | self.credentials = credentials(username, password) 87 | self.verify = verify 88 | # Actual age of the login token 89 | self._token_age = None 90 | self.login() 91 | 92 | def _request(self, method, url, request_id=1, verbose=False, **kwargs): 93 | ''' 94 | Perform a JSON request 95 | :param method: Method to use (get/set/delete etc.) 96 | :param url: Internal URL 97 | :param \**kwargs: Additional params according to the FortiManager 98 | JSON API documentation and method used. 99 | ''' 100 | try: 101 | params = {'url': url} 102 | params.update(kwargs_to_json_handler(kwargs)) 103 | post_data = json.dumps({ 104 | 'method': method, 105 | 'params': [params], 106 | 'id': request_id, 107 | 'verbose': verbose, 108 | 'jsonrpc': '2.0', 109 | 'session': self.token if self.token else 1 110 | # 'skip': skip 111 | }) 112 | logger.debug('POST DATA: {}'.format(post_data)) 113 | # Set verify to True to verify SSL certificates 114 | r = requests.post(self.json_url, post_data, verify=self.verify) 115 | if not r.ok: 116 | logger.error('Erroneous response') 117 | r.raise_for_status() 118 | logger.debug(r.text) 119 | res = r.json() 120 | assert res['id'] == request_id, 'Request ID changed.' 121 | return res 122 | except requests.exceptions.SSLError as e: 123 | logger.error( 124 | 'SSL Handshake failed: {}\n' 125 | 'You may want to disable SSL cert verification ' 126 | '[!!!INSECURE!!!]'.format(e) 127 | ) 128 | raise e 129 | 130 | @login_required 131 | def _syntax(self, url, request_id=1): 132 | return self._request( 133 | method='get', 134 | option='syntax', 135 | url=url, 136 | request_id=request_id 137 | ) 138 | 139 | @login_required 140 | def _get(self, url, request_id=11, verbose=False, skip=False, **kwargs): 141 | ''' 142 | Generic "get" function 143 | ''' 144 | res = self._request( 145 | method='get', 146 | url=url, 147 | request_id=request_id, 148 | verbose=verbose, 149 | **kwargs 150 | ) 151 | logger.debug(res) 152 | # assert len(res['result']) == 1, 'More than one result has been returned' 153 | if len(res['result']) > 1: 154 | logger.warning('More than one result has been returned') 155 | 156 | if isinstance(res['result'], list): 157 | if 'data' in res['result'][0]: 158 | if isinstance(res['result'][0]['data'], list): 159 | return [x for x in res['result'][0]['data']] 160 | else: 161 | # its a dict, just return it 162 | return res['result'][0]['data'] 163 | else: 164 | logger.warning("unhandled case - don't know if thats possible") 165 | return res['result']['data'] 166 | 167 | @login_required 168 | def _add(self, url, data, request_id=12, verbose=False): 169 | ''' 170 | Generic "add" function 171 | ''' 172 | return self._request( 173 | method='add', 174 | url=url, 175 | request_id=request_id, 176 | data=data, 177 | verbose=verbose 178 | ) 179 | 180 | @login_required 181 | def _set(self, url, data, request_id=14, verbose=False): 182 | ''' 183 | Generic "set" method 184 | ''' 185 | return self._request( 186 | method='set', 187 | url=url, 188 | request_id=request_id, 189 | data=data, 190 | verbose=verbose 191 | ) 192 | 193 | @login_required 194 | def _update(self, url, data, request_id=15, verbose=False): 195 | ''' 196 | Generic "set" method 197 | ''' 198 | return self._request( 199 | method='update', 200 | url=url, 201 | request_id=request_id, 202 | data=data, 203 | verbose=verbose 204 | ) 205 | 206 | @login_required 207 | def _delete(self, url, data, request_id=13, verbose=False): 208 | ''' 209 | Generic "delete" function 210 | ''' 211 | return self._request( 212 | method='delete', 213 | url=url, 214 | request_id=request_id, 215 | data=data, 216 | verbose=verbose 217 | ) 218 | 219 | @login_required 220 | def _clone(self, url, request_id=11, verbose=False, skip=False, **kwargs): 221 | ''' 222 | Generic "clone" function 223 | ''' 224 | return self._request( 225 | method='clone', 226 | url=url, 227 | request_id=request_id, 228 | verbose=verbose, 229 | **kwargs 230 | ) 231 | 232 | @login_required 233 | def _move(self, url, request_id=11, verbose=False, skip=False, **kwargs): 234 | ''' 235 | Generic "move" function 236 | ''' 237 | return self._request( 238 | method='move', 239 | url=url, 240 | request_id=request_id, 241 | verbose=verbose, 242 | **kwargs 243 | ) 244 | 245 | def _exec(self, url, request_id=11, verbose=False, skip=False, **kwargs): 246 | ''' 247 | Generic "exec" function 248 | ''' 249 | return self._request( 250 | method='exec', 251 | url=url, 252 | request_id=request_id, 253 | verbose=verbose, 254 | **kwargs 255 | ) 256 | 257 | def login(self, username=None, password=None): 258 | ''' 259 | Login using given credentials 260 | Return the session token 261 | ''' 262 | if username is None: 263 | username = self.credentials.userID 264 | if password is None: 265 | password = self.credentials.password 266 | res = self._exec( 267 | url='sys/login/user', 268 | data={'passwd': password, 'user': username} 269 | ) 270 | assert res, 'No data received' 271 | if 'session' in res: 272 | self.token = res['session'] 273 | # Automatically log out at program exit 274 | atexit.register(self.logout) 275 | self._token_age = datetime.datetime.now() 276 | return self.token 277 | else: 278 | logger.error('Login failed: {}'.format(res)) 279 | 280 | @login_required 281 | def logout(self): 282 | ''' 283 | Log out, invalidate the session token 284 | ''' 285 | logger.debug('LOGOUT REQUEST') 286 | res = self._exec(url='sys/logout', request_id=3) 287 | self.token = None 288 | return res 289 | -------------------------------------------------------------------------------- /fortipy/fortimanager.py: -------------------------------------------------------------------------------- 1 | ''' 2 | FortiManager 3 | Author: Philipp Schmitt 4 | URLs: https://fndn.fortinet.net/index.php?/topic/52-an-incomplete-list-of-url-parameters-for-use-with-the-json-api/ 5 | ''' 6 | 7 | from __future__ import absolute_import 8 | from __future__ import print_function 9 | from .forti import (login_required, Forti) 10 | import json 11 | import logging 12 | import sys 13 | 14 | 15 | logging.basicConfig(level=logging.DEBUG) 16 | logger = logging.getLogger(__name__) 17 | 18 | 19 | # Custom exceptions 20 | class LockException(Exception): 21 | pass 22 | 23 | 24 | class CommitException(Exception): 25 | pass 26 | 27 | 28 | def toggle_lock(f): 29 | ''' 30 | Decorator that locks an ADOM before performing the requested 31 | action, and then unlocks it again 32 | ''' 33 | def _wrapper(self, *args, **kwargs): 34 | ''' 35 | Function to be applied on top of all deorated methods 36 | ''' 37 | adom = kwargs['adom'] 38 | lock = self.lock_adom(adom=adom) 39 | logger.debug(lock) 40 | if lock['result'][0]['status']['code'] != 0: 41 | raise LockException('Unable to lock ADOM') 42 | res = f(self, *args, **kwargs) 43 | commit = self.commit(adom=adom) 44 | logger.debug(commit) 45 | if commit['result'][0]['status']['code'] != 0: 46 | raise CommitException('Unable to commit changes') 47 | unlock = self.unlock_adom(adom=adom) 48 | logger.debug(unlock) 49 | return res 50 | return _wrapper 51 | 52 | 53 | class FortiManager(Forti): 54 | ''' 55 | FortiManager class (SOAP/XML API) 56 | ''' 57 | 58 | @login_required 59 | def get_system_status(self): 60 | # TODO This method may be common to FortiManager and Analyzer 61 | return self._get('sys/status') 62 | 63 | @login_required 64 | def get_serial_number(self): 65 | return self.get_system_status().get('Serial Number', None) 66 | 67 | @login_required 68 | def get_version(self): 69 | return self.get_system_status().get('Version', None) 70 | 71 | @login_required 72 | def get_hostname(self): 73 | return self.get_system_status().get('Hostname', None) 74 | 75 | @login_required 76 | def get_adom_vdom_list(self, verbose=False, skip=False): 77 | ''' 78 | Get a list of all ADOMs and their assigned VDOMs 79 | ''' 80 | return self._request( 81 | 'get', 82 | 'dvmdb/adom', 83 | option='object member', 84 | request_id=42, 85 | verbose=verbose 86 | ) 87 | 88 | @login_required 89 | def get_adoms(self, **kwargs): 90 | return self._get( 91 | url='dvmdb/adom', 92 | request_id=42, 93 | option='object member', 94 | **kwargs 95 | ) 96 | 97 | @login_required 98 | def get_load_balancers(self, adom, **kwargs): 99 | return self._get( 100 | url='pm/config/adom/{}/obj/firewall/ldb-monitor'.format(adom), 101 | request_id=545634, 102 | **kwargs 103 | ) 104 | 105 | @login_required 106 | @toggle_lock 107 | def add_policy_package(self, adom, data): 108 | ''' 109 | Add a new device policy package 110 | adom: Name of the parent ADOM (ie. the destination) 111 | TODO 112 | ''' 113 | data = [ 114 | { 115 | "name": "test1", 116 | "type": "pkg" 117 | }, 118 | { 119 | "name": "folder1", 120 | "type": "folder", 121 | "subobj": [ 122 | { 123 | "name": "pkg01", 124 | "type": "pkg" 125 | } 126 | ] 127 | } 128 | ] 129 | return self._set( 130 | url="pm/pkg/adom/{}".format(adom), 131 | data=data, 132 | request_id=5 133 | ) 134 | 135 | @login_required 136 | def get_policies(self, adom, policy_id=None, policy_package='default', **kwargs): 137 | ''' 138 | Read a policy 139 | If policy_id is supplied retrieve only the corresponding policy 140 | Otherwise get all policies in package 141 | ''' 142 | url = 'pm/config/adom/{}/pkg/{}/firewall/policy/{}'.format( 143 | adom, 144 | policy_package, 145 | policy_id if policy_id else '' 146 | ) 147 | return self._get(url=url, request_id=13789, **kwargs) 148 | 149 | @login_required 150 | def get_policy(self, adom, policy_id, policy_package='default', **kwargs): 151 | return self.get_policies( 152 | adom, 153 | policy_package=policy_package, 154 | policy_id=policy_id, 155 | **kwargs 156 | ) 157 | 158 | @login_required 159 | def get_all_policies(self, adom, **kwargs): 160 | policies = [] 161 | policy_packages = self.get_policy_package_names(adom) 162 | if not policy_packages: 163 | return 164 | for polpkg in policy_packages: 165 | pols = self.get_policies(adom=adom, policy_package=polpkg, **kwargs) 166 | if pols: 167 | # Append policy package info 168 | for p in pols: 169 | p['__policy_package'] = polpkg 170 | policies += pols 171 | return policies 172 | 173 | @login_required 174 | def get_policy_packages(self, adom, **kwargs): 175 | return self._get( 176 | url='pm/pkg/adom/{}/'.format(adom), 177 | request_id=900001, 178 | **kwargs 179 | ) 180 | 181 | @login_required 182 | def get_policy_package_names(self, adom, **kwargs): 183 | policy_packages = self.get_policy_packages(adom, **kwargs) 184 | if not policy_packages: 185 | return 186 | package_names = [] 187 | for pol_pkg in policy_packages: 188 | children = pol_pkg.get('subobj') 189 | if children: 190 | # FIXME This only works with a depth of one! 191 | for child in children: 192 | package_names.append( 193 | '{}/{}'.format(pol_pkg.get('name'), child.get('name'))) 194 | else: 195 | package_names.append(pol_pkg.get('name')) 196 | return package_names 197 | 198 | @login_required 199 | def get_global_policies(self, section='header', policy_id=None, policy_package='default', **kwargs): 200 | ''' 201 | Read the global policy, specifing the header or footer section 202 | If policy_id is supplied retrieve only the corresponding policy 203 | Otherwise get all policies in package 204 | ''' 205 | url = 'pm/config/global/pkg/{}/global/{}/policy/{}'.format( 206 | policy_package, 207 | section, 208 | policy_id if policy_id else '' 209 | ) 210 | return self._get(url=url, request_id=13789, **kwargs) 211 | 212 | @login_required 213 | def rename_device(self, device): 214 | ''' 215 | Rename a device 216 | ''' 217 | pass 218 | 219 | @login_required 220 | def add_vdom(self, vdom): 221 | ''' 222 | Create a new VDOM 223 | ''' 224 | pass 225 | 226 | @login_required 227 | def assign_vdom_to_adom(self, adom, vdom): 228 | ''' 229 | Assign an ADOM to a VDOM 230 | ''' 231 | pass 232 | 233 | @login_required 234 | def get_adom_revision_list(self, adom='default', 235 | verbose=False, skip=False): 236 | ''' 237 | Get a list of all revisions for a given ADOM 238 | ''' 239 | data = json.dumps( 240 | { 241 | "method": "get", 242 | "params": [ 243 | { 244 | "url": "dvmdb/adom/{}/revision".format(adom) 245 | } 246 | ], 247 | "id": 899, 248 | "session": self.token, 249 | "verbose": verbose, 250 | "skip": skip 251 | } 252 | ) 253 | return self._request(data) 254 | 255 | @login_required 256 | def create_revision(self, adom, name=None, created_by=None, 257 | description=None, locked=False): 258 | ''' 259 | Create a new revision for a given ADOM 260 | ''' 261 | if created_by is None: 262 | created_by = self.credentials.userID 263 | data = { 264 | "created_by": created_by, 265 | "desc": description, 266 | "locked": locked, 267 | "name": name 268 | } 269 | return self._set( 270 | url="dvmdb/adom/{}/revision".format(adom), 271 | data=data, 272 | request_id=12015 273 | ) 274 | 275 | @login_required 276 | def delete_adom_revision(self, adom, revision_id): 277 | return self._delete( 278 | url='dvmdb/adom/{}/revision/{}'.format(adom, revision_id), 279 | data=None 280 | ) 281 | 282 | @login_required 283 | def revert_revision(self, adom, revision_id, name=None, created_by=None, 284 | locked=False, description=None): 285 | ''' 286 | Revert ADOM to a previous revision 287 | ''' 288 | if created_by is None: 289 | created_by = self.credentials.userID 290 | data = { 291 | "created_by": created_by, 292 | "desc": description, 293 | "locked": locked, 294 | "name": name 295 | } 296 | return self._clone( 297 | url='dvmdb/adom/{}/revision/{}'.format(adom, revision_id), 298 | request_id=8921, 299 | data=data 300 | ) 301 | 302 | @login_required 303 | @toggle_lock 304 | def add_policy(self, adom='root', policy_pkg='default', data=None): 305 | return self._add( 306 | url='pm/config/adom/{}/pkg/{}/firewall/policy'.format( 307 | adom, policy_pkg 308 | ), 309 | data=data, 310 | request_id=666 311 | ) 312 | 313 | @login_required 314 | @toggle_lock 315 | def add_policy6(self, adom='root', policy_pkg='default', data=None): 316 | ''' 317 | Add new single or multiple IPv6 firewall policy. 318 | :param adom: define the administrative domain 319 | :param policy_pkg: define the policy package 320 | :param data: IPv6 firewall policy object 321 | :return: Response object 322 | ''' 323 | return self._add( 324 | url='pm/config/adom/{}/pkg/{}/firewall/policy6'.format( 325 | adom, policy_pkg 326 | ), 327 | data=data, 328 | request_id=670 329 | ) 330 | 331 | @login_required 332 | @toggle_lock 333 | def edit_policy(self, adom, policy_id): 334 | pass 335 | 336 | # Add objects 337 | @login_required 338 | @toggle_lock 339 | def add_interface(self, adom='root', data=None): 340 | return self._add( 341 | url='pm/config/adom/{}/obj/dynamic/interface'.format(adom), 342 | data=data, 343 | request_id=667, 344 | ) 345 | 346 | @login_required 347 | @toggle_lock 348 | def add_firewall_address(self, adom='root', data=None): 349 | return self._add( 350 | url='pm/config/adom/{}/obj/firewall/address'.format(adom), 351 | data=data, 352 | request_id=6670 353 | ) 354 | 355 | @login_required 356 | @toggle_lock 357 | def add_firewall_address6(self, adom='root', data=None): 358 | ''' 359 | Adding new single or multiple IPv6 firewall address objects. 360 | :param adom: define the administrative domain 361 | :param data: firewall address object to create 362 | :return: Response object 363 | ''' 364 | return self._add( 365 | url='pm/config/adom/{}/obj/firewall/address6'.format(adom), 366 | data=data, 367 | request_id=668 368 | ) 369 | 370 | @login_required 371 | @toggle_lock 372 | def add_service(self, adom='root', data=None): 373 | ''' 374 | Add new single or multiple custom service object. 375 | :param adom: define the administrative domain 376 | :param data: custom service object to create 377 | :return: Response object 378 | ''' 379 | return self._add( 380 | url='/pm/config/adom/{}/obj/firewall/service/custom'.format(adom), 381 | data=data, 382 | request_id=669 383 | ) 384 | 385 | # Update existing objects 386 | @login_required 387 | @toggle_lock 388 | def update_firewall_addrgrp(self, adom='root', addrgrp_name=None, data=None): 389 | return self._update( 390 | url='pm/config/adom/{}/obj/firewall/addrgrp/{}'.format( 391 | adom, addrgrp_name 392 | ), 393 | data=data, 394 | request_id=66700 395 | ) 396 | 397 | @login_required 398 | @toggle_lock 399 | def delete_policy(self, policy_id, adom='root', policy_pkg='default'): 400 | ''' 401 | Delete a policy 402 | ''' 403 | return self._delete( 404 | url='pm/config/adom/{}/pkg/{}/firewall/policy/{}'.format( 405 | adom, policy_pkg, policy_id 406 | ), 407 | data=None, 408 | request_id=89561 409 | ) 410 | 411 | @login_required 412 | @toggle_lock 413 | def delete_interface(self, interface, adom='root'): 414 | ''' 415 | Delete an interface 416 | ''' 417 | return self._delete( 418 | url='pm/config/adom/{}/obj/dynamic/interface/{}'.format( 419 | adom, interface 420 | ), 421 | data=None 422 | ) 423 | 424 | @login_required 425 | def get_security_profiles(self, adom, **kwargs): 426 | ''' 427 | Get security profiles 428 | ''' 429 | return self._get( 430 | url='pm/config/adom/{}/obj/firewall'.format(adom), 431 | request_id=5723, 432 | **kwargs 433 | ) 434 | 435 | @login_required 436 | def get_firewall_addresses(self, adom, **kwargs): 437 | ''' 438 | Get all firewall adresses defined for an ADOM 439 | ''' 440 | return self._get( 441 | url='pm/config/adom/{}/obj/firewall/address'.format(adom), 442 | request_id=5623, 443 | **kwargs 444 | ) 445 | 446 | @login_required 447 | def get_firewall_addresses6(self, adom): 448 | ''' 449 | Get all firewall adresses defined for an ADOM 450 | ''' 451 | return self._get( 452 | url='pm/config/adom/{}/obj/firewall/address6'.format(adom), 453 | request_id=562 454 | ) 455 | 456 | @login_required 457 | def get_firewall_address6_groups(self, adom, **kwargs): 458 | ''' 459 | Get all firewall adresses defined for an ADOM 460 | ''' 461 | return self._get( 462 | url='pm/config/adom/{}/obj/firewall/addrgrp6'.format(adom), 463 | request_id=5622, 464 | **kwargs 465 | ) 466 | 467 | @login_required 468 | def get_firewall_address_groups(self, adom, **kwargs): 469 | ''' 470 | Get all firewall adress groups defined for an ADOM 471 | ''' 472 | return self._get( 473 | url='pm/config/adom/{}/obj/firewall/addrgrp'.format(adom), 474 | request_id=56227, 475 | **kwargs 476 | ) 477 | 478 | @login_required 479 | def get_firewall_address_group(self, adom, addrgrp_name, **kwargs): 480 | ''' 481 | Get all firewall adress groups defined for an ADOM 482 | ''' 483 | return self._get( 484 | url='pm/config/adom/{}/obj/firewall/addrgrp/{}'.format( 485 | adom, addrgrp_name 486 | ), 487 | request_id=562270, 488 | **kwargs 489 | ) 490 | 491 | @login_required 492 | def get_interfaces(self, adom, **kwargs): 493 | ''' 494 | Get all interfaces defined for an ADOM 495 | ''' 496 | return self._get( 497 | url='pm/config/adom/{}/obj/dynamic/interface'.format(adom), 498 | request_id=5682, 499 | **kwargs 500 | ) 501 | 502 | @login_required 503 | def get_services(self, adom, **kwargs): 504 | ''' 505 | Get all (firewall) services defined for an ADOM 506 | ''' 507 | return self._get( 508 | url='pm/config/adom/{}/obj/firewall/service/custom'.format(adom), 509 | request_id=5617, 510 | **kwargs 511 | ) 512 | 513 | @login_required 514 | def get_firewall_service_groups(self, adom, **kwargs): 515 | ''' 516 | Get all firewall adresses defined for an ADOM 517 | ''' 518 | return self._get( 519 | url='pm/config/adom/{}/obj/firewall/service/group'.format(adom), 520 | request_id=5616, 521 | **kwargs 522 | ) 523 | 524 | @login_required 525 | def get_schedules(self, adom, **kwargs): 526 | ''' 527 | Get all scheduless defined for an ADOM 528 | ''' 529 | return self._get( 530 | url='pm/config/adom/{}/obj/firewall/schedule/recurring'.format(adom), 531 | request_id=5620, 532 | **kwargs 533 | ) 534 | 535 | @login_required 536 | def get_firewall_schedule_groups(self, adom, **kwargs): 537 | ''' 538 | Get all firewall adresses defined for an ADOM 539 | ''' 540 | return self._get( 541 | url='pm/config/adom/{}/obj/firewall/schedule/group'.format(adom), 542 | request_id=56201, 543 | **kwargs 544 | ) 545 | 546 | @login_required 547 | def get_firewall_vips(self, adom, **kwargs): 548 | ''' 549 | Get all firewall adresses defined for an ADOM 550 | ''' 551 | return self._get( 552 | url='pm/config/adom/{}/obj/firewall/vip'.format(adom), 553 | request_id=5632, 554 | **kwargs 555 | ) 556 | 557 | @login_required 558 | def get_firewall_vip_groups(self, adom, **kwargs): 559 | ''' 560 | Get all firewall adresses defined for an ADOM 561 | ''' 562 | return self._get( 563 | url='pm/config/adom/{}/obj/firewall/vipgrp'.format(adom), 564 | request_id=5633, 565 | **kwargs 566 | ) 567 | 568 | @login_required 569 | def get_devices(self, adom=None, **kwargs): 570 | ''' 571 | Get all devices defined for an ADOM 572 | If adom is undefined return all devices 573 | ''' 574 | return self._get( 575 | url='dvmdb/adom/{}/device'.format(adom) if adom else 'dvmdb', 576 | request_id=7465, 577 | **kwargs 578 | ) 579 | 580 | @login_required 581 | def get_traffic_shapers(self, adom, **kwargs): 582 | ''' 583 | Get all traffic shapers for an ADOM 584 | ''' 585 | return self._get( 586 | url='pm/config/adom/{}/obj/firewall/shaper/traffic-shaper'.format(adom), 587 | request_id=5037, 588 | **kwargs 589 | ) 590 | 591 | # Profiles 592 | 593 | @login_required 594 | def get_antivirus_profiles(self, adom, **kwargs): 595 | ''' 596 | Get all antivirus profiles defined for an ADOM 597 | ''' 598 | return self._get( 599 | url='pm/config/adom/root/obj/antivirus/profile'.format(adom), 600 | request_id=8175, 601 | **kwargs 602 | ) 603 | 604 | def get_webfilters(self, adom, **kwargs): 605 | ''' 606 | Get all antivirus profiles defined for an ADOM 607 | ''' 608 | return self._get( 609 | url='pm/config/adom/{}/obj/webfilter/profile'.format(adom), 610 | request_id=8177, 611 | **kwargs 612 | ) 613 | 614 | @login_required 615 | def get_ips_sensors(self, adom, **kwargs): 616 | ''' 617 | Get all firewall adresses defined for an ADOM 618 | ''' 619 | return self._get( 620 | url='pm/config/adom/{}/obj/ips/sensor'.format(adom), 621 | request_id=9846, 622 | **kwargs 623 | ) 624 | 625 | @login_required 626 | def get_application_sensors(self, adom, **kwargs): 627 | ''' 628 | Get a list of all applications defined for an ADOM 629 | ''' 630 | return self._get( 631 | url='pm/config/adom/{}/obj/application/list'.format(adom), 632 | request_id=7850, 633 | **kwargs 634 | ) 635 | 636 | @login_required 637 | def get_users(self, adom, **kwargs): 638 | ''' 639 | Get a list of all local users defined for an ADOM 640 | ''' 641 | return self._get( 642 | url='pm/config/adom/{}/obj/user/local'.format(adom), 643 | request_id=9123, 644 | **kwargs 645 | ) 646 | 647 | @login_required 648 | def json_get_groups(self, adom, **kwargs): 649 | ''' 650 | Get a list of all user groups defined for an ADOM 651 | ''' 652 | return self._get( 653 | url='pm/config/adom/{}/obj/user/group'.format(adom), 654 | request_id=9124, 655 | **kwargs 656 | ) 657 | 658 | # Workspace functions (FortiManager 5 Patch Release 3) 659 | 660 | @login_required 661 | def lock_adom(self, adom): 662 | ''' 663 | Lock an ADOM 664 | ''' 665 | return self._exec(url="pm/config/adom/{}/_workspace/lock".format(adom), request_id=5612) 666 | 667 | @login_required 668 | def unlock_adom(self, adom): 669 | ''' 670 | Unclock an ADOM 671 | ''' 672 | return self._exec(url="pm/config/adom/{}/_workspace/unlock".format(adom), request_id=5613) 673 | 674 | @login_required 675 | def commit(self, adom): 676 | ''' 677 | Commit changes made to ADOM 678 | ''' 679 | return self._exec(url="pm/config/adom/{}/_workspace/commit".format(adom), request_id=5614) 680 | 681 | 682 | if __name__ == '__main__': 683 | host = sys.argv[1] 684 | username = sys.argv[2] 685 | password = sys.argv[3] 686 | fm = FortiManager( 687 | host=host, 688 | username=username, 689 | password=password 690 | ) 691 | print(fm.login()) 692 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. {http://fsf.org/} 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see {http://www.gnu.org/licenses/}. 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | pia-tools Copyright (C) 2013 Philipp Schmitt 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | {http://www.gnu.org/licenses/}. 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | {http://www.gnu.org/philosophy/why-not-lgpl.html}. 675 | --------------------------------------------------------------------------------