Fortinet FortiOSAPI

Fortinet Fortigate-Konfigurations-API (FortiOS)

Diese Bibliothek wird automatisch generiert. Wenn Sie Unterstützung für eine neuere Version wünschen, öffnen Sie bitte ein Problem.

PHP-Bibliothek für die Interaktion mit Fortigate-Firewall-APIs (FortiOS) (CMDB (Konfiguration), Protokoll und Monitor). Diese Bibliothek kann Konfigurationen auf der Firewall abrufen, erstellen, aktualisieren und löschen.

Alle unterstützten Methoden finden Sie auf der Entwickler-Website von Fortinet. Zum Durchsuchen der Informationen benötigen Sie ein Konto.

Inhaltsverzeichnis

• Erste Schritte
• Dokumentation
  • Konfigurationsklasse
    • Verwendung
    • Beispiele
  • Konfigurations-, Protokoll- und Überwachungsklassen
    • Verwendung
    • Beispiele
    • Transaktionen

Erste Schritte

1. Holen Sie sich Composer.
2. Installieren Sie die Bibliothek mit Composer composer require benclerc/fortinet-fortiosapi .
3. Fügen Sie der Haupt-PHP-Datei Ihrer Anwendung Folgendes hinzu require 'vendor/autoload.php'; .
4. Instanziieren Sie die Config-Klasse mit dem Hostnamen, Benutzernamen und Passwort der Firewall $configConnection = new FortinetFortiOSAPIConfig('123.123.123.123', 'admin', 'password'); .
5. Verwenden Sie das zuvor erstellte Config-Objekt, um das FortiOSAPI-Objekt zu instanziieren $firewallConf = new FortinetFortiOSAPIConfiguration($configConnection); .
6. Beginnen Sie mit der Verwendung der Bibliothek $staticRoutes = $firewallConf->getAllRouterStatic(); .

Dokumentation

Eine vollständige Dokumentation finden Sie hier.

Konfigurationsklasse

Verwendung

Diese Konfigurationsklasse wird verwendet, um die obligatorischen Konfigurationsinformationen für die Instanziierung und Verwendung der FortiOSAPI...-Klassen vorzubereiten. Im Konstruktor müssen Sie Folgendes übergeben:

1. Der Hostname (FQDN) oder die IP-Adresse der Firewall
2. Der Benutzername eines gültigen Benutzers
3. Das Passwort des gültigen Benutzers

Optionale Parameter:

• Zeitüberschreitung: 5000 ms. Verwenden Sie setTimeout() zum Ändern.
• SSL-Überprüfungs-Peer-Option: TRUE. Verwenden Sie zum Ändern setSSLVerifyPeer() .
• SSL-Host-Überprüfungsoption: 2. Verwenden Sie setSSLVerifyHost() zum Ändern.
• API-Version: 2. Verwenden Sie setAPIVersion() zum Ändern.

Beispiele

 // 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 ());
}

Konfigurations-, Protokoll- und Überwachungsklassen

Verwendung

Diese Klassen verwenden Exception, um Fehler zu behandeln. Für die nominale Ausführung sollten Sie Methoden innerhalb von Try/Catch-Anweisungen instanziieren und anfordern.

Beispiele

 // 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 ());
}

Transaktionen

Diese Bibliothek unterstützt auch Transaktionen: eine Transaktion starten, erstellen, aktualisieren, löschen und je nach Ergebnis Ihre Änderungen festschreiben oder abbrechen.

 // 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 ();
}