Browse Source

Plugin IPSet pour SPIP qui ajoute un champ 'access_ips' sur les auteurs SPIP,

permettant de définir des IPs ou Plages d’IPs pour les auteurs donc.

Des fonctions permettent de tester qu’une IP arrivante est connue (c’est rapide),
de retrouver d’id_auteur associé (plus lent, mais avec différents caches ça passe),
et d’en faire une session anonyme, ou éventuellement d’autres choses qui seraient voulues.
pull/2/head
Matthieu Marcillaud 2 years ago
commit
94253fe99d
  1. 31
      base/ipset.php
  2. 78
      genie/accessip.php
  3. 112
      inc/AccessIP.php
  4. 106
      inc/ipset.php
  5. 77
      inclure/ipset_diagnostic.html
  6. 52
      ipset_administrations.php
  7. 14
      ipset_fonctions.php
  8. 83
      ipset_options.php
  9. 36
      ipset_pipelines.php
  10. 25
      lang/ipset_fr.php
  11. 14
      lang/paquet-ipset_fr.php
  12. 339
      lib/IPSet/COPYING
  13. 84
      lib/IPSet/README.md
  14. 6
      lib/IPSet/src/IPSet/IPSet.php
  15. 232
      lib/IPSet/src/Wikimedia/IPSet.php
  16. 4
      lib/IPTools/.codeclimate.yml
  17. 32
      lib/IPTools/.gitignore
  18. 17
      lib/IPTools/.travis.yml
  19. 20
      lib/IPTools/LICENSE
  20. 206
      lib/IPTools/README.md
  21. 25
      lib/IPTools/composer.json
  22. 286
      lib/IPTools/src/IP.php
  23. 365
      lib/IPTools/src/Network.php
  24. 45
      lib/IPTools/src/PropertyTrait.php
  25. 228
      lib/IPTools/src/Range.php
  26. 255
      lib/IPTools/tests/IPTest.php
  27. 305
      lib/IPTools/tests/NetworkTest.php
  28. 146
      lib/IPTools/tests/RangeTest.php
  29. 10
      lib/IPTools/tests/bootstrap.php
  30. 27
      paquet.xml
  31. 72
      prive/squelettes/contenu/ipset_diagnostic.html
  32. 1
      prive/themes/spip/images/ipset-xx.svg
  33. 7
      saisies-vues/access_ips.html
  34. 15
      saisies-vues/access_ips_fonctions.php
  35. 51
      saisies/access_ips.html
  36. 69
      verifier/access_ips.php

31
base/ipset.php

@ -0,0 +1,31 @@
<?php
/**
* Fichier déclarant les champs de base de données
*
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Base
*/
/**
* Champs extra sur auteurs
*/
function ipset_declarer_champs_extras($champs = array()){
$champs['spip_auteurs']['access_ips'] = array(
'saisie' => 'access_ips', //Type du champs (voir plugin Saisies)
'options' => array(
'nom' => 'access_ips',
'label' => _T('ipset:label_access_ips'),
'sql' => "mediumtext DEFAULT '' NOT NULL", // declaration sql
'defaut' => '',
'explication' => _T('ipset:label_access_ips_explication'),
),
'verifier' => array(
'type' => 'access_ips'
),
);
return $champs;
}

78
genie/accessip.php

@ -0,0 +1,78 @@
<?php
/**
* Gestion du nettoyage des access IP
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Genie
**/
if (!defined("_ECRIRE_INC_VERSION")) {
return;
}
/**
* Cron de nettoyage des accès IP
*
* @param int $t
* Timestamp de la dernière exécution de cette tâche
* @return int
* Positif si la tâche a été terminée, négatif pour réexécuter cette tâche
**/
function genie_accessip_dist($t) {
$ips = accessip_lister_vieux_access(_DIR_TMP . 'accessip', 7 * 24 * 3600);
if ($ips) {
spip_log('Nettoyage de ' . count($ips) . ' acces par IPs : ' . implode(', ', $ips), 'ipset');
include_spip('inc/ipset');
foreach ($ips as $ip) {
$accessip = new AccessIP($ip);
$accessip->remove();
}
}
return 1;
}
/**
* Nettoyer un répertoire suivant l'age de ses fichiers
*
* @param string $repertoire
* Répertoire à nettoyer
* @param int $age_max
* Age maximum des fichiers en seconde. Par défaut 24*3600
* @return array Liste des IPs trop vieilles
**/
function accessip_lister_vieux_access($repertoire, $age_max = 86400) {
$repertoire = rtrim($repertoire, '/');
if (!is_dir($repertoire)) {
return [];
}
$fichiers = scandir($repertoire);
if ($fichiers === false) {
return [];
}
$fichiers = array_diff($fichiers, ['..', '.', '.ok']);
if (!$fichiers) {
return [];
}
$ips = [];
foreach ($fichiers as $fichier) {
$chemin = $repertoire . DIRECTORY_SEPARATOR . $fichier;
if (is_file($chemin) and !jeune_fichier($chemin, $age_max)) {
$ips[] = $fichier;
}
}
return $ips;
}

112
inc/AccessIP.php

@ -0,0 +1,112 @@
<?php
/**
* Fonctions du plugin IPs pour les auteurs
*
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Fonctions
*/
class AccessIP {
/**
* @var string IP to test
*/
private $ip;
/**
* @var string Cache directory for IP -> Id author
*/
private $dir_accessip = _DIR_TMP . 'accessip' . DIRECTORY_SEPARATOR;
/**
* @var string Noflood directory for IPs (whitelist for NoSpam plugin and other)
*/
private $dir_noflood = _DIR_TMP . 'noflood' . DIRECTORY_SEPARATOR;
public function __construct(string $ip) {
$this->ip = $ip;
}
/**
* Find id_author for this IP in cache, else in database
*
* Touch cache files (accessip and noflood) to update time if author is found.
*
* @return int id_auteur
*/
public function author() : int {
if ($id_auteur = $this->read()) {
$this->touch();
return $id_auteur;
}
if ($id_auteur = $this->search()) {
$this->save($id_auteur);
return $id_auteur;
}
return 0;
}
/**
* Read cache file for this IP, if exists
* @return int id_auteur
*/
public function read() : int {
if (lire_fichier($this->dir_accessip . $this->ip, $id_auteur) and $id_auteur) {
return (int)$id_auteur;
}
return 0;
}
/**
* Search this IP in each authors
* Can be long process.
* @return int $id_auteur
*/
public function search() : int {
spip_timer('ips');
$relations = ipset_get_all_ips_by_authors();
include_spip('lib/IPSet/src/Wikimedia/IPSet');
foreach ($relations as $id_auteur => $ips) {
$ipset = new \Wikimedia\IPSet($ips);
if ($ipset->match($this->ip)) {
spip_log("Recherche IP $this->ip vers $id_auteur en " . spip_timer('ips'), 'ipset');
return $id_auteur;
}
}
spip_log("Recherche IP $this->ip inconnue en " . spip_timer('ips'), 'ipset');
return 0;
}
/**
* Save in cache file the relation IP to id author.
* @param int $id_auteur
* @return bool
*/
public function save(int $id_auteur) : bool {
sous_repertoire($this->dir_accessip);
if (ecrire_fichier($this->dir_accessip . $this->ip, $id_auteur)) {
@touch($this->dir_noflood . $this->ip);
return true;
}
return false;
}
/**
* Remove cache files for this IP
*/
public function remove() {
supprimer_fichier($this->dir_accessip . $this->ip);
supprimer_fichier($this->dir_noflood . $this->ip);
}
/**
* Update timestamp of cache files for this IP
*/
public function touch() {
@touch($this->dir_accessip . $this->ip);
@touch($this->dir_noflood . $this->ip);
}
}

106
inc/ipset.php

@ -0,0 +1,106 @@
<?php
/**
* Fonctions du plugin IPs pour les auteurs
*
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Fonctions
*/
include_spip('inc/AccessIP');
/**
* Retourne la liste des IP / plages d’IP des auteurs avec l’id_auteur associé en clé
*
* @return array [ id_auteur => [ liste ip ou plages ip ]]
*/
function ipset_get_all_ips_by_authors() {
static $couples = null;
if (is_array($couples)) {
return $couples;
}
include_spip('base/abstract_sql');
// Chaque entrée est une liste séparée par des virgules d’IPs ou de CIDR
$couples = sql_allfetsel(
'id_auteur, access_ips',
'spip_auteurs',
'statut!='.sql_quote('5poubelle').' AND access_ips!=\'\''
);
$couples = array_column($couples, 'access_ips', 'id_auteur');
$couples = array_map('ipset_filter_access_ips', $couples);
return $couples;
}
/**
* Découpe une chaîne d’ips en tableau
* @param string $ips Liste d’ips et plages, séparés par ','
* @return array Liste d’ips et plage
*/
function ipset_filter_access_ips(string $ips) : array {
$ips = explode(',', $ips);
$ips = array_map('trim', $ips);
$ips = array_filter($ips);
return array_unique($ips);
}
/**
* Retourne la liste des IP / plages d’IP de tous les auteurs
*
* @uses ipset_get_all_ips_by_authors()
* @return array
*/
function ipset_get_all_ips() {
$relations = ipset_get_all_ips_by_authors();
// combine tous les sous tableaux d’IP en 1 seul…
$ips = array_reduce($relations, function ($carry, $item) {
return array_merge($carry, $item);
}, []);
return $ips;
}
/**
* Pour eviter un acces en base a chaque hit on compile les IPs dans une meta
*
* @return \Wikimedia\IPSet
*/
function ipset_update_ips_cache() : \Wikimedia\IPSet {
// Calcul du cache des range d’IPs pour calcul de match global assez rapide.
$ips = ipset_get_all_ips();
spip_log("Mise en cache de " . count($ips) . " ips ou plages d’ips", 'ipset');
spip_timer('ips');
include_spip('lib/IPSet/src/Wikimedia/IPSet');
$ipset = new \Wikimedia\IPSet($ips);
ecrire_config("ipset", $ipset);
spip_log("IPSet calculé en " . spip_timer('ips'), 'ipset');
return $ipset;
}
/**
* Retrouver l'id_auteur qui correspond a une IP (si il y en a un)
*
* @param string $ip
* @return int|bool
*/
function ipset_get_author($ip) {
static $ips = [];
if (isset($ips[$ip])) {
return $ips[$ip];
}
$accessip = new AccessIP($ip);
$id_auteur = $accessip->author();
if ($id_auteur) {
$ips[$ip] = $id_auteur;
return $id_auteur;
}
return false;
}

77
inclure/ipset_diagnostic.html

@ -0,0 +1,77 @@
[(#REM) Fil d'Ariane ]
#CACHE{0}
<section>
<header class="cartouche">
<h1><:ipset:titre_page_ip_diagnostic:></h1>
</header>
<div class="main">
<?php
spip_log("Visite IP diagnostic", 'ipset');
function test_ip_cache_ipset() {
include_spip('inc/config');
include_spip('lib/IPSet/src/Wikimedia/IPSet');
$cache_ipset = lire_config("ipset");
if (
!$cache_ipset
or !($cache_ipset instanceof \Wikimedia\IPSet)
) {
return false;
}
return true;
}
$data = array();
$ip = $GLOBALS['ip'];
$data['Your IP'] = $ip;
$data['Cache IPset exists'] = test_ip_cache_ipset() ? 'yes' : 'no';
$data['Your Cache Session exists'] = isset($GLOBALS['visiteur_session']['ip_id_auteur']) ? 'yes' : 'no';
if (($data['Your Cache Session exists'] === 'yes') and empty($GLOBALS['visiteur_session']['ip_id_auteur'])) {
$data['Your Cache Session exists'] .= " (but empty!)";
}
$data['Your IP Session is accepted'] = ipset_access_author() ? 'yes' : 'no';
$data['Your name'] = !empty($GLOBALS['visiteur_session']['ip_id_auteur']) ? $GLOBALS['visiteur_session']['ip_id_auteur'] : 'unknown';
$ipset = ipset_get();
$data['IP matched the IPSet'] = $ipset->match($ip) ? 'yes' : 'no';
include_spip('inc/ipset');
$accessip = new AccessIP($ip);
$data['IP found in file cache'] = $accessip->read() ? 'yes' : 'no';
$data['IP found by full search'] = $accessip->search() ? 'yes' : 'no';
// maintenant, on tente de corriger si problème de cache…
if (!test_ip_cache_ipset()) {
$data['Error : Cache is missing'] = "We make it again...";
ipset_update_ips_cache();
if (!test_ip_cache_ipset()) {
$data['Error : Cache still missing'] = ":-(";
}
}
$data['Thank you'] =
"Thank you for visiting this page. It will help us improve the reliability of your access."
. " <br />You can now return on the home page: <a href='#URL_SITE_SPIP'>#URL_SITE_SPIP</a>";
spip_log("Fin visite IP diagnostic", 'ipset');
?>
<dl><?php
foreach ($data as $dt => $dd) {
echo "<dt>$dt</dt>\n";
echo "<dd>$dd</dd>\n";
}
?><dl>
<?php
spip_log('IP DIAGNOSTIC', 'ip_diagnostic');
spip_log($data, 'ip_diagnostic');
?>
</div>
</section>

52
ipset_administrations.php

@ -0,0 +1,52 @@
<?php
/**
* Fichier gérant l'installation et désinstallation du plugin IPs pour les auteurs
*
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Installation
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
/**
* Fonction d'installation et de mise à jour du plugin IPs pour les auteurs.
*
* @param string $nom_meta_base_version
* Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
* @param string $version_cible
* Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
* @return void
**/
function ipset_upgrade($nom_meta_base_version, $version_cible) {
$maj = array();
// ajout du champ compte_institution_ips + disclaimer_articles
include_spip('inc/cextras');
include_spip('base/ipset');
$champs = ipset_declarer_champs_extras();
cextras_api_upgrade($champs, $maj['create']);
include_spip('base/upgrade');
maj_plugin($nom_meta_base_version, $version_cible, $maj);
}
/**
* Fonction de désinstallation du plugin IPs pour les auteurs.
*
* @param string $nom_meta_base_version
* Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
* @return void
**/
function ipset_vider_tables($nom_meta_base_version) {
include_spip('inc/cextras');
include_spip('base/ipset');
cextras_api_vider_tables(ipset_declarer_champs_extras());
effacer_meta($nom_meta_base_version);
}

14
ipset_fonctions.php

@ -0,0 +1,14 @@
<?php
/**
* Fonctions utiles au plugin IPs pour les auteurs
*
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Fonctions
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}

83
ipset_options.php

@ -0,0 +1,83 @@
<?php
/**
* Options au chargement du plugin IPs pour les auteurs
*
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Options
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
/**
* Retourne un IPSet : pour vérification rapide d’une IP sur les ranges d’ip des auteurs.
* @return \Wikimedia\IPSet
*/
function ipset_get() {
/** @var $ipset \Wikimedia\IPSet */
static $ipset = null;
if (!is_null($ipset)) {
return $ipset;
}
// Retourner le cache des IPs compilé si déjà calculé.
// Selon la méthode de cache, la classe IPSet doit être connue !
include_spip('inc/config');
include_spip('lib/IPSet/src/Wikimedia/IPSet');
$ipset = lire_config('ipset');
if (
$ipset
and $ipset instanceof \Wikimedia\IPSet
and (!defined('_VAR_MODE') or _VAR_MODE !== 'recalcul')
) {
return $ipset;
}
spip_log("Cache ipset absent -> calcul", 'ipset');
include_spip('inc/ipset');
return ipset_update_ips_cache();
}
/**
* Verifier et retrouver id_auteur lie a une IP, si besoin
* avec memo en session
* @return bool|int Id auteur, sinon false.
*/
function ipset_access_author() {
if (isset($GLOBALS['visiteur_session']['ip_id_auteur'])){
return $GLOBALS['visiteur_session']['ip_id_auteur'];
}
$ip = $GLOBALS['ip'];
$ipset = ipset_get();
if ($ipset->match($ip)) {
spip_log("IP : acceptée", "ipset");
// a partir du moment ou on match, il faut enregistrer le resultat en session pour pas faire un acces SQL a chaque hit
// l’ip peut matcher un range d’ip… et retrouver l’auteur est fastidieux.
include_spip('inc/ipset');
$id_auteur = ipset_get_author($ip);
if (!function_exists('session_set')) {
include_spip('inc/session');
}
session_set("ip_id_auteur", $id_auteur);
// retrouver le nom de l’auteur
if ($id_auteur) {
include_spip('base/abstract_sql');
$nom = sql_getfetsel('nom', 'spip_auteurs', array('id_auteur = ' . $id_auteur));
session_set("ip_name", $nom);
spip_log("IP : Auteur $id_auteur / Nom : $nom", "ipset");
} else {
spip_log("IP : Pas d’auteur !", "ipset." . _LOG_ERREUR);
session_set("ip_name", null);
}
return $id_auteur;
}
return false;
}

36
ipset_pipelines.php

@ -0,0 +1,36 @@
<?php
/**
* Utilisations de pipelines par IPs pour les auteurs
*
* @plugin IPs pour les auteurs
* @copyright 2020
* @author marcimat
* @licence GNU/GPL
* @package SPIP\Ipset\Pipelines
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
/**
* Actualiser le cache des IPs lorsqu’un auteur est mis à jour
*
* @param array $flux
* @return array
*/
function ipset_post_edition($flux) {
if (
$flux['args']['table'] === 'spip_auteurs'
and $id_auteur = $flux['args']['id_objet']
and isset($flux['data']['access_ips'])
and $flux['args']['action'] === 'modifier'
) {
include_spip('inc/ipset');
ipset_update_ips_cache();
}
return $flux;
}

25
lang/ipset_fr.php

@ -0,0 +1,25 @@
<?php
// This is a SPIP language file -- Ceci est un fichier langue de SPIP
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
$GLOBALS[$GLOBALS['idx_lang']] = array(
// E
'erreur_format_ip_string' => 'Format de valeur invalide (string)',
'erreur_format_ip' => '<code>@ip@</code> n\'est pas une adresse IP valide',
'erreur_ip_deja_utilisee' => '<code>@ip@</code> est déjà affectée à l\'auteur #@id@',
// I
'ipset_titre' => 'IPs pour les auteurs',
'ip_un' => '1 IP',
'ip_nb' => '@nb@ IPs',
// L
'label_access_ips' => 'Accès par IPs',
'label_access_ips_explication' => 'Liste d’IPs ou de plages d’IPs (CIDR) séparés par des virgules.',
// T
'titre_page_ip_diagnostic' => 'Diagnostic IP',
);

14
lang/paquet-ipset_fr.php

@ -0,0 +1,14 @@
<?php
// This is a SPIP language file -- Ceci est un fichier langue de SPIP
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
$GLOBALS[$GLOBALS['idx_lang']] = array(
// I
'ipset_description' => 'Permet d’attribuer une ou plusieurs IPs ou plages d’IPs à des auteurs SPIP.',
'ipset_nom' => 'IPs pour les auteurs',
'ipset_slogan' => 'Permet d’affecter des IPs à des auteurs',
);

339
lib/IPSet/COPYING

@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

84
lib/IPSet/README.md

@ -0,0 +1,84 @@
IPSet
=====
IPSet is a PHP library for matching IP addresses against a set of CIDR
specifications.
Here is how you use it:
<pre lang="php">
use Wikimedia\IPSet;
// At startup, calculate the optimized data structure for the set:
$ipset = new IPSet( [
'208.80.154.0/26',
'2620:0:861:1::/64',
'10.64.0.0/22',
] );
// Runtime check against cached set (returns bool):
if ( $ipset->match( $ip ) ) {
// ...
}
</pre>
In rough benchmarking, this takes about 80% more time than `in_array()` checks
on a short (a couple hundred at most) array of addresses. It's fast either way
at those levels, though, and IPSet would scale better than in_array if the
array were much larger.
For mixed-family CIDR sets, however, this code gives well over 100x speedup vs
iterating `IP::isInRange()` over an array of CIDR specs.
The basic implementation is two separate binary trees (IPv4 and IPv6) as nested
php arrays with keys named 0 and 1. The values false and true are terminal
match-fail and match-success, otherwise the value is a deeper node in the tree.
A simple depth-compression scheme is also implemented: whole-byte tree
compression at whole-byte boundaries only, where no branching occurs during
that whole byte of depth. A compressed node has keys 'comp' (the byte to
compare) and 'next' (the next node to recurse into if 'comp' matched successfully).
For example, given these inputs:
<pre>
25.0.0.0/9
25.192.0.0/10
</pre>
The v4 tree would look like:
<pre lang="php">
root4 => [
'comp' => 25,
'next' => [
0 => true,
1 => [
0 => false,
1 => true,
],
],
];
</pre>
(multi-byte compression nodes were attempted as well, but were
a net loss in my test scenarios due to additional match complexity)
License
-------
Copyright 2014, 2015 Brandon Black <blblack@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<http://www.gnu.org/copyleft/gpl.html>

6
lib/IPSet/src/IPSet/IPSet.php

@ -0,0 +1,6 @@
<?php
namespace IPSet;
class IPSet extends \Wikimedia\IPSet {
}

232
lib/IPSet/src/Wikimedia/IPSet.php

@ -0,0 +1,232 @@
<?php
/**
* Copyright 2014, 2015 Brandon Black <blblack@gmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Brandon Black <blblack@gmail.com>
*/
namespace Wikimedia;
/**
* Matches IP addresses against a set of CIDR specifications
*
* Usage:
*
* use Wikimedia\IPSet;
* // At startup, calculate the optimized data structure for the set:
* $ipset = new IPSet( [
* '208.80.154.0/26',
* '2620:0:861:1::/64',
* '10.64.0.0/22',
* ] );
*
* // Runtime check against cached set (returns bool):
* $allowme = $ipset->match( $ip );
*
* In rough benchmarking, this takes about 80% more time than
* in_array() checks on a short (a couple hundred at most) array
* of addresses. It's fast either way at those levels, though,
* and IPSet would scale better than in_array if the array were
* much larger.
*
* For mixed-family CIDR sets, however, this code gives well over
* 100x speedup vs iterating IP::isInRange() over an array
* of CIDR specs.
*
* The basic implementation is two separate binary trees
* (IPv4 and IPv6) as nested php arrays with keys named 0 and 1.
* The values false and true are terminal match-fail and match-success,
* otherwise the value is a deeper node in the tree.
*
* A simple depth-compression scheme is also implemented: whole-byte
* tree compression at whole-byte boundaries only, where no branching
* occurs during that whole byte of depth. A compressed node has
* keys 'comp' (the byte to compare) and 'next' (the next node to
* recurse into if 'comp' matched successfully).
*
* For example, given these inputs:
*
* 25.0.0.0/9
* 25.192.0.0/10
*
* The v4 tree would look like:
*
* root4 => [
* 'comp' => 25,
* 'next' => [
* 0 => true,
* 1 => [
* 0 => false,
* 1 => true,
* ],
* ],
* ];
*
* (multi-byte compression nodes were attempted as well, but were
* a net loss in my test scenarios due to additional match complexity)
*/
class IPSet {
/** @var array|bool $root4 The root of the IPv4 matching tree */
private $root4 = false;
/** @var array|bool $root6 The root of the IPv6 matching tree */
private $root6 = false;
/**
* Instantiate the object from an array of CIDR specs
*
* Invalid input network/mask values in $cfg will result in issuing
* E_WARNING and/or E_USER_WARNING and the bad values being ignored.
*
* @param array $cfg Array of IPv[46] CIDR specs as strings
*/
public function __construct( array $cfg ) {
foreach ( $cfg as $cidr ) {
$this->addCidr( $cidr );
}
}
/**
* Add a single CIDR spec to the internal matching trees
*
* @param string $cidr String CIDR spec, IPv[46], optional /mask (def all-1's)
*/
private function addCidr( $cidr ) {
// v4 or v6 check
if ( strpos( $cidr, ':' ) === false ) {
$node =& $this->root4;
$defMask = '32';
} else {
$node =& $this->root6;
$defMask = '128';
}
// Default to all-1's mask if no netmask in the input
if ( strpos( $cidr, '/' ) === false ) {
$net = $cidr;
$mask = $defMask;
} else {
list( $net, $mask ) = explode( '/', $cidr, 2 );
if ( !ctype_digit( $mask ) || intval( $mask ) > $defMask ) {
trigger_error( "IPSet: Bad mask '$mask' from '$cidr', ignored", E_USER_WARNING );
return;
}
}
$mask = intval( $mask ); // explicit integer convert, checked above
// convert $net to an array of integer bytes, length 4 or 16:
$raw = inet_pton( $net );
if ( $raw === false ) {
return; // inet_pton() sends an E_WARNING for us
}
$rawOrd = array_map( 'ord', str_split( $raw ) );
// iterate the bits of the address while walking the tree structure for inserts
// at the end, $snode will point to the highest node that could only lead to a
// successful match (and thus can be set to true)
$snode =& $node;
$curBit = 0;
while ( 1 ) {
if ( $node === true ) {
// already added a larger supernet, no need to go deeper
return;
} elseif ( $curBit == $mask ) {
// this may wipe out deeper subnets from earlier
$snode = true;
return;
} elseif ( $node === false ) {
// create new subarray to go deeper
if ( !( $curBit & 7 ) && $curBit <= $mask - 8 ) {
$node = [ 'comp' => $rawOrd[$curBit >> 3], 'next' => false ];
} else {
$node = [ false, false ];
}
}
if ( isset( $node['comp'] ) ) {
$comp = $node['comp'];
if ( $rawOrd[$curBit >> 3] == $comp && $curBit <= $mask - 8 ) {
// whole byte matches, skip over the compressed node
$node =& $node['next'];
$snode =& $node;
$curBit += 8;
continue;
} else {
// have to decompress the node and check individual bits
$unode = $node['next'];
for ( $i = 0; $i < 8; ++$i ) {
$unode = ( $comp & ( 1 << $i ) )
? [ false, $unode ]
: [ $unode, false ];
}
$node = $unode;
}
}
$maskShift = 7 - ( $curBit & 7 );
$index = ( $rawOrd[$curBit >> 3] & ( 1 << $maskShift ) ) >> $maskShift;
if ( $node[$index ^ 1] !== true ) {
// no adjacent subnet, can't form a supernet at this level
$snode =& $node[$index];
}
$node =& $node[$index];
++$curBit;
} // Unreachable outside 'while'
} // @codeCoverageIgnore
/**
* Match an IP address against the set
*
* If $ip is unparseable, inet_pton may issue an E_WARNING to that effect
*
* @param string $ip string IPv[46] address
* @return bool True is match success, false is match failure
*/
public function match( $ip ) {
$raw = inet_pton( $ip );
if ( $raw === false ) {
return false; // inet_pton() sends an E_WARNING for us
}
$rawOrd = array_map( 'ord', str_split( $raw ) );
if ( count( $rawOrd ) == 4 ) {
$node =& $this->root4;
} else {
$node =& $this->root6;
}
$curBit = 0;
while ( $node !== true && $node !== false ) {
if ( isset( $node['comp'] ) ) {
// compressed node, matches 1 whole byte on a byte boundary
if ( $rawOrd[$curBit >> 3] != $node['comp'] ) {
return false;
}
$curBit += 8;
$node =& $node['next'];
} else {
// uncompressed node, walk in the correct direction for the current bit-value
$maskShift = 7 - ( $curBit & 7 );
$node =& $node[( $rawOrd[$curBit >> 3] & ( 1 << $maskShift ) ) >> $maskShift];
++$curBit;
}
}
return $node;
}
}

4
lib/IPTools/.codeclimate.yml

@ -0,0 +1,4 @@
languages:
PHP: true
exclude_paths:
- "tests/*"

32
lib/IPTools/.gitignore

@ -0,0 +1,32 @@
# phpstorm project files
.idea
# netbeans project files
nbproject
# zend studio for eclipse project files
.buildpath
.project
.settings
# windows thumbnail cache
Thumbs.db
# Mac DS_Store Files
.DS_Store
# composer vendor dir
/vendor
# phpunit itself is not needed
phpunit.phar
# local phpunit config
phpunit.xml
phpunit.xml.dist
# coverage report
/coverage
composer.phar
composer.lock

17
lib/IPTools/.travis.yml

@ -0,0 +1,17 @@
language: php
php:
- 5.4
- 5.5
- 5.6
- 7.0
before_script:
- wget http://getcomposer.org/composer.phar
- php composer.phar install --dev --no-interaction
script:
- mkdir -p build/logs
- phpunit --coverage-clover build/logs/clover.xml
after_script:
- php vendor/bin/coveralls

20
lib/IPTools/LICENSE

@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2014 Safarov Alisher
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

206
lib/IPTools/README.md

@ -0,0 +1,206 @@
# IPTools
PHP Library for manipulating network addresses (IPv4 and IPv6).
[![Build Status](https://travis-ci.org/S1lentium/IPTools.svg)](https://travis-ci.org/S1lentium/IPTools)
[![Coverage Status](https://coveralls.io/repos/S1lentium/IPTools/badge.svg?branch=master&service=github)](https://coveralls.io/github/S1lentium/IPTools?branch=master)
[![Code Climate](https://codeclimate.com/github/S1lentium/IPTools/badges/gpa.svg)](https://codeclimate.com/github/S1lentium/IPTools)
[![PHP 5.4](https://img.shields.io/badge/PHP-5.4-8892BF.svg)](http://php.net)
[![PHP 7.0](https://img.shields.io/badge/PHP-7.0-8892BF.svg)](http://php.net)
## Installation
Composer:
Run in command line:
```
composer require s1lentium/iptools
```
or put in composer.json:
```json
{
"require": {
"s1lentium/iptools": "*"
}
}
```
## Usage
### IP Operations
```php
$ip = new IP('192.168.1.1');
echo $ip->version;// IPv4
```
```php
$ip = new IP('fc00::');
echo $ip->version; // IPv6
```
**Parsing IP from integer, binary and hex:**
```php
echo (string)IP::parse(2130706433); // 127.0.0.1
echo (string)IP::parse('0b11000000101010000000000100000001') // 192.168.1.1
echo (string)IP::parse('0x0a000001'); // 10.0.0.1
```
or:
```php
echo (string)IP::parseLong(2130706433); // 127.0.0.1
echo (string)IP::parseBin('11000000101010000000000100000001'); // 192.168.1.1
echo (string)IP::parseHex('0a000001'); // 10.0.0.1
```
**Converting IP to other formats:**
```php
echo IP::parse('192.168.1.1')->bin // 11000000101010000000000100000001
echo IP::parse('10.0.0.1')->hex // 0a000001
echo IP::parse('127.0.0.1')->long // 2130706433
```
#### Other public properties:
`maxPrefixLength`
The max number of bits in the address representation: 32 for IPv4, 128 for IPv6.
`octetsCount`
The count of octets in IP address: 4 for IPv4, 16 for IPv6
`reversePointer`
The name of the reverse DNS PTR for the address:
```php
echo new IP::parse('192.0.2.5')->reversePointer // 5.2.0.192.in-addr.arpa
echo new IP::parse('2001:db8::567:89ab')->reversePointer // b.a.9.8.7.6.5.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa
```
### Network Operations
```php
echo Network::parse('192.0.0.1 255.0.0.0')->CIDR; // 192.0.0.0/8
echo (string)Network::parse('192.0.0.1/8')->netmask; // 255.0.0.0
echo (string)Network::parse('192.0.0.1'); // 192.0.0.1/32
```
**Exclude IP from Network:**
```php
$excluded = Network::parse('192.0.0.0/8')->exclude(new IP('192.168.1.1'));
foreach($excluded as $network) {
echo (string)$network . '<br>';
}
```
192.0.0.0/9
192.128.0.0/11
192.160.0.0/13
192.168.0.0/24
192.168.1.0/32
192.168.1.2/31
...
192.192.0.0/10
**Exclude Subnet from Network:**
```php
$excluded = Network::parse('192.0.0.0/8')->exclude(new Network('192.168.1.0/24'));
foreach($excluded as $network) {
echo (string)$network . '<br>';
}
```
192.0.0.0/9
192.128.0.0/11
192.160.0.0/13
192.168.0.0/24
192.168.2.0/23
...
192.192.0.0/10
**Split network into equal subnets**
```php
$networks = Network::parse('192.168.0.0/22')->moveTo('24');
foreach ($networks as $network) {
echo (string)$network . '<br>';
}
```
192.168.0.0/24
192.168.1.0/24
192.168.2.0/24
192.168.3.0/24
**Iterate over Network IP adresses:**
```php
$network = Network::parse('192.168.1.0/24');
foreach($network as $ip) {
echo (string)$ip . '<br>';
}
```
192.168.1.0
...
192.168.1.255
**Get Network hosts adresses as Range:**
```php
$hosts = Network::parse('192.168.1.0/24')->hosts // Range(192.168.1.1, 192.168.1.254);
foreach($hosts as $ip) {
echo (string)$ip . '<br>';
}
```
192.168.1.1
...
192.168.1.254
**Count Network IP adresses**
```php
echo count(Network::parse('192.168.1.0/24')) // 254
```
### Range Operations
**Define the range in different formats:**
```php
$range = new Range(new IP('192.168.1.0'), new IP('192.168.1.255'));
$range = Range::parse('192.168.1.0-192.168.1.255');
$range = Range::parse('192.168.1.*');
$range = Range::parse('192.168.1.0/24');
```
**Check if IP is within Range:**
```php
echo Range::parse('192.168.1.1-192.168.1.254')->contains(new IP('192.168.1.5')); // true
echo Range::parse('::1-::ffff')->contains(new IP('::1234')); // true
```
**Iterate over Range IP adresses:**
```php
$range = Range::parse('192.168.1.1-192.168.1.254');
foreach($range as $ip) {
echo (string)$ip . '<br>';
}
```
192.168.1.1
...
192.168.1.254
**Get Networks that fit into a specified range of IP Adresses:**
```php
$networks = Range::parse('192.168.1.1-192.168.1.254')->getNetworks();
foreach($networks as $network) {
echo (string)$network . '<br>';
}
```
192.168.1.1/32
192.168.1.2/31
192.168.1.4/30
192.168.1.8/29
192.168.1.16/28
192.168.1.32/27
192.168.1.64/26
192.168.1.128/26
192.168.1.192/27
192.168.1.224/28
192.168.1.240/29
192.168.1.248/30
192.168.1.252/31
192.168.1.254/32
**Count IP adresses in Range**
```php
echo count(Range::parse('192.168.1.1-192.168.1.254')) // 254
```
# License
The library is released under the [MIT](https://opensource.org/licenses/MIT).

25
lib/IPTools/composer.json

@ -0,0 +1,25 @@
{
"name": "s1lentium/iptools",
"type": "library",
"description": "PHP Library for manipulating network addresses (IPv4 and IPv6)",
"keywords": ["IP-Tools", "network", "subnet", "cidr", "IP", "IPv4", "IPv6"],
"license": "MIT",
"authors": [{
"name": "Safarov Alisher",
"email": "alisher.safarov@outlook.com",
"homepage": "https://github.com/S1lentium"
}],
"require": {
"php": ">=5.4.0",
"ext-bcmath": "*"
},
"require-dev": {
"satooshi/php-coveralls": "~1.0",
"phpunit/phpunit": "~4.0"
},
"autoload": {
"psr-4": {
"IPTools\\": "src/"
}
}
}

286
lib/IPTools/src/IP.php

@ -0,0 +1,286 @@
<?php
namespace IPTools;
/**
* @author Safarov Alisher <alisher.safarov@outlook.com>
* @link https://github.com/S1lentium/IPTools
*/
class IP
{
use PropertyTrait;
const IP_V4 = 'IPv4';
const IP_V6 = 'IPv6';
const IP_V4_MAX_PREFIX_LENGTH = 32;
const IP_V6_MAX_PREFIX_LENGTH = 128;
const IP_V4_OCTETS = 4;
const IP_V6_OCTETS = 16;
/**
* @var string
*/
private $in_addr;
/**
* @param string ip
* @throws \Exception
*/
public function __construct($ip)
{
if (!filter_var($ip, FILTER_VALIDATE_IP)) {
throw new \Exception("Invalid IP address format");
}
$this->in_addr = inet_pton($ip);
}
/**
* @return string
*/
public function __toString()
{
return inet_ntop($this->in_addr);
}
/**
* @param string ip
* @return IP
*/
public static function parse($ip)
{
if (strpos($ip, '0x') === 0) {
$ip = substr($ip, 2);
return self::parseHex($ip);
}
if (strpos($ip, '0b') === 0) {
$ip = substr($ip, 2);
return self::parseBin($ip);
}
if (is_numeric($ip)) {
return self::parseLong($ip);
}
return new self($ip);
}
/**
* @param string $binIP
* @throws \Exception
* @return IP
*/
public static function parseBin($binIP)
{
if (!preg_match('/^([0-1]{32}|[0-1]{128})$/', $binIP)) {
throw new \Exception("Invalid binary IP address format");
}
$in_addr = '';
foreach (array_map('bindec', str_split($binIP, 8)) as $char) {
$in_addr .= pack('C*', $char);
}
return new self(inet_ntop($in_addr));
}
/**
* @param string $hexIP
* @throws \Exception
* @return IP
*/
public static function parseHex($hexIP)
{
if (!preg_match('/^([0-9a-fA-F]{8}|[0-9a-fA-F]{32})$/', $hexIP)) {
throw new \Exception("Invalid hexadecimal IP address format");
}