Sophos XGAPI

Sophos XGAPI

Sophos XGAPI هي مكتبة PHP لطلب جدران الحماية Sophos XG. يمكن لهذه المكتبة:

• استرداد البيانات من جدار الحماية
• ضبط البيانات على جدار الحماية
• إزالة البيانات من جدار الحماية

يمكنك العثور على أسماء جميع الكيانات المدعومة على موقع سوفوس الإلكتروني.

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

• ابدء
• التوثيق
  • فئة التكوين
  • فئة XGAPI
    • يحصل()
    • تعيين()
    • يزيل()

ابدء

1. احصل على الملحن.
2. تثبيت المكتبة باستخدام composer require benclerc/sophos-xgapi .
3. أضف ما يلي إلى ملف PHP الرئيسي لتطبيقك require 'vendor/autoload.php'; .
4. قم بإنشاء فئة Config باستخدام اسم مضيف جدار الحماية واسم المستخدم وكلمة المرور $configFirewall = new SophosConfig('123.123.123.123', 'admin', 'password'); .
5. استخدم كائن التكوين الذي تم إنشاؤه مسبقًا لإنشاء كائن XGAPI $firewall = new SophosXGAPI($configFirewall); .
6. ابدأ باستخدام المكتبة $hosts = $firewall->get(['IPHost']); .

التوثيق

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

فئة التكوين

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

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

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

• مهلة الضفيرة: 10000 مللي ثانية. استخدم setTimeout() للتغيير.
• CURL SSL التحقق من خيار النظير: TRUE. استخدم setSSLVerifyPeer() للتغيير.
• خيار التحقق من المضيف CURL SSL: 2. استخدم setSSLVerifyHost() للتغيير.

مثال :

 // Basic configuration
$ configFirewall = new  Sophos  Config ( ' 123.123.123.123 ' , ' admin ' , ' password ' );

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

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

$ firewall = new  Sophos  XGAPI ( $ configFirewall );

فئة XGAPI

يحصل()

يتم استخدام هذه الطريقة لاسترداد البيانات من جدار الحماية. يجب عليك تحديد الكيان/الكيانات التي تريد استردادها ويمكنك تعيين عامل تصفية لكل منها. كن حذرًا، إذا قمت بتعيين عدة عوامل تصفية لنفس الكيان، فسيتم إضافتها مثل "OR" وليس "AND". كن حذرًا، ليست كل السمات قابلة للتصفية، راجع وثائق Sophos. المعايير المتاحة للتصفية:

1. =
2. يحب
3. !=

أمثلة :

 // All IPHost
$ entities = [ ' IPHost ' ];
// IPHost named 'IP_TEST'
$ entities = [
	' IPHost ' =>[
		[ ' Name ' , ' = ' , ' IP_TEST ' ]
	]
];
// All IPHost with 'IP_' in the name OR of type 'Network' 
$ entities = [
	' IPHost ' =>[
		[ ' Name ' , ' like ' , ' IP_ ' ],
		[ ' HostType ' , ' = ' , ' Network ' ]
	]
];
// All IPHost and network interface named LAN
$ entities = [
	' IPHost ' ,
	' Interface ' =>[
		[ ' Name ' , ' = ' , ' LAN ' ]
	]
];

try {
	$ result = $ firewall -> get ( $ entites );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

تعيين()

يتم استخدام هذه الطريقة لتعيين البيانات على جدار الحماية. يجب عليك تعيين كافة السمات الإلزامية لكل كيانات تريد إضافتها.

أمثلة :

 // Add 1 IPv4 hosts
$ entities = [
	' IPHost ' => [
		[
			' Name ' => ' IP_TEST ' ,
			' IPFamily ' => ' IPv4 ' ,
			' HostType ' => ' IP ' ,
			' HostGroupList ' =>[
				' HostGroup ' => ' IP-GRP_TEST '
			],
			' IPAddress ' => ' 10.11.12.13 ' ,
			' Subnet ' => ' 255.255.255.0 '
		]
	]
];
// Add 2 IPv4 hosts
$ entities = [
	' IPHost ' => [
		[
			' Name ' => ' IP_TEST ' ,
			' IPFamily ' => ' IPv4 ' ,
			' HostType ' => ' IP ' ,
			' HostGroupList ' =>[
				' HostGroup ' => ' IP-GRP_TEST '
			],
			' IPAddress ' => ' 10.11.12.13 ' ,
			' Subnet ' => ' 255.255.255.0 '
		],
		[
			' Name ' => ' IP_TEST2 ' ,
			' IPFamily ' => ' IPv4 ' ,
			' HostType ' => ' IP ' ,
			' HostGroupList ' =>[
				' HostGroup ' => ' IP-GRP_TEST '
			],
			' IPAddress ' => ' 10.11.12.14 ' ,
			' Subnet ' => ' 255.255.255.0 '
		]
	]
];
// Add 2 IPv4 hosts and 1 QOS policy
$ entities = [
	' IPHost ' => [
		[
			' Name ' => ' IP_TEST ' ,
			' IPFamily ' => ' IPv4 ' ,
			' HostType ' => ' IP ' ,
			' HostGroupList ' =>[
				' HostGroup ' => ' IP-GRP_TEST '
			],
			' IPAddress ' => ' 10.11.12.13 ' ,
			' Subnet ' => ' 255.255.255.0 '
		],
		[
			' Name ' => ' IP_TEST2 ' ,
			' IPFamily ' => ' IPv4 ' ,
			' HostType ' => ' IP ' ,
			' HostGroupList ' =>[
				' HostGroup ' => ' IP-GRP_TEST '
			],
			' IPAddress ' => ' 10.11.12.14 ' ,
			' Subnet ' => ' 255.255.255.0 '
		]
	],
	' QoSPolicy ' =>[
		[
		' Name ' => ' QOS_TEST ' ,
		' PolicyBasedOn ' => ' FirewallRule ' ,
		' BandwidthUsageType ' => ' Shared ' ,
		' ImplementationOn ' => ' Total ' ,
		' PolicyType ' => ' Strict ' ,
		' Priority ' => ' Normal4 ' ,
		' TotalBandwidth ' => ' 6875 '
		]
	]
];

try {
	$ result = $ firewall -> set ( $ entites );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}

يزيل()

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

أمثلة :

 // Remove the IPv4 host 'IP_TEST'
$ entities = [
	' IPHost ' => [
		' IP_TEST '
	]
];
// Remove the IPv4 hosts 'IP_TEST' and 'IP_TEST2'
$ entities = [
	' IPHost ' => [
		' IP_TEST ' ,
		' IP_TEST2 '
	]
];
// Remove the IPv4 hosts 'IP_TEST' and 'IP_TEST2' and QOS policy 'QOS_TEST'
$ entities = [
	' IPHost ' => [
		' IP_TEST ' ,
		' IP_TEST2 '
	],
	' QoSPolicy ' => [
		' QOS_TEST '
	]
];

try {
	$ result = $ firewall -> remove ( $ entites );
} catch ( Exception $ e ) {
	echo ( ' Handle error : ' . $ e -> getMessage ());
}