Sophos XGAPI

Sophos XGAPI

Sophos XGAPI est une bibliothèque PHP permettant de demander les pare-feu Sophos XG. Cette bibliothèque peut :

• Récupérer les données du pare-feu
• Définir les données sur le pare-feu
• Supprimer les données du pare-feu

Vous pouvez trouver les noms de toutes les entités prises en charge sur le site Web de Sophos.

Table des matières

• Commencer
• Documentation
  • Classe de configuration
  • Classe XGAPI
    • obtenir()
    • ensemble()
    • retirer()

Commencer

1. Obtenez Compositeur.
2. Installez la bibliothèque à l'aide de composer composer require benclerc/sophos-xgapi .
3. Ajoutez ce qui suit au fichier PHP principal de votre application require 'vendor/autoload.php'; .
4. Instanciez la classe Config avec le nom d'hôte, le nom d'utilisateur et le mot de passe du pare-feu $configFirewall = new SophosConfig('123.123.123.123', 'admin', 'password'); .
5. Utilisez l'objet Config créé précédemment pour instancier l'objet XGAPI $firewall = new SophosXGAPI($configFirewall); .
6. Commencez à utiliser la bibliothèque $hosts = $firewall->get(['IPHost']); .

Documentation

Vous pouvez trouver une documentation complète ici.

Classe de configuration

Cette classe Config est utilisée pour préparer les informations de configuration obligatoires pour instancier et utiliser la classe XGAPI. Dans le constructeur vous devez passer :

1. Le nom d'hôte du pare-feu (FQDN)
2. Le nom d'utilisateur d'un utilisateur valide
3. Le mot de passe de l'utilisateur valide

Paramètres optionnels :

• Délai d'expiration CURL : 10 000 ms. Utilisez setTimeout() pour changer.
• Option de vérification homologue CURL SSL : TRUE. Utilisez setSSLVerifyPeer() pour modifier.
• Option d'hôte de vérification SSL CURL : 2. Utilisez setSSLVerifyHost() pour modifier.

Exemple :

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

obtenir()

Cette méthode est utilisée pour récupérer les données du pare-feu. Vous devez définir la ou les entités que vous souhaitez récupérer et vous pouvez définir un filtre pour chacune d'elles. Attention, si vous définissez plusieurs filtres pour la même entité, ils s'additionnent comme un « OU » et non un « ET ». Attention, tous les attributs ne sont pas filtrables, consultez la documentation Sophos. Critères disponibles pour le filtrage :

1. =
2. comme
3. !=

Exemples :

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

ensemble()

Cette méthode est utilisée pour définir les données sur le pare-feu. Vous devez définir tous les attributs obligatoires pour chaque entité que vous souhaitez ajouter.

Exemples :

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

retirer()

Cette méthode est utilisée pour supprimer les données du pare-feu. Vous devez définir les entités que vous souhaitez supprimer ainsi que le nom des objets que vous souhaitez supprimer, vous ne pouvez pas supprimer autre chose que le nom de l'objet.

Exemples :

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