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
|
--[[
Copyright (c) 2022, Vsevolod Stakhov <vsevolod@rspamd.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
]]--
--[[[
-- @module lua_content/pdf
-- This module contains some heuristics for PDF files
--]]
local rspamd_trie = require "rspamd_trie"
local rspamd_util = require "rspamd_util"
local rspamd_text = require "rspamd_text"
local rspamd_url = require "rspamd_url"
local bit = require "bit"
local N = "lua_content"
local lua_util = require "lua_util"
local rspamd_regexp = require "rspamd_regexp"
local lpeg = require "lpeg"
local pdf_patterns = {
trailer = {
patterns = {
[[\ntrailer\r?\n]]
}
},
suspicious = {
patterns = {
[[netsh\s]],
[[echo\s]],
[=[\/[A-Za-z]*#\d\d[#A-Za-z<>/\s]]=], -- Hex encode obfuscation
}
},
start_object = {
patterns = {
[=[[\r\n\0]\s*\d+\s+\d+\s+obj[\s<]]=]
}
},
end_object = {
patterns = {
[=[endobj[\r\n]]=]
}
},
start_stream = {
patterns = {
[=[>\s*stream[\r\n]]=],
}
},
end_stream = {
patterns = {
[=[endstream[\r\n]]=]
}
}
}
local pdf_cmap_patterns = {
start = {
patterns = {
[[\d\s+beginbfchar\s]],
[[\d\s+beginbfrange\s]]
}
},
stop = {
patterns = {
[[\sendbfrange\b]],
[[\sendbchar\b]]
}
}
}
-- index[n] ->
-- t[1] - pattern,
-- t[2] - key in patterns table,
-- t[3] - value in patterns table
-- t[4] - local pattern index
local pdf_indexes = {}
local pdf_cmap_indexes = {}
local pdf_trie
local pdf_text_trie
local pdf_cmap_trie
local exports = {}
local config = {
max_extraction_size = 512 * 1024,
max_processing_size = 32 * 1024,
text_extraction = true,
url_extraction = true,
enabled = true,
js_fuzzy = true, -- Generate fuzzy hashes from PDF javascripts
min_js_fuzzy = 256, -- Minimum size of js to be considered as a fuzzy
openaction_fuzzy_only = false, -- Generate fuzzy from all scripts
max_pdf_objects = 10000, -- Maximum number of objects to be considered
max_pdf_trailer = 10 * 1024 * 1024, -- Maximum trailer size (to avoid abuse)
max_pdf_trailer_lines = 100, -- Maximum number of lines in pdf trailer
pdf_process_timeout = 2.0, -- Timeout in seconds for processing
text_quality_threshold = 0.4, -- Minimum confidence to accept extracted text
text_quality_min_length = 10, -- Minimum text length to apply quality filtering
text_quality_enabled = true, -- Enable text quality filtering
}
-- Used to process patterns found in PDF
-- positions for functional processors should be a iter/table from trie matcher in form
---- [{n1, pat_idx1}, ... {nn, pat_idxn}] where
---- pat_idxn is pattern index and n1 ... nn are match positions
local processors = {}
-- PDF objects outer grammar in LPEG style (performing table captures)
local pdf_outer_grammar
local pdf_text_grammar
-- Used to match objects
local object_re = rspamd_regexp.create_cached([=[/(\d+)\s+(\d+)\s+obj\s*/]=])
local function config_module()
local opts = rspamd_config:get_all_opt('lua_content')
if opts and opts.pdf then
config = lua_util.override_defaults(config, opts.pdf)
end
end
local function compile_tries()
local default_compile_flags = bit.bor(rspamd_trie.flags.re,
rspamd_trie.flags.dot_all,
rspamd_trie.flags.no_start)
local function compile_pats(patterns, indexes, compile_flags)
local strs = {}
for what, data in pairs(patterns) do
for i, pat in ipairs(data.patterns) do
strs[#strs + 1] = pat
indexes[#indexes + 1] = { what, data, pat, i }
end
end
return rspamd_trie.create(strs, compile_flags or default_compile_flags)
end
if not pdf_trie then
pdf_trie = compile_pats(pdf_patterns, pdf_indexes)
end
if not pdf_text_trie then
pdf_text_trie = rspamd_trie.create({
[[\sBT\s]],
[[\sET\b]]
}, default_compile_flags)
end
if not pdf_cmap_trie then
pdf_cmap_trie = compile_pats(pdf_cmap_patterns, pdf_cmap_indexes)
end
end
-- Returns a table with generic grammar elements for PDF
local function generic_grammar_elts()
local P = lpeg.P
local R = lpeg.R
local S = lpeg.S
local V = lpeg.V
local C = lpeg.C
local D = R '09' -- Digits
local grammar_elts = {}
-- Helper functions
local function pdf_hexstring_unescape(s)
local res
if #s % 2 == 0 then
-- Sane hex string
res = lua_util.unhex(s)
else
-- WTF hex string
-- Append '0' to it and unescape...
res = lua_util.unhex(s:sub(1, #s - 1)) .. lua_util.unhex((s:sub(#s) .. '0'))
end
if res then
-- StandardEncoding/MacRomanEncoding ligature substitutions
res = res:gsub('\171', 'ff')
res = res:gsub('\172', 'ffi')
res = res:gsub('\173', 'ffl')
res = res:gsub('\174', 'fi')
res = res:gsub('\175', 'fl')
res = res:gsub('\222', 'fi')
res = res:gsub('\223', 'fl')
end
return res
end
local function pdf_string_unescape(s)
local function ue_single(cc)
if cc == '\\r' then
return '\r'
elseif cc == '\\n' then
return '\n'
else
return cc:gsub(2, 2)
end
end
-- simple unescape \char
s = s:gsub('\\[^%d]', ue_single)
-- unescape octal
local function ue_octal(cc)
-- Replace unknown stuff with '?'
return string.char(tonumber(cc:sub(2), 8) or 63)
end
s = s:gsub('\\%d%d?%d?', ue_octal)
-- StandardEncoding/MacRomanEncoding ligature substitutions
s = s:gsub('\171', 'ff')
s = s:gsub('\172', 'ffi')
s = s:gsub('\173', 'ffl')
s = s:gsub('\174', 'fi')
s = s:gsub('\175', 'fl')
s = s:gsub('\222', 'fi')
s = s:gsub('\223', 'fl')
return s
end
local function pdf_id_unescape(s)
return (s:gsub('#%d%d', function(cc)
return string.char(tonumber(cc:sub(2), 16))
end))
end
local delim = S '()<>[]{}/%'
grammar_elts.ws = S '\0 \r\n\t\f'
local hex = R 'af' + R 'AF' + D
-- Comments.
local eol = P '\r\n' + '\n'
local line = (1 - S '\r\n\f') ^ 0 * eol ^ -1
grammar_elts.comment = P '%' * line
-- Numbers.
local sign = S '+-' ^ -1
local decimal = D ^ 1
local float = D ^ 1 * P '.' * D ^ 0 + P '.' * D ^ 1
grammar_elts.number = C(sign * (float + decimal)) / tonumber
-- String
grammar_elts.str = P { "(" * C(((1 - S "()\\") + (P '\\' * 1) + V(1)) ^ 0) / pdf_string_unescape * ")" }
grammar_elts.hexstr = P { "<" * C(hex ^ 0) / pdf_hexstring_unescape * ">" }
-- Identifier
grammar_elts.id = P { '/' * C((1 - (delim + grammar_elts.ws)) ^ 1) / pdf_id_unescape }
-- Booleans (who care about them?)
grammar_elts.boolean = C(P("true") + P("false"))
-- Stupid references
grammar_elts.ref = lpeg.Ct { lpeg.Cc("%REF%") * C(D ^ 1) * " " * C(D ^ 1) * " " * "R" }
return grammar_elts
end
-- Generates a grammar to parse outer elements (external objects in PDF notation)
local function gen_outer_grammar()
local V = lpeg.V
local gen = generic_grammar_elts()
return lpeg.P {
"EXPR";
EXPR = gen.ws ^ 0 * V("ELT") ^ 0 * gen.ws ^ 0,
ELT = V("ARRAY") + V("DICT") + V("ATOM"),
ATOM = gen.ws ^ 0 * (gen.comment + gen.boolean + gen.ref +
gen.number + V("STRING") + gen.id) * gen.ws ^ 0,
DICT = "<<" * gen.ws ^ 0 * lpeg.Cf(lpeg.Ct("") * V("KV_PAIR") ^ 0, rawset) * gen.ws ^ 0 * ">>",
KV_PAIR = lpeg.Cg(gen.id * gen.ws ^ 0 * V("ELT") * gen.ws ^ 0),
ARRAY = "[" * gen.ws ^ 0 * lpeg.Ct(V("ELT") ^ 0) * gen.ws ^ 0 * "]",
STRING = lpeg.P { gen.str + gen.hexstr },
}
end
-- Graphic state in PDF
local function gen_graphics_unary()
local P = lpeg.P
local S = lpeg.S
return P("q") + P("Q") + P("h")
+ S("WSsFfBb") * P("*") ^ 0 + P("n")
end
local function gen_graphics_binary()
local P = lpeg.P
local S = lpeg.S
return S("gGwJjMi") +
P("M") + P("ri") + P("gs") +
P("CS") + P("cs") + P("sh")
end
local function gen_graphics_ternary()
local P = lpeg.P
local S = lpeg.S
return P("d") + P("m") + S("lm")
end
local function gen_graphics_nary()
local P = lpeg.P
local S = lpeg.S
return P("SC") + P("sc") + P("SCN") + P("scn") + P("k") + P("K") + P("re") + S("cvy") +
P("RG") + P("rg")
end
-- Calculate text quality confidence score using UTF-8 aware analysis
-- Returns a score between 0.0 (garbage) and 1.0 (high quality text)
local function calculate_text_confidence(text)
if not text or #text < config.text_quality_min_length then
return 1.0 -- Don't filter short text
end
local stats = rspamd_util.get_text_quality(text)
if not stats or stats.total == 0 then
return 0.0
end
local score = 0.0
local non_ws = stats.total - stats.spaces
-- Printable ratio (weight: 0.25) - target > 0.95
local printable_ratio = stats.printable / stats.total
score = score + math.min(printable_ratio / 0.95, 1.0) * 0.25
-- Letter ratio (weight: 0.20) - target > 0.6
local letter_ratio = 0
if non_ws > 0 then
letter_ratio = stats.letters / non_ws
end
score = score + math.min(letter_ratio / 0.6, 1.0) * 0.20
-- Word ratio (weight: 0.25) - target > 0.7
local word_ratio = 0
if non_ws > 0 then
word_ratio = stats.word_chars / non_ws
end
score = score + math.min(word_ratio / 0.7, 1.0) * 0.25
-- Average word length (weight: 0.15) - ideal: 3-10
local avg_word_len = 0
if stats.words > 0 then
avg_word_len = stats.word_chars / stats.words
end
local word_len_score = 0
if avg_word_len >= 3 and avg_word_len <= 10 then
word_len_score = 1.0
elseif avg_word_len >= 2 and avg_word_len < 3 then
word_len_score = 0.7
elseif avg_word_len > 10 and avg_word_len <= 15 then
word_len_score = 0.5
else
word_len_score = 0.2
end
score = score + word_len_score * 0.15
-- Space ratio (weight: 0.15) - ideal: 0.08-0.25
local space_ratio = stats.spaces / stats.total
local space_score = 0
if space_ratio >= 0.08 and space_ratio <= 0.25 then
space_score = 1.0
elseif space_ratio > 0.25 and space_ratio <= 0.4 then
space_score = 0.6
elseif space_ratio > 0 and space_ratio < 0.08 then
space_score = 0.5
else
space_score = 0.2
end
score = score + space_score * 0.15
return score
end
-- Generates a grammar to parse text blocks (between BT and ET)
local function gen_text_grammar()
local V = lpeg.V
local P = lpeg.P
local C = lpeg.C
local gen = generic_grammar_elts()
local function sanitize_pdf_text(s)
if not s or #s < 4 then return s end
local nulls_odd = 0
local nulls_even = 0
local len = #s
local limit = math.min(len, 16)
for i = 1, limit do
local b = string.byte(s, i)
if b == 0 then
if i % 2 == 1 then
nulls_odd = nulls_odd + 1
else
nulls_even = nulls_even + 1
end
end
end
if len > 32 then
for i = len - 15, len do
local b = string.byte(s, i)
if b == 0 then
if i % 2 == 1 then
nulls_odd = nulls_odd + 1
else
nulls_even = nulls_even + 1
end
end
end
elseif len > 16 then
for i = 17, len do
local b = string.byte(s, i)
if b == 0 then
if i % 2 == 1 then
nulls_odd = nulls_odd + 1
else
nulls_even = nulls_even + 1
end
end
end
end
local total_checked = (len > 32) and 32 or len
local total_odd = math.ceil(total_checked / 2)
local total_even = math.floor(total_checked / 2)
if len > 32 then
total_odd = 16
total_even = 16
end
local ratio_odd = nulls_odd / total_odd
local ratio_even = nulls_even / total_even
local charset
if ratio_odd > 0.8 and ratio_even < 0.2 then
charset = 'UTF-16BE'
elseif ratio_even > 0.8 and ratio_odd < 0.2 then
charset = 'UTF-16LE'
end
if charset and rspamd_util.to_utf8 then
local conv = rspamd_util.to_utf8(s, charset)
if conv then
local garbage_limit = 0
local clen = #conv
for i = 1, clen do
local b = conv:byte(i)
if b < 32 and b ~= 9 and b ~= 10 and b ~= 13 then
garbage_limit = garbage_limit + 1
end
end
if garbage_limit > 0 then
return ''
end
return conv
end
end
return s
end
local function text_op_handler(...)
local args = { ... }
local op = args[#args]
local t = args[#args - 1]
local res = t
if type(t) == 'table' then
local tres = {}
for _, chunk in ipairs(t) do
if type(chunk) == 'string' then
table.insert(tres, chunk)
elseif type(chunk) == 'number' and chunk < -200 then
table.insert(tres, ' ')
end
end
res = table.concat(tres)
end
res = sanitize_pdf_text(res)
-- Apply text quality filtering to reject garbage chunks
if config.text_quality_enabled and res and #res >= config.text_quality_min_length then
local confidence = calculate_text_confidence(res)
if confidence < config.text_quality_threshold then
lua_util.debugm(N, nil, 'rejected low confidence text chunk (%.2f): %s',
confidence, res:sub(1, 50))
return ''
end
end
if op == "'" or op == '"' then
return '\n' .. res
end
return res
end
local function nary_op_handler(...)
local args = { ... }
local op = args[#args]
if op == 'Tm' then
return '\n'
end
return ''
end
local function ternary_op_handler(...)
local args = { ... }
local op = args[#args]
local a2 = args[#args - 2]
if (op == 'Td' or op == 'TD') and type(a2) == 'number' and a2 ~= 0 then
return '\n'
end
return ''
end
local empty = ""
local unary_ops = C("T*") / "\n" +
C(gen_graphics_unary()) / empty
local binary_ops = P("Tc") + P("Tw") + P("Tz") + P("TL") + P("Tr") + P("Ts") +
gen_graphics_binary()
local ternary_ops = P("TD") + P("Td") + gen_graphics_ternary()
local nary_op = P("Tm") + gen_graphics_nary()
local text_binary_op = C(P("Tj") + P("TJ") + P("'"))
local text_quote_op = C(P('"'))
local font_op = P("Tf")
return lpeg.P {
"EXPR";
EXPR = gen.ws ^ 0 * lpeg.Ct(V("COMMAND") ^ 0),
COMMAND = (V("UNARY") + V("BINARY") + V("TERNARY") + V("NARY") + V("TEXT") +
V("FONT") + gen.comment) * gen.ws ^ 0,
UNARY = unary_ops,
BINARY = V("ARG") / empty * gen.ws ^ 1 * binary_ops,
TERNARY = (V("ARG") * gen.ws ^ 1 * V("ARG") * gen.ws ^ 1 * ternary_ops) / ternary_op_handler,
NARY = lpeg.Ct((V("ARG") * gen.ws ^ 1) ^ 1) * (gen.id / empty * gen.ws ^ 0) ^ -1 * nary_op / nary_op_handler,
ARG = V("ARRAY") + V("DICT") + V("ATOM"),
ATOM = (gen.comment + gen.boolean + gen.ref +
gen.number + V("STRING") + gen.id),
DICT = "<<" * gen.ws ^ 0 * lpeg.Cf(lpeg.Ct("") * V("KV_PAIR") ^ 0, rawset) * gen.ws ^ 0 * ">>",
KV_PAIR = lpeg.Cg(gen.id * gen.ws ^ 0 * V("ARG") * gen.ws ^ 0),
ARRAY = "[" * gen.ws ^ 0 * lpeg.Ct(V("ARG") ^ 0) * gen.ws ^ 0 * "]",
STRING = lpeg.P { gen.str + gen.hexstr },
TEXT = ((V("TEXT_ARG") * gen.ws ^ 0 * text_binary_op) / text_op_handler) +
((V("ARG") / empty * gen.ws ^ 1 * V("ARG") / empty * gen.ws ^ 1 * V("TEXT_ARG") * gen.ws ^ 0 * text_quote_op) / text_op_handler),
FONT = (V("FONT_ARG") * gen.ws ^ 1 * (gen.number / empty) * gen.ws ^ 1 * font_op) / empty,
FONT_ARG = lpeg.Ct(lpeg.Cc("%font%") * gen.id),
TEXT_ARG = lpeg.Ct(V("STRING")) + V("TEXT_ARRAY"),
TEXT_ARRAY = "[" * gen.ws ^ 0 * lpeg.Ct((V("TEXT_ARRAY_ELT") * gen.ws ^ 0) ^ 0) * "]",
TEXT_ARRAY_ELT = gen.number + gen.str + gen.hexstr,
}
end
-- Call immediately on require
compile_tries()
config_module()
pdf_outer_grammar = gen_outer_grammar()
pdf_text_grammar = gen_text_grammar()
local function extract_text_data(specific)
local res = {}
if specific.objects then
for _, obj in ipairs(specific.objects) do
if obj.text then
if type(obj.text) == 'userdata' then
res[#res + 1] = tostring(obj.text)
else
res[#res + 1] = obj.text
end
end
end
end
return res
end
-- Generates index for major/minor pair
local function obj_ref(major, minor)
return major * 10.0 + 1.0 / (minor + 1.0)
end
-- Return indirect object reference (if needed)
local function maybe_dereference_object(elt, pdf, task)
if type(elt) == 'table' and elt[1] == '%REF%' then
local ref = obj_ref(elt[2], elt[3])
if pdf.ref[ref] then
-- No recursion!
return pdf.ref[ref]
else
lua_util.debugm(N, task, 'cannot dereference %s:%s -> %s, no object',
elt[2], elt[3], obj_ref(elt[2], elt[3]))
return nil
end
end
return elt
end
-- Apply PDF stream filter
local function apply_pdf_filter(input, filt)
-- Validate input before processing
if not input or (type(input) == 'string' and #input == 0) then
return nil
end
if filt == 'FlateDecode' or filt == 'Fl' then
return rspamd_util.inflate(input, config.max_extraction_size)
elseif filt == 'ASCIIHexDecode' or filt == 'AHx' then
-- Strip > at the end if present (should be stripped by parser but safety check)
-- Also strip whitespaces
local to_decode = input:gsub('%s', '')
if to_decode:sub(-1) == '>' then
to_decode = to_decode:sub(1, -2)
end
if #to_decode == 0 then
return nil
end
return lua_util.unhex(to_decode)
end
return nil
end
-- Conditionally apply a pipeline of stream filters and return uncompressed data
local function maybe_apply_filter(dict, data, pdf, task)
local uncompressed = data
if dict.Filter then
local filt = dict.Filter
local filts = {}
if type(filt) == 'string' then
filts = { filt }
elseif type(filt) == 'table' then
filts = filt
end
if dict.DecodeParms then
local decode_params = maybe_dereference_object(dict.DecodeParms, pdf, task)
if type(decode_params) == 'table' then
if decode_params.Predictor then
local predictor = tonumber(decode_params.Predictor) or 1
if predictor > 1 then
return nil, 'predictor exists: ' .. tostring(predictor)
end
end
end
end
for _, f in ipairs(filts) do
local next_uncompressed = apply_pdf_filter(uncompressed, f)
if next_uncompressed then
uncompressed = next_uncompressed
else
return nil, 'filter failed: ' .. tostring(f)
end
end
end
return uncompressed, nil
end
-- Conditionally extract stream data from object and attach it as obj.uncompressed
local function maybe_extract_object_stream(obj, pdf, task)
if pdf.encrypted then
-- TODO add decryption some day
return nil
end
local dict = obj.dict
local len = obj.stream.len
local decl_len = maybe_dereference_object(dict.Length, pdf, task)
if decl_len then
local nlen = tonumber(decl_len)
if nlen then
len = math.min(len, nlen)
end
end
if len > 0 then
local real_stream = obj.stream.data:span(1, len)
local uncompressed, filter_err = maybe_apply_filter(dict, real_stream, pdf, task)
if uncompressed then
obj.uncompressed = uncompressed
lua_util.debugm(N, task, 'extracted object %s:%s: (%s -> %s)',
obj.major, obj.minor, len, #uncompressed)
return obj.uncompressed
else
lua_util.debugm(N, task, 'cannot extract object %s:%s; len = %s; filter = %s: %s',
obj.major, obj.minor, len, dict.Filter, filter_err)
end
else
lua_util.debugm(N, task, 'cannot extract object %s:%s; len = %s',
obj.major, obj.minor, len)
end
end
local function parse_object_grammar(obj, task, pdf)
-- Parse grammar
local obj_dict_span
if obj.stream then
obj_dict_span = obj.data:span(1, obj.stream.start - obj.start)
else
obj_dict_span = obj.data
end
if obj_dict_span:len() < config.max_processing_size then
local ret, obj_or_err = pcall(pdf_outer_grammar.match, pdf_outer_grammar, obj_dict_span)
if ret then
if obj.stream then
if type(obj_or_err) == 'table' then
obj.dict = obj_or_err
else
obj.dict = {}
end
lua_util.debugm(N, task, 'stream object %s:%s is parsed to: %s',
obj.major, obj.minor, obj_or_err)
else
-- Direct object
if type(obj_or_err) == 'table' then
obj.dict = obj_or_err
obj.uncompressed = obj_or_err
lua_util.debugm(N, task, 'direct object %s:%s is parsed to: %s',
obj.major, obj.minor, obj_or_err)
pdf.ref[obj_ref(obj.major, obj.minor)] = obj
else
lua_util.debugm(N, task, 'direct object %s:%s is parsed to raw data: %s',
obj.major, obj.minor, obj_or_err)
pdf.ref[obj_ref(obj.major, obj.minor)] = obj_or_err
obj.dict = {}
obj.uncompressed = obj_or_err
end
end
else
lua_util.debugm(N, task, 'object %s:%s cannot be parsed: %s',
obj.major, obj.minor, obj_or_err)
end
else
lua_util.debugm(N, task, 'object %s:%s cannot be parsed: too large %s',
obj.major, obj.minor, obj_dict_span:len())
end
end
-- Extracts font data and process /ToUnicode mappings
-- NYI in fact as cmap is ridiculously stupid and complicated
--[[
local function process_font(task, pdf, font, fname)
local dict = font
if font.dict then
dict = font.dict
end
if type(dict) == 'table' and dict.ToUnicode then
local cmap = maybe_dereference_object(dict.ToUnicode, pdf, task)
if cmap and cmap.dict then
maybe_extract_object_stream(cmap, pdf, task)
lua_util.debugm(N, task, 'found cmap for font %s: %s',
fname, cmap.uncompressed)
end
end
end
--]]
-- Forward declaration
local process_dict
-- This function processes javascript string and returns JS hash and JS rspamd_text
local function process_javascript(task, pdf, js, obj)
local rspamd_cryptobox_hash = require "rspamd_cryptobox_hash"
if type(js) == 'string' then
js = rspamd_text.fromstring(js):oneline()
elseif type(js) == 'userdata' then
js = js:oneline()
else
return nil
end
local hash = rspamd_cryptobox_hash.create(js)
local bin_hash = hash:bin()
if not pdf.scripts then
pdf.scripts = {}
end
if pdf.scripts[bin_hash] then
-- Duplicate
return pdf.scripts[bin_hash]
end
local njs = {
data = js,
hash = hash:hex(),
bin_hash = bin_hash,
object = obj,
}
pdf.scripts[bin_hash] = njs
return njs
end
-- Extract interesting stuff from /Action, e.g. javascript
local function process_action(task, pdf, obj)
if not (obj.js or obj.launch) and (obj.dict and obj.dict.JS) then
local js = maybe_dereference_object(obj.dict.JS, pdf, task)
if js then
if type(js) == 'table' then
local extracted_js = maybe_extract_object_stream(js, pdf, task)
if not extracted_js then
lua_util.debugm(N, task, 'invalid type for JavaScript from %s:%s: %s',
obj.major, obj.minor, js)
else
js = extracted_js
end
end
js = process_javascript(task, pdf, js, obj)
if js then
obj.js = js
lua_util.debugm(N, task, 'extracted javascript from %s:%s: %s',
obj.major, obj.minor, obj.js.data)
else
lua_util.debugm(N, task, 'invalid type for JavaScript from %s:%s: %s',
obj.major, obj.minor, js)
end
elseif obj.dict.F then
local launch = maybe_dereference_object(obj.dict.F, pdf, task)
if launch then
if type(launch) == 'string' then
obj.launch = rspamd_text.fromstring(launch):exclude_chars('%n%c')
lua_util.debugm(N, task, 'extracted launch from %s:%s: %s',
obj.major, obj.minor, obj.launch)
elseif type(launch) == 'userdata' then
obj.launch = launch:exclude_chars('%n%c')
lua_util.debugm(N, task, 'extracted launch from %s:%s: %s',
obj.major, obj.minor, obj.launch)
else
lua_util.debugm(N, task, 'invalid type for launch from %s:%s: %s',
obj.major, obj.minor, launch)
end
end
else
lua_util.debugm(N, task, 'no JS attribute in action %s:%s',
obj.major, obj.minor)
end
end
end
-- Extract interesting stuff from /Catalog, e.g. javascript in /OpenAction
local function process_catalog(task, pdf, obj)
if obj.dict then
if obj.dict.OpenAction then
local action = maybe_dereference_object(obj.dict.OpenAction, pdf, task)
if action and type(action) == 'table' then
-- This also processes action js (if not already processed)
process_dict(task, pdf, action, action.dict)
if action.js then
lua_util.debugm(N, task, 'found openaction JS in %s:%s: %s',
obj.major, obj.minor, action.js)
pdf.openaction = action.js
action.js.object = obj
elseif action.launch then
lua_util.debugm(N, task, 'found openaction launch in %s:%s: %s',
obj.major, obj.minor, action.launch)
pdf.launch = action.launch
else
lua_util.debugm(N, task, 'no JS in openaction %s:%s: %s',
obj.major, obj.minor, action)
end
else
lua_util.debugm(N, task, 'cannot find openaction %s:%s: %s -> %s',
obj.major, obj.minor, obj.dict.OpenAction, action)
end
else
lua_util.debugm(N, task, 'no openaction in catalog %s:%s',
obj.major, obj.minor)
end
end
end
local function process_xref(task, pdf, obj)
if obj.dict then
if obj.dict.Encrypt then
local encrypt = maybe_dereference_object(obj.dict.Encrypt, pdf, task)
lua_util.debugm(N, task, 'found encrypt: %s in xref object %s:%s',
encrypt, obj.major, obj.minor)
pdf.encrypted = true
end
end
end
process_dict = function(task, pdf, obj, dict)
if not obj.type and type(dict) == 'table' then
if dict.Type and type(dict.Type) == 'string' then
-- Common stuff
obj.type = dict.Type
end
if not obj.type then
if obj.dict.S and obj.dict.JS then
obj.type = 'Javascript'
lua_util.debugm(N, task, 'implicit type for JavaScript object %s:%s',
obj.major, obj.minor)
else
lua_util.debugm(N, task, 'no type for %s:%s',
obj.major, obj.minor)
return
end
end
lua_util.debugm(N, task, 'processed stream dictionary for object %s:%s -> %s',
obj.major, obj.minor, obj.type)
local contents = dict.Contents
if contents and type(contents) == 'table' then
if contents[1] == '%REF%' then
-- Single reference
contents = { contents }
end
obj.contents = {}
for _, c in ipairs(contents) do
local cobj = maybe_dereference_object(c, pdf, task)
if cobj and type(cobj) == 'table' then
obj.contents[#obj.contents + 1] = cobj
cobj.parent = obj
cobj.type = 'content'
end
end
lua_util.debugm(N, task, 'found content objects for %s:%s -> %s',
obj.major, obj.minor, #obj.contents)
end
local resources = dict.Resources
if resources and type(resources) == 'table' then
local res_ref = maybe_dereference_object(resources, pdf, task)
if type(res_ref) ~= 'table' then
lua_util.debugm(N, task, 'cannot parse resources from pdf: %s',
resources)
obj.resources = {}
elseif res_ref.dict then
obj.resources = res_ref.dict
else
obj.resources = {}
end
else
-- Fucking pdf: we need to inherit from parent
resources = {}
if dict.Parent then
local parent = maybe_dereference_object(dict.Parent, pdf, task)
if parent and type(parent) == 'table' and parent.dict then
if parent.resources then
lua_util.debugm(N, task, 'propagated resources from %s:%s to %s:%s',
parent.major, parent.minor, obj.major, obj.minor)
resources = parent.resources
end
end
end
obj.resources = resources
end
--[[Disabled fonts extraction
local fonts = obj.resources.Font
if fonts and type(fonts) == 'table' then
obj.fonts = {}
for k,v in pairs(fonts) do
obj.fonts[k] = maybe_dereference_object(v, pdf, task)
if obj.fonts[k] then
local font = obj.fonts[k]
if config.text_extraction then
process_font(task, pdf, font, k)
lua_util.debugm(N, task, 'found font "%s" for object %s:%s -> %s',
k, obj.major, obj.minor, font)
end
end
end
end
]]
lua_util.debugm(N, task, 'found resources for object %s:%s (%s): %s',
obj.major, obj.minor, obj.type, obj.resources)
if obj.type == 'Action' then
process_action(task, pdf, obj)
elseif obj.type == 'Catalog' then
process_catalog(task, pdf, obj)
elseif obj.type == 'XRef' then
-- XRef stream instead of trailer from PDF 1.5 (thanks Adobe)
process_xref(task, pdf, obj)
elseif obj.type == 'Javascript' then
local js = maybe_dereference_object(obj.dict.JS, pdf, task)
if js then
if type(js) == 'table' then
local extracted_js = maybe_extract_object_stream(js, pdf, task)
if not extracted_js then
lua_util.debugm(N, task, 'invalid type for JavaScript from %s:%s: %s',
obj.major, obj.minor, js)
else
js = extracted_js
end
end
js = process_javascript(task, pdf, js, obj)
if js then
obj.js = js
lua_util.debugm(N, task, 'extracted javascript from %s:%s: %s',
obj.major, obj.minor, obj.js.data)
else
lua_util.debugm(N, task, 'invalid type for JavaScript from %s:%s: %s',
obj.major, obj.minor, js)
end
end
end
end -- Already processed dict (obj.type is not empty)
end
-- This function is intended to unpack objects from ObjStm crappy structure
local compound_obj_grammar
local function compound_obj_grammar_gen()
if not compound_obj_grammar then
local gen = generic_grammar_elts()
compound_obj_grammar = gen.ws ^ 0 * (gen.comment * gen.ws ^ 1) ^ 0 *
lpeg.Ct(lpeg.Ct(gen.number * gen.ws ^ 1 * gen.number * gen.ws ^ 0) ^ 1)
end
return compound_obj_grammar
end
local function pdf_compound_object_unpack(_, uncompressed, pdf, task, first)
-- First, we need to parse data line by line likely to find a line
-- that consists of pairs of numbers
compound_obj_grammar_gen()
local elts = compound_obj_grammar:match(uncompressed)
if elts and #elts > 0 then
lua_util.debugm(N, task, 'compound elts (chunk length %s): %s',
#uncompressed, elts)
for i, pair in ipairs(elts) do
local obj_number, offset = pair[1], pair[2]
offset = offset + first
if offset < #uncompressed then
local span_len
if i == #elts then
span_len = #uncompressed - offset
else
span_len = (elts[i + 1][2] + first) - offset
end
if span_len > 0 and offset + span_len <= #uncompressed then
local obj = {
major = obj_number,
minor = 0, -- Implicit
data = uncompressed:span(offset + 1, span_len),
ref = obj_ref(obj_number, 0)
}
parse_object_grammar(obj, task, pdf)
if obj.dict then
pdf.objects[#pdf.objects + 1] = obj
end
else
lua_util.debugm(N, task, 'invalid span_len for compound object %s:%s; offset = %s, len = %s',
pair[1], pair[2], offset + span_len, #uncompressed)
end
end
end
end
end
-- PDF 1.5 ObjStmt
local function extract_pdf_compound_objects(task, pdf)
for i, obj in ipairs(pdf.objects or {}) do
if i > 0 and i % 100 == 0 then
local now = rspamd_util.get_ticks()
if now >= pdf.end_timestamp then
pdf.timeout_processing = now - pdf.start_timestamp
lua_util.debugm(N, task, 'pdf: timeout processing compound objects after spending %s seconds, ' ..
'%s elements processed',
pdf.timeout_processing, i)
break
end
end
if obj.stream and obj.dict and type(obj.dict) == 'table' then
local t = obj.dict.Type
if t and t == 'ObjStm' then
-- We are in troubles sir...
local nobjs = tonumber(maybe_dereference_object(obj.dict.N, pdf, task))
local first = tonumber(maybe_dereference_object(obj.dict.First, pdf, task))
if nobjs and first then
--local extend = maybe_dereference_object(obj.dict.Extends, pdf, task)
lua_util.debugm(N, task, 'extract ObjStm with %s objects (%s first) %s extend',
nobjs, first, obj.dict.Extends)
local uncompressed = maybe_extract_object_stream(obj, pdf, task)
if uncompressed then
pdf_compound_object_unpack(obj, uncompressed, pdf, task, first)
end
else
lua_util.debugm(N, task, 'ObjStm object %s:%s has bad dict: %s',
obj.major, obj.minor, obj.dict)
end
end
end
end
end
-- This function arranges starts and ends of all objects and process them into initial
-- set of objects
local function extract_outer_objects(task, input, pdf)
local start_pos, end_pos = 1, 1
local max_start_pos, max_end_pos
local obj_count = 0
max_start_pos = math.min(config.max_pdf_objects, #pdf.start_objects)
max_end_pos = math.min(config.max_pdf_objects, #pdf.end_objects)
lua_util.debugm(N, task, "pdf: extract objects from %s start positions and %s end positions",
max_start_pos, max_end_pos)
while start_pos <= max_start_pos and end_pos <= max_end_pos do
local first = pdf.start_objects[start_pos]
local last = pdf.end_objects[end_pos]
-- 7 is length of `endobj\n`
if first + 6 < last then
local len = last - first - 6
-- Also get the starting span and try to match it versus obj re to get numbers
local obj_line_potential = first - 32
if obj_line_potential < 1 then
obj_line_potential = 1
end
local prev_obj_end = pdf.end_objects[end_pos - 1]
if end_pos > 1 and prev_obj_end >= obj_line_potential and prev_obj_end < first then
obj_line_potential = prev_obj_end + 1
end
local obj_line_span = input:span(obj_line_potential, first - obj_line_potential + 1)
local matches = object_re:search(obj_line_span, true, true)
if matches and matches[1] then
local nobj = {
start = first,
len = len,
data = input:span(first, len),
major = tonumber(matches[1][2]),
minor = tonumber(matches[1][3]),
}
pdf.objects[obj_count + 1] = nobj
if nobj.major and nobj.minor then
-- Add reference
local ref = obj_ref(nobj.major, nobj.minor)
nobj.ref = ref -- Our internal reference
pdf.ref[ref] = nobj
end
end
obj_count = obj_count + 1
start_pos = start_pos + 1
end_pos = end_pos + 1
elseif first > last then
end_pos = end_pos + 1
else
start_pos = start_pos + 1
end_pos = end_pos + 1
end
end
end
-- This function attaches streams to objects and processes outer pdf grammar
local function attach_pdf_streams(task, input, pdf)
if pdf.start_streams and pdf.end_streams then
local start_pos, end_pos = 1, 1
local max_start_pos, max_end_pos
max_start_pos = math.min(config.max_pdf_objects, #pdf.start_streams)
max_end_pos = math.min(config.max_pdf_objects, #pdf.end_streams)
for _, obj in ipairs(pdf.objects) do
while start_pos <= max_start_pos and end_pos <= max_end_pos do
local first = pdf.start_streams[start_pos]
local last = pdf.end_streams[end_pos]
last = last - 10 -- Exclude endstream\n pattern
lua_util.debugm(N, task, "start: %s, end: %s; obj: %s-%s",
first, last, obj.start, obj.start + obj.len)
if first > obj.start and last < obj.start + obj.len and last > first then
-- In case if we have fake endstream :(
while pdf.end_streams[end_pos + 1] and pdf.end_streams[end_pos + 1] < obj.start + obj.len do
end_pos = end_pos + 1
last = pdf.end_streams[end_pos]
end
-- Strip the first \n
while first < last do
local chr = input:byte(first)
if chr ~= 13 and chr ~= 10 then
break
end
first = first + 1
end
local len = last - first
obj.stream = {
start = first,
len = len,
data = input:span(first, len)
}
start_pos = start_pos + 1
end_pos = end_pos + 1
break
elseif first < obj.start then
start_pos = start_pos + 1
elseif last > obj.start + obj.len then
-- Not this object
break
else
start_pos = start_pos + 1
end_pos = end_pos + 1
end
end
if obj.stream then
lua_util.debugm(N, task, 'found object %s:%s %s start %s len, %s stream start, %s stream length',
obj.major, obj.minor, obj.start, obj.len, obj.stream.start, obj.stream.len)
else
lua_util.debugm(N, task, 'found object %s:%s %s start %s len, no stream',
obj.major, obj.minor, obj.start, obj.len)
end
end
end
end
-- Processes PDF objects: extracts streams, object numbers, process outer grammar,
-- augment object types
local function postprocess_pdf_objects(task, input, pdf)
pdf.objects = {} -- objects table
pdf.ref = {} -- references table
extract_outer_objects(task, input, pdf)
-- Now we have objects and we need to attach streams that are in bounds
attach_pdf_streams(task, input, pdf)
-- Parse grammar for outer objects
for i, obj in ipairs(pdf.objects) do
if i > 0 and i % 100 == 0 then
local now = rspamd_util.get_ticks()
if now >= pdf.end_timestamp then
pdf.timeout_processing = now - pdf.start_timestamp
lua_util.debugm(N, task, 'pdf: timeout processing grammars after spending %s seconds, ' ..
'%s elements processed',
pdf.timeout_processing, i)
break
end
end
if obj.ref then
parse_object_grammar(obj, task, pdf)
-- Special early handling
if obj.dict and obj.dict.Type and obj.dict.Type == 'XRef' then
process_xref(task, pdf, obj)
end
end
end
if not pdf.timeout_processing then
extract_pdf_compound_objects(task, pdf)
else
-- ENOTIME
return
end
-- Now we might probably have all objects being processed
for i, obj in ipairs(pdf.objects) do
if obj.dict then
-- Types processing
if i > 0 and i % 100 == 0 then
local now = rspamd_util.get_ticks()
if now >= pdf.end_timestamp then
pdf.timeout_processing = now - pdf.start_timestamp
lua_util.debugm(N, task, 'pdf: timeout processing dicts after spending %s seconds, ' ..
'%s elements processed',
pdf.timeout_processing, i)
break
end
end
process_dict(task, pdf, obj, obj.dict)
end
end
end
local function offsets_to_blocks(starts, ends, out)
local start_pos, end_pos = 1, 1
while start_pos <= #starts and end_pos <= #ends do
local first = starts[start_pos]
local last = ends[end_pos]
if first < last then
local len = last - first
out[#out + 1] = {
start = first,
len = len,
}
start_pos = start_pos + 1
end_pos = end_pos + 1
elseif first > last then
end_pos = end_pos + 1
else
-- Not ordered properly!
break
end
end
end
local function search_text(task, pdf, mpart)
for _, obj in ipairs(pdf.objects) do
if obj.type == 'Page' and obj.contents then
local text = {}
for _, tobj in ipairs(obj.contents) do
maybe_extract_object_stream(tobj, pdf, task)
local matches = pdf_text_trie:match(tobj.uncompressed or '')
if matches then
local text_blocks = {}
local starts = {}
local ends = {}
for npat, matched_positions in pairs(matches) do
if npat == 1 then
for _, pos in ipairs(matched_positions) do
starts[#starts + 1] = pos
end
else
for _, pos in ipairs(matched_positions) do
ends[#ends + 1] = pos
end
end
end
table.sort(starts)
table.sort(ends)
offsets_to_blocks(starts, ends, text_blocks)
for _, bl in ipairs(text_blocks) do
if bl.len > 2 then
-- To remove \s+ET\b pattern (it can leave trailing space or not but it doesn't matter)
bl.len = bl.len - 2
end
bl.data = tobj.uncompressed:span(bl.start, bl.len)
if bl.len <= 256 then
lua_util.debugm(N, task, 'extracted text from object %s:%s: %s',
tobj.major, tobj.minor, bl.data)
else
lua_util.debugm(N, task, 'extracted text from object %s:%s (%d bytes)',
tobj.major, tobj.minor, bl.len)
end
if bl.len < config.max_processing_size then
local ret, obj_or_err = pcall(pdf_text_grammar.match, pdf_text_grammar,
bl.data)
if ret then
if #obj_or_err == 0 then
lua_util.debugm(N, task, 'empty text match from block: %s', bl.data)
end
for _, chunk in ipairs(obj_or_err) do
text[#text + 1] = chunk
end
text[#text + 1] = '\n'
lua_util.debugm(N, task, 'attached %s from content object %s:%s to %s:%s',
obj_or_err, tobj.major, tobj.minor, obj.major, obj.minor)
else
lua_util.debugm(N, task, 'object %s:%s cannot be parsed: %s',
obj.major, obj.minor, obj_or_err)
end
end
end
end
end
-- Join all text data together
if #text > 0 then
for i, chunk in ipairs(text) do
if type(chunk) == 'userdata' then
text[i] = tostring(chunk)
elseif type(chunk) == 'table' then
local function flatten(t)
local res = {}
local stack = { { tbl = t, idx = 1 } }
local max_depth = 100
while #stack > 0 and #stack <= max_depth do
local frame = stack[#stack]
local tbl, idx = frame.tbl, frame.idx
if idx > #tbl then
stack[#stack] = nil
else
local v = tbl[idx]
frame.idx = idx + 1
if type(v) == 'userdata' then
res[#res + 1] = tostring(v)
elseif type(v) == 'table' then
stack[#stack + 1] = { tbl = v, idx = 1 }
elseif v ~= nil then
res[#res + 1] = tostring(v)
end
end
end
return table.concat(res, '')
end
text[i] = flatten(chunk)
end
end
local res = table.concat(text, '')
-- Page-level confidence check before storing text
if config.text_quality_enabled and #res >= config.text_quality_min_length then
local page_confidence = calculate_text_confidence(res)
if page_confidence < config.text_quality_threshold then
lua_util.debugm(N, task, 'skipping low confidence page text for %s:%s (%.2f)',
obj.major, obj.minor, page_confidence)
-- Don't store this page's text
else
obj.text = rspamd_text.fromstring(res)
lua_util.debugm(N, task, 'object %s:%s is parsed (confidence: %.2f): %s',
obj.major, obj.minor, page_confidence, obj.text)
end
else
obj.text = rspamd_text.fromstring(res)
lua_util.debugm(N, task, 'object %s:%s is parsed to: %s',
obj.major, obj.minor, obj.text)
end
end
end
end
if task.inject_part then
local all_text = {}
for _, obj in ipairs(pdf.objects) do
if obj.text and obj.text:len() > 0 then
table.insert(all_text, obj.text)
end
end
if #all_text > 0 then
task:inject_part('text', all_text, mpart)
end
end
end
-- This function searches objects for `/URI` key and parses it's content
local function search_urls(task, pdf, mpart)
local function recursive_object_traverse(obj, dict, rec)
if rec > 10 then
lua_util.debugm(N, task, 'object %s:%s recurses too much',
obj.major, obj.minor)
return
end
for k, v in pairs(dict) do
if type(v) == 'table' then
recursive_object_traverse(obj, v, rec + 1)
elseif k == 'URI' then
v = maybe_dereference_object(v, pdf, task)
if type(v) == 'string' then
local url = rspamd_url.create(task:get_mempool(), v, { 'content' })
if url then
lua_util.debugm(N, task, 'found url %s in object %s:%s',
v, obj.major, obj.minor)
task:inject_url(url, mpart)
end
end
end
end
end
for _, obj in ipairs(pdf.objects) do
if obj.dict and type(obj.dict) == 'table' then
recursive_object_traverse(obj, obj.dict, 0)
end
end
end
local function process_pdf(input, mpart, task)
if not config.enabled then
-- Skip processing
return {}
end
local matches = pdf_trie:match(input)
if matches then
local start_ts = rspamd_util.get_ticks()
-- Temp object used to share data between pdf extraction methods
local pdf_object = {
tag = 'pdf',
extract_text = extract_text_data,
start_timestamp = start_ts,
end_timestamp = start_ts + config.pdf_process_timeout,
}
-- Output object that excludes all internal stuff
local pdf_output = lua_util.shallowcopy(pdf_object)
local grouped_processors = {}
for npat, matched_positions in pairs(matches) do
local index = pdf_indexes[npat]
local proc_key, loc_npat = index[1], index[4]
if not grouped_processors[proc_key] then
grouped_processors[proc_key] = {
processor_func = processors[proc_key],
offsets = {},
}
end
local proc = grouped_processors[proc_key]
-- Fill offsets
for _, pos in ipairs(matched_positions) do
proc.offsets[#proc.offsets + 1] = { pos, loc_npat }
end
end
for name, processor in pairs(grouped_processors) do
-- Sort by offset
lua_util.debugm(N, task, "pdf: process group %s with %s matches",
name, #processor.offsets)
table.sort(processor.offsets, function(e1, e2)
return e1[1] < e2[1]
end)
processor.processor_func(input, task, processor.offsets, pdf_object, pdf_output)
end
pdf_output.flags = {}
if pdf_object.start_objects and pdf_object.end_objects then
if #pdf_object.start_objects > config.max_pdf_objects then
pdf_output.many_objects = #pdf_object.start_objects
-- Trim
end
-- Postprocess objects
postprocess_pdf_objects(task, input, pdf_object)
pdf_output.objects = pdf_object.objects
-- Skip text extraction if timeout occurred - partial results would be incorrect
if config.text_extraction and not pdf_object.timeout_processing then
search_text(task, pdf_object, mpart)
end
if config.url_extraction then
search_urls(task, pdf_object, mpart, pdf_output)
end
if config.js_fuzzy and pdf_object.scripts then
pdf_output.fuzzy_hashes = {}
if config.openaction_fuzzy_only then
-- OpenAction only
if pdf_object.openaction and pdf_object.openaction.bin_hash then
if config.min_js_fuzzy and #pdf_object.openaction.data >= config.min_js_fuzzy then
lua_util.debugm(N, task, "pdf: add fuzzy hash from openaction: %s; size = %s; object: %s:%s",
pdf_object.openaction.hash,
#pdf_object.openaction.data,
pdf_object.openaction.object.major, pdf_object.openaction.object.minor)
table.insert(pdf_output.fuzzy_hashes, pdf_object.openaction.bin_hash)
else
lua_util.debugm(N, task, "pdf: skip fuzzy hash from JavaScript: %s, too short: %s",
pdf_object.openaction.hash, #pdf_object.openaction.data)
end
end
else
-- All hashes
for h, sc in pairs(pdf_object.scripts) do
if config.min_js_fuzzy and #sc.data >= config.min_js_fuzzy then
lua_util.debugm(N, task, "pdf: add fuzzy hash from JavaScript: %s; size = %s; object: %s:%s",
sc.hash,
#sc.data,
sc.object.major, sc.object.minor)
table.insert(pdf_output.fuzzy_hashes, h)
else
lua_util.debugm(N, task, "pdf: skip fuzzy hash from JavaScript: %s, too short: %s",
sc.hash, #sc.data)
end
end
end
end
else
pdf_output.flags.no_objects = true
end
-- Propagate from object to output
if pdf_object.encrypted then
pdf_output.encrypted = true
end
if pdf_object.scripts then
pdf_output.scripts = true
end
return pdf_output
end
end
-- Processes the PDF trailer
processors.trailer = function(input, task, positions, pdf_object, pdf_output)
local last_pos = positions[#positions]
lua_util.debugm(N, task, 'pdf: process trailer at position %s (%s total length)',
last_pos, #input)
if last_pos[1] > config.max_pdf_trailer then
pdf_output.long_trailer = #input - last_pos[1]
return
end
local last_span = input:span(last_pos[1])
local lines_checked = 0
for line in last_span:lines(true) do
if line:find('/Encrypt ') then
lua_util.debugm(N, task, "pdf: found encrypted line in trailer: %s",
line)
pdf_output.encrypted = true
pdf_object.encrypted = true
break
end
lines_checked = lines_checked + 1
if lines_checked > config.max_pdf_trailer_lines then
lua_util.debugm(N, task, "pdf: trailer has too many lines, stop checking")
pdf_output.long_trailer = #input - last_pos[1]
break
end
end
end
processors.suspicious = function(input, task, positions, pdf_object, pdf_output)
local suspicious_factor = 0.0
local nexec = 0
local nencoded = 0
local close_encoded = 0
local last_encoded
for _, match in ipairs(positions) do
if match[2] == 1 then
-- netsh
suspicious_factor = suspicious_factor + 0.5
elseif match[2] == 2 then
nexec = nexec + 1
elseif match[2] == 3 then
local enc_data = input:sub(match[1] - 2, match[1] - 1)
local legal_escape = false
if enc_data then
enc_data = enc_data:strtoul()
if enc_data then
-- Legit encode cases are non printable characters (e.g. spaces)
if enc_data < 0x21 or enc_data >= 0x7f then
legal_escape = true
end
end
end
if not legal_escape then
nencoded = nencoded + 1
if last_encoded then
if match[1] - last_encoded < 8 then
-- likely consecutive encoded chars, increase factor
close_encoded = close_encoded + 1
end
end
last_encoded = match[1]
end
end
end
if nencoded > 10 then
suspicious_factor = suspicious_factor + nencoded / 10
end
if nexec > 1 then
suspicious_factor = suspicious_factor + nexec / 2.0
end
if close_encoded > 4 and nencoded - close_encoded < 5 then
-- Too many close encoded comparing to the total number of encoded characters
suspicious_factor = suspicious_factor + 0.5
end
lua_util.debugm(N, task, 'pdf: found a suspicious patterns: %s exec, %s encoded (%s close), ' ..
'%s final factor',
nexec, nencoded, close_encoded, suspicious_factor)
if suspicious_factor > 1.0 then
suspicious_factor = 1.0
end
pdf_output.suspicious = suspicious_factor
end
local function generic_table_inserter(positions, pdf_object, output_key)
if not pdf_object[output_key] then
pdf_object[output_key] = {}
end
local shift = #pdf_object[output_key]
for i, pos in ipairs(positions) do
pdf_object[output_key][i + shift] = pos[1]
end
end
processors.start_object = function(_, task, positions, pdf_object)
generic_table_inserter(positions, pdf_object, 'start_objects')
end
processors.end_object = function(_, task, positions, pdf_object)
generic_table_inserter(positions, pdf_object, 'end_objects')
end
processors.start_stream = function(_, task, positions, pdf_object)
generic_table_inserter(positions, pdf_object, 'start_streams')
end
processors.end_stream = function(_, task, positions, pdf_object)
generic_table_inserter(positions, pdf_object, 'end_streams')
end
exports.process = process_pdf
return exports
|