Fortinet FortiOSAPI

API de configuration Fortinet Fortigate (FortiOS)

Cette bibliothèque est générée automatiquement, si vous souhaitez prendre en charge une version plus récente, veuillez ouvrir un ticket.

Bibliothèque PHP utilisée pour interagir avec les API du pare-feu Fortigate (FortiOS) (CMDB (Configuration), Log et Monitor). Cette bibliothèque peut récupérer, créer, mettre à jour et supprimer la configuration sur le pare-feu.

Vous pouvez trouver toutes les méthodes prises en charge sur le site Web des développeurs de Fortinet. Vous aurez besoin d'un compte pour parcourir les informations.

Table des matières

• Commencer
• Documentation
  • Classe de configuration
    • Usage
    • Exemples
  • Classes de configuration, de journalisation et de surveillance
    • Usage
    • Exemples
    • Transactions

Commencer

1. Obtenez Compositeur.
2. Installez la bibliothèque à l'aide de composer composer require benclerc/fortinet-fortiosapi .
3. Ajoutez ce qui suit au fichier PHP principal de votre application require 'vendor/autoload.php'; .
4. Instanciez la classe Config avec le nom d'hôte, le nom d'utilisateur et le mot de passe du pare-feu $configConnection = new FortinetFortiOSAPIConfig('123.123.123.123', 'admin', 'password'); .
5. Utilisez l'objet Config créé précédemment pour instancier l'objet FortiOSAPI $firewallConf = new FortinetFortiOSAPIConfiguration($configConnection); .
6. Commencez à utiliser la bibliothèque $staticRoutes = $firewallConf->getAllRouterStatic(); .

Documentation

Vous pouvez trouver une documentation complète ici.

Classe de configuration

Usage

Cette classe Config est utilisée pour préparer les informations de configuration obligatoires pour instancier et utiliser les classes FortiOSAPI.... Dans le constructeur vous devez passer :

1. Le nom d'hôte (FQDN) ou l'adresse IP du pare-feu
2. Le nom d'utilisateur d'un utilisateur valide
3. Le mot de passe de l'utilisateur valide

Paramètres optionnels :

• Délai d'attente : 5000ms. Utilisez setTimeout() pour changer.
• Option de vérification SSL : TRUE. Utilisez setSSLVerifyPeer() pour modifier.
• Option d'hôte de vérification SSL : 2. Utilisez setSSLVerifyHost() pour modifier.
• Version API : 2. Utilisez setAPIVersion() pour modifier.

Exemples

 // Basic configuration
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );

// Configuration for very slow firewalls/long requests
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configConnection -> setTimeout ( 20000 );

// Unsecure configuration
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configConnection -> setSSLVerifyPeer ( FALSE )-> setSSLVerifyHost ( FALSE );

// Special API version
$ configConnection = new  Fortinet  FortiOSAPI  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );
$ configConnection -> setAPIVersion ( 1 );

// The class logins to the firewall when being instanciated hence the try/catch statement.
// Here I use the class Configuration for the example but it the same for Log and Monitor classes.
try {
	$ firewallConf = new  Fortinet  FortiOSAPI  Configuration ( $ configConnection );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

Classes de configuration, de journalisation et de surveillance

Usage

Ces classes utilisent Exception pour gérer les erreurs. Pour une exécution nominale, vous devez instancier et demander des méthodes dans les instructions try/catch.

Exemples

 // Get one particular static route
try {
	$ res = $ firewallConf -> getRouterStatic ( 1 );
	echo ( ' Gateway is : ' . $ res -> results [ 0 ]-> gateway );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

// Get routes using filters
try {
	// Will return fields dst and status of default gateways
	$ res = $ firewallConf -> getAllRouterStatic ( NULL , NULL , NULL , NULL , NULL , NULL , [ ' dst ' , ' status ' ], [ ' dst==0.0.0.0 0.0.0.0 ' ]);
	// For obvious reasons, it would be a charm to use the new PHP 8.0 syntax to call the method :
	// $firewallConf->getAllRouterStatic(format: ['dst', 'status'], filter: ['dst==0.0.0.0 0.0.0.0'])
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}


// Set a static route
// Define the route
$ staticRoute = new stdClass ;
$ staticRoute -> status = ' enable ' ;
$ staticRoute -> dst = ' 1.1.1.1 255.255.255.255 ' ;
$ staticRoute -> src = ' 198.168.1.0 255.255.255.0 ' ;
$ staticRoute -> gateway = ' 198.168.1.254 ' ;
$ staticRoute -> device = ' lan ' ;
$ staticRoute -> distance = 20 ;

// Send the request to the firewall
try {
	$ res = $ firewallConf -> addRouterStatic ( $ staticRoute );

	if ( $ res -> status == ' success ' ) {
		echo ( ' Route added ' );
	} else {
		echo ( ' Route adding failed ' );
	}
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

Transactions

Cette bibliothèque prend également en charge les transactions : démarrez une transaction, créez, mettez à jour, supprimez et, en fonction du résultat, validez ou abandonnez vos modifications.

 // Start transaction
$ firewallConf -> startTransaction ();

// Create many IP objects
$ error = FALSE ;
for ( $ i = 1 ; $ i < 50 ; $ i ++) {
	// Create body object
	$ ip = new stdClass ;
	$ ip -> name = ' IP ' . $ i ;
	$ ip -> type = ' subnet ' ;
	$ ip -> subnet = ' 10.1. ' . $ i . ' .0/24 ' ;

	// Create object on the firewall
	try {
		$ firewallConf -> addFirewallAddress ( $ ip );
		echo ( " [SUCCESS] Created IP " . $ ip -> name . " . n" );
	} catch ( Exception $ e ) {
		echo ( " [ERROR] Unable to create IP : " . $ ip -> name . " . Details : " . $ e -> getMessage (). "n" );
		$ error = TRUE ;
	}
}

// Check error
if ( $ error === FALSE ) {
	// No errors, commit
	$ firewallConf -> commitTransaction ();
} else {
	// Errors, abort and rollback
	$ firewallConf -> abortTransaction ();
}