Sophos XGAPI

Sophos XGAPI

Sophos XGAPI ist eine PHP-Bibliothek zum Anfordern von Sophos XG-Firewalls. Diese Bibliothek kann:

• Daten von der Firewall abrufen
• Legen Sie die Daten in der Firewall fest
• Daten aus der Firewall entfernen

Die Namen aller unterstützten Einheiten finden Sie auf der Sophos-Website.

Inhaltsverzeichnis

• Erste Schritte
• Dokumentation
  • Konfigurationsklasse
  • XGAPI-Klasse
    • erhalten()
    • Satz()
    • entfernen()

Erste Schritte

1. Holen Sie sich Composer.
2. Installieren Sie die Bibliothek mit Composer composer require benclerc/sophos-xgapi .
3. Fügen Sie der Haupt-PHP-Datei Ihrer Anwendung Folgendes hinzu require 'vendor/autoload.php'; .
4. Instanziieren Sie die Config-Klasse mit dem Hostnamen, Benutzernamen und Passwort der Firewall $configFirewall = new SophosConfig('123.123.123.123', 'admin', 'password'); .
5. Verwenden Sie das zuvor erstellte Config-Objekt, um das XGAPI-Objekt zu instanziieren $firewall = new SophosXGAPI($configFirewall); .
6. Beginnen Sie mit der Verwendung der Bibliothek $hosts = $firewall->get(['IPHost']); .

Dokumentation

Eine vollständige Dokumentation finden Sie hier.

Konfigurationsklasse

Diese Konfigurationsklasse wird verwendet, um die obligatorischen Konfigurationsinformationen für die Instanziierung und Verwendung der XGAPI-Klasse vorzubereiten. Im Konstruktor müssen Sie Folgendes übergeben:

1. Der Hostname (FQDN) der Firewall
2. Der Benutzername eines gültigen Benutzers
3. Das Passwort des gültigen Benutzers

Optionale Parameter:

• CURL-Timeout: 10000 ms. Verwenden Sie setTimeout() zum Ändern.
• CURL-SSL-Peer-Überprüfungsoption: TRUE. Verwenden Sie zum Ändern setSSLVerifyPeer() .
• CURL-SSL-Host-Überprüfungsoption: 2. Verwenden Sie setSSLVerifyHost() zum Ändern.

Beispiel :

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

erhalten()

Mit dieser Methode werden Daten von der Firewall abgerufen. Sie müssen festlegen, welche Entität(en) Sie abrufen möchten, und Sie können für jede einzelne einen Filter festlegen. Seien Sie vorsichtig, wenn Sie mehrere Filter für dieselbe Entität festlegen, addieren sie sich wie ein „ODER“ und nicht wie ein „UND“. Beachten Sie, dass nicht alle Attribute filterbar sind. Weitere Informationen finden Sie in der Sophos-Dokumentation. Verfügbare Filterkriterien:

1. =
2. wie
3. !=

Beispiele:

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

Satz()

Mit dieser Methode werden Daten auf der Firewall eingestellt. Sie müssen alle obligatorischen Attribute für jede Entität festlegen, die Sie hinzufügen möchten.

Beispiele:

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

entfernen()

Mit dieser Methode werden Daten aus der Firewall entfernt. Sie müssen die Entitäten festlegen, die Sie löschen möchten, sowie den Namen der Objekte, die Sie löschen möchten. Sie können nichts anderes als den Namen des Objekts löschen.

Beispiele:

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