mirror of
https://github.com/mozilla/pdf.js.git
synced 2026-07-30 19:07:22 +02:00
Update the signatures-helpers to actually handle MissingDataExceptions
The `PDFDocument.prototype.signatures` getter returns a (shadowed) Promise, however the way that it invokes various helper-methods can lead to *intermittent* failures to parse the signature data. These helper-methods will lookup a fair amount of Dictionary data, however any one of those cases could throw `MissingDataException` during document loading. To avoid having to re-factor those methods a lot, and adding a bunch more `pdfManager.ensureDoc()` calls, they are instead made asynchronous and the Dictionary lookups changed to use `Dict.prototype.getAsync` (similar to the existing `fieldObjects` handling). Technically this additional asynchronicity may be ever so slightly slower, however I don't think it matters in practice since: most PDFs don't have any signatures, the signature-UI is initialized lazily in the viewer, and finally fetching/parsing of signatures do not block rendering. Also, note how multiple values are being fetched in parallel in order to attempt to reduce overall asynchronicity. *Note:* The unit-test changes are essentially fixing pre-existing bugs, that this patch exposed, since the test-only `Dict` instances weren't able to fetch indirect objects.
This commit is contained in:
Jonas Jenwald
parent
1609bd87c5
commit
f38e8b659e
@ -1996,7 +1996,7 @@ class PDFDocument {
|
||||
return shadow(this, "fieldObjects", promise);
|
||||
}
|
||||
|
||||
#collectSignatureFields(fields, out, visitedRefs) {
|
||||
async #collectSignatureFields(fields, out, visitedRefs) {
|
||||
if (!Array.isArray(fields)) {
|
||||
return;
|
||||
}
|
||||
@ -2007,14 +2007,18 @@ class PDFDocument {
|
||||
}
|
||||
visitedRefs.put(fieldRef);
|
||||
}
|
||||
const field = this.xref.fetchIfRef(fieldRef);
|
||||
const field = await this.xref.fetchIfRefAsync(fieldRef);
|
||||
if (!(field instanceof Dict)) {
|
||||
continue;
|
||||
}
|
||||
if (isName(field.get("FT"), "Sig")) {
|
||||
const sigDict = this.xref.fetchIfRef(field.get("V"));
|
||||
if (isName(await field.getAsync("FT"), "Sig")) {
|
||||
const sigDict = await field.getAsync("V");
|
||||
if (sigDict instanceof Dict) {
|
||||
const parsed = this.#parseSignatureDict(field, sigDict, fieldRef);
|
||||
const parsed = await this.#parseSignatureDict(
|
||||
field,
|
||||
sigDict,
|
||||
fieldRef
|
||||
);
|
||||
if (parsed) {
|
||||
out.push(parsed);
|
||||
}
|
||||
@ -2023,7 +2027,11 @@ class PDFDocument {
|
||||
if (field.has("Kids")) {
|
||||
// A terminal field can have Widget annotations as children, so its
|
||||
// own signature must be collected before walking the field tree.
|
||||
this.#collectSignatureFields(field.get("Kids"), out, visitedRefs);
|
||||
await this.#collectSignatureFields(
|
||||
await field.getAsync("Kids"),
|
||||
out,
|
||||
visitedRefs
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -2070,8 +2078,8 @@ class PDFDocument {
|
||||
return true;
|
||||
}
|
||||
|
||||
#parseSignatureDict(field, sigDict, fieldRef) {
|
||||
const byteRange = sigDict.get("ByteRange");
|
||||
async #parseSignatureDict(field, sigDict, fieldRef) {
|
||||
const byteRange = await sigDict.getAsync("ByteRange");
|
||||
if (
|
||||
!Array.isArray(byteRange) ||
|
||||
byteRange.length !== 4 ||
|
||||
@ -2079,15 +2087,17 @@ class PDFDocument {
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
const contents = sigDict.get("Contents");
|
||||
const contents = await sigDict.getAsync("Contents");
|
||||
if (typeof contents !== "string" || contents.length === 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const filterName = sigDict.get("Filter");
|
||||
const filter = filterName instanceof Name ? filterName.name : null;
|
||||
const subFilterName = sigDict.get("SubFilter");
|
||||
const subFilter = subFilterName instanceof Name ? subFilterName.name : null;
|
||||
const [filterName, subFilterName] = await Promise.all([
|
||||
sigDict.getAsync("Filter"),
|
||||
sigDict.getAsync("SubFilter"),
|
||||
]);
|
||||
const filter = filterName instanceof Name ? filterName.name : null,
|
||||
subFilter = subFilterName instanceof Name ? subFilterName.name : null;
|
||||
|
||||
let signatureType = null;
|
||||
if (subFilter === "adbe.pkcs7.detached") {
|
||||
@ -2118,22 +2128,20 @@ class PDFDocument {
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
const pkcs7 = stringToBytes(contents);
|
||||
|
||||
const t = field.get("T");
|
||||
const fieldName = typeof t === "string" ? stringToPDFString(t) : "";
|
||||
const name = sigDict.get("Name");
|
||||
const reason = sigDict.get("Reason");
|
||||
const location = sigDict.get("Location");
|
||||
const contactInfo = sigDict.get("ContactInfo");
|
||||
const m = sigDict.get("M");
|
||||
|
||||
const [t, name, reason, location, contactInfo, m] = await Promise.all([
|
||||
field.getAsync("T"),
|
||||
sigDict.getAsync("Name"),
|
||||
sigDict.getAsync("Reason"),
|
||||
sigDict.getAsync("Location"),
|
||||
sigDict.getAsync("ContactInfo"),
|
||||
sigDict.getAsync("M"),
|
||||
]);
|
||||
const refKey = fieldRef instanceof Ref ? fieldRef.toString() : "inline";
|
||||
const id = `${refKey}:${a}-${b}-${c}-${d}`;
|
||||
|
||||
return {
|
||||
id,
|
||||
fieldName,
|
||||
id: `${refKey}:${a}-${b}-${c}-${d}`,
|
||||
fieldName: typeof t === "string" ? stringToPDFString(t) : "",
|
||||
signerName: typeof name === "string" ? stringToPDFString(name) : null,
|
||||
reason: typeof reason === "string" ? stringToPDFString(reason) : null,
|
||||
location:
|
||||
@ -2145,7 +2153,7 @@ class PDFDocument {
|
||||
subFilter,
|
||||
signatureType,
|
||||
byteRange,
|
||||
pkcs7,
|
||||
pkcs7: stringToBytes(contents),
|
||||
revisionIndex: 0,
|
||||
parentId: null,
|
||||
};
|
||||
@ -2165,7 +2173,7 @@ class PDFDocument {
|
||||
const fields = annotationGlobals.acroForm.get("Fields");
|
||||
|
||||
const collected = [];
|
||||
this.#collectSignatureFields(fields, collected, new RefSet());
|
||||
await this.#collectSignatureFields(fields, collected, new RefSet());
|
||||
|
||||
await Promise.all(
|
||||
collected.map(async signature => {
|
||||
|
||||
@ -322,6 +322,10 @@ describe("document", function () {
|
||||
{ ref: sigRef, data: sigDict },
|
||||
{ ref: fieldRef, data: fieldDict },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
sigDict.assignXref(xref);
|
||||
fieldDict.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [fieldRef]);
|
||||
|
||||
const pdfDocument = getDocument(acroForm, xref);
|
||||
@ -362,6 +366,10 @@ describe("document", function () {
|
||||
{ ref: sigRef, data: sigDict },
|
||||
{ ref: fieldRef, data: fieldDict },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
sigDict.assignXref(xref);
|
||||
fieldDict.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [fieldRef]);
|
||||
|
||||
const documentStream = new StringStream(
|
||||
@ -386,6 +394,10 @@ describe("document", function () {
|
||||
{ ref: sigRef, data: sigDict },
|
||||
{ ref: fieldRef, data: fieldDict },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
sigDict.assignXref(xref);
|
||||
fieldDict.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [fieldRef]);
|
||||
|
||||
const documentStream = new StringStream(
|
||||
@ -418,6 +430,11 @@ describe("document", function () {
|
||||
{ ref: sigFieldRef, data: sigField },
|
||||
{ ref: containerRef, data: container },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
sigDict.assignXref(xref);
|
||||
sigField.assignXref(xref);
|
||||
container.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [containerRef]);
|
||||
|
||||
const pdfDocument = getDocument(acroForm, xref);
|
||||
@ -450,6 +467,11 @@ describe("document", function () {
|
||||
{ ref: sigFieldRef, data: sigField },
|
||||
{ ref: widgetRef, data: widget },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
sigDict.assignXref(xref);
|
||||
sigField.assignXref(xref);
|
||||
widget.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [sigFieldRef]);
|
||||
|
||||
const pdfDocument = getDocument(acroForm, xref);
|
||||
@ -472,6 +494,10 @@ describe("document", function () {
|
||||
{ ref: sigRef, data: sigDict },
|
||||
{ ref: fieldRef, data: fieldDict },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
sigDict.assignXref(xref);
|
||||
fieldDict.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [fieldRef]);
|
||||
|
||||
const pdfDocument = getDocument(acroForm, xref);
|
||||
@ -498,18 +524,21 @@ describe("document", function () {
|
||||
name: "Inner",
|
||||
});
|
||||
|
||||
const outerField = makeSigField({ T: "outer", sigRef: outerSigRef });
|
||||
const innerField = makeSigField({ T: "inner", sigRef: innerSigRef });
|
||||
|
||||
const xref = new XRefMock([
|
||||
{ ref: outerSigRef, data: outerSig },
|
||||
{
|
||||
ref: outerFieldRef,
|
||||
data: makeSigField({ T: "outer", sigRef: outerSigRef }),
|
||||
},
|
||||
{ ref: outerFieldRef, data: outerField },
|
||||
{ ref: innerSigRef, data: innerSig },
|
||||
{
|
||||
ref: innerFieldRef,
|
||||
data: makeSigField({ T: "inner", sigRef: innerSigRef }),
|
||||
},
|
||||
{ ref: innerFieldRef, data: innerField },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
outerSig.assignXref(xref);
|
||||
innerSig.assignXref(xref);
|
||||
outerField.assignXref(xref);
|
||||
innerField.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [outerFieldRef, innerFieldRef]);
|
||||
|
||||
const pdfDocument = getDocument(acroForm, xref);
|
||||
@ -535,14 +564,18 @@ describe("document", function () {
|
||||
byteRange: [0, 10, 20, 30],
|
||||
subFilter,
|
||||
});
|
||||
const sigField = makeSigField({ T: "sig", sigRef });
|
||||
|
||||
const xref = new XRefMock([
|
||||
{ ref: sigRef, data: sigDict },
|
||||
{
|
||||
ref: fieldRef,
|
||||
data: makeSigField({ T: "sig", sigRef }),
|
||||
},
|
||||
{ ref: fieldRef, data: sigField },
|
||||
]);
|
||||
acroForm.assignXref(xref);
|
||||
sigDict.assignXref(xref);
|
||||
sigField.assignXref(xref);
|
||||
|
||||
acroForm.set("Fields", [fieldRef]);
|
||||
|
||||
const pdfDocument = getDocument(acroForm, xref);
|
||||
const [sig] = await pdfDocument.signatures;
|
||||
return sig.signatureType;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user