Metadata-Version: 2.1
Name: fortilib
Version: 0.1.5
Summary: fortilib - a Python Library to interact with Fortigate Firewalls
Author: Daniel Zinke
Author-email: Daniel.Zinke@t-systems.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: httpx (>=0.23.0,<0.24.0)
Description-Content-Type: text/markdown

# fortilib - a Python Library to interact with Fortigate Firewalls

This Python module contains the ability to get and configure following object on [Fortigate Firewalls](https://www.fortinet.com/products/next-generation-firewall):
* Addresses
* Address Groups
* Interfaces
* IPPools
* Policies
* Proxy Addresses
* Proxy Address Groups
* Proxy Policies
* Routes
* Services
* Service Groups
* Vips
* Vip Groups

## Installation
Python >= 3.8 is required.

Dependencies:
* [httpx](https://www.python-httpx.org/)

Simply install fortilib via pip:
```
> pip install fortilib
```

## Quickstart

```python
import ipaddress

from fortilib.firewall import FortigateFirewall
from fortilib.fortigateapi import FortigateFirewallApi
from fortilib.address import FortigateIpMask


api = FortigateFirewallApi(
    "127.0.0.1", # firewall ip
    "username",
    "password",
    "vdom", # use "root" if you dont have vdoms activated
)
firewall = FortigateFirewall("fw01", api)
firewall.login()

# load all objects from fortigate
firewall.get_all_objects()

# create an firewall address
address = FortigateIpMask()
address.name = "Test Address"
address.subnet = ipaddress.ip_network("127.0.0.1/32")

# add object to firewall
firewall.create_firewall_address(address)

# print all addresses on firewall
for address in firewall.addresses:
    print(address.name)
```

## Contributing

See [Contributing](CONTRIBUTING.md).

## License

GPLv3

