/usr/share/perl5/Net/Google/SafeBrowsing2.pm is in libnet-google-safebrowsing2-perl 1.07-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 | package Net::Google::SafeBrowsing2;
use strict;
use warnings;
use Carp;
use LWP::UserAgent;
use URI;
use Digest::SHA qw(sha256);
use List::Util qw(first);
use Net::IPAddress;
use Text::Trim;
use Digest::HMAC_SHA1 qw(hmac_sha1 hmac_sha1_hex);
use MIME::Base64::URLSafe;
use MIME::Base64;
use String::HexConvert;
use File::Slurp;
use Exporter 'import';
our @EXPORT = qw(DATABASE_RESET MAC_ERROR MAC_KEY_ERROR INTERNAL_ERROR SERVER_ERROR NO_UPDATE NO_DATA SUCCESSFUL MALWARE PHISHING);
our $VERSION = '1.07';
=head1 NAME
Net::Google::SafeBrowsing2 - Perl extension for the Google Safe Browsing v2 API. (Google Safe Browsing v1 has been deprecated by Google.)
=head1 SYNOPSIS
use Net::Google::SafeBrowsing2;
use Net::Google::SafeBrowsing2::Sqlite;
my $storage = Net::Google::SafeBrowsing2::Sqlite->new(file => 'google-v2.db');
my $gsb = Net::Google::SafeBrowsing2->new(
key => "my key",
storage => $storage,
);
$gsb->update();
my $match = $gsb->lookup(url => 'http://www.gumblar.cn/');
if ($match eq MALWARE) {
print "http://www.gumblar.cn/ is flagged as a dangerous site\n";
}
$storage->close();
=head1 DESCRIPTION
Net::Google::SafeBrowsing2 implements the Google Safe Browsing v2 API.
The library passes most of the unit tests listed in the API documentation. See the documentation (L<http://code.google.com/apis/safebrowsing/developers_guide_v2.html>) for more details about the failed tests.
The Google Safe Browsing database must be stored and managed locally. L<Net::Google::SafeBrowsing2::Sqlite> uses Sqlite as the storage back-end, L<Net::Google::SafeBrowsing2::MySQL> uses MySQL. Other storage mechanisms (databases, memory, etc.) can be added and used transparently with this module.
You may want to look at "Google Safe Browsing v2: Implementation Notes" (L<http://www.zscaler.com/research/Google%20Safe%20Browsing%20v2%20API.pdf>), a collection of notes and real-world numbers about the API. This is intended for people who want to learn more about the API, whether as a user or to make their own implementation.
The source code is available on github at L<https://github.com/juliensobrier/Net-Google-SafeBrowsing2>.
If you do not need to inspect more than 10,000 URLs a day, you can use L<Net::Google::SafeBrowsing2::Lookup> with the Google Safe Browsing v2 Lookup API which does not require to store and maintain a local database.
IMPORTANT: If you start with an empty database, you will need to perform several updates to retrieve all the Google Safe Browsing information. This may require up to 24 hours. This is a limitation of the Google API, not of this module. See "Google Safe Browsing v2: Implementation Notes" at L<http://www.zscaler.com/research/Google%20Safe%20Browsing%20v2%20API.pdf>.
=head1 CONSTANTS
Several constants are exported by this module:
=over 4
=item DATABASE_RESET
Google requested to reset (empty) the local database.
=item MAC_ERROR
The replies from Google could not be validated with the MAC keys.
=item MAC_KEY_ERROR
The request for the MAC keys failed.
=item INTERNAL_ERROR
An internal error occurred.
=item SERVER_ERROR
The server sent an error back to the client.
=item NO_UPDATE
No update was performed, probably because it is too early to make a new request to Google Safe Browsing.
=item NO_DATA
No data was sent back by Google to the client, probably because the database is up to date.
=item SUCCESSFUL
The operation was successful.
=item MALWARE
Name of the Malware list in Google Safe Browsing (shortcut to 'goog-malware-shavar')
=item PHISHING
Name of the Phishing list in Google Safe Browsing (shortcut to 'googpub-phish-shavar')
=back
=cut
use constant {
DATABASE_RESET => -6,
MAC_ERROR => -5,
MAC_KEY_ERROR => -4,
INTERNAL_ERROR => -3, # internal/parsing error
SERVER_ERROR => -2, # Server sent an error back
NO_UPDATE => -1, # no update (too early)
NO_DATA => 0, # no data sent
SUCCESSFUL => 1, # data sent
MALWARE => 'goog-malware-shavar',
PHISHING => 'googpub-phish-shavar',
FULL_HASH_TIME => 45 * 60,
INTERVAL_FULL_HASH_TIME => 'INTERVAL 45 MINUTE',
};
=head1 CONSTRUCTOR
=over 4
=back
=head2 new()
Create a Net::Google::SafeBrowsing2 object
my $gsb = Net::Google::SafeBrowsing2->new(
key => "my key",
storage => Net::Google::SafeBrowsing2::Sqlite->new(file => 'google-v2.db'),
debug => 0,
mac => 0,
list => MALWARE,
);
Arguments
=over 4
=item key
Required. Your Google Safe browsing API key
=item storage
Required. Object which handle the storage for the Google Safe Browsing database. See L<Net::Google::SafeBrowsing2::Storage> for more details.
=item list
Optional. The Google Safe Browsing list to handle. By default, handles both MALWARE and PHISHING.
=item mac
Optional. Set to 1 to enable Message Authentication Code (MAC). 0 (disabled) by default.
=item debug
Optional. Set to 1 to enable debugging. 0 (disabled) by default.
The debug output maybe quite large and can slow down significantly the update and lookup functions.
=item errors
Optional. Set to 1 to show errors to STDOUT. 0 (disabled by default).
=item version
Optional. Google Safe Browsing version. 2.2 by default
=back
=cut
sub new {
my ($class, %args) = @_;
my $self = { # default arguments
list => ['googpub-phish-shavar', 'goog-malware-shavar'],
key => '',
version => '2.2',
debug => 0,
errors => 0,
last_error => '',
mac => 0,
%args,
};
if (! exists $self->{storage}) {
use Net::Google::SafeBrowsing2::Storage;
$self->{storage} = Net::Google::SafeBrowsing2::Storage->new();
}
if (ref $self->{list} ne 'ARRAY') {
$self->{list} = [$self->{list}];
}
bless $self, $class or croak "Can't bless $class: $!";
return $self;
}
=head1 PUBLIC FUNCTIONS
=over 4
=back
=head2 update()
Perform a database update.
$gsb->update();
Return the status of the update (see the list of constants above): INTERNAL_ERROR, SERVER_ERROR, NO_UPDATE, NO_DATA or SUCCESSFUL
This function can handle two lists at the same time. If one of the list should not be updated, it will automatically skip it and update the other one. It is faster to update two lists at once rather than doing them one by one.
NOTE: If you start with an empty database, you will need to perform several updates to retrieve all the Google Safe Browsing information. This may require up to 24 hours. This is a limitation of the Google API, not of this module. See "Google Safe Browsing v2: Implementation Notes" at L<http://www.zscaler.com/research/Google%20Safe%20Browsing%20v2%20API.pdf>.
Arguments
=over 4
=item list
Optional. Update a specific list. Use the list(s) from new() by default.
=item mac
Optional. Set to 1 to enable Message Authentication Code (MAC). Use the value from new() by default.
=item force
Optional. Force the update (1). Disabled by default (0).
Be careful if you set this option to 1 as too frequent updates might result in the blacklisting of your API key.
=back
=cut
sub update {
my ($self, %args) = @_;
# my @lists = @{[$args{list}]} || @{$self->{list}} || croak "Missing list name\n";
my $list = $args{list};
my $force = $args{force} || 0;
my $mac = $args{mac} || $self->{mac} || 0;
my @lists = @{$self->{list}};
@lists = @{[$args{list}]} if (defined $list);
my $result = 0;
# too early to update? need to handle errors
my $i = 0;
while ($i < scalar @lists) {
my $list = $lists[$i];
my $info = $self->{storage}->last_update(list => $list);
if ($info->{'time'} + $info->{'wait'} > time && $force == 0) {
$self->debug("Too early to update $list\n");
splice(@lists, $i, 1);
}
else {
$self->debug("OK to update $list: " . time() . "/" . ($info->{'time'} + $info->{'wait'}) . "\n");
$i++;
}
}
if (scalar @lists == 0) {
$self->debug("Too early to update any list\n");
return NO_UPDATE;
}
# MAC?
my $client_key = '';
my $wrapped_key = '';
if ($mac) {
($client_key, $wrapped_key) = $self->get_mac_keys();
if ($client_key eq '' || $wrapped_key eq '') {
return MAC_KEY_ERROR;
}
}
my $ua = $self->ua;
my $url = "http://safebrowsing.clients.google.com/safebrowsing/downloads?client=api&apikey=" . $self->{key} . "&appver=$VERSION&pver=" . $self->{version};
$url .= "&wrkey=$wrapped_key" if ($mac);
my $body = '';
foreach my $list (@lists) {
# Report existng chunks
my $a_range = $self->create_range(numbers => [$self->{storage}->get_add_chunks_nums(list => $list)]);
my $s_range = $self->create_range(numbers => [$self->{storage}->get_sub_chunks_nums(list => $list)]);
my $chunks_list = '';
if ($a_range ne '') {
$chunks_list .= "a:$a_range";
}
if ($s_range ne '') {
$chunks_list .= ":" if ($a_range ne '');
$chunks_list .= "s:$s_range";
}
$body .= "$list;$chunks_list";
$body .= ":mac" if ($mac);
$body .= "\n";
}
my $res = $ua->post($url, Content => $body);
# $self->debug($res->request->as_string . "\n" . $res->as_string . "\n");
$self->debug($res->request->as_string . "\n");
$self->debug($res->as_string . "\n");
if (! $res->is_success) {
$self->error("Request failed\n");
foreach my $list (@lists) {
$self->update_error('time' => time(), list => $list);
}
return SERVER_ERROR;
}
my $last_update = time;
my $wait = 0;
my @redirections = ();
my @lines = split/\s/, $res->decoded_content;
$list = '';
foreach my $line (@lines) {
if ($line =~ /n:\s*(\d+)\s*$/) {
$self->debug("Next poll: $1 seconds\n");
$wait = $1;
}
elsif ($line =~ /i:\s*(\S+)\s*$/) {
$self->debug("List: $1\n");
$list = $1;
}
elsif ($line =~ /u:\s*(\S+),(\S+)\s*$/) {
$self->debug("Redirection: $1\n");
$self->debug("MAC: $2\n");
push(@redirections, [$1, $list, $2]);
}
elsif ($line =~ /u:\s*(\S+)\s*$/) {
$self->debug("Redirection: $1\n");
push(@redirections, [$1, $list, '']);
}
elsif ($line =~ /ad:(\S+)$/) {
$self->debug("Delete Add Chunks: $1\n");
my @nums = $self->expand_range(range => $1);
$self->{storage}->delete_add_ckunks(chunknums => [@nums], list => $list);
# Delete full hash as well
$self->{storage}->delete_full_hashes(chunknums => [@nums], list => $list);
$result = 1;
}
elsif ($line =~ /sd:(\S+)$/) {
$self->debug("Delete Sub Chunks: $1\n");
my @nums = $self->expand_range(range => $1);
$self->{storage}->delete_sub_ckunks(chunknums => [@nums], list => $list);
$result = 1;
}
elsif ($line =~ /m:(\S+)$/ && $mac) {
my $hmac = $1;
$self->debug("MAC of request: $hmac\n");
# Remove this line for data
my $data = $res->decoded_content;
$data =~ s/^m:(\S+)\n//g;
if (! $self->validate_data_mac(data => $data, key => $client_key, digest => $hmac) ) {
$self->error("MAC error on main request\n");
return MAC_ERROR;
}
}
elsif ($line =~ /e:pleaserekey/ && $mac) {
$self->debug("MAC key has been expired\n");
$self->{storage}->delete_mac_keys();
return $self->update(list => $list, force => $force, mac => $mac);
}
elsif ($line =~ /r:pleasereset/) {
$self->debug("Database must be reset\n");
$self->{storage}->reset(list => $list);
return DATABASE_RESET;
}
}
$self->debug("\n");
$result = 1 if (scalar @redirections > 0);
foreach my $data (@redirections) {
my $redirection = $data->[0];
$list = $data->[1];
my $hmac = $data->[2];
$self->debug("Checking redirection http://$redirection ($list)\n");
$res = $ua->get("http://$redirection");
if (! $res->is_success) {
$self->error("Request to $redirection failed\n");
foreach my $list (@lists) {
$self->update_error('time' => $last_update, list => $list);
}
return SERVER_ERROR;
}
$self->debug(substr($res->as_string, 0, 250) . "\n\n") if ($self->{debug});
$self->debug(substr($res->content, 0, 250) . "\n\n") if ($self->{debug});
my $data = $res->content;
if ($mac && ! $self->validate_data_mac(data => $data, key => $client_key, digest => $hmac) ) {
$self->error("MAC error on redirection\n");
$self->debug("Length of data: " . length($data) . "\n");
return MAC_ERROR;
}
my $result = $self->parse_data(data => $data, list => $list);
if ($result != SUCCESSFUL) {
foreach my $list (@lists) {
$self->update_error('time' => $last_update, list => $list);
}
return $result;
}
}
foreach my $list (@lists) {
$self->debug("List update: $last_update $wait $list\n");
$self->{storage}->updated('time' => $last_update, 'wait' => $wait, list => $list);
}
return $result; # ok
}
=head2 import_chunks()
Import add and sub chunks from a file.
my $result = $gsb->import_chunks(list => MALWARE, file => 'malware.dat');
Return the status of the import: INTERNAL_ERROR or SUCCESSFUL.
This function should be used to initialize an empty back-end storage.
Arguments
=over 4
=item list
Required. Google list to use.
=item file
Required. File that contains the list of chunks. This file can be created with the C<export> function inherited from C<Net::Google::SafeBrowsing2::DBI>.
=back
=cut
sub import_chunks {
my ($self, %args) = @_;
my $list = $args{list} || '';
my $file = $args{file} || "$list.dat";
my $data = read_file($file, { binmode => ':raw' });
return $self->parse_data(data => $data, list => $list);
}
=head2 lookup()
Lookup a URL against the Google Safe Browsing database.
my $match = $gsb->lookup(url => 'http://www.gumblar.cn');
Returns the name of the list if there is any match, returns an empty string otherwise.
Arguments
=over 4
=item list
Optional. Lookup against a specific list. Use the list(s) from new() by default.
=item url
Required. URL to lookup.
=back
=cut
sub lookup {
my ($self, %args) = @_;
my $list = $args{list} || '';
my $url = $args{url} || return '';
my @lists = @{$self->{list}};
@lists = @{[$args{list}]} if ($list ne '');
# TODO: create our own URI management for canonicalization
# fix for http:///foo.com (3 ///)
$url =~ s/^(https?:\/\/)\/+/$1/;
my $uri = URI->new($url)->canonical;
my $domain = $uri->host;
my @hosts = $self->canonical_domain_suffixes($domain); # only top-3 in this case
foreach my $host (@hosts) {
$self->debug("Domain for key: $domain => $host\n");
my $suffix = $self->prefix("$host/"); # Don't forget trailing hash
$self->debug("Host key: " . $self->hex_to_ascii($suffix) . "\n");
my $match = $self->lookup_suffix(lists => [@lists], url => $url, suffix => $suffix);
return $match if ($match ne '');
}
return '';
}
=head2 get_lists()
Returns the name of all the Google Safe Browsing lists
my $@lists = $gsb->get_lists();
NOTE: this function is useless in practice because Google includes some lists which cannot be used by the Google Safe Browsing API, like lists used by the Google toolbar.
=cut
sub get_lists {
my ($self, %args) = @_;
my $url = "http://safebrowsing.clients.google.com/safebrowsing/list?client=api&apikey=" . $self->{key} . "&appver=$VERSION&pver=" . $self->{version};
my $res = $self->ua->get($url);
return split/\s/, $res->decoded_content; # 1 list per line
}
=head2 last_error()
Get/Set the last error message.
print "Last error: ", $gsb->last_error(), "\n";
$gsb->last_error(''); # Reset last error
NOTE: the last error message might not come from the last call. Returns an empty string if no errors.
=cut
sub last_error {
my ($self, $message) = @_;
if (defined $message) {
$self->{last_error} = $message;
}
else {
return $self->{last_error};
}
}
=pod
=head1 PRIVATE FUNCTIONS
These functions are not intended to be used externally.
=over 4
=back
=head2 lookup_suffix()
Lookup a host prefix.
=cut
sub lookup_suffix {
my ($self, %args) = @_;
my $lists = $args{lists} || croak "Missing lists\n";
my $url = $args{url} || return '';
my $suffix = $args{suffix} || return '';
# Calculcate prefixes
my @full_hashes = $self->full_hashes($url); # Get the prefixes from the first 4 bytes
my @full_hashes_prefix = map (substr($_, 0, 4), @full_hashes);
# Local lookup
my @add_chunks = $self->local_lookup_suffix(lists => $lists, url => $url, suffix => $suffix, full_hashes_prefix => [@full_hashes_prefix]);
if (scalar @add_chunks == 0) {
$self->debug("No hit in local lookup\n");
return '';
}
# Check against full hashes
my $found = '';
# get stored full hashes
foreach my $add_chunk (@add_chunks) {
my @hashes = $self->{storage}->get_full_hashes( chunknum => $add_chunk->{chunknum}, timestamp => time() - FULL_HASH_TIME, list => $add_chunk->{list});
$self->debug("Full hashes already stored for chunk " . $add_chunk->{chunknum} . ": " . scalar @hashes . "\n");
foreach my $full_hash (@full_hashes) {
foreach my $hash (@hashes) {
if ($hash eq $full_hash && defined first { $add_chunk->{list} eq $_ } @$lists) {
$self->debug("Full hash was found in storage\n");
$found = $add_chunk->{list};
last;
}
# elsif ($hash ne $full_hash) {
# $self->debug($self->hex_to_ascii($hash) . " ne " . $self->hex_to_ascii($full_hash) . "\n\n");
# }
}
last if ($found ne '');
}
last if ($found ne '');
}
return $found if ($found ne '');
# ask for new hashes
# TODO: make sure we don't keep asking for the same over and over
my @hashes = $self->request_full_hash(prefixes => [ map($_->{prefix} || $_->{hostkey}, @add_chunks) ]);
$self->{storage}->add_full_hashes(full_hashes => [@hashes], timestamp => time());
foreach my $full_hash (@full_hashes) {
my $hash = first { $_->{hash} eq $full_hash} @hashes;
next if (! defined $hash);
my $list = first { $hash->{list} eq $_ } @$lists;
if (defined $hash && defined $list) {
# $self->debug($self->hex_to_ascii($hash->{hash}) . " eq " . $self->hex_to_ascii($full_hash) . "\n\n");
$self->debug("Match\n");
return $hash->{list};
}
# elsif (defined $hash) {
# $self->debug("hash: " . $self->hex_to_ascii($hash->{hash}) . "\n");
# $self->debug("list: " . $hash->{list} . "\n");
# }
}
$self->debug("No match\n");
return '';
}
=head2 lookup_suffix()
Lookup a host prefix in the local database only.
=cut
sub local_lookup_suffix {
my ($self, %args) = @_;
my $lists = $args{lists} || croak "Missing lists\n";
my $url = $args{url} || return ();
my $suffix = $args{suffix} || return ();
my $full_hashe_list = $args{full_hashes} || [];
my $full_hashes_prefix_list = $args{full_hashes_prefix} || [];
# Step 1: get all add chunks for this host key
# Do it for all lists
my @add_chunks = $self->{storage}->get_add_chunks(hostkey => $suffix);
# return scalar @add_chunks;
if (scalar @add_chunks == 0) { # no match
$self->debug("No host key\n");
return @add_chunks;
}
# Step 2: calculcate prefixes
# Get the prefixes from the first 4 bytes
my @full_hashes_prefix = @{$full_hashes_prefix_list};
if (scalar @full_hashes_prefix == 0) {
my @full_hashes = @{$full_hashe_list};
@full_hashes = $self->full_hashes($url) if (scalar @full_hashes == 0);
@full_hashes_prefix = map (substr($_, 0, 4), @full_hashes);
}
# Step 3: filter out add_chunks with prefix
my $i = 0;
while ($i < scalar @add_chunks) {
if ($add_chunks[$i]->{prefix} ne '') {
my $found = 0;
foreach my $hash_prefix (@full_hashes_prefix) {
if ( $add_chunks[$i]->{prefix} eq $hash_prefix) {
$found = 1;
last;
}
# else {
# $self->debug( $self->hex_to_ascii($add_chunks[$i]->{prefix}) . " ne " . $self->hex_to_ascii($hash_prefix) . "\n" );
# }
}
if ($found == 0) {
$self->debug("No prefix found\n");
splice(@add_chunks, $i, 1);
}
else {
$i++;
}
}
else {
$i++;
}
}
if (scalar @add_chunks == 0) {
$self->debug("No prefix match for any host key\n");
return @add_chunks;
}
# Step 4: get all sub chunks for this host key
my @sub_chunks = $self->{storage}->get_sub_chunks(hostkey => $suffix);
foreach my $sub_chunk (@sub_chunks) {
my $i = 0;
while ($i < scalar @add_chunks) {
my $add_chunk = $add_chunks[$i];
if ($add_chunk->{chunknum} != $sub_chunk->{addchunknum} || $add_chunk->{list} ne $sub_chunk->{list}) {
$i++;
next;
}
if ($sub_chunk->{prefix} eq $add_chunk->{prefix}) {
splice(@add_chunks, $i, 1);
}
else {
$i++;
}
}
}
if (scalar @add_chunks == 0) {
$self->debug("All add_chunks have been removed by sub_chunks\n");
}
return @add_chunks;
}
=head2 local_lookup()
Lookup a URL against the local Google Safe Browsing database URL. This should be used for debugging purpose only. See the lookup for normal use.
my $match = $gsb->local_lookup(url => 'http://www.gumblar.cn');
Returns the name of the list if there is any match, returns an empty string otherwise.
Arguments
=over 4
=item list
Optional. Lookup against a specific list. Use the list(s) from new() by default.
=item url
Required. URL to lookup.
=back
=cut
sub local_lookup {
my ($self, %args) = @_;
my $list = $args{list} || '';
my $url = $args{url} || return '';
my @lists = @{$self->{list}};
@lists = @{[$args{list}]} if ($list ne '');
# TODO: create our own URI management for canonicalization
# fix for http:///foo.com (3 ///)
$url =~ s/^(https?:\/\/)\/+/$1/;
my $uri = URI->new($url)->canonical;
my $domain = $uri->host;
my @hosts = $self->canonical_domain_suffixes($domain); # only top-3 in this case
foreach my $host (@hosts) {
$self->debug("Domain for key: $domain => $host\n");
my $suffix = $self->prefix("$host/"); # Don't forget trailing hash
$self->debug("Host key: " . $self->hex_to_ascii($suffix) . "\n");
my @matches = $self->local_lookup_suffix(lists => [@lists], url => $url, suffix => $suffix);
# return $matches[0]->{list} if (scalar @matches > 0);
return $matches[0]->{list} . " " . $matches[0]->{chunknum} if (scalar @matches > 0);
}
return '';
}
=head2 request_key()
Request the Message Authentication Code (MAC) keys
=cut
sub get_mac_keys {
my ($self, %args) = @_;
my $keys = $self->{storage}->get_mac_keys();
if ($keys->{client_key} eq '' || $keys->{wrapped_key} eq '') {
my ($client_key, $wrapped_key) = $self->request_mac_keys();
# $self->debug("Client key: $client_key\n");
$self->{storage}->add_mac_keys(client_key => $client_key, wrapped_key => $wrapped_key);
return ($client_key, $wrapped_key);
}
return ($keys->{client_key}, $keys->{wrapped_key});
}
=head2 request_mac_keys()
Request the Message Authentication Code (MAC) keys from Google.
=cut
sub request_mac_keys {
my ($self, %args) = @_;
my $client_key = '';
my $wrapped_key = '';
my $url = "http://sb-ssl.google.com/safebrowsing/newkey?client=api&apikey=" . $self->{key} . "&appver=$VERSION&pver=" . $self->{version};
my $res = $self->ua->get($url);
if (! $res->is_success) {
$self->error("Key request failed: " . $res->code . "\n");
return ($client_key, $wrapped_key);
}
my $data = $res->decoded_content;
if ($data =~ s/^clientkey:(\d+)://mi) {
my $length = $1;
$self->debug("MAC client key length: $length\n");
$client_key = substr($data, 0, $length, '');
$self->debug("MAC client key: $client_key\n");
substr($data, 0, 1, ''); # remove \n
if ($data =~ s/^wrappedkey:(\d+)://mi) {
$length = $1;
$self->debug("MAC wrapped key length: $length\n");
$wrapped_key = substr($data, 0, $length, '');
$self->debug("MAC wrapped key: $wrapped_key\n");
return (decode_base64($client_key), $wrapped_key);
}
else {
return ('', '');
}
}
return ($client_key, $wrapped_key);
}
=head2 validate_data_mac()
Validate data against the MAC keys.
=cut
sub validate_data_mac {
my ($self, %args) = @_;
my $data = $args{data} || '';
my $key = $args{key} || '';
my $digest = $args{digest} || '';
# my $hash = urlsafe_b64encode trim hmac_sha1($data, decode_base64($key));
# my $hash = urlsafe_b64encode (trim (hmac_sha1($data, decode_base64($key))));
my $hash = urlsafe_b64encode(hmac_sha1($data, $key));
$hash .= '=';
$self->debug("$hash / $digest\n");
# $self->debug(urlsafe_b64encode(hmac_sha1($data, decode_base64($key))) . "\n");
# $self->debug(urlsafe_b64encode(trim(hmac_sha1($data, decode_base64($key)))) . "\n");
return ($hash eq $digest);
}
=head2 update_error()
Handle server errors during a database update.
=cut
sub update_error {
my ($self, %args) = @_;
my $time = $args{'time'} || time;
my $list = $args{'list'} || '';
my $info = $self->{storage}->last_update(list => $list);
$info->{errors} = 0 if (! exists $info->{errors});
my $errors = $info->{errors} + 1;
my $wait = 0;
$wait = $errors == 1 ? 60
: $errors == 2 ? int(30 * 60 * (rand(1) + 1)) # 30-60 mins
: $errors == 3 ? int(60 * 60 * (rand(1) + 1)) # 60-120 mins
: $errors == 4 ? int(2 * 60 * 60 * (rand(1) + 1)) # 120-240 mins
: $errors == 5 ? int(4 * 60 * 60 * (rand(1) + 1)) # 240-480 mins
: $errors > 5 ? 480 * 60
: 0;
$self->{storage}->update_error('time' => $time, list => $list, 'wait' => $wait, errors => $errors);
}
=head2 lookup_whitelist()
Lookup a host prefix and suffix in the whitelist (s chunks)
=cut
sub lookup_whitelist {
my ($self, %args) = @_;
my $suffix = $args{suffix} || return 0;
my $prefix = $args{prefix} || '';
my $chuknum = $args{chunknum} || return 0;
foreach my $schunknum (keys %{ $self->{s_chunks} }) {
foreach my $chunk ( @{ $self->{s_chunks}->{$schunknum} }) {
if ($chunk->{host} eq $suffix && ($chunk->{prefix} eq $prefix || $chunk->{prefix} eq '') && $chunk->{add_chunknum} == $chuknum) {
return 1;
}
}
}
return 0;
}
=head2 ua()
Create LWP::UserAgent to make HTTP requests to Google.
=cut
sub ua {
my ($self, %args) = @_;
if (! exists $self->{ua}) {
my $ua = LWP::UserAgent->new;
$ua->timeout(60);
$self->{ua} = $ua;
}
return $self->{ua};
}
=head2 parse_s()
Parse data from a rediration (add asnd sub chunk information).
=cut
sub parse_data {
my ($self, %args) = @_;
my $data = $args{data} || '';
my $list = $args{list} || '';
my $chunk_num = 0;
my $hash_length = 0;
my $chunk_length = 0;
while (length $data > 0) {
# print "Length 1: ", length $data, "\n"; # 58748
my $type = substr($data, 0, 2, ''); # s:34321:4:137
# print "Length 1.5: ", length $data, "\n"; # 58746 -2
if ($data =~ /^(\d+):(\d+):(\d+)\n/sgi) {
$chunk_num = $1;
$hash_length = $2;
$chunk_length = $3;
# shorten data
substr($data, 0, length($chunk_num) + length($hash_length) + length($chunk_length) + 3, '');
# print "Remove ", length($chunk_num) + length($hash_length) + length($chunk_length) + 3, "\n";
# print "Length 2: ", length $data, "\n"; # 58741 -5
my $encoded = substr($data, 0, $chunk_length, '');
# print "Length 3: ", length $data, "\n"; # 58604 -137
if ($type eq 's:') {
my @chunks = $self->parse_s(value => $encoded, hash_length => $hash_length);
$self->{storage}->add_chunks(type => 's', chunknum => $chunk_num, chunks => [@chunks], list => $list); # Must happen all at once => not 100% sure
}
elsif ($type eq 'a:') {
my @chunks = $self->parse_a(value => $encoded, hash_length => $hash_length);
$self->{storage}->add_chunks(type => 'a', chunknum => $chunk_num, chunks => [@chunks], list => $list); # Must happen all at once => not 100% sure
}
else {
$self->error("Incorrect chunk type: $type, should be a: or s:\n");
return INTERNAL_ERROR;# failed
}
$self->debug("$type$chunk_num:$hash_length:$chunk_length OK\n");
}
else {
$self->error("could not parse header\n");
return INTERNAL_ERROR;# failed
}
}
return SUCCESSFUL;
}
=head2 parse_s()
Parse s chunks information for a database update.
=cut
sub parse_s {
my ($self, %args) = @_;
my $value = $args{value} || return ();
my $hash_length = $args{hash_length} || 4;
my @data = ();
while (length $value > 0) {
# my $host = $self->hex_to_ascii( substr($value, 0, 4, '') ); # Host hash
my $host = substr($value, 0, 4, ''); # HEX
# print "\t Host key: $host\n";
my $count = substr($value, 0, 1, ''); # hex value
$count = ord($count);
# my $add_chunk_num_hex;
if ($count == 0) { # ADDCHUNKNUM only
# $self->debug("\nadd_chuknum: " . substr($value, 0, 4) . " => ");
my $add_chunknum = hex($self->hex_to_ascii( substr($value, 0, 4, '') ) ); #chunk num
# $self->debug("$add_chunknum\n");
push(@data, { host => $host, add_chunknum => $add_chunknum, prefix => '' });
if ($self->{debug}) {
$self->debug("\t" . $self->hex_to_ascii($host) . " $add_chunknum\n");
}
}
else { # ADDCHUNKNUM + PREFIX
for(my $i = 0; $i < $count; $i++) {
# my $add_chunknum = $self->hex_to_ascii( substr($value, 0, 4, '') ); #chunk num - ACII
# $self->debug("\nadd_chuknum: " . substr($value, 0, 4) . " => ");
my $add_chunknum = hex($self->hex_to_ascii( substr($value, 0, 4, '') )); # DEC
# $self->debug("$add_chunknum\n");
# my $prefix = $self->hex_to_ascii( substr($value, 0, $hash_length, '') ); # ASCII
my $prefix = substr($value, 0, $hash_length, ''); # HEX
push(@data, { host => $host, add_chunknum => $add_chunknum, prefix => $prefix });
if ($self->{debug}) {
$self->debug("\t" . $self->hex_to_ascii($host) . " $add_chunknum " . $self->hex_to_ascii($prefix) . "\n");
}
}
}
}
return @data;
}
=head2 parse_a()
Parse a chunks information for a database update.
=cut
sub parse_a {
my ($self, %args) = @_;
my $value = $args{value} || return ();
my $hash_length = $args{hash_length} || 4;
my @data = ();
while (length $value > 0) {
# my $host = $self->hex_to_ascii( substr($value, 0, 4, '') ); # Host hash
my $host = substr($value, 0, 4, ''); # HEX
# print "\t Host key: $host\n";
my $count = substr($value, 0, 1, ''); # hex value
$count = ord($count);
if ($count > 0) { # ADDCHUNKNUM only
for(my $i = 0; $i < $count; $i++) {
# my $prefix = $self->hex_to_ascii( substr($value, 0, $hash_length, '') ); # ASCII
my $prefix = substr($value, 0, $hash_length, ''); # HEX
push(@data, { host => $host, prefix => $prefix });
if ($self->{debug}) {
$self->debug("\t" . $self->hex_to_ascii($host) . " " . $self->hex_to_ascii($prefix) . "\n");
}
}
}
else {
push(@data, { host => $host, prefix => '' });
if ($self->{debug}) {
$self->debug("\t" . $self->hex_to_ascii($host) . "\n");
}
}
}
return @data;
}
=head2 hex_to_ascii()
Transform hexadecimal strings to printable ASCII strings. Used mainly for debugging.
print $gsb->hex_to_ascii('hex value');
=cut
sub hex_to_ascii {
my ($self, $hex) = @_;
return String::HexConvert::ascii_to_hex($hex);
# my $ascii = '';
#
# while (length $hex > 0) {
# $ascii .= sprintf("%02x", ord( substr($hex, 0, 1, '') ) );
# }
#
# return $ascii;
}
=head2 ascii_to_hex()
Transform ASCII strings to hexadecimal strings.
=cut
sub ascii_to_hex {
my ($self, $ascii) = @_;
my $hex = '';
for (my $i = 0; $i < int(length($ascii) / 2); $i++) {
$hex .= chr hex( substr($ascii, $i * 2, 2) );
}
return $hex;
}
=head2 debug()
Print debug output.
=cut
sub debug {
my ($self, $message) = @_;
print $message if ($self->{debug} > 0);
}
=head2 error()
Print error message.
=cut
sub error {
my ($self, $message) = @_;
print "ERROR - ", $message if ($self->{debug} > 0 || $self->{errors} > 0);
$self->{last_error} = $message;
}
=head2 canonical_domain_suffixes()
Find all suffixes for a domain.
=cut
sub canonical_domain_suffixes {
my ($self, $domain) = @_;
my @domains = ();
if ($domain =~ /^\d+\.\d+\.\d+\.\d+$/) { # loose check for IP address, should be enough
return ($domain);
}
my @parts = split/\./, $domain; # take 3 components
if (scalar @parts >= 3) {
@parts = splice (@parts, -3, 3);
push(@domains, join('.', @parts));
splice(@parts, 0, 1);
}
push(@domains, join('.', @parts));
return @domains;
}
=head2 canonical_domain()
Find all canonical domains a domain.
=cut
sub canonical_domain {
my ($self, $domain) = @_;
my @domains = ($domain);
if ($domain =~ /^\d+\.\d+\.\d+\.\d+$/) { # loose check for IP address, should be enough
return @domains;
}
my @parts = split/\./, $domain;
splice(@parts, 0, -6); # take 5 top most compoments
while (scalar @parts > 2) {
shift @parts;
push(@domains, join(".", @parts) );
}
return @domains;
}
=head2 canonical_path()
Find all canonical paths for a URL.
=cut
sub canonical_path {
my ($self, $path) = @_;
my @paths = ($path); # return full path
if ($path =~ /\?/) {
$path =~ s/\?.*$//;
push(@paths, $path);
}
my @parts = split /\//, $path;
my $previous = '';
while (scalar @parts > 1 && scalar @paths < 6) {
my $val = shift(@parts);
$previous .= "$val/";
push(@paths, $previous);
}
return @paths;
}
=head2 canonical()
Find all canonical URLs for a URL.
=cut
sub canonical {
my ($self, $url) = @_;
my @urls = ();
# my $uri = URI->new($url)->canonical;
my $uri = $self->canonical_uri($url);
my @domains = $self->canonical_domain($uri->host);
my @paths = $self->canonical_path($uri->path_query);
foreach my $domain (@domains) {
foreach my $path (@paths) {
push(@urls, "$domain$path");
}
}
return @urls;
}
=head2 canonical_uri()
Create a canonical URI.
NOTE: URI cannot handle all the test cases provided by Google. This method is a hack to pass most of the test. A few tests are still failing. The proper way to handle URL canonicalization according to Google would be to create a new module to handle URLs. However, I believe most real-life cases are handled correctly by this function.
=cut
sub canonical_uri {
my ($self, $url) = @_;
$url = trim $url;
# Special case for \t \r \n
while ($url =~ s/^([^?]+)[\r\t\n]/$1/sgi) { }
my $uri = URI->new($url)->canonical; # does not deal with directory traversing
# $self->debug("0. $url => " . $uri->as_string . "\n");
if (! $uri->scheme() || $uri->scheme() eq '') {
$uri = URI->new("http://$url")->canonical;
}
$uri->fragment('');
my $escape = $uri->as_string;
# Reduce double // to single / in path
while ($escape =~ s/^([a-z]+:\/\/[^?]+)\/\//$1\//sgi) { }
# Remove empty fragment
$escape =~ s/#$//;
# canonial does not handle ../
# $self->debug("\t$escape\n");
while($escape =~ s/([^\/])\/([^\/]+)\/\.\.([\/?].*)?$/$1$3/gi) { }
# May have removed ending /
# $self->debug("\t$escape\n");
$escape .= "/" if ($escape =~ /^[a-z]+:\/\/[^\/\?]+$/);
$escape =~ s/^([a-z]+:\/\/[^\/]+)(\?.*)$/$1\/$2/gi;
# $self->debug("\t$escape\n");
# other weird case if domain = digits only, try to translte it to IP address
if ((my $domain = URI->new($escape)->host) =~/^\d+$/) {
my $ip = num2ip($domain);
if (validaddr($ip)) {
$uri = URI->new($escape);
$uri->host($ip);
$escape = $uri->as_string;
}
}
# $self->debug("1. $url => $escape\n");
# Try to escape the path again
$url = $escape;
while (($escape = URI::Escape::uri_unescape($url)) ne $escape) { # wrong for %23 -> #
$url = $escape;
}
# while (($escape = URI->new($url)->canonical->as_string) ne $escape) { # breask more unit tests than previous
# $url = $escape;
# }
# Fix for %23 -> #
while($escape =~ s/#/%23/sgi) { }
# $self->debug("2. $url => $escape\n");
# Fix over escaping
while($escape =~ s/^([^?]+)%%(%.*)?$/$1%25%25$2/sgi) { }
# URI has issues with % in domains, it gets the host wrong
# 1. fix the host
# $self->debug("Domain: " . URI->new($escape)->host . "\n");
my $exception = 0;
while ($escape =~ /^[a-z]+:\/\/[^\/]*([^a-z0-9%_.-\/:])[^\/]*(\/.*)$/) {
my $source = $1;
my $target = sprintf("%02x", ord($source));
$escape =~ s/^([a-z]+:\/\/[^\/]*)\Q$source\E/$1%\Q$target\E/;
$exception = 1;
}
# 2. need to parse the path again
if ($exception && $escape =~ /^[a-z]+:\/\/[^\/]+\/(.+)/) {
my $source = $1;
my $target = URI::Escape::uri_unescape($source);
# print "Source: $source\n";
while ($target ne URI::Escape::uri_unescape($target)) {
$target = URI::Escape::uri_unescape($target);
}
$escape =~ s/\/\Q$source\E/\/$target/;
while ($escape =~ s/#/%23/sgi) { } # fragement has been removed earlier
while ($escape =~ s/^([a-z]+:\/\/[^\/]+\/.*)%5e/$1\&/sgi) { } # not in the host name
# while ($escape =~ s/%5e/&/sgi) { }
while ($escape =~ s/%([^0-9a-f]|.[^0-9a-f])/%25$1/sgi) { }
}
# $self->debug("$url => $escape\n");
# $self->debug(URI->new($escape)->as_string . "\n");
return URI->new($escape);
}
=head2 canonical()
Return all possible full hashes for a URL.
=cut
sub full_hashes {
my ($self, $url) = @_;
my @urls = $self->canonical($url);
my @hashes = ();
foreach my $url (@urls) {
# $self->debug("$url\n");
push(@hashes, sha256($url));
}
return @hashes;
}
=head2 prefix()
Return a hash prefix. The size of the prefix is set to 4 bytes.
=cut
sub prefix {
my ($self, $string) = @_;
return substr(sha256($string), 0, 4);
}
=head2 request_full_hash()
Request full full hashes for specific prefixes from Google.
=cut
sub request_full_hash {
my ($self, %args) = @_;
my $prefixes = $args{prefixes} || return ();
my $size = $args{size} || length $prefixes->[0];
# # Handle errors
my $i = 0;
my $errors;
my $delay = sub {
my $time = shift;
if ((time() - $errors->{timestamp}) < $time) {
splice(@$prefixes, $i, 1);
}
else {
$i++;
}
};
while ($i < scalar @$prefixes) {
my $prefix = $prefixes->[$i];
$errors = $self->{storage}->get_full_hash_error(prefix => $prefix);
if (defined $errors && $errors->{errors} > 2) { # 2 errors is OK
$errors->{errors} == 3 ? $delay->(30 * 60) # 30 minutes
: $errors->{errors} == 4 ? $delay->(60 * 60) # 1 hour
: $delay->(2 * 60 * 60); # 2 hours
}
else {
$i++;
}
}
my $url = "http://safebrowsing.clients.google.com/safebrowsing/gethash?client=api&apikey=" . $self->{key} . "&appver=$VERSION&pver=" . $self->{version};
my $prefix_list = join('', @$prefixes);
my $header = "$size:" . scalar @$prefixes * $size;
# print @{$args{prefixes}}, "\n";
# print $$prefixes[0], "\n"; return;
my $res = $self->ua->post($url, Content => "$header\n$prefix_list");
if (! $res->is_success) {
$self->error("Full hash request failed\n");
$self->debug($res->as_string . "\n");
foreach my $prefix (@$prefixes) {
my $errors = $self->{storage}->get_full_hash_error(prefix => $prefix);
if (defined $errors && (
$errors->{errors} >=2 # backoff mode
|| $errors->{errors} == 1 && (time() - $errors->{timestamp}) > 5 * 60)) { # 5 minutes
$self->{storage}->full_hash_error(prefix => $prefix, timestamp => time()); # more complicate than this, need to check time between 2 errors
}
}
return ();
}
else {
$self->debug("Full hash request OK\n");
foreach my $prefix (@$prefixes) {
$self->{storage}->full_hash_ok(prefix => $prefix, timestamp => time());
}
}
$self->debug($res->request->as_string . "\n");
$self->debug($res->as_string . "\n");
# $self->debug(substr($res->content, 0, 250), "\n\n");
return $self->parse_full_hashes($res->content);
}
=head2 parse_full_hashes()
Process the request for full hashes from Google.
=cut
sub parse_full_hashes {
my ($self, $data) = @_;
my @hashes = ();
# goog-malware-shavar:22428:32\nHEX
while (length $data > 0) {
if ($data !~ /^[a-z-]+:\d+:\d+\n/) {
$self->error("list not found\n");
return ();
}
$data =~ s/^([a-z-]+)://;
my $list = $1;
$data =~ s/^(\d+)://;
my $chunknum = $1;
$data =~ s/^(\d+)\n//;
my $length = $1;
my $current = 0;
while ($current < $length) {
my $hash = substr($data, 0, 32, '');
push(@hashes, { hash => $hash, chunknum => $chunknum, list => $list });
$current += 32;
}
}
return @hashes;
}
=head2 get_a_range()
Get the list of a chunks ranges for a list update.
=cut
sub get_a_range {
my ($self, %args) = @_;
my $list = $args{'list'} || '';
my @nums = $self->{storage}->get_add_chunks_nums(); # trust storage to torder list, or reorder it here?
return $self->create_range(numbers => [@nums]);
}
=head2 get_s_range()
Get the list of s chunks ranges for a list update.
=cut
sub get_s_range {
my ($self, %args) = @_;
my $list = $args{'list'} || '';
my @nums = $self->{storage}->get_sub_chunks_nums(); # trust storage to torder list, or reorder it here?
return $self->create_range(numbers => [@nums]);
}
=head2 create_range()
Create a list of ranges (1-3, 5, 7-11) from a list of numbers.
=cut
sub create_range {
my ($self, %args) = @_;
my $numbers = $args{numbers} || []; # should already be ordered
return '' if (scalar @$numbers == 0);
my $range = $$numbers[0];
my $new_range = 0;
for(my $i = 1; $i < scalar @$numbers; $i++) {
# next if ($$numbers[$i] == $$numbers[$i-1]); # should not happen
if ($$numbers[$i] != $$numbers[$i-1] + 1) {
$range .= $$numbers[$i-1] if ($i > 1 && $new_range == 1);
$range .= ',' . $$numbers[$i];
$new_range = 0
}
elsif ($new_range == 0) {
$range .= "-";
$new_range = 1;
}
}
$range .= $$numbers[scalar @$numbers - 1] if ($new_range == 1);
return $range;
}
=head2 expand_range()
Explode list of ranges (1-3, 5, 7-11) into a list of numbers (1,2,3,5,7,8,9,10,11).
=cut
sub expand_range {
my ($self, %args) = @_;
my $range = $args{range} || return ();
my @list = ();
my @elements = split /,/, $range;
foreach my $data (@elements) {
if ($data =~ /^\d+$/) { # single number
push(@list, $data);
}
elsif ($data =~ /^(\d+)-(\d+)$/) {
my $start = $1;
my $end = $2;
for(my $i = $start; $i <= $end; $i++) {
push(@list, $i);
}
}
}
return @list;
}
=head1 CHANGELOG
=over 4
=item 1.07
Add C<import_chunks()> feature to import add chunks and sub chunks from a file.
=item 1.05
No code change. Move C<local_lookup> to PRIVATE FUNCTIONS to avoid confusions.
=item 1.04
Introduce L<Net::Google::SafeBrowsing2::Lookup>. Remind people that Google Safe Browsing v1 has been deprecated by Google.
=item 1.03
The source code is available on github at L<https://github.com/juliensobrier/Net-Google-SafeBrowsing2>.
=item 1.02
Fix uninitialized $self->{errors} variable
=item 1.01
Use String::HexConvert for faster hex_to_ascii.
=item 1.0
Separate the error output from the debug output.
=item 0.9
Fix bug with local whitelisting (sub chunks). Fix the parsing of full hashes.
=item 0.8
Reduce the number of full hash requests.
=item 0.7
Add local_lookup to perform a lookup against the local database only. This function should be used for debugging purpose only.
Small code optimizations.
=item 0.6
Handle local database reset.
=item 0.5
Update documentation.
=item 0.4
Speed update the database update. The first update went down from 20 minutes to 20 minutes.
=item 0.3
Fix typos in the documentation.
Remove dependency on Switch (thanks to Curtis Jewel).
Fix value of FULL_HASH_TIME.
=item 0.2
Add support for Message Authentication Code (MAC)
=back
=head1 SEE ALSO
See L<Net::Google::SafeBrowsing2::Storage>, L<Net::Google::SafeBrowsing2::Sqlite> and L<Net::Google::SafeBrowsing2::MySQL> for information on storing and managing the Google Safe Browsing database.
Google Safe Browsing v2 API: L<http://code.google.com/apis/safebrowsing/developers_guide_v2.html>
L<Net::Google::SafeBrowsing> (Google Safe Browsing v1) is deprecated by Google since 12/01/2011.
=head1 AUTHOR
Julien Sobrier, E<lt>jsobrier@zscaler.comE<gt> or E<lt>julien@sobrier.netE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2012 by Julien Sobrier
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.
=cut
1;
|