Repository Public
1// ORIX Docs2// File: Packages/ORIXDocsKit/Tests/DocDOCXTests/SecurityTests.swift3// Description: Hostile input: decompression bombs, path traversal, DTDs and external entities, deep nesting, macros, OLE,4// external relationships, malformed and truncated packages. Nothing may crash, hang, or reach outside the package.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import Foundation9import Testing10import DocModel11import DocContainer12@testable import DocDOCX1314/// A ZIP writer without any validation, to produce archives the real writer refuses to create.15func rawZip(_ entries: [(name: String, data: Data)]) -> Data {16 var body = Data(), central = Data()17 func le16(_ v: Int) -> [UInt8] { [UInt8(v & 0xFF), UInt8((v >> 8) & 0xFF)] }18 func le32(_ v: UInt32) -> [UInt8] { [UInt8(v & 0xFF), UInt8((v >> 8) & 0xFF), UInt8((v >> 16) & 0xFF), UInt8(v >> 24)] }19 for e in entries {20 let name = Array(e.name.utf8)21 let crc = CRC32.checksum(e.data)22 let offset = UInt32(body.count)23 var common: [UInt8] = le16(20) + le16(0x0800) + le16(0) + le16(0) + le16(0x5C21)24 common += le32(crc) + le32(UInt32(e.data.count)) + le32(UInt32(e.data.count)) + le16(name.count) + le16(0)25 body.append(contentsOf: le32(0x04034B50) + common + name)26 body.append(e.data)27 central.append(contentsOf: le32(0x02014B50) + le16(20) + common + le16(0) + le16(0) + le16(0) + le32(0) + le32(offset) + name)28 }29 var out = body30 let cdOffset = UInt32(body.count)31 out.append(central)32 out.append(contentsOf: le32(0x06054B50) + le16(0) + le16(0) + le16(entries.count) + le16(entries.count) + le32(UInt32(central.count)) + le32(cdOffset) + le16(0))33 return out34}3536@Suite("DOCX import — hostile input")37struct SecurityTests {38 func expectFormatError(_ data: Data, limits: ZipLimits = .standard, _ check: (FormatError) -> Bool = { _ in true }, sourceLocation: SourceLocation = #_sourceLocation) {39 do {40 _ = try DocxImporter.importDocument(data, limits: limits)41 Issue.record("the import should have been refused", sourceLocation: sourceLocation)42 } catch let e as FormatError {43 #expect(check(e), "unexpected error \(e)", sourceLocation: sourceLocation)44 } catch {45 Issue.record("unexpected error type \(error)", sourceLocation: sourceLocation)46 }47 }4849 @Test func notAnArchive() {50 expectFormatError(Data("this is not a zip file at all, just text".utf8)) { if case .unreadable = $0 { return true } else { return false } }51 expectFormatError(Data())52 expectFormatError(Data(repeating: 0x50, count: 4096))53 }5455 @Test func archiveWithoutDocument() throws {56 var zip = ZipWriter()57 try zip.add("hello.txt", text: "hi")58 expectFormatError(zip.finalize())59 // Content types present but no main part.60 var zip2 = ZipWriter()61 try zip2.add("[Content_Types].xml", text: Pkg.head + "<Types xmlns=\"http://schemas.openxmlformats.org/package/2006/content-types\"/>")62 expectFormatError(zip2.finalize())63 // The main part is some other XML vocabulary.64 expectFormatError(try Pkg.make(body: "", parts: ["word/document.xml": Pkg.head + "<html><body/></html>"]))65 }6667 @Test func decompressionBombIsRefused() throws {68 // 24 MB of zeros deflate to a few kilobytes: ratio far above the limit.69 let bomb = Data(count: 24 * 1024 * 1024)70 let data = try Pkg.make(body: Pkg.p("x"), binary: ["word/media/bomb.png": bomb])71 #expect(data.count < 200_000)72 expectFormatError(data) { if case .tooLarge = $0 { return true } else { return false } }73 // Entry and total size limits are enforced from the caller's limits.74 var small = ZipLimits()75 small.maxEntrySize = 100076 expectFormatError(try Pkg.make(body: String(repeating: Pkg.p("filler text"), count: 200)), limits: small) { if case .tooLarge = $0 { return true } else { return false } }77 var few = ZipLimits()78 few.maxEntries = 279 expectFormatError(try Pkg.make(body: Pkg.p("x")), limits: few) { if case .tooLarge = $0 { return true } else { return false } }80 }8182 @Test func pathTraversalEntryNamesAreRefused() throws {83 let good = try ZipReader(data: try Pkg.make(body: Pkg.p("x")))84 var entries: [(String, Data)] = try good.names.map { ($0, try good.data(for: $0)!) }85 for evil in ["../../evil.txt", "/etc/passwd", "word/../../escape.xml", "C:\\evil.txt", "word\\evil.xml"] {86 entries.append((evil, Data("x".utf8)))87 expectFormatError(rawZip(entries)) { if case .unreadable = $0 { return true } else { return false } }88 entries.removeLast()89 }90 // The unmodified raw archive is fine: the refusals above are due to the names only.91 #expect(try DocxImporter.importDocument(rawZip(entries)).document.bodyLines == ["x"])92 }9394 @Test func relationshipTargetsCannotLeaveThePackage() throws {95 let data = try Pkg.make(body: Pkg.p("Body text"), documentRels: [("rId1", "styles", "../../../../etc/passwd", false), ("rId2", "numbering", "/../../secret.xml", false),96 ("rId3", "footnotes", "file:///etc/passwd", false), ("rId4", "settings", "..\\..\\x.xml", false)])97 let r = try DocxImporter.importDocument(data)98 #expect(r.document.bodyLines == ["Body text"])99 #expect(r.warnings.contains { $0.feature == "Unsafe relationship" && $0.severity == .dropped })100 #expect(OPC.resolve(target: "../../x", from: "word/document.xml") == nil)101 #expect(OPC.resolve(target: "%2e%2e/%2e%2e/x", from: "word/document.xml") == nil)102 #expect(OPC.resolve(target: "http://example.org/x", from: "word/document.xml") == nil)103 #expect(OPC.resolve(target: "../customXml/item1.xml", from: "word/document.xml") == "customXml/item1.xml")104 #expect(OPC.resolve(target: "media/image1.png", from: "word/document.xml") == "word/media/image1.png")105 #expect(OPC.resolve(target: "/word/styles.xml", from: "word/document.xml") == "word/styles.xml")106 }107108 @Test func doctypeAndEntitiesAreRefused() throws {109 let xxe = "<?xml version=\"1.0\"?><!DOCTYPE w:document [<!ENTITY xxe SYSTEM \"file:///etc/passwd\">]><w:document \(Pkg.ns)><w:body><w:p><w:r><w:t>&xxe;</w:t></w:r></w:p></w:body></w:document>"110 expectFormatError(try Pkg.make(body: "", parts: ["word/document.xml": xxe])) { if case .unreadable(let why) = $0 { return why.contains("document type") } else { return false } }111 let laughs = "<?xml version=\"1.0\"?><!DOCTYPE lolz [<!ENTITY lol \"lol\"><!ENTITY lol2 \"&lol;&lol;&lol;&lol;&lol;&lol;&lol;&lol;&lol;&lol;\"><!ENTITY lol3 \"&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;\">]><w:document \(Pkg.ns)><w:body><w:p><w:r><w:t>&lol3;</w:t></w:r></w:p></w:body></w:document>"112 expectFormatError(try Pkg.make(body: "", parts: ["word/document.xml": laughs]))113 // The same in a secondary part (styles) and in UTF-16.114 let styles = "<?xml version=\"1.0\"?><!DOCTYPE s [<!ENTITY e SYSTEM \"http://example.org/evil.dtd\">]><w:styles \(Hand.w)/>"115 expectFormatError(try Pkg.make(body: Pkg.p("x"), parts: ["word/styles.xml": styles], documentRels: [("rId1", "styles", "styles.xml", false)]))116 var utf16 = Data([0xFF, 0xFE])117 utf16.append(xxe.data(using: .utf16LittleEndian)!)118 expectFormatError(try Pkg.make(body: "", binary: ["word/document.xml": utf16]))119 // Undefined entities are simply malformed XML.120 expectFormatError(try Pkg.make(body: "<w:p><w:r><w:t>&undefined;</w:t></w:r></w:p>"))121 }122123 @Test func hugeNestingIsRefusedNotOverflowed() throws {124 let depth = 20_000125 let body = String(repeating: "<w:smartTag>", count: depth) + Pkg.p("deep") + String(repeating: "</w:smartTag>", count: depth)126 expectFormatError(try Pkg.make(body: body)) { if case .tooLarge = $0 { return true } else { return false } }127 // Nesting below the cap is imported.128 let ok = String(repeating: "<w:smartTag>", count: 100) + Pkg.p("deep") + String(repeating: "</w:smartTag>", count: 100)129 #expect(try DocxImporter.importDocument(try Pkg.make(body: ok)).document.bodyLines == ["deep"])130 // Deeply nested tables are flattened without recursion problems.131 var nested = Pkg.p("core")132 for _ in 0..<40 { nested = "<w:tbl><w:tr><w:tc>\(nested)</w:tc></w:tr></w:tbl>" + Pkg.p("") }133 let r = try DocxImporter.importDocument(try Pkg.make(body: nested))134 #expect(r.document.tables.count == 1)135 #expect(r.document.bodyLines.contains("core"))136 }137138 @Test func macrosOleAndActiveXAreDroppedNeverPreserved() throws {139 let data = try Pkg.make(body: Pkg.p("Macro document text") + "<w:p><w:r><w:object><o:OLEObject Type=\"Embed\" ProgID=\"Package\" r:id=\"rId8\"/></w:object></w:r><w:r><w:control r:id=\"rId9\" w:name=\"Button1\"/></w:r></w:p>",140 parts: ["word/vbaData.xml": Pkg.head + "<x/>", "word/activeX/activeX1.xml": Pkg.head + "<x/>", "customUI/customUI.xml": Pkg.head + "<x/>"],141 binary: ["word/vbaProject.bin": Data([0xD0, 0xCF, 0x11, 0xE0, 0xA1, 0xB1, 0x1A, 0xE1] + Array(repeating: 7, count: 64)),142 "word/embeddings/oleObject1.bin": Data(repeating: 9, count: 64), "word/activeX/activeX1.bin": Data(repeating: 3, count: 16)],143 documentRels: [("rId7", "http://schemas.microsoft.com/office/2006/relationships/vbaProject", "vbaProject.bin", false),144 ("rId8", "oleObject", "embeddings/oleObject1.bin", false), ("rId9", "control", "activeX/activeX1.xml", false)],145 mainType: "application/vnd.ms-word.document.macroEnabled.main+xml")146 let r = try DocxImporter.importDocument(data)147 #expect(r.document.bodyLines.first == "Macro document text")148 #expect(r.warnings.contains { $0.feature == "VBA macros" && $0.severity == .dropped })149 #expect(r.warnings.contains { $0.feature == "Embedded objects" && $0.severity == .dropped })150 #expect(r.warnings.contains { $0.feature == "ActiveX controls" && $0.severity == .dropped })151 #expect(r.document.preservedParts.isEmpty)152 #expect(r.document.assets.isEmpty)153 // Nothing of it comes back out, and the result is an ordinary (not macro-enabled) document.154 let out = try DocxExporter.export(r.document)155 let names = try ZipReader(data: out.data).names156 #expect(!names.contains { $0.lowercased().contains("vba") || $0.hasSuffix(".bin") || $0.contains("activeX") || $0.contains("embeddings") || $0.contains("customUI") })157 let types = try #require(try unpack(out.data)["[Content_Types].xml"])158 #expect(!types.contains("macroEnabled") && !types.contains("vba"))159 }160161 @Test func preservedPartsFromAnUntrustedModelAreRevalidatedOnExport() throws {162 var doc = testDocument([.paragraph(Paragraph("Text"))])163 doc.preservedParts = [164 "word/vbaProject.bin": Data(repeating: 1, count: 32),165 "word/embeddings/oleObject1.bin": Data(repeating: 1, count: 32),166 "word/theme/theme1.xml": Data("<!DOCTYPE a [<!ENTITY x SYSTEM \"file:///etc/passwd\">]><a:theme xmlns:a=\"http://schemas.openxmlformats.org/drawingml/2006/main\"/>".utf8),167 "docProps/app.xml": Data("<Properties xmlns=\"http://schemas.openxmlformats.org/officeDocument/2006/extended-properties\"><Application>X</Application></Properties>".utf8),168 "word/document.xml": Data("<evil/>".utf8),169 "customXml/item1.xml": Data("<data/>".utf8),170 "customXml/_rels/item1.xml.rels": Data("<Relationships xmlns=\"http://schemas.openxmlformats.org/package/2006/relationships\"><Relationship Id=\"rId1\" Type=\"x\" Target=\"http://example.org/evil\" TargetMode=\"External\"/></Relationships>".utf8),171 ]172 let out = try DocxExporter.export(doc)173 let names = Set(try ZipReader(data: out.data).names)174 #expect(names.contains("docProps/app.xml"))175 #expect(names.contains("customXml/item1.xml"))176 #expect(!names.contains("customXml/_rels/item1.xml.rels")) // external relationship: not written back177 #expect(!names.contains("word/vbaProject.bin") && !names.contains("word/embeddings/oleObject1.bin") && !names.contains("word/theme/theme1.xml"))178 #expect(out.warnings.contains { $0.feature == "Preserved parts" && $0.severity == .dropped })179 #expect(try DocxImporter.importDocument(out.data).document.bodyLines == ["Text"])180 }181182 @Test func externalTargetsAreKeptAsTextNeverFetched() throws {183 let body = "<w:p><w:hyperlink r:id=\"rId1\"><w:r><w:t>link</w:t></w:r></w:hyperlink><w:r><w:t> </w:t></w:r>\(Hand.drawing(anchor: false, rid: "rId2", link: true))</w:p>"184 + "<w:p>\(Hand.field("INCLUDEPICTURE \"http://127.0.0.1:9/never.png\" \\d", "picture placeholder"))\(Hand.field("INCLUDETEXT \"file:///etc/passwd\"", "included"))</w:p>"185 let settings = Pkg.head + "<w:settings \(Pkg.ns)><w:attachedTemplate r:id=\"rId1\"/></w:settings>"186 let data = try Pkg.make(body: body, parts: ["word/settings.xml": settings, "word/_rels/settings.xml.rels": Pkg.head + "<Relationships xmlns=\"http://schemas.openxmlformats.org/package/2006/relationships\"><Relationship Id=\"rId1\" Type=\"\(Hand.rel)attachedTemplate\" Target=\"file:///Volumes/evil/Normal.dotm\" TargetMode=\"External\"/></Relationships>"],187 documentRels: [("rId1", "hyperlink", "file:///etc/passwd", true), ("rId2", "image", "http://127.0.0.1:9/tracker.png", true), ("rId3", "settings", "settings.xml", false)])188 let started = Date()189 let r = try DocxImporter.importDocument(data)190 #expect(Date().timeIntervalSince(started) < 2)191 #expect(r.document.bodyParagraphs[0].runs.first?.props.link == "file:///etc/passwd") // a string, nothing more192 #expect(r.document.assets.isEmpty)193 #expect(r.warnings.contains { $0.feature == "Linked pictures" && $0.severity == .dropped })194 #expect(r.warnings.contains { $0.feature == "External links" && $0.severity == .dropped })195 #expect(r.warnings.contains { $0.feature == "Attached template" })196 #expect(r.document.bodyLines[1] == "picture placeholderincluded")197 // No content of the local file system leaked into the model.198 #expect(!r.document.bodyLines.joined().contains("root:"))199 }200201 @Test func absurdValuesDoNotCrash() throws {202 let body = """203 <w:p><w:pPr><w:ind w:left="99999999999999999999999" w:hanging="-1e400"/><w:spacing w:line="NaN" w:before="-5"/><w:numPr><w:ilvl w:val="4000000000"/><w:numId w:val="77"/></w:numPr><w:outlineLvl w:val="250"/></w:pPr>\204 <w:r><w:rPr><w:sz w:val="99999999999"/><w:color w:val="ZZZZZZ"/><w:highlight w:val="nope"/></w:rPr><w:t>odd</w:t></w:r><w:r><w:sym w:font="X" w:char="D800"/><w:sym w:char="ZZ"/></w:r>\205 <w:r><w:fldChar w:fldCharType="end"/></w:r><w:r><w:fldChar w:fldCharType="separate"/></w:r><w:commentRangeEnd w:id="5"/><w:bookmarkEnd w:id="9"/></w:p>\206 <w:tbl><w:tblGrid><w:gridCol w:w="-50"/></w:tblGrid><w:tr><w:tc><w:tcPr><w:gridSpan w:val="100000"/><w:vMerge w:val="weird"/></w:tcPr></w:tc><w:tc><w:tcPr><w:hMerge/></w:tcPr><w:p/></w:tc></w:tr><w:tr/></w:tbl>\207 <w:p><w:r><w:drawing><wp:inline><wp:extent cx="-1" cy="1e999"/><a:graphic><a:graphicData><pic:pic><pic:blipFill><a:blip r:embed="nope"/></pic:blipFill></pic:pic></a:graphicData></a:graphic></wp:inline></w:drawing></w:r></w:p>\208 <w:p><w:r><w:fldChar w:fldCharType="begin"/></w:r><w:r><w:instrText>PAGE</w:instrText></w:r></w:p><w:p><w:r><w:t>after unterminated field</w:t></w:r></w:p>\209 <w:sectPr><w:pgSz w:w="0" w:h="-3"/><w:pgMar w:top="-99999999999" w:left="1e309"/><w:cols w:num="99999"/></w:sectPr>210 """211 let r = try DocxImporter.importDocument(try Pkg.make(body: body))212 #expect(r.document.bodyLines.first?.hasPrefix("odd") == true)213 #expect(r.document.tables.count == 1)214 #expect(r.document.pageSetup.columns <= 12)215 // Whatever came in, the model can be exported and read back.216 let out = try DocxExporter.export(r.document)217 #expect(try DocxImporter.importDocument(out.data).document.bodyLines.first?.hasPrefix("odd") == true)218 }219220 @Test func truncatedAndCorruptedPackagesNeverCrash() throws {221 var outcomes = (imported: 0, refused: 0)222 for name in ["pandoc-basic.docx", "pandoc-math.docx", "libreoffice-pagesetup.docx"] {223 let original = try Corpus.data(name)224 var cases: [Data] = []225 for fraction in [0.1, 0.35, 0.5, 0.8, 0.95, 0.999] { cases.append(original.prefix(Int(Double(original.count) * fraction))) }226 // Deterministic byte corruption spread over the file.227 var seed: UInt64 = 0x9E3779B97F4A7C15228 for _ in 0..<60 {229 var d = original230 for _ in 0..<4 {231 seed = seed &* 6364136223846793005 &+ 1442695040888963407232 let i = Int(seed >> 33) % d.count233 d[d.startIndex + i] ^= UInt8(truncatingIfNeeded: seed >> 17) | 1234 }235 cases.append(d)236 }237 for d in cases {238 do { _ = try DocxImporter.importDocument(d); outcomes.imported += 1 } catch is FormatError { outcomes.refused += 1 } catch {239 Issue.record("corrupted input raised an error that is not a FormatError: \(error)")240 }241 }242 }243 #expect(outcomes.imported + outcomes.refused == 3 * 66)244 #expect(outcomes.refused > 0)245 }246247 @Test func mutatedXmlNeverCrashes() throws {248 // Structure-level fuzzing: drop, duplicate and swap slices of the document part of every hand-authored package.249 var seed: UInt64 = 42250 func next(_ n: Int) -> Int { seed = seed &* 6364136223846793005 &+ 1442695040888963407; return Int(seed >> 33) % max(1, n) }251 var runs = 0252 for (_, data) in try Hand.all() {253 let zip = try ZipReader(data: data)254 let xml = String(decoding: try zip.data(for: "word/document.xml")!, as: UTF8.self)255 let pieces = xml.components(separatedBy: "<")256 for _ in 0..<25 {257 var p = pieces258 for _ in 0..<3 {259 let i = 1 + next(p.count - 1)260 switch next(3) {261 case 0: p.remove(at: i)262 case 1: p.insert(p[i], at: i)263 default: p.swapAt(i, 1 + next(p.count - 1))264 }265 }266 var entries: [(String, Data)] = try zip.names.filter { $0 != "word/document.xml" }.map { ($0, try zip.data(for: $0)!) }267 entries.append(("word/document.xml", Data(p.joined(separator: "<").utf8)))268 do {269 let r = try DocxImporter.importDocument(rawZip(entries))270 // Anything that imports must also export.271 _ = try DocxExporter.export(r.document)272 } catch is FormatError {} catch { Issue.record("unexpected error \(error)") }273 runs += 1274 }275 }276 #expect(runs == 8 * 25)277 }278}279