Sophos XGAPI

Sophos XGAPI

Sophos XGAPI es una biblioteca PHP para solicitar cortafuegos de Sophos XG. Esta biblioteca puede:

• Recuperar datos del firewall
• Establecer datos en el firewall
• Eliminar datos del firewall

Puede encontrar los nombres de todas las entidades admitidas en el sitio web de Sophos.

Tabla de contenido

• Empezando
• Documentación
  • clase de configuración
  • clase XGAPI
    • conseguir()
    • colocar()
    • eliminar()

Empezando

1. Obtener compositor.
2. Instale la biblioteca usando Composer composer require benclerc/sophos-xgapi .
3. Agregue lo siguiente al archivo PHP principal de su aplicación require 'vendor/autoload.php'; .
4. Cree una instancia de la clase Config con el nombre de host, el nombre de usuario y la contraseña del firewall $configFirewall = new SophosConfig('123.123.123.123', 'admin', 'password'); .
5. Utilice el objeto Config creado previamente para instanciar el objeto XGAPI $firewall = new SophosXGAPI($configFirewall); .
6. Comience a usar la biblioteca $hosts = $firewall->get(['IPHost']); .

Documentación

Puede encontrar una documentación completa aquí.

clase de configuración

Esta clase de configuración se utiliza para preparar la información de configuración obligatoria para instanciar y utilizar la clase XGAPI. En el constructor debes pasar:

1. El nombre de host del firewall (FQDN)
2. Un nombre de usuario válido
3. La contraseña del usuario válida

Parámetros opcionales:

• Tiempo de espera de CURL: 10000 ms. Utilice setTimeout() para cambiar.
• Opción de verificación de pares de CURL SSL: VERDADERO. Utilice setSSLVerifyPeer() para cambiar.
• Opción de verificación de host CURL SSL: 2. Utilice setSSLVerifyHost() para cambiar.

Ejemplo :

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

clase XGAPI

conseguir()

Este método se utiliza para recuperar datos del firewall. Debe establecer qué entidad/entidades desea recuperar y puede establecer un filtro para cada una. Tenga cuidado, si configura varios filtros para la misma entidad, se suman como un "O", no como un "Y". Tenga cuidado, no todos los atributos se pueden filtrar; consulte la documentación de Sophos. Criterios disponibles para filtrar:

1. =
2. como
3. !=

Ejemplos:

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

colocar()

Este método se utiliza para configurar datos en el firewall. Debe configurar todos los atributos obligatorios para cada entidad que desee agregar.

Ejemplos:

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

eliminar()

Este método se utiliza para eliminar datos del firewall. Debe configurar las entidades que desea eliminar, así como el nombre de los objetos que desea eliminar; no puede eliminar nada más que el nombre del objeto.

Ejemplos:

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