Sophos XGAPI

Sophos XGAPI

Sophos XGAPI adalah perpustakaan PHP untuk meminta firewall Sophos XG. Perpustakaan ini dapat:

• Ambil data dari firewall
• Atur data di firewall
• Hapus data dari firewall

Anda dapat menemukan semua nama entitas yang didukung di situs web Sophos.

Daftar isi

• Memulai
• Dokumentasi
  • Kelas konfigurasi
  • kelas XGAPI
    • mendapatkan()
    • mengatur()
    • menghapus()

Memulai

1. Dapatkan Komposer.
2. Instal perpustakaan menggunakan composer composer require benclerc/sophos-xgapi .
3. Tambahkan yang berikut ini ke file PHP utama aplikasi Anda require 'vendor/autoload.php'; .
4. Buat instance kelas Config dengan nama host, nama pengguna, dan kata sandi firewall $configFirewall = new SophosConfig('123.123.123.123', 'admin', 'password'); .
5. Gunakan objek Config yang sebelumnya dibuat untuk membuat instance objek XGAPI $firewall = new SophosXGAPI($configFirewall); .
6. Mulai gunakan perpustakaan $hosts = $firewall->get(['IPHost']); .

Dokumentasi

Anda dapat menemukan dokumentasi lengkapnya di sini.

Kelas konfigurasi

Kelas Config ini digunakan untuk menyiapkan informasi konfigurasi wajib untuk membuat instance dan menggunakan kelas XGAPI. Di konstruktor Anda harus melewati:

1. Nama host firewall (FQDN)
2. Nama pengguna pengguna yang valid
3. Kata sandi pengguna yang valid

Parameter opsional:

• Batas waktu CURL: 10.000 ms. Gunakan setTimeout() untuk mengubah.
• Opsi rekan verifikasi CURL SSL: BENAR. Gunakan setSSLVerifyPeer() untuk mengubah.
• Opsi CURL SSL verifikasi host : 2. Gunakan setSSLVerifyHost() untuk mengubahnya.

Contoh :

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

kelas XGAPI

mendapatkan()

Metode ini digunakan untuk mengambil data dari firewall. Anda harus mengatur entitas/entitas mana yang ingin Anda ambil dan Anda dapat mengatur filter untuk masing-masing entitas. Hati-hati, jika Anda menyetel beberapa filter untuk entitas yang sama, filter tersebut akan dijumlahkan seperti 'ATAU', bukan 'DAN'. Hati-hati tidak semua atribut dapat difilter, lihat dokumentasi Sophos. Kriteria yang tersedia untuk pemfilteran:

1. =
2. menyukai
3. !=

Contoh :

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

mengatur()

Cara ini digunakan untuk mengatur data pada firewall. Anda harus menetapkan semua atribut wajib untuk setiap entitas yang ingin Anda tambahkan.

Contoh :

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

menghapus()

Metode ini digunakan untuk menghapus data dari firewall. Anda harus mengatur entitas yang ingin Anda hapus serta nama objek yang ingin Anda hapus, Anda tidak dapat menghapus selain nama objek tersebut.

Contoh :

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