Fortinet FortiOSAPI

واجهة برمجة تطبيقات تكوين Fortinet Fortigate (FortiOS)

يتم إنشاء هذه المكتبة تلقائيًا، إذا كنت تريد دعمًا لإصدار أحدث، فيرجى فتح مشكلة.

مكتبة PHP المستخدمة للتفاعل مع واجهات برمجة تطبيقات جدار الحماية Fortigate (FortiOS) (CMDB (التكوين)، والسجل والمراقبة). يمكن لهذه المكتبة استرداد التكوين على جدار الحماية وإنشائه وتحديثه وحذفه.

يمكنك العثور على جميع الطرق المدعومة على موقع مطور Fortinet، وسوف تحتاج إلى حساب لتصفح المعلومات.

جدول المحتويات

• ابدء
• التوثيق
  • فئة التكوين
    • الاستخدام
    • أمثلة
  • فئات التكوين والتسجيل والمراقبة
    • الاستخدام
    • أمثلة
    • المعاملات

ابدء

1. احصل على الملحن.
2. قم بتثبيت المكتبة باستخدام composer require benclerc/fortinet-fortiosapi .
3. أضف ما يلي إلى ملف PHP الرئيسي لتطبيقك require 'vendor/autoload.php'; .
4. قم بإنشاء فئة التكوين باستخدام اسم مضيف جدار الحماية واسم المستخدم وكلمة المرور $configConnection = new FortinetFortiOSAPIConfig('123.123.123.123', 'admin', 'password'); .
5. استخدم كائن التكوين الذي تم إنشاؤه مسبقًا لإنشاء كائن FortiOSAPI $firewallConf = new FortinetFortiOSAPIConfiguration($configConnection); .
6. ابدأ في استخدام المكتبة $staticRoutes = $firewallConf->getAllRouterStatic(); .

التوثيق

يمكنك العثور على وثائق كاملة هنا.

فئة التكوين

الاستخدام

يتم استخدام فئة التكوين هذه لإعداد معلومات التكوين الإلزامية لإنشاء واستخدام فئات FortiOSAPI.... في المنشئ يجب عليك تمرير:

1. اسم مضيف جدار الحماية (FQDN) أو عنوان IP
2. اسم مستخدم صالح للمستخدم
3. كلمة مرور المستخدم الصالحة

المعلمات الاختيارية :

• المهلة: 5000 مللي ثانية. استخدم 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 ());
}

فئات التكوين والتسجيل والمراقبة

الاستخدام

تستخدم هذه الفئات الاستثناء لمعالجة الأخطاء، وبالنسبة للتنفيذ الاسمي، يجب عليك إنشاء مثيل وطلب الأساليب داخل عبارات المحاولة/التقاط.

أمثلة

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