Fortinet FortiOSAPI

フォーティネット Fortigate 構成 API (FortiOS)

このライブラリは自動的に生成されます。新しいバージョンのサポートが必要な場合は、問題を作成してください。

Fortigate ファイアウォール (FortiOS) API (CMDB (構成)、ログ、およびモニター) と対話するために使用される PHP ライブラリ。このライブラリは、ファイアウォール上の構成を取得、作成、更新、削除できます。

サポートされているすべてのメソッドはフォーティネットの開発者 Web サイトで見つけることができます。情報を参照するにはアカウントが必要です。

目次

• はじめる
• ドキュメント
  • 構成クラス
    • 使用法
    • 例
  • 構成、ログ、およびモニターのクラス
    • 使用法
    • 例
    • トランザクション

はじめる

1. コンポーザーを入手します。
2. composer require benclerc/fortinet-fortiosapi使用してライブラリをインストールします。
3. アプリケーションのメイン PHP ファイルrequire 'vendor/autoload.php'; 。
4. ファイアウォールのホスト名、ユーザー名、パスワードを使用して Config クラスをインスタンス化します$configConnection = new FortinetFortiOSAPIConfig('123.123.123.123', 'admin', 'password'); 。
5. 前に作成した Config オブジェクトを使用して、FortiOSAPI オブジェクトをインスタンス化します$firewallConf = new FortinetFortiOSAPIConfiguration($configConnection); 。
6. ライブラリ$staticRoutes = $firewallConf->getAllRouterStatic(); 。

ドキュメント

完全なドキュメントはここで見つけることができます。

構成クラス

使用法

この Config クラスは、FortiOSAPI... クラスをインスタンス化して使用するために必須の構成情報を準備するために使用されます。コンストラクターでは、次のものを渡す必要があります。

1. ファイアウォールのホスト名 (FQDN) または IP アドレス
2. 有効なユーザーのユーザー名
3. 有効なユーザーのパスワード

オプションのパラメータ:

• タイムアウト: 5000ms。変更するにはsetTimeout()を使用します。
• SSL ピア検証オプション: TRUE。変更するにはsetSSLVerifyPeer()を使用します。
• SSL 検証ホスト オプション: 2. setSSLVerifyHost()を使用して変更します。
• APIバージョン：2. setAPIVersion()を使用して変更します。

例

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

構成、ログ、およびモニターのクラス

使用法

これらのクラスは例外を使用してエラーを処理します。通常の実行では、try/catch ステートメント内でメソッドをインスタンス化し、リクエストする必要があります。

例

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

トランザクション

このライブラリはトランザクションもサポートしています。トランザクションの開始、作成、更新、削除、および結果に応じて変更のコミットまたは中止が行われます。

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