xml-fiesta
Version:
Electronic signed document XML Protocol for Node & Browser
428 lines • 22.7 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var jsrsasign = require("jsrsasign");
var signature_1 = require("./signature");
var conservancyRecord_1 = require("./conservancyRecord");
var conservancyRecordNom2016_1 = require("./conservancyRecordNom2016");
var common_1 = require("./common");
var errors_1 = require("./errors");
var xmlPatch_1 = require("./patches/xmlPatch");
var blockchain_1 = require("./services/blockchain");
var certificate_1 = require("./certificate");
var validate_1 = require("./validations/validate");
var VERSION = "0.0.1";
var Document = (function () {
function Document(file, options) {
var _this = this;
var _a;
if (!file) {
throw new errors_1.ArgumentError("file is required");
}
this.pdf_content = file;
this.signers = [];
var defaultOpts = {
version: VERSION,
signers: [],
encrypted: false,
};
this.errors = {};
options = common_1.extend(defaultOpts, options);
this.conservancyRecord = null;
this.recordPresent = false;
if (options.conservancyRecord) {
this.setConservancyRecord(options.conservancyRecord);
}
else
console.error("The conservancy record was not found");
this.contentType = options.contentType;
this.name = options.name;
this.version = options.version;
this.encrypted = options.encrypted === "true" || options.encrypted === true;
this.tracked = options.tracked;
this.destroyed = options.destroyed;
this.blockchainTrack = options.blockchainTrack;
this.blockchainBinding = options.blockchainBinding;
this.transfersXml = options.transfersXml || [];
this.currentHolder = options.currentHolder;
this.prevHolder = options.prevHolder;
this.assetId = options.assetId;
this.network = options.network;
this.electronicDocument = options.electronicDocument;
var digest = new jsrsasign.crypto.MessageDigest({
alg: "sha256",
prov: "cryptojs",
});
this.originalHash = digest.digestHex(this.file("hex"));
if (((_a = options.signers) === null || _a === void 0 ? void 0 : _a.length) > 0) {
options.signers.forEach(function (el) { return _this.addSigner(el); });
}
}
Document.prototype.setConservancyRecord = function (data) {
this.originalXmlHash = data.originalXmlHash;
this.recordPresent = true;
try {
if (!data.version) {
this.conservancyRecord = new conservancyRecord_1.default(data.caCert, data.userCert, data.record, data.timestamp, data.originalXmlHash);
}
else {
this.conservancyRecord = new conservancyRecordNom2016_1.default(data.caCert, data.record, data.timestamp, data.originalXmlHash);
}
}
catch (e) {
throw new errors_1.InvalidRecordError("The conservancy record is not valid: " + e.message);
}
};
Document.prototype.fileBuffer = function () {
if (!this.pdf_content) {
return null;
}
return Buffer.from(this.pdf_content, "base64");
};
Document.prototype.pdfBuffer = function () {
return this.fileBuffer();
};
Document.prototype.file = function (format) {
if (!this.pdf_content) {
return null;
}
if (!format) {
return common_1.b64toAscii(this.pdf_content);
}
if (format === "hex") {
return common_1.b64toHex(this.pdf_content);
}
if (format === "base64") {
return this.pdf_content;
}
throw new errors_1.ArgumentError("unknown format " + format);
};
Document.prototype.setFile = function (file) {
this.pdf_content = file;
};
Document.prototype.toXML = function (eDocument) {
if (!eDocument)
throw new errors_1.ArgumentError("eDocument is required");
return xmlPatch_1.default.toXML(eDocument, this.file("base64"));
};
Document.prototype.pdf = function (format) {
return this.file(format);
};
Document.prototype.addSigner = function (signer) {
if (!signer.cer || !signer.signature || !signer.signedAt) {
throw new errors_1.InvalidSignerError("signer must contain cer, signature and signedAt");
}
return this.signers.push(signer);
};
Document.prototype.signatures = function () {
return this.signers.map(function (signer) {
return new signature_1.default(signer.cer, signer.signature, signer.signedAt, signer.email, signer.ePass, signer.name);
});
};
Document.prototype.validSignatures = function () {
if (!this.originalHash) {
return false;
}
var valid = true;
var oHash = this.originalHash;
this.signatures().forEach(function (signature) {
if (valid && !signature.valid(oHash)) {
return (valid = false);
}
});
return valid;
};
Document.prototype.transfers = function () {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4, Promise.all(this.transfersXml.map(function (transfer, index) { return __awaiter(_this, void 0, void 0, function () {
var xml, prevHolder, opts, prevAddress, currentAddress, transferData, Transfer;
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
return __generator(this, function (_o) {
switch (_o.label) {
case 0:
Object.entries(this.electronicDocument.$).map(function (_a) {
var key = _a[0], value = _a[1];
if (key.includes("xmlns")) {
transfer.$[key] = value;
}
});
xml = xmlPatch_1.default.parseByElectronicDocument(transfer);
prevHolder = index === 0
? this.currentHolder
: (_f = (_e = (_d = (_c = (_b = (_a = this.electronicDocument) === null || _a === void 0 ? void 0 : _a.transfers) === null || _b === void 0 ? void 0 : _b[0].electronicDocument) === null || _c === void 0 ? void 0 : _c[index - 1].blockchain) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.holder) === null || _f === void 0 ? void 0 : _f[0];
return [4, Document.getOptsToInitializeDocument({
xml: xml,
prevHolder: prevHolder,
})];
case 1:
opts = _o.sent();
prevAddress = index === 0
? this.currentHolder.binding[0].signature[0].$.plaintext.split("|")[0]
: this.transfersXml[index - 1].blockchain[0].holder[0].binding[0].signature[0].$.plaintext.split("|")[0];
currentAddress = (_k = (_j = (_h = (_g = xml.eDocument.blockchain) === null || _g === void 0 ? void 0 : _g[0]) === null || _h === void 0 ? void 0 : _h.holder) === null || _j === void 0 ? void 0 : _j[0]) === null || _k === void 0 ? void 0 : _k.binding[0].signature[0].$.plaintext.split("|")[0];
transferData = {
dataBlockchain: ((_m = (_l = this.blockchainTrack) === null || _l === void 0 ? void 0 : _l.transfers) === null || _m === void 0 ? void 0 : _m[index]) || {},
prevAddress: prevAddress,
currentAddress: currentAddress,
};
Transfer = require("./transfer").default;
return [2, new Transfer(xml, opts, transferData)];
}
});
}); }))];
case 1: return [2, _a.sent()];
}
});
});
};
Document.prototype.isSimpleTrackedDocument = function (rootCertificates) {
if (!this.tracked)
throw new Error("Document is not tracked");
var certificateB64 = this.blockchainBinding.certificate[0]._;
var certificateHex = common_1.b64toHex(certificateB64);
var certificate = new certificate_1.default(null, certificateHex);
var isCa = rootCertificates.some(function (rootCer) {
return certificate.isCa(rootCer.cer_hex);
});
return isCa;
};
Document.prototype.isValidHashInTrackedDocument = function (rootCertificates) {
if (!this.tracked)
throw new Error("Document is not tracked");
var plaintext = this.blockchainBinding.signature[0].$.plaintext;
var originalHashPlaintext = plaintext.split("|")[0];
var originalHashInBlockchainBindingIsValid = this.validHashInBlockchainBinding(rootCertificates, plaintext);
if (!originalHashInBlockchainBindingIsValid ||
this.originalHash !== originalHashPlaintext) {
console.error("Document(validate hash in tracked document): invalid hash", {
originalHashInBlockchainBindingIsValid: originalHashInBlockchainBindingIsValid,
providedOriginalHash: this.originalHash,
originalHashInPlaintext: originalHashPlaintext,
});
return {
isValid: false,
error_code: "integrity",
};
}
return {
isValid: true,
};
};
Document.prototype.validHashInBlockchainBinding = function (rootCertificates, hash) {
if (!this.tracked)
throw new Error("Document is not tracked");
if (this.network === "LTC")
return true;
var trackedDocumentIsSimple = this.isSimpleTrackedDocument(rootCertificates);
var cerHex = common_1.b64toHex(this.blockchainBinding.certificate[0]._);
var nodeSignature = this.blockchainBinding.signature[0];
var signatureData = {
signedAt: nodeSignature.$.signedAt,
signatureHex: common_1.b64toHex(nodeSignature._),
};
if (!trackedDocumentIsSimple) {
var certificate_2 = new certificate_1.default(null, cerHex);
var certificateNumberIsValid = rootCertificates.some(function (rootCer) {
return certificate_2.validParent(null, rootCer.cer_hex);
});
var certificateIsFromSigner = this.signers.some(function (signer) { return signer.cer === cerHex; });
if (!certificateNumberIsValid || !certificateIsFromSigner) {
console.error("Document(validate hash in blockchain binding): certificate validation failed", {
certificateNumberIsValid: certificateNumberIsValid,
certificateIsFromSigner: certificateIsFromSigner,
});
return false;
}
}
var signatureInstance = new signature_1.default(cerHex, signatureData.signatureHex, signatureData.signedAt, null, null);
var isValidSignature = signatureInstance.valid(hash);
if (!isValidSignature) {
console.error("Document(validate hash in blockchain binding): signature validation failed");
return false;
}
return true;
};
Document.prototype.getStatusTrackedDocument = function (rootCertificates) {
var _a;
if (!this.tracked)
throw new Error("Document is not tracked");
if (!this.isValidAssetId(rootCertificates).isValid)
return "error";
var transfersLengthXml = ((_a = this.transfersXml) === null || _a === void 0 ? void 0 : _a.length) || 0;
var transfersLengthBlockchain = this.blockchainTrack.transfers.length;
if (this.destroyed) {
transfersLengthXml += 1;
}
if (transfersLengthXml === transfersLengthBlockchain)
return "updated";
if (transfersLengthXml < transfersLengthBlockchain)
return "not_updated";
};
Document.prototype.isValidAssetId = function (rootCertificates) {
if (!this.tracked)
throw new Error("Document is not tracked");
var plaintext = this.blockchainBinding.signature[0].$.plaintext;
var assetPlaintext = plaintext.split("|")[1];
var assetInBlockchainBindingIsValid = this.validHashInBlockchainBinding(rootCertificates, plaintext);
if (!assetInBlockchainBindingIsValid || this.assetId !== assetPlaintext) {
console.error("Asset ID validation failed", {
assetInBlockchainBindingIsValid: assetInBlockchainBindingIsValid,
providedAssetId: this.assetId,
assetInPlaintext: assetPlaintext,
});
return {
isValid: false,
error_code: "integrity",
};
}
if (!this.blockchainTrack) {
console.error("Blockchain track not found");
return {
isValid: false,
error_code: "not_found",
};
}
return {
isValid: true,
};
};
Document.fromXml = function (xmlString, useTestnet) {
if (useTestnet === void 0) { useTestnet = false; }
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
return [2, new Promise(function (resolve, reject) {
return xmlPatch_1.default.parse(xmlString)
.then(function (xml) { return __awaiter(_this, void 0, void 0, function () {
var opts, doc;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4, this.getOptsToInitializeDocument({
xml: xml,
useTestnet: useTestnet,
isOriginalDocument: true,
})];
case 1:
opts = _a.sent();
doc = new Document(xml.file(), opts);
resolve({
xml: xml,
document: doc,
xmljs: xml.eDocument,
xmlHash: xml.getConservancyRecord() &&
xml.getConservancyRecord().originalXmlHash,
xmlOriginalHash: xml.originalHash,
validate: function (options) {
return validate_1.validateParsedXml({ xml: xml, document: doc, xmlOriginalHash: xml.originalHash }, options);
},
});
return [2];
}
});
}); })
.catch(function (error) { return reject(error); });
})];
});
});
};
Document.getOptsToInitializeDocument = function (_a) {
var xml = _a.xml, _b = _a.prevHolder, prevHolder = _b === void 0 ? null : _b, _c = _a.useTestnet, useTestnet = _c === void 0 ? false : _c, _d = _a.isOriginalDocument, isOriginalDocument = _d === void 0 ? false : _d;
return __awaiter(void 0, void 0, void 0, function () {
var parseStringToBoolean, opts, assetIdPlaintext, network, blockchainInstance, blockchainTrack, error_1;
var _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
return __generator(this, function (_r) {
switch (_r.label) {
case 0:
parseStringToBoolean = function (string) { return string === "true"; };
opts = {
electronicDocument: xml.eDocument,
signers: xml.xmlSigners(),
version: xml.version,
name: xml.name,
encrypted: xml.encrypted,
contentType: xml.contentType,
conservancyRecord: xml.getConservancyRecord(),
blockchainTrack: null,
tracked: xml.tracked,
destroyed: parseStringToBoolean(xml.destroyed),
transfersXml: ((_g = (_f = (_e = xml.eDocument) === null || _e === void 0 ? void 0 : _e.transfers) === null || _f === void 0 ? void 0 : _f[0]) === null || _g === void 0 ? void 0 : _g.electronicDocument) || null,
blockchainBinding: (_l = (_k = (_j = (_h = xml.eDocument) === null || _h === void 0 ? void 0 : _h.blockchain) === null || _j === void 0 ? void 0 : _j[0]) === null || _k === void 0 ? void 0 : _k.binding) === null || _l === void 0 ? void 0 : _l[0],
currentHolder: (_q = (_p = (_o = (_m = xml.eDocument) === null || _m === void 0 ? void 0 : _m.blockchain) === null || _o === void 0 ? void 0 : _o[0]) === null || _p === void 0 ? void 0 : _p.holder) === null || _q === void 0 ? void 0 : _q[0],
prevHolder: prevHolder,
assetId: null,
network: null,
};
if (!(xml.tracked && isOriginalDocument)) return [3, 4];
assetIdPlaintext = xml.eDocument.blockchain[0].binding[0].signature[0].$.plaintext.split("|")[1];
network = xml.eDocument.blockchain[0].$.name;
opts.assetId = assetIdPlaintext;
opts.network = network;
_r.label = 1;
case 1:
_r.trys.push([1, 3, , 4]);
blockchainInstance = blockchain_1.Blockchain.init(network);
if (useTestnet)
blockchainInstance.useTestnet();
return [4, blockchainInstance.getBlockchainTrack(assetIdPlaintext)];
case 2:
blockchainTrack = _r.sent();
opts.blockchainTrack = blockchainTrack;
return [3, 4];
case 3:
error_1 = _r.sent();
console.error(error_1);
return [3, 4];
case 4:
if (opts.network === "LTC") {
opts.blockchainTrack = {
transfers: [],
asset: opts.assetId,
};
}
return [2, opts];
}
});
});
};
return Document;
}());
exports.default = Document;
//# sourceMappingURL=document.js.map