Sophos XGAPI

Sophos XGAPI

Sophos XGAPI — это PHP-библиотека для запроса межсетевых экранов Sophos XG. Эта библиотека может:

• Получить данные с брандмауэра
• Установить данные на брандмауэре
• Удалить данные с брандмауэра

Названия всех поддерживаемых объектов можно найти на веб-сайте Sophos.

Оглавление

• Начиная
• Документация
  • Класс конфигурации
  • 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. Используйте ранее созданный объект Config для создания экземпляра объекта XGAPI $firewall = new SophosXGAPI($configFirewall); .
6. Начните использовать библиотеку $hosts = $firewall->get(['IPHost']); .

Документация

Вы можете найти полную документацию здесь.

Класс конфигурации

Этот класс Config используется для подготовки обязательной информации о конфигурации для создания и использования класса XGAPI. В конструкторе необходимо передать:

1. Имя хоста брандмауэра (FQDN)
2. Действительное имя пользователя
3. Действительный пароль пользователя

Дополнительные параметры:

• Тайм-аут CURL: 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-класс

получать()

Этот метод используется для получения данных от брандмауэра. Вы должны указать, какой объект/объекты вы хотите получить, и вы можете установить фильтр для каждого из них. Будьте осторожны: если вы установите несколько фильтров для одного и того же объекта, они складываются как «ИЛИ», а не как «И». Будьте осторожны: не все атрибуты можно фильтровать, см. документацию 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 ());
}