kreuzberg 4.0.0.rc2 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (446) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +14 -14
  3. data/.rspec +3 -3
  4. data/.rubocop.yaml +1 -1
  5. data/.rubocop.yml +543 -538
  6. data/Gemfile +8 -8
  7. data/Gemfile.lock +194 -6
  8. data/README.md +396 -426
  9. data/Rakefile +34 -25
  10. data/Steepfile +51 -47
  11. data/examples/async_patterns.rb +283 -341
  12. data/ext/kreuzberg_rb/extconf.rb +65 -45
  13. data/ext/kreuzberg_rb/native/.cargo/config.toml +23 -0
  14. data/ext/kreuzberg_rb/native/Cargo.lock +7619 -6535
  15. data/ext/kreuzberg_rb/native/Cargo.toml +75 -44
  16. data/ext/kreuzberg_rb/native/README.md +425 -425
  17. data/ext/kreuzberg_rb/native/build.rs +15 -15
  18. data/ext/kreuzberg_rb/native/include/ieeefp.h +11 -11
  19. data/ext/kreuzberg_rb/native/include/msvc_compat/strings.h +14 -14
  20. data/ext/kreuzberg_rb/native/include/strings.h +20 -20
  21. data/ext/kreuzberg_rb/native/include/unistd.h +47 -47
  22. data/ext/kreuzberg_rb/native/src/lib.rs +3802 -2998
  23. data/extconf.rb +60 -28
  24. data/kreuzberg.gemspec +199 -148
  25. data/lib/kreuzberg/api_proxy.rb +126 -142
  26. data/lib/kreuzberg/cache_api.rb +67 -46
  27. data/lib/kreuzberg/cli.rb +47 -55
  28. data/lib/kreuzberg/cli_proxy.rb +117 -127
  29. data/lib/kreuzberg/config.rb +936 -691
  30. data/lib/kreuzberg/error_context.rb +136 -32
  31. data/lib/kreuzberg/errors.rb +116 -118
  32. data/lib/kreuzberg/extraction_api.rb +313 -85
  33. data/lib/kreuzberg/mcp_proxy.rb +177 -186
  34. data/lib/kreuzberg/ocr_backend_protocol.rb +40 -113
  35. data/lib/kreuzberg/post_processor_protocol.rb +15 -86
  36. data/lib/kreuzberg/result.rb +334 -216
  37. data/lib/kreuzberg/setup_lib_path.rb +99 -80
  38. data/lib/kreuzberg/types.rb +170 -0
  39. data/lib/kreuzberg/validator_protocol.rb +16 -89
  40. data/lib/kreuzberg/version.rb +5 -5
  41. data/lib/kreuzberg.rb +96 -103
  42. data/lib/libpdfium.so +0 -0
  43. data/sig/kreuzberg/internal.rbs +184 -184
  44. data/sig/kreuzberg.rbs +561 -520
  45. data/spec/binding/async_operations_spec.rb +473 -0
  46. data/spec/binding/batch_operations_spec.rb +595 -0
  47. data/spec/binding/batch_spec.rb +359 -0
  48. data/spec/binding/cache_spec.rb +227 -227
  49. data/spec/binding/cli_proxy_spec.rb +85 -85
  50. data/spec/binding/cli_spec.rb +55 -55
  51. data/spec/binding/config_result_spec.rb +377 -0
  52. data/spec/binding/config_spec.rb +419 -345
  53. data/spec/binding/config_validation_spec.rb +377 -283
  54. data/spec/binding/embeddings_spec.rb +816 -0
  55. data/spec/binding/error_handling_spec.rb +399 -213
  56. data/spec/binding/error_recovery_spec.rb +488 -0
  57. data/spec/binding/errors_spec.rb +66 -66
  58. data/spec/binding/font_config_spec.rb +220 -0
  59. data/spec/binding/images_spec.rb +738 -0
  60. data/spec/binding/keywords_extraction_spec.rb +600 -0
  61. data/spec/binding/metadata_types_spec.rb +1228 -0
  62. data/spec/binding/pages_extraction_spec.rb +471 -0
  63. data/spec/binding/plugins/ocr_backend_spec.rb +307 -307
  64. data/spec/binding/plugins/postprocessor_spec.rb +269 -269
  65. data/spec/binding/plugins/validator_spec.rb +273 -274
  66. data/spec/binding/tables_spec.rb +641 -0
  67. data/spec/fixtures/config.toml +38 -39
  68. data/spec/fixtures/config.yaml +41 -41
  69. data/spec/fixtures/invalid_config.toml +3 -4
  70. data/spec/smoke/package_spec.rb +177 -178
  71. data/spec/spec_helper.rb +40 -42
  72. data/spec/unit/config/chunking_config_spec.rb +213 -0
  73. data/spec/unit/config/embedding_config_spec.rb +343 -0
  74. data/spec/unit/config/extraction_config_spec.rb +438 -0
  75. data/spec/unit/config/font_config_spec.rb +285 -0
  76. data/spec/unit/config/hierarchy_config_spec.rb +314 -0
  77. data/spec/unit/config/image_extraction_config_spec.rb +209 -0
  78. data/spec/unit/config/image_preprocessing_config_spec.rb +249 -0
  79. data/spec/unit/config/keyword_config_spec.rb +229 -0
  80. data/spec/unit/config/language_detection_config_spec.rb +258 -0
  81. data/spec/unit/config/ocr_config_spec.rb +171 -0
  82. data/spec/unit/config/page_config_spec.rb +221 -0
  83. data/spec/unit/config/pdf_config_spec.rb +267 -0
  84. data/spec/unit/config/postprocessor_config_spec.rb +290 -0
  85. data/spec/unit/config/tesseract_config_spec.rb +181 -0
  86. data/spec/unit/config/token_reduction_config_spec.rb +251 -0
  87. data/test/metadata_types_test.rb +959 -0
  88. data/vendor/Cargo.toml +61 -0
  89. data/vendor/kreuzberg/Cargo.toml +259 -204
  90. data/vendor/kreuzberg/README.md +263 -175
  91. data/vendor/kreuzberg/build.rs +782 -474
  92. data/vendor/kreuzberg/examples/bench_fixes.rs +71 -0
  93. data/vendor/kreuzberg/examples/test_pdfium_fork.rs +62 -0
  94. data/vendor/kreuzberg/src/api/error.rs +81 -81
  95. data/vendor/kreuzberg/src/api/handlers.rs +320 -199
  96. data/vendor/kreuzberg/src/api/mod.rs +94 -79
  97. data/vendor/kreuzberg/src/api/server.rs +518 -353
  98. data/vendor/kreuzberg/src/api/types.rs +206 -170
  99. data/vendor/kreuzberg/src/cache/mod.rs +1167 -1167
  100. data/vendor/kreuzberg/src/chunking/mod.rs +2303 -677
  101. data/vendor/kreuzberg/src/chunking/processor.rs +219 -0
  102. data/vendor/kreuzberg/src/core/batch_mode.rs +95 -95
  103. data/vendor/kreuzberg/src/core/batch_optimizations.rs +385 -0
  104. data/vendor/kreuzberg/src/core/config.rs +1914 -1032
  105. data/vendor/kreuzberg/src/core/config_validation.rs +949 -0
  106. data/vendor/kreuzberg/src/core/extractor.rs +1200 -1024
  107. data/vendor/kreuzberg/src/core/formats.rs +235 -0
  108. data/vendor/kreuzberg/src/core/io.rs +329 -329
  109. data/vendor/kreuzberg/src/core/mime.rs +605 -605
  110. data/vendor/kreuzberg/src/core/mod.rs +61 -45
  111. data/vendor/kreuzberg/src/core/pipeline.rs +1223 -984
  112. data/vendor/kreuzberg/src/core/server_config.rs +1220 -0
  113. data/vendor/kreuzberg/src/embeddings.rs +471 -432
  114. data/vendor/kreuzberg/src/error.rs +431 -431
  115. data/vendor/kreuzberg/src/extraction/archive.rs +959 -954
  116. data/vendor/kreuzberg/src/extraction/capacity.rs +263 -0
  117. data/vendor/kreuzberg/src/extraction/docx.rs +404 -40
  118. data/vendor/kreuzberg/src/extraction/email.rs +855 -854
  119. data/vendor/kreuzberg/src/extraction/excel.rs +697 -688
  120. data/vendor/kreuzberg/src/extraction/html.rs +1830 -553
  121. data/vendor/kreuzberg/src/extraction/image.rs +492 -368
  122. data/vendor/kreuzberg/src/extraction/libreoffice.rs +574 -563
  123. data/vendor/kreuzberg/src/extraction/markdown.rs +216 -213
  124. data/vendor/kreuzberg/src/extraction/mod.rs +93 -81
  125. data/vendor/kreuzberg/src/extraction/office_metadata/app_properties.rs +398 -398
  126. data/vendor/kreuzberg/src/extraction/office_metadata/core_properties.rs +247 -247
  127. data/vendor/kreuzberg/src/extraction/office_metadata/custom_properties.rs +240 -240
  128. data/vendor/kreuzberg/src/extraction/office_metadata/mod.rs +130 -130
  129. data/vendor/kreuzberg/src/extraction/office_metadata/odt_properties.rs +284 -287
  130. data/vendor/kreuzberg/src/extraction/pptx.rs +3102 -3000
  131. data/vendor/kreuzberg/src/extraction/structured.rs +491 -490
  132. data/vendor/kreuzberg/src/extraction/table.rs +329 -328
  133. data/vendor/kreuzberg/src/extraction/text.rs +277 -269
  134. data/vendor/kreuzberg/src/extraction/xml.rs +333 -333
  135. data/vendor/kreuzberg/src/extractors/archive.rs +447 -446
  136. data/vendor/kreuzberg/src/extractors/bibtex.rs +470 -469
  137. data/vendor/kreuzberg/src/extractors/docbook.rs +504 -502
  138. data/vendor/kreuzberg/src/extractors/docx.rs +400 -367
  139. data/vendor/kreuzberg/src/extractors/email.rs +157 -143
  140. data/vendor/kreuzberg/src/extractors/epub.rs +696 -707
  141. data/vendor/kreuzberg/src/extractors/excel.rs +385 -343
  142. data/vendor/kreuzberg/src/extractors/fictionbook.rs +492 -491
  143. data/vendor/kreuzberg/src/extractors/html.rs +419 -393
  144. data/vendor/kreuzberg/src/extractors/image.rs +219 -198
  145. data/vendor/kreuzberg/src/extractors/jats.rs +1054 -1051
  146. data/vendor/kreuzberg/src/extractors/jupyter.rs +368 -367
  147. data/vendor/kreuzberg/src/extractors/latex.rs +653 -652
  148. data/vendor/kreuzberg/src/extractors/markdown.rs +701 -700
  149. data/vendor/kreuzberg/src/extractors/mod.rs +429 -365
  150. data/vendor/kreuzberg/src/extractors/odt.rs +628 -628
  151. data/vendor/kreuzberg/src/extractors/opml.rs +635 -634
  152. data/vendor/kreuzberg/src/extractors/orgmode.rs +529 -528
  153. data/vendor/kreuzberg/src/extractors/pdf.rs +761 -493
  154. data/vendor/kreuzberg/src/extractors/pptx.rs +279 -248
  155. data/vendor/kreuzberg/src/extractors/rst.rs +577 -576
  156. data/vendor/kreuzberg/src/extractors/rtf.rs +809 -810
  157. data/vendor/kreuzberg/src/extractors/security.rs +484 -484
  158. data/vendor/kreuzberg/src/extractors/security_tests.rs +367 -367
  159. data/vendor/kreuzberg/src/extractors/structured.rs +142 -140
  160. data/vendor/kreuzberg/src/extractors/text.rs +265 -260
  161. data/vendor/kreuzberg/src/extractors/typst.rs +651 -650
  162. data/vendor/kreuzberg/src/extractors/xml.rs +147 -135
  163. data/vendor/kreuzberg/src/image/dpi.rs +164 -164
  164. data/vendor/kreuzberg/src/image/mod.rs +6 -6
  165. data/vendor/kreuzberg/src/image/preprocessing.rs +417 -417
  166. data/vendor/kreuzberg/src/image/resize.rs +89 -89
  167. data/vendor/kreuzberg/src/keywords/config.rs +154 -154
  168. data/vendor/kreuzberg/src/keywords/mod.rs +237 -237
  169. data/vendor/kreuzberg/src/keywords/processor.rs +275 -267
  170. data/vendor/kreuzberg/src/keywords/rake.rs +293 -293
  171. data/vendor/kreuzberg/src/keywords/types.rs +68 -68
  172. data/vendor/kreuzberg/src/keywords/yake.rs +163 -163
  173. data/vendor/kreuzberg/src/language_detection/mod.rs +985 -942
  174. data/vendor/kreuzberg/src/language_detection/processor.rs +218 -0
  175. data/vendor/kreuzberg/src/lib.rs +114 -105
  176. data/vendor/kreuzberg/src/mcp/mod.rs +35 -32
  177. data/vendor/kreuzberg/src/mcp/server.rs +2090 -1968
  178. data/vendor/kreuzberg/src/ocr/cache.rs +469 -469
  179. data/vendor/kreuzberg/src/ocr/error.rs +37 -37
  180. data/vendor/kreuzberg/src/ocr/hocr.rs +216 -216
  181. data/vendor/kreuzberg/src/ocr/language_registry.rs +520 -0
  182. data/vendor/kreuzberg/src/ocr/mod.rs +60 -58
  183. data/vendor/kreuzberg/src/ocr/processor.rs +858 -863
  184. data/vendor/kreuzberg/src/ocr/table/mod.rs +4 -4
  185. data/vendor/kreuzberg/src/ocr/table/tsv_parser.rs +144 -144
  186. data/vendor/kreuzberg/src/ocr/tesseract_backend.rs +456 -450
  187. data/vendor/kreuzberg/src/ocr/types.rs +393 -393
  188. data/vendor/kreuzberg/src/ocr/utils.rs +47 -47
  189. data/vendor/kreuzberg/src/ocr/validation.rs +206 -206
  190. data/vendor/kreuzberg/src/panic_context.rs +154 -154
  191. data/vendor/kreuzberg/src/pdf/bindings.rs +306 -0
  192. data/vendor/kreuzberg/src/pdf/bundled.rs +408 -0
  193. data/vendor/kreuzberg/src/pdf/error.rs +214 -122
  194. data/vendor/kreuzberg/src/pdf/fonts.rs +358 -0
  195. data/vendor/kreuzberg/src/pdf/hierarchy.rs +903 -0
  196. data/vendor/kreuzberg/src/pdf/images.rs +139 -139
  197. data/vendor/kreuzberg/src/pdf/metadata.rs +509 -346
  198. data/vendor/kreuzberg/src/pdf/mod.rs +81 -50
  199. data/vendor/kreuzberg/src/pdf/rendering.rs +369 -369
  200. data/vendor/kreuzberg/src/pdf/table.rs +417 -393
  201. data/vendor/kreuzberg/src/pdf/text.rs +553 -158
  202. data/vendor/kreuzberg/src/plugins/extractor.rs +1042 -1013
  203. data/vendor/kreuzberg/src/plugins/mod.rs +212 -209
  204. data/vendor/kreuzberg/src/plugins/ocr.rs +637 -620
  205. data/vendor/kreuzberg/src/plugins/processor.rs +650 -642
  206. data/vendor/kreuzberg/src/plugins/registry.rs +1339 -1337
  207. data/vendor/kreuzberg/src/plugins/traits.rs +258 -258
  208. data/vendor/kreuzberg/src/plugins/validator.rs +967 -956
  209. data/vendor/kreuzberg/src/stopwords/mod.rs +1470 -1470
  210. data/vendor/kreuzberg/src/text/mod.rs +27 -19
  211. data/vendor/kreuzberg/src/text/quality.rs +710 -697
  212. data/vendor/kreuzberg/src/text/quality_processor.rs +231 -0
  213. data/vendor/kreuzberg/src/text/string_utils.rs +229 -217
  214. data/vendor/kreuzberg/src/text/token_reduction/cjk_utils.rs +164 -164
  215. data/vendor/kreuzberg/src/text/token_reduction/config.rs +100 -100
  216. data/vendor/kreuzberg/src/text/token_reduction/core.rs +832 -796
  217. data/vendor/kreuzberg/src/text/token_reduction/filters.rs +923 -902
  218. data/vendor/kreuzberg/src/text/token_reduction/mod.rs +160 -160
  219. data/vendor/kreuzberg/src/text/token_reduction/semantic.rs +619 -619
  220. data/vendor/kreuzberg/src/text/token_reduction/simd_text.rs +148 -147
  221. data/vendor/kreuzberg/src/text/utf8_validation.rs +193 -0
  222. data/vendor/kreuzberg/src/types.rs +1713 -903
  223. data/vendor/kreuzberg/src/utils/mod.rs +31 -17
  224. data/vendor/kreuzberg/src/utils/pool.rs +503 -0
  225. data/vendor/kreuzberg/src/utils/pool_sizing.rs +364 -0
  226. data/vendor/kreuzberg/src/utils/quality.rs +968 -959
  227. data/vendor/kreuzberg/src/utils/string_pool.rs +761 -0
  228. data/vendor/kreuzberg/src/utils/string_utils.rs +381 -381
  229. data/vendor/kreuzberg/stopwords/af_stopwords.json +53 -53
  230. data/vendor/kreuzberg/stopwords/ar_stopwords.json +482 -482
  231. data/vendor/kreuzberg/stopwords/bg_stopwords.json +261 -261
  232. data/vendor/kreuzberg/stopwords/bn_stopwords.json +400 -400
  233. data/vendor/kreuzberg/stopwords/br_stopwords.json +1205 -1205
  234. data/vendor/kreuzberg/stopwords/ca_stopwords.json +280 -280
  235. data/vendor/kreuzberg/stopwords/cs_stopwords.json +425 -425
  236. data/vendor/kreuzberg/stopwords/da_stopwords.json +172 -172
  237. data/vendor/kreuzberg/stopwords/de_stopwords.json +622 -622
  238. data/vendor/kreuzberg/stopwords/el_stopwords.json +849 -849
  239. data/vendor/kreuzberg/stopwords/en_stopwords.json +1300 -1300
  240. data/vendor/kreuzberg/stopwords/eo_stopwords.json +175 -175
  241. data/vendor/kreuzberg/stopwords/es_stopwords.json +734 -734
  242. data/vendor/kreuzberg/stopwords/et_stopwords.json +37 -37
  243. data/vendor/kreuzberg/stopwords/eu_stopwords.json +100 -100
  244. data/vendor/kreuzberg/stopwords/fa_stopwords.json +801 -801
  245. data/vendor/kreuzberg/stopwords/fi_stopwords.json +849 -849
  246. data/vendor/kreuzberg/stopwords/fr_stopwords.json +693 -693
  247. data/vendor/kreuzberg/stopwords/ga_stopwords.json +111 -111
  248. data/vendor/kreuzberg/stopwords/gl_stopwords.json +162 -162
  249. data/vendor/kreuzberg/stopwords/gu_stopwords.json +226 -226
  250. data/vendor/kreuzberg/stopwords/ha_stopwords.json +41 -41
  251. data/vendor/kreuzberg/stopwords/he_stopwords.json +196 -196
  252. data/vendor/kreuzberg/stopwords/hi_stopwords.json +227 -227
  253. data/vendor/kreuzberg/stopwords/hr_stopwords.json +181 -181
  254. data/vendor/kreuzberg/stopwords/hu_stopwords.json +791 -791
  255. data/vendor/kreuzberg/stopwords/hy_stopwords.json +47 -47
  256. data/vendor/kreuzberg/stopwords/id_stopwords.json +760 -760
  257. data/vendor/kreuzberg/stopwords/it_stopwords.json +634 -634
  258. data/vendor/kreuzberg/stopwords/ja_stopwords.json +136 -136
  259. data/vendor/kreuzberg/stopwords/kn_stopwords.json +84 -84
  260. data/vendor/kreuzberg/stopwords/ko_stopwords.json +681 -681
  261. data/vendor/kreuzberg/stopwords/ku_stopwords.json +64 -64
  262. data/vendor/kreuzberg/stopwords/la_stopwords.json +51 -51
  263. data/vendor/kreuzberg/stopwords/lt_stopwords.json +476 -476
  264. data/vendor/kreuzberg/stopwords/lv_stopwords.json +163 -163
  265. data/vendor/kreuzberg/stopwords/ml_stopwords.json +1 -1
  266. data/vendor/kreuzberg/stopwords/mr_stopwords.json +101 -101
  267. data/vendor/kreuzberg/stopwords/ms_stopwords.json +477 -477
  268. data/vendor/kreuzberg/stopwords/ne_stopwords.json +490 -490
  269. data/vendor/kreuzberg/stopwords/nl_stopwords.json +415 -415
  270. data/vendor/kreuzberg/stopwords/no_stopwords.json +223 -223
  271. data/vendor/kreuzberg/stopwords/pl_stopwords.json +331 -331
  272. data/vendor/kreuzberg/stopwords/pt_stopwords.json +562 -562
  273. data/vendor/kreuzberg/stopwords/ro_stopwords.json +436 -436
  274. data/vendor/kreuzberg/stopwords/ru_stopwords.json +561 -561
  275. data/vendor/kreuzberg/stopwords/si_stopwords.json +193 -193
  276. data/vendor/kreuzberg/stopwords/sk_stopwords.json +420 -420
  277. data/vendor/kreuzberg/stopwords/sl_stopwords.json +448 -448
  278. data/vendor/kreuzberg/stopwords/so_stopwords.json +32 -32
  279. data/vendor/kreuzberg/stopwords/st_stopwords.json +33 -33
  280. data/vendor/kreuzberg/stopwords/sv_stopwords.json +420 -420
  281. data/vendor/kreuzberg/stopwords/sw_stopwords.json +76 -76
  282. data/vendor/kreuzberg/stopwords/ta_stopwords.json +129 -129
  283. data/vendor/kreuzberg/stopwords/te_stopwords.json +54 -54
  284. data/vendor/kreuzberg/stopwords/th_stopwords.json +118 -118
  285. data/vendor/kreuzberg/stopwords/tl_stopwords.json +149 -149
  286. data/vendor/kreuzberg/stopwords/tr_stopwords.json +506 -506
  287. data/vendor/kreuzberg/stopwords/uk_stopwords.json +75 -75
  288. data/vendor/kreuzberg/stopwords/ur_stopwords.json +519 -519
  289. data/vendor/kreuzberg/stopwords/vi_stopwords.json +647 -647
  290. data/vendor/kreuzberg/stopwords/yo_stopwords.json +62 -62
  291. data/vendor/kreuzberg/stopwords/zh_stopwords.json +796 -796
  292. data/vendor/kreuzberg/stopwords/zu_stopwords.json +31 -31
  293. data/vendor/kreuzberg/tests/api_embed.rs +360 -0
  294. data/vendor/kreuzberg/tests/api_extract_multipart.rs +52 -52
  295. data/vendor/kreuzberg/tests/api_large_pdf_extraction.rs +471 -0
  296. data/vendor/kreuzberg/tests/api_large_pdf_extraction_diagnostics.rs +289 -0
  297. data/vendor/kreuzberg/tests/api_tests.rs +1472 -966
  298. data/vendor/kreuzberg/tests/archive_integration.rs +545 -543
  299. data/vendor/kreuzberg/tests/batch_orchestration.rs +587 -556
  300. data/vendor/kreuzberg/tests/batch_pooling_benchmark.rs +154 -0
  301. data/vendor/kreuzberg/tests/batch_processing.rs +328 -316
  302. data/vendor/kreuzberg/tests/bibtex_parity_test.rs +421 -421
  303. data/vendor/kreuzberg/tests/concurrency_stress.rs +541 -525
  304. data/vendor/kreuzberg/tests/config_features.rs +612 -598
  305. data/vendor/kreuzberg/tests/config_integration_test.rs +753 -0
  306. data/vendor/kreuzberg/tests/config_loading_tests.rs +416 -415
  307. data/vendor/kreuzberg/tests/core_integration.rs +519 -510
  308. data/vendor/kreuzberg/tests/csv_integration.rs +414 -414
  309. data/vendor/kreuzberg/tests/data/hierarchy_ground_truth.json +294 -0
  310. data/vendor/kreuzberg/tests/docbook_extractor_tests.rs +500 -498
  311. data/vendor/kreuzberg/tests/docx_metadata_extraction_test.rs +122 -122
  312. data/vendor/kreuzberg/tests/docx_vs_pandoc_comparison.rs +370 -370
  313. data/vendor/kreuzberg/tests/email_integration.rs +327 -325
  314. data/vendor/kreuzberg/tests/epub_native_extractor_tests.rs +275 -275
  315. data/vendor/kreuzberg/tests/error_handling.rs +402 -393
  316. data/vendor/kreuzberg/tests/fictionbook_extractor_tests.rs +228 -228
  317. data/vendor/kreuzberg/tests/format_integration.rs +165 -159
  318. data/vendor/kreuzberg/tests/helpers/mod.rs +202 -142
  319. data/vendor/kreuzberg/tests/html_table_test.rs +551 -551
  320. data/vendor/kreuzberg/tests/image_integration.rs +255 -253
  321. data/vendor/kreuzberg/tests/instrumentation_test.rs +139 -139
  322. data/vendor/kreuzberg/tests/jats_extractor_tests.rs +639 -639
  323. data/vendor/kreuzberg/tests/jupyter_extractor_tests.rs +704 -704
  324. data/vendor/kreuzberg/tests/keywords_integration.rs +479 -479
  325. data/vendor/kreuzberg/tests/keywords_quality.rs +509 -509
  326. data/vendor/kreuzberg/tests/latex_extractor_tests.rs +496 -496
  327. data/vendor/kreuzberg/tests/markdown_extractor_tests.rs +490 -490
  328. data/vendor/kreuzberg/tests/mime_detection.rs +429 -428
  329. data/vendor/kreuzberg/tests/ocr_configuration.rs +514 -510
  330. data/vendor/kreuzberg/tests/ocr_errors.rs +698 -676
  331. data/vendor/kreuzberg/tests/ocr_language_registry.rs +191 -0
  332. data/vendor/kreuzberg/tests/ocr_quality.rs +629 -627
  333. data/vendor/kreuzberg/tests/ocr_stress.rs +469 -469
  334. data/vendor/kreuzberg/tests/odt_extractor_tests.rs +674 -695
  335. data/vendor/kreuzberg/tests/opml_extractor_tests.rs +616 -616
  336. data/vendor/kreuzberg/tests/orgmode_extractor_tests.rs +822 -822
  337. data/vendor/kreuzberg/tests/page_markers.rs +297 -0
  338. data/vendor/kreuzberg/tests/pdf_hierarchy_detection.rs +301 -0
  339. data/vendor/kreuzberg/tests/pdf_hierarchy_quality.rs +589 -0
  340. data/vendor/kreuzberg/tests/pdf_integration.rs +45 -43
  341. data/vendor/kreuzberg/tests/pdf_ocr_triggering.rs +301 -0
  342. data/vendor/kreuzberg/tests/pdf_text_merging.rs +475 -0
  343. data/vendor/kreuzberg/tests/pdfium_linking.rs +340 -0
  344. data/vendor/kreuzberg/tests/pipeline_integration.rs +1446 -1411
  345. data/vendor/kreuzberg/tests/plugin_ocr_backend_test.rs +776 -771
  346. data/vendor/kreuzberg/tests/plugin_postprocessor_test.rs +577 -560
  347. data/vendor/kreuzberg/tests/plugin_system.rs +927 -921
  348. data/vendor/kreuzberg/tests/plugin_validator_test.rs +783 -783
  349. data/vendor/kreuzberg/tests/registry_integration_tests.rs +587 -586
  350. data/vendor/kreuzberg/tests/rst_extractor_tests.rs +694 -692
  351. data/vendor/kreuzberg/tests/rtf_extractor_tests.rs +775 -776
  352. data/vendor/kreuzberg/tests/security_validation.rs +416 -415
  353. data/vendor/kreuzberg/tests/stopwords_integration_test.rs +888 -888
  354. data/vendor/kreuzberg/tests/test_fastembed.rs +631 -609
  355. data/vendor/kreuzberg/tests/typst_behavioral_tests.rs +1260 -1259
  356. data/vendor/kreuzberg/tests/typst_extractor_tests.rs +648 -647
  357. data/vendor/kreuzberg/tests/xlsx_metadata_extraction_test.rs +87 -87
  358. data/vendor/kreuzberg-ffi/Cargo.toml +67 -0
  359. data/vendor/kreuzberg-ffi/README.md +851 -0
  360. data/vendor/kreuzberg-ffi/benches/result_view_benchmark.rs +227 -0
  361. data/vendor/kreuzberg-ffi/build.rs +168 -0
  362. data/vendor/kreuzberg-ffi/cbindgen.toml +37 -0
  363. data/vendor/kreuzberg-ffi/kreuzberg-ffi.pc.in +12 -0
  364. data/vendor/kreuzberg-ffi/kreuzberg.h +3012 -0
  365. data/vendor/kreuzberg-ffi/src/batch_streaming.rs +588 -0
  366. data/vendor/kreuzberg-ffi/src/config.rs +1341 -0
  367. data/vendor/kreuzberg-ffi/src/error.rs +901 -0
  368. data/vendor/kreuzberg-ffi/src/extraction.rs +555 -0
  369. data/vendor/kreuzberg-ffi/src/helpers.rs +879 -0
  370. data/vendor/kreuzberg-ffi/src/lib.rs +977 -0
  371. data/vendor/kreuzberg-ffi/src/memory.rs +493 -0
  372. data/vendor/kreuzberg-ffi/src/mime.rs +329 -0
  373. data/vendor/kreuzberg-ffi/src/panic_shield.rs +265 -0
  374. data/vendor/kreuzberg-ffi/src/plugins/document_extractor.rs +442 -0
  375. data/vendor/kreuzberg-ffi/src/plugins/mod.rs +14 -0
  376. data/vendor/kreuzberg-ffi/src/plugins/ocr_backend.rs +628 -0
  377. data/vendor/kreuzberg-ffi/src/plugins/post_processor.rs +438 -0
  378. data/vendor/kreuzberg-ffi/src/plugins/validator.rs +329 -0
  379. data/vendor/kreuzberg-ffi/src/result.rs +510 -0
  380. data/vendor/kreuzberg-ffi/src/result_pool.rs +639 -0
  381. data/vendor/kreuzberg-ffi/src/result_view.rs +773 -0
  382. data/vendor/kreuzberg-ffi/src/string_intern.rs +568 -0
  383. data/vendor/kreuzberg-ffi/src/types.rs +363 -0
  384. data/vendor/kreuzberg-ffi/src/util.rs +210 -0
  385. data/vendor/kreuzberg-ffi/src/validation.rs +848 -0
  386. data/vendor/kreuzberg-ffi/tests.disabled/README.md +48 -0
  387. data/vendor/kreuzberg-ffi/tests.disabled/config_loading_tests.rs +299 -0
  388. data/vendor/kreuzberg-ffi/tests.disabled/config_tests.rs +346 -0
  389. data/vendor/kreuzberg-ffi/tests.disabled/extractor_tests.rs +232 -0
  390. data/vendor/kreuzberg-ffi/tests.disabled/plugin_registration_tests.rs +470 -0
  391. data/vendor/kreuzberg-tesseract/.commitlintrc.json +13 -0
  392. data/vendor/kreuzberg-tesseract/.crate-ignore +2 -0
  393. data/vendor/kreuzberg-tesseract/Cargo.lock +2933 -0
  394. data/vendor/kreuzberg-tesseract/Cargo.toml +57 -0
  395. data/vendor/{rb-sys/LICENSE-MIT → kreuzberg-tesseract/LICENSE} +22 -21
  396. data/vendor/kreuzberg-tesseract/README.md +399 -0
  397. data/vendor/kreuzberg-tesseract/build.rs +1127 -0
  398. data/vendor/kreuzberg-tesseract/patches/README.md +71 -0
  399. data/vendor/kreuzberg-tesseract/patches/tesseract.diff +199 -0
  400. data/vendor/kreuzberg-tesseract/src/api.rs +1371 -0
  401. data/vendor/kreuzberg-tesseract/src/choice_iterator.rs +77 -0
  402. data/vendor/kreuzberg-tesseract/src/enums.rs +297 -0
  403. data/vendor/kreuzberg-tesseract/src/error.rs +81 -0
  404. data/vendor/kreuzberg-tesseract/src/lib.rs +145 -0
  405. data/vendor/kreuzberg-tesseract/src/monitor.rs +57 -0
  406. data/vendor/kreuzberg-tesseract/src/mutable_iterator.rs +197 -0
  407. data/vendor/kreuzberg-tesseract/src/page_iterator.rs +253 -0
  408. data/vendor/kreuzberg-tesseract/src/result_iterator.rs +286 -0
  409. data/vendor/kreuzberg-tesseract/src/result_renderer.rs +183 -0
  410. data/vendor/kreuzberg-tesseract/tests/integration_test.rs +211 -0
  411. metadata +196 -45
  412. data/vendor/kreuzberg/benches/otel_overhead.rs +0 -48
  413. data/vendor/kreuzberg/src/extractors/fictionbook.rs.backup2 +0 -738
  414. data/vendor/rb-sys/.cargo-ok +0 -1
  415. data/vendor/rb-sys/.cargo_vcs_info.json +0 -6
  416. data/vendor/rb-sys/Cargo.lock +0 -393
  417. data/vendor/rb-sys/Cargo.toml +0 -70
  418. data/vendor/rb-sys/Cargo.toml.orig +0 -57
  419. data/vendor/rb-sys/LICENSE-APACHE +0 -190
  420. data/vendor/rb-sys/bin/release.sh +0 -21
  421. data/vendor/rb-sys/build/features.rs +0 -108
  422. data/vendor/rb-sys/build/main.rs +0 -246
  423. data/vendor/rb-sys/build/stable_api_config.rs +0 -153
  424. data/vendor/rb-sys/build/version.rs +0 -48
  425. data/vendor/rb-sys/readme.md +0 -36
  426. data/vendor/rb-sys/src/bindings.rs +0 -21
  427. data/vendor/rb-sys/src/hidden.rs +0 -11
  428. data/vendor/rb-sys/src/lib.rs +0 -34
  429. data/vendor/rb-sys/src/macros.rs +0 -371
  430. data/vendor/rb-sys/src/memory.rs +0 -53
  431. data/vendor/rb-sys/src/ruby_abi_version.rs +0 -38
  432. data/vendor/rb-sys/src/special_consts.rs +0 -31
  433. data/vendor/rb-sys/src/stable_api/compiled.c +0 -179
  434. data/vendor/rb-sys/src/stable_api/compiled.rs +0 -257
  435. data/vendor/rb-sys/src/stable_api/ruby_2_6.rs +0 -316
  436. data/vendor/rb-sys/src/stable_api/ruby_2_7.rs +0 -316
  437. data/vendor/rb-sys/src/stable_api/ruby_3_0.rs +0 -324
  438. data/vendor/rb-sys/src/stable_api/ruby_3_1.rs +0 -317
  439. data/vendor/rb-sys/src/stable_api/ruby_3_2.rs +0 -315
  440. data/vendor/rb-sys/src/stable_api/ruby_3_3.rs +0 -326
  441. data/vendor/rb-sys/src/stable_api/ruby_3_4.rs +0 -327
  442. data/vendor/rb-sys/src/stable_api.rs +0 -261
  443. data/vendor/rb-sys/src/symbol.rs +0 -31
  444. data/vendor/rb-sys/src/tracking_allocator.rs +0 -332
  445. data/vendor/rb-sys/src/utils.rs +0 -89
  446. data/vendor/rb-sys/src/value_type.rs +0 -7
@@ -1,484 +1,484 @@
1
- //! Security utilities for document extractors.
2
- //!
3
- //! This module provides validation and protection mechanisms against common attacks:
4
- //! - ZIP bomb detection (decompression bombs)
5
- //! - XML entity expansion limits
6
- //! - Nesting depth limits
7
- //! - Input size limits
8
- //! - Entity length validation
9
-
10
- #[cfg(feature = "archives")]
11
- use std::io::{Read, Seek};
12
-
13
- /// Configuration for security limits across extractors.
14
- ///
15
- /// All limits are intentionally conservative to prevent DoS attacks
16
- /// while still supporting legitimate documents.
17
- #[derive(Clone, Debug)]
18
- pub struct SecurityLimits {
19
- /// Maximum uncompressed size for archives (500 MB)
20
- pub max_archive_size: usize,
21
-
22
- /// Maximum compression ratio before flagging as potential bomb (100:1)
23
- pub max_compression_ratio: usize,
24
-
25
- /// Maximum number of files in archive (10,000)
26
- pub max_files_in_archive: usize,
27
-
28
- /// Maximum nesting depth for structures (100)
29
- pub max_nesting_depth: usize,
30
-
31
- /// Maximum entity/string length (32)
32
- pub max_entity_length: usize,
33
-
34
- /// Maximum string growth per document (100 MB)
35
- pub max_content_size: usize,
36
-
37
- /// Maximum iterations per operation
38
- pub max_iterations: usize,
39
-
40
- /// Maximum XML depth (100 levels)
41
- pub max_xml_depth: usize,
42
-
43
- /// Maximum cells per table (100,000)
44
- pub max_table_cells: usize,
45
- }
46
-
47
- impl Default for SecurityLimits {
48
- fn default() -> Self {
49
- Self {
50
- max_archive_size: 500 * 1024 * 1024,
51
- max_compression_ratio: 100,
52
- max_files_in_archive: 10_000,
53
- max_nesting_depth: 100,
54
- max_entity_length: 32,
55
- max_content_size: 100 * 1024 * 1024,
56
- max_iterations: 10_000_000,
57
- max_xml_depth: 100,
58
- max_table_cells: 100_000,
59
- }
60
- }
61
- }
62
-
63
- /// Security validation errors.
64
- #[derive(Debug, Clone)]
65
- pub enum SecurityError {
66
- /// Potential ZIP bomb detected
67
- ZipBombDetected {
68
- compressed_size: u64,
69
- uncompressed_size: u64,
70
- ratio: f64,
71
- },
72
-
73
- /// Archive exceeds maximum size
74
- ArchiveTooLarge { size: u64, max: usize },
75
-
76
- /// Archive contains too many files
77
- TooManyFiles { count: usize, max: usize },
78
-
79
- /// Nesting too deep
80
- NestingTooDeep { depth: usize, max: usize },
81
-
82
- /// Content exceeds maximum size
83
- ContentTooLarge { size: usize, max: usize },
84
-
85
- /// Entity/string too long
86
- EntityTooLong { length: usize, max: usize },
87
-
88
- /// Too many iterations
89
- TooManyIterations { count: usize, max: usize },
90
-
91
- /// XML depth exceeded
92
- XmlDepthExceeded { depth: usize, max: usize },
93
-
94
- /// Too many table cells
95
- TooManyCells { cells: usize, max: usize },
96
- }
97
-
98
- impl std::fmt::Display for SecurityError {
99
- fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
100
- match self {
101
- SecurityError::ZipBombDetected {
102
- compressed_size,
103
- uncompressed_size,
104
- ratio,
105
- } => {
106
- write!(
107
- f,
108
- "Potential ZIP bomb detected: compressed {}B -> uncompressed {}B (ratio: {:.1}:1)",
109
- compressed_size, uncompressed_size, ratio
110
- )
111
- }
112
- SecurityError::ArchiveTooLarge { size, max } => {
113
- write!(f, "Archive too large: {} bytes (max: {} bytes)", size, max)
114
- }
115
- SecurityError::TooManyFiles { count, max } => {
116
- write!(f, "Archive has too many files: {} (max: {})", count, max)
117
- }
118
- SecurityError::NestingTooDeep { depth, max } => {
119
- write!(f, "Nesting too deep: {} levels (max: {})", depth, max)
120
- }
121
- SecurityError::ContentTooLarge { size, max } => {
122
- write!(f, "Content too large: {} bytes (max: {} bytes)", size, max)
123
- }
124
- SecurityError::EntityTooLong { length, max } => {
125
- write!(f, "Entity too long: {} chars (max: {})", length, max)
126
- }
127
- SecurityError::TooManyIterations { count, max } => {
128
- write!(f, "Too many iterations: {} (max: {})", count, max)
129
- }
130
- SecurityError::XmlDepthExceeded { depth, max } => {
131
- write!(f, "XML depth exceeded: {} (max: {})", depth, max)
132
- }
133
- SecurityError::TooManyCells { cells, max } => {
134
- write!(f, "Too many table cells: {} (max: {})", cells, max)
135
- }
136
- }
137
- }
138
- }
139
-
140
- impl std::error::Error for SecurityError {}
141
-
142
- /// Helper struct for validating ZIP archives for security issues.
143
- #[cfg(feature = "archives")]
144
- pub struct ZipBombValidator {
145
- limits: SecurityLimits,
146
- }
147
-
148
- #[cfg(feature = "archives")]
149
- impl ZipBombValidator {
150
- /// Create a new ZIP bomb validator.
151
- pub fn new(limits: SecurityLimits) -> Self {
152
- Self { limits }
153
- }
154
-
155
- /// Validate a ZIP archive for security issues.
156
- ///
157
- /// # Arguments
158
- /// * `archive` - Mutable ZIP archive to validate
159
- ///
160
- /// # Returns
161
- /// * `Ok(())` if archive is safe
162
- /// * `Err(SecurityError)` if security limit violated
163
- pub fn validate<R: Read + Seek>(&self, archive: &mut zip::ZipArchive<R>) -> Result<(), SecurityError> {
164
- let file_count = archive.len();
165
-
166
- if file_count > self.limits.max_files_in_archive {
167
- return Err(SecurityError::TooManyFiles {
168
- count: file_count,
169
- max: self.limits.max_files_in_archive,
170
- });
171
- }
172
-
173
- let mut total_uncompressed: u64 = 0;
174
- let mut total_compressed: u64 = 0;
175
-
176
- for i in 0..file_count {
177
- if let Ok(file) = archive.by_index(i) {
178
- let compressed_size = file.compressed_size();
179
- let uncompressed_size = file.size();
180
-
181
- total_uncompressed += uncompressed_size;
182
- total_compressed += compressed_size;
183
-
184
- if compressed_size > 0 && uncompressed_size > 0 {
185
- let ratio = uncompressed_size as f64 / compressed_size as f64;
186
- if ratio > self.limits.max_compression_ratio as f64 {
187
- return Err(SecurityError::ZipBombDetected {
188
- compressed_size,
189
- uncompressed_size,
190
- ratio,
191
- });
192
- }
193
- }
194
- }
195
- }
196
-
197
- if total_uncompressed > self.limits.max_archive_size as u64 {
198
- return Err(SecurityError::ArchiveTooLarge {
199
- size: total_uncompressed,
200
- max: self.limits.max_archive_size,
201
- });
202
- }
203
-
204
- if total_compressed > 0 {
205
- let ratio = total_uncompressed as f64 / total_compressed as f64;
206
- if ratio > self.limits.max_compression_ratio as f64 {
207
- return Err(SecurityError::ZipBombDetected {
208
- compressed_size: total_compressed,
209
- uncompressed_size: total_uncompressed,
210
- ratio,
211
- });
212
- }
213
- }
214
-
215
- Ok(())
216
- }
217
- }
218
-
219
- /// Helper struct for tracking and validating string growth.
220
- pub struct StringGrowthValidator {
221
- max_size: usize,
222
- current_size: usize,
223
- }
224
-
225
- impl StringGrowthValidator {
226
- /// Create a new string growth validator.
227
- pub fn new(max_size: usize) -> Self {
228
- Self {
229
- max_size,
230
- current_size: 0,
231
- }
232
- }
233
-
234
- /// Validate and update size after appending.
235
- ///
236
- /// # Returns
237
- /// * `Ok(())` if size is within limits
238
- /// * `Err(SecurityError)` if size exceeds limit
239
- pub fn check_append(&mut self, len: usize) -> Result<(), SecurityError> {
240
- self.current_size = self.current_size.saturating_add(len);
241
- if self.current_size > self.max_size {
242
- Err(SecurityError::ContentTooLarge {
243
- size: self.current_size,
244
- max: self.max_size,
245
- })
246
- } else {
247
- Ok(())
248
- }
249
- }
250
-
251
- /// Get current size.
252
- pub fn current_size(&self) -> usize {
253
- self.current_size
254
- }
255
- }
256
-
257
- /// Helper struct for validating iteration counts.
258
- pub struct IterationValidator {
259
- max_iterations: usize,
260
- current_count: usize,
261
- }
262
-
263
- impl IterationValidator {
264
- /// Create a new iteration validator.
265
- pub fn new(max_iterations: usize) -> Self {
266
- Self {
267
- max_iterations,
268
- current_count: 0,
269
- }
270
- }
271
-
272
- /// Validate and increment iteration count.
273
- ///
274
- /// # Returns
275
- /// * `Ok(())` if count is within limits
276
- /// * `Err(SecurityError)` if count exceeds limit
277
- pub fn check_iteration(&mut self) -> Result<(), SecurityError> {
278
- self.current_count += 1;
279
- if self.current_count > self.max_iterations {
280
- Err(SecurityError::TooManyIterations {
281
- count: self.current_count,
282
- max: self.max_iterations,
283
- })
284
- } else {
285
- Ok(())
286
- }
287
- }
288
-
289
- /// Get current iteration count.
290
- pub fn current_count(&self) -> usize {
291
- self.current_count
292
- }
293
- }
294
-
295
- /// Helper struct for validating nesting depth.
296
- pub struct DepthValidator {
297
- max_depth: usize,
298
- current_depth: usize,
299
- }
300
-
301
- impl DepthValidator {
302
- /// Create a new depth validator.
303
- pub fn new(max_depth: usize) -> Self {
304
- Self {
305
- max_depth,
306
- current_depth: 0,
307
- }
308
- }
309
-
310
- /// Push a level (increase depth).
311
- ///
312
- /// # Returns
313
- /// * `Ok(())` if depth is within limits
314
- /// * `Err(SecurityError)` if depth exceeds limit
315
- pub fn push(&mut self) -> Result<(), SecurityError> {
316
- self.current_depth += 1;
317
- if self.current_depth > self.max_depth {
318
- Err(SecurityError::NestingTooDeep {
319
- depth: self.current_depth,
320
- max: self.max_depth,
321
- })
322
- } else {
323
- Ok(())
324
- }
325
- }
326
-
327
- /// Pop a level (decrease depth).
328
- pub fn pop(&mut self) {
329
- if self.current_depth > 0 {
330
- self.current_depth -= 1;
331
- }
332
- }
333
-
334
- /// Get current depth.
335
- pub fn current_depth(&self) -> usize {
336
- self.current_depth
337
- }
338
- }
339
-
340
- /// Helper struct for validating entity/string length.
341
- pub struct EntityValidator {
342
- max_length: usize,
343
- }
344
-
345
- impl EntityValidator {
346
- /// Create a new entity validator.
347
- pub fn new(max_length: usize) -> Self {
348
- Self { max_length }
349
- }
350
-
351
- /// Validate entity length.
352
- ///
353
- /// # Returns
354
- /// * `Ok(())` if length is within limits
355
- /// * `Err(SecurityError)` if length exceeds limit
356
- pub fn validate(&self, content: &str) -> Result<(), SecurityError> {
357
- if content.len() > self.max_length {
358
- Err(SecurityError::EntityTooLong {
359
- length: content.len(),
360
- max: self.max_length,
361
- })
362
- } else {
363
- Ok(())
364
- }
365
- }
366
- }
367
-
368
- /// Helper struct for validating table cell counts.
369
- pub struct TableValidator {
370
- max_cells: usize,
371
- current_cells: usize,
372
- }
373
-
374
- impl TableValidator {
375
- /// Create a new table validator.
376
- pub fn new(max_cells: usize) -> Self {
377
- Self {
378
- max_cells,
379
- current_cells: 0,
380
- }
381
- }
382
-
383
- /// Add cells to table and validate.
384
- ///
385
- /// # Returns
386
- /// * `Ok(())` if cell count is within limits
387
- /// * `Err(SecurityError)` if cell count exceeds limit
388
- pub fn add_cells(&mut self, count: usize) -> Result<(), SecurityError> {
389
- self.current_cells = self.current_cells.saturating_add(count);
390
- if self.current_cells > self.max_cells {
391
- Err(SecurityError::TooManyCells {
392
- cells: self.current_cells,
393
- max: self.max_cells,
394
- })
395
- } else {
396
- Ok(())
397
- }
398
- }
399
-
400
- /// Get current cell count.
401
- pub fn current_cells(&self) -> usize {
402
- self.current_cells
403
- }
404
- }
405
-
406
- #[cfg(test)]
407
- mod tests {
408
- use super::*;
409
-
410
- #[test]
411
- fn test_depth_validator() {
412
- let mut validator = DepthValidator::new(3);
413
-
414
- assert!(validator.push().is_ok());
415
- assert_eq!(validator.current_depth(), 1);
416
-
417
- assert!(validator.push().is_ok());
418
- assert_eq!(validator.current_depth(), 2);
419
-
420
- assert!(validator.push().is_ok());
421
- assert_eq!(validator.current_depth(), 3);
422
-
423
- assert!(validator.push().is_err());
424
- assert_eq!(validator.current_depth(), 4);
425
-
426
- validator.pop();
427
- assert_eq!(validator.current_depth(), 3);
428
- }
429
-
430
- #[test]
431
- fn test_entity_validator() {
432
- let validator = EntityValidator::new(10);
433
-
434
- assert!(validator.validate("short").is_ok());
435
-
436
- assert!(validator.validate("0123456789").is_ok());
437
-
438
- assert!(validator.validate("01234567890").is_err());
439
- }
440
-
441
- #[test]
442
- fn test_string_growth_validator() {
443
- let mut validator = StringGrowthValidator::new(100);
444
-
445
- assert!(validator.check_append(50).is_ok());
446
- assert_eq!(validator.current_size(), 50);
447
-
448
- assert!(validator.check_append(50).is_ok());
449
- assert_eq!(validator.current_size(), 100);
450
-
451
- assert!(validator.check_append(1).is_err());
452
- }
453
-
454
- #[test]
455
- fn test_iteration_validator() {
456
- let mut validator = IterationValidator::new(3);
457
-
458
- assert!(validator.check_iteration().is_ok());
459
- assert!(validator.check_iteration().is_ok());
460
- assert!(validator.check_iteration().is_ok());
461
- assert!(validator.check_iteration().is_err());
462
- }
463
-
464
- #[test]
465
- fn test_table_validator() {
466
- let mut validator = TableValidator::new(10);
467
-
468
- assert!(validator.add_cells(5).is_ok());
469
- assert_eq!(validator.current_cells(), 5);
470
-
471
- assert!(validator.add_cells(5).is_ok());
472
- assert_eq!(validator.current_cells(), 10);
473
-
474
- assert!(validator.add_cells(1).is_err());
475
- }
476
-
477
- #[test]
478
- fn test_default_limits() {
479
- let limits = SecurityLimits::default();
480
- assert_eq!(limits.max_archive_size, 500 * 1024 * 1024);
481
- assert_eq!(limits.max_nesting_depth, 100);
482
- assert_eq!(limits.max_entity_length, 32);
483
- }
484
- }
1
+ //! Security utilities for document extractors.
2
+ //!
3
+ //! This module provides validation and protection mechanisms against common attacks:
4
+ //! - ZIP bomb detection (decompression bombs)
5
+ //! - XML entity expansion limits
6
+ //! - Nesting depth limits
7
+ //! - Input size limits
8
+ //! - Entity length validation
9
+
10
+ #[cfg(feature = "archives")]
11
+ use std::io::{Read, Seek};
12
+
13
+ /// Configuration for security limits across extractors.
14
+ ///
15
+ /// All limits are intentionally conservative to prevent DoS attacks
16
+ /// while still supporting legitimate documents.
17
+ #[derive(Clone, Debug)]
18
+ pub struct SecurityLimits {
19
+ /// Maximum uncompressed size for archives (500 MB)
20
+ pub max_archive_size: usize,
21
+
22
+ /// Maximum compression ratio before flagging as potential bomb (100:1)
23
+ pub max_compression_ratio: usize,
24
+
25
+ /// Maximum number of files in archive (10,000)
26
+ pub max_files_in_archive: usize,
27
+
28
+ /// Maximum nesting depth for structures (100)
29
+ pub max_nesting_depth: usize,
30
+
31
+ /// Maximum entity/string length (32)
32
+ pub max_entity_length: usize,
33
+
34
+ /// Maximum string growth per document (100 MB)
35
+ pub max_content_size: usize,
36
+
37
+ /// Maximum iterations per operation
38
+ pub max_iterations: usize,
39
+
40
+ /// Maximum XML depth (100 levels)
41
+ pub max_xml_depth: usize,
42
+
43
+ /// Maximum cells per table (100,000)
44
+ pub max_table_cells: usize,
45
+ }
46
+
47
+ impl Default for SecurityLimits {
48
+ fn default() -> Self {
49
+ Self {
50
+ max_archive_size: 500 * 1024 * 1024,
51
+ max_compression_ratio: 100,
52
+ max_files_in_archive: 10_000,
53
+ max_nesting_depth: 100,
54
+ max_entity_length: 32,
55
+ max_content_size: 100 * 1024 * 1024,
56
+ max_iterations: 10_000_000,
57
+ max_xml_depth: 100,
58
+ max_table_cells: 100_000,
59
+ }
60
+ }
61
+ }
62
+
63
+ /// Security validation errors.
64
+ #[derive(Debug, Clone)]
65
+ pub enum SecurityError {
66
+ /// Potential ZIP bomb detected
67
+ ZipBombDetected {
68
+ compressed_size: u64,
69
+ uncompressed_size: u64,
70
+ ratio: f64,
71
+ },
72
+
73
+ /// Archive exceeds maximum size
74
+ ArchiveTooLarge { size: u64, max: usize },
75
+
76
+ /// Archive contains too many files
77
+ TooManyFiles { count: usize, max: usize },
78
+
79
+ /// Nesting too deep
80
+ NestingTooDeep { depth: usize, max: usize },
81
+
82
+ /// Content exceeds maximum size
83
+ ContentTooLarge { size: usize, max: usize },
84
+
85
+ /// Entity/string too long
86
+ EntityTooLong { length: usize, max: usize },
87
+
88
+ /// Too many iterations
89
+ TooManyIterations { count: usize, max: usize },
90
+
91
+ /// XML depth exceeded
92
+ XmlDepthExceeded { depth: usize, max: usize },
93
+
94
+ /// Too many table cells
95
+ TooManyCells { cells: usize, max: usize },
96
+ }
97
+
98
+ impl std::fmt::Display for SecurityError {
99
+ fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
100
+ match self {
101
+ SecurityError::ZipBombDetected {
102
+ compressed_size,
103
+ uncompressed_size,
104
+ ratio,
105
+ } => {
106
+ write!(
107
+ f,
108
+ "Potential ZIP bomb detected: compressed {}B -> uncompressed {}B (ratio: {:.1}:1)",
109
+ compressed_size, uncompressed_size, ratio
110
+ )
111
+ }
112
+ SecurityError::ArchiveTooLarge { size, max } => {
113
+ write!(f, "Archive too large: {} bytes (max: {} bytes)", size, max)
114
+ }
115
+ SecurityError::TooManyFiles { count, max } => {
116
+ write!(f, "Archive has too many files: {} (max: {})", count, max)
117
+ }
118
+ SecurityError::NestingTooDeep { depth, max } => {
119
+ write!(f, "Nesting too deep: {} levels (max: {})", depth, max)
120
+ }
121
+ SecurityError::ContentTooLarge { size, max } => {
122
+ write!(f, "Content too large: {} bytes (max: {} bytes)", size, max)
123
+ }
124
+ SecurityError::EntityTooLong { length, max } => {
125
+ write!(f, "Entity too long: {} chars (max: {})", length, max)
126
+ }
127
+ SecurityError::TooManyIterations { count, max } => {
128
+ write!(f, "Too many iterations: {} (max: {})", count, max)
129
+ }
130
+ SecurityError::XmlDepthExceeded { depth, max } => {
131
+ write!(f, "XML depth exceeded: {} (max: {})", depth, max)
132
+ }
133
+ SecurityError::TooManyCells { cells, max } => {
134
+ write!(f, "Too many table cells: {} (max: {})", cells, max)
135
+ }
136
+ }
137
+ }
138
+ }
139
+
140
+ impl std::error::Error for SecurityError {}
141
+
142
+ /// Helper struct for validating ZIP archives for security issues.
143
+ #[cfg(feature = "archives")]
144
+ pub struct ZipBombValidator {
145
+ limits: SecurityLimits,
146
+ }
147
+
148
+ #[cfg(feature = "archives")]
149
+ impl ZipBombValidator {
150
+ /// Create a new ZIP bomb validator.
151
+ pub fn new(limits: SecurityLimits) -> Self {
152
+ Self { limits }
153
+ }
154
+
155
+ /// Validate a ZIP archive for security issues.
156
+ ///
157
+ /// # Arguments
158
+ /// * `archive` - Mutable ZIP archive to validate
159
+ ///
160
+ /// # Returns
161
+ /// * `Ok(())` if archive is safe
162
+ /// * `Err(SecurityError)` if security limit violated
163
+ pub fn validate<R: Read + Seek>(&self, archive: &mut zip::ZipArchive<R>) -> Result<(), SecurityError> {
164
+ let file_count = archive.len();
165
+
166
+ if file_count > self.limits.max_files_in_archive {
167
+ return Err(SecurityError::TooManyFiles {
168
+ count: file_count,
169
+ max: self.limits.max_files_in_archive,
170
+ });
171
+ }
172
+
173
+ let mut total_uncompressed: u64 = 0;
174
+ let mut total_compressed: u64 = 0;
175
+
176
+ for i in 0..file_count {
177
+ if let Ok(file) = archive.by_index(i) {
178
+ let compressed_size = file.compressed_size();
179
+ let uncompressed_size = file.size();
180
+
181
+ total_uncompressed += uncompressed_size;
182
+ total_compressed += compressed_size;
183
+
184
+ if compressed_size > 0 && uncompressed_size > 0 {
185
+ let ratio = uncompressed_size as f64 / compressed_size as f64;
186
+ if ratio > self.limits.max_compression_ratio as f64 {
187
+ return Err(SecurityError::ZipBombDetected {
188
+ compressed_size,
189
+ uncompressed_size,
190
+ ratio,
191
+ });
192
+ }
193
+ }
194
+ }
195
+ }
196
+
197
+ if total_uncompressed > self.limits.max_archive_size as u64 {
198
+ return Err(SecurityError::ArchiveTooLarge {
199
+ size: total_uncompressed,
200
+ max: self.limits.max_archive_size,
201
+ });
202
+ }
203
+
204
+ if total_compressed > 0 {
205
+ let ratio = total_uncompressed as f64 / total_compressed as f64;
206
+ if ratio > self.limits.max_compression_ratio as f64 {
207
+ return Err(SecurityError::ZipBombDetected {
208
+ compressed_size: total_compressed,
209
+ uncompressed_size: total_uncompressed,
210
+ ratio,
211
+ });
212
+ }
213
+ }
214
+
215
+ Ok(())
216
+ }
217
+ }
218
+
219
+ /// Helper struct for tracking and validating string growth.
220
+ pub struct StringGrowthValidator {
221
+ max_size: usize,
222
+ current_size: usize,
223
+ }
224
+
225
+ impl StringGrowthValidator {
226
+ /// Create a new string growth validator.
227
+ pub fn new(max_size: usize) -> Self {
228
+ Self {
229
+ max_size,
230
+ current_size: 0,
231
+ }
232
+ }
233
+
234
+ /// Validate and update size after appending.
235
+ ///
236
+ /// # Returns
237
+ /// * `Ok(())` if size is within limits
238
+ /// * `Err(SecurityError)` if size exceeds limit
239
+ pub fn check_append(&mut self, len: usize) -> Result<(), SecurityError> {
240
+ self.current_size = self.current_size.saturating_add(len);
241
+ if self.current_size > self.max_size {
242
+ Err(SecurityError::ContentTooLarge {
243
+ size: self.current_size,
244
+ max: self.max_size,
245
+ })
246
+ } else {
247
+ Ok(())
248
+ }
249
+ }
250
+
251
+ /// Get current size.
252
+ pub fn current_size(&self) -> usize {
253
+ self.current_size
254
+ }
255
+ }
256
+
257
+ /// Helper struct for validating iteration counts.
258
+ pub struct IterationValidator {
259
+ max_iterations: usize,
260
+ current_count: usize,
261
+ }
262
+
263
+ impl IterationValidator {
264
+ /// Create a new iteration validator.
265
+ pub fn new(max_iterations: usize) -> Self {
266
+ Self {
267
+ max_iterations,
268
+ current_count: 0,
269
+ }
270
+ }
271
+
272
+ /// Validate and increment iteration count.
273
+ ///
274
+ /// # Returns
275
+ /// * `Ok(())` if count is within limits
276
+ /// * `Err(SecurityError)` if count exceeds limit
277
+ pub fn check_iteration(&mut self) -> Result<(), SecurityError> {
278
+ self.current_count += 1;
279
+ if self.current_count > self.max_iterations {
280
+ Err(SecurityError::TooManyIterations {
281
+ count: self.current_count,
282
+ max: self.max_iterations,
283
+ })
284
+ } else {
285
+ Ok(())
286
+ }
287
+ }
288
+
289
+ /// Get current iteration count.
290
+ pub fn current_count(&self) -> usize {
291
+ self.current_count
292
+ }
293
+ }
294
+
295
+ /// Helper struct for validating nesting depth.
296
+ pub struct DepthValidator {
297
+ max_depth: usize,
298
+ current_depth: usize,
299
+ }
300
+
301
+ impl DepthValidator {
302
+ /// Create a new depth validator.
303
+ pub fn new(max_depth: usize) -> Self {
304
+ Self {
305
+ max_depth,
306
+ current_depth: 0,
307
+ }
308
+ }
309
+
310
+ /// Push a level (increase depth).
311
+ ///
312
+ /// # Returns
313
+ /// * `Ok(())` if depth is within limits
314
+ /// * `Err(SecurityError)` if depth exceeds limit
315
+ pub fn push(&mut self) -> Result<(), SecurityError> {
316
+ self.current_depth += 1;
317
+ if self.current_depth > self.max_depth {
318
+ Err(SecurityError::NestingTooDeep {
319
+ depth: self.current_depth,
320
+ max: self.max_depth,
321
+ })
322
+ } else {
323
+ Ok(())
324
+ }
325
+ }
326
+
327
+ /// Pop a level (decrease depth).
328
+ pub fn pop(&mut self) {
329
+ if self.current_depth > 0 {
330
+ self.current_depth -= 1;
331
+ }
332
+ }
333
+
334
+ /// Get current depth.
335
+ pub fn current_depth(&self) -> usize {
336
+ self.current_depth
337
+ }
338
+ }
339
+
340
+ /// Helper struct for validating entity/string length.
341
+ pub struct EntityValidator {
342
+ max_length: usize,
343
+ }
344
+
345
+ impl EntityValidator {
346
+ /// Create a new entity validator.
347
+ pub fn new(max_length: usize) -> Self {
348
+ Self { max_length }
349
+ }
350
+
351
+ /// Validate entity length.
352
+ ///
353
+ /// # Returns
354
+ /// * `Ok(())` if length is within limits
355
+ /// * `Err(SecurityError)` if length exceeds limit
356
+ pub fn validate(&self, content: &str) -> Result<(), SecurityError> {
357
+ if content.len() > self.max_length {
358
+ Err(SecurityError::EntityTooLong {
359
+ length: content.len(),
360
+ max: self.max_length,
361
+ })
362
+ } else {
363
+ Ok(())
364
+ }
365
+ }
366
+ }
367
+
368
+ /// Helper struct for validating table cell counts.
369
+ pub struct TableValidator {
370
+ max_cells: usize,
371
+ current_cells: usize,
372
+ }
373
+
374
+ impl TableValidator {
375
+ /// Create a new table validator.
376
+ pub fn new(max_cells: usize) -> Self {
377
+ Self {
378
+ max_cells,
379
+ current_cells: 0,
380
+ }
381
+ }
382
+
383
+ /// Add cells to table and validate.
384
+ ///
385
+ /// # Returns
386
+ /// * `Ok(())` if cell count is within limits
387
+ /// * `Err(SecurityError)` if cell count exceeds limit
388
+ pub fn add_cells(&mut self, count: usize) -> Result<(), SecurityError> {
389
+ self.current_cells = self.current_cells.saturating_add(count);
390
+ if self.current_cells > self.max_cells {
391
+ Err(SecurityError::TooManyCells {
392
+ cells: self.current_cells,
393
+ max: self.max_cells,
394
+ })
395
+ } else {
396
+ Ok(())
397
+ }
398
+ }
399
+
400
+ /// Get current cell count.
401
+ pub fn current_cells(&self) -> usize {
402
+ self.current_cells
403
+ }
404
+ }
405
+
406
+ #[cfg(test)]
407
+ mod tests {
408
+ use super::*;
409
+
410
+ #[test]
411
+ fn test_depth_validator() {
412
+ let mut validator = DepthValidator::new(3);
413
+
414
+ assert!(validator.push().is_ok());
415
+ assert_eq!(validator.current_depth(), 1);
416
+
417
+ assert!(validator.push().is_ok());
418
+ assert_eq!(validator.current_depth(), 2);
419
+
420
+ assert!(validator.push().is_ok());
421
+ assert_eq!(validator.current_depth(), 3);
422
+
423
+ assert!(validator.push().is_err());
424
+ assert_eq!(validator.current_depth(), 4);
425
+
426
+ validator.pop();
427
+ assert_eq!(validator.current_depth(), 3);
428
+ }
429
+
430
+ #[test]
431
+ fn test_entity_validator() {
432
+ let validator = EntityValidator::new(10);
433
+
434
+ assert!(validator.validate("short").is_ok());
435
+
436
+ assert!(validator.validate("0123456789").is_ok());
437
+
438
+ assert!(validator.validate("01234567890").is_err());
439
+ }
440
+
441
+ #[test]
442
+ fn test_string_growth_validator() {
443
+ let mut validator = StringGrowthValidator::new(100);
444
+
445
+ assert!(validator.check_append(50).is_ok());
446
+ assert_eq!(validator.current_size(), 50);
447
+
448
+ assert!(validator.check_append(50).is_ok());
449
+ assert_eq!(validator.current_size(), 100);
450
+
451
+ assert!(validator.check_append(1).is_err());
452
+ }
453
+
454
+ #[test]
455
+ fn test_iteration_validator() {
456
+ let mut validator = IterationValidator::new(3);
457
+
458
+ assert!(validator.check_iteration().is_ok());
459
+ assert!(validator.check_iteration().is_ok());
460
+ assert!(validator.check_iteration().is_ok());
461
+ assert!(validator.check_iteration().is_err());
462
+ }
463
+
464
+ #[test]
465
+ fn test_table_validator() {
466
+ let mut validator = TableValidator::new(10);
467
+
468
+ assert!(validator.add_cells(5).is_ok());
469
+ assert_eq!(validator.current_cells(), 5);
470
+
471
+ assert!(validator.add_cells(5).is_ok());
472
+ assert_eq!(validator.current_cells(), 10);
473
+
474
+ assert!(validator.add_cells(1).is_err());
475
+ }
476
+
477
+ #[test]
478
+ fn test_default_limits() {
479
+ let limits = SecurityLimits::default();
480
+ assert_eq!(limits.max_archive_size, 500 * 1024 * 1024);
481
+ assert_eq!(limits.max_nesting_depth, 100);
482
+ assert_eq!(limits.max_entity_length, 32);
483
+ }
484
+ }