Sophos XGAPI

Sophos XGAPI

Sophos XGAPI é uma biblioteca PHP para solicitar firewalls Sophos XG. Esta biblioteca pode:

• Recuperar dados do firewall
• Definir dados no firewall
• Remover dados do firewall

Você pode encontrar os nomes de todas as entidades suportadas no site da Sophos.

Índice

• Começando
• Documentação
  • Classe de configuração
  • Classe XGAPI
    • pegar()
    • definir()
    • remover()

Começando

1. Obtenha o Compositor.
2. Instale a biblioteca usando composer require benclerc/sophos-xgapi .
3. Adicione o seguinte ao arquivo PHP principal do seu aplicativo require 'vendor/autoload.php'; .
4. Instancie a classe Config com o nome de host, nome de usuário e senha do firewall $configFirewall = new SophosConfig('123.123.123.123', 'admin', 'password'); .
5. Utilize o objeto Config criado anteriormente para instanciar o objeto XGAPI $firewall = new SophosXGAPI($configFirewall); .
6. Comece a usar a biblioteca $hosts = $firewall->get(['IPHost']); .

Documentação

Você pode encontrar uma documentação completa aqui.

Classe de configuração

Esta classe Config é usada para preparar as informações de configuração obrigatórias para instanciar e usar a classe XGAPI. No construtor você deve passar:

1. O nome de host do firewall (FQDN)
2. Um nome de usuário válido
3. A senha do usuário válida

Parâmetros opcionais:

• Tempo limite do CURL: 10.000 ms. Use setTimeout() para alterar.
• Opção de verificação de par CURL SSL: TRUE. Use setSSLVerifyPeer() para alterar.
• Opção de host de verificação CURL SSL: 2. Use setSSLVerifyHost() para alterar.

Exemplo :

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

Classe XGAPI

pegar()

Este método é usado para recuperar dados do firewall. Você deve definir quais entidades deseja recuperar e pode definir um filtro para cada uma. Tenha cuidado, se você definir vários filtros para a mesma entidade, eles serão somados como um 'OR' e não como um 'AND'. Tenha cuidado, nem todos os atributos são filtráveis, consulte a documentação do Sophos. Critérios disponíveis para filtragem:

1. =
2. como
3. !=

Exemplos:

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

definir()

Este método é usado para definir dados no firewall. Você deve definir todos os atributos obrigatórios para cada entidade que deseja adicionar.

Exemplos:

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

remover()

Este método é usado para remover dados do firewall. Você deve definir as entidades que deseja excluir, bem como o nome dos objetos que deseja excluir; você não pode excluir nada além do nome do objeto.

Exemplos:

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