@syzlm/ofdparser 0.0.1

package/src/core/ofd-core/Signatures/Signatures.md

@@ -0,0 +1,24 @@
+
+# Signatures
+
+签名节点
+
+## MaxSignId
+
+xs:ID 可选 安全标识的最大值,作用与文档人口文件Document. xml中的MaxID相同,为了避免在签名时影响文档入口文件,采用了与ST, _ID不一样的ID编码方式。推荐使用“sNNN”的编码方式,NNN从1开始
+
+## Signature
+
+ 数字签名或安全签章在列表中的注册信息,一次签名或签章对应一个
+
+### ID
+
+xs:ID 必选 签名或签章的标识
+
+### Type
+
+xs:string 可选 签名节点的类型,目前规定了两个可选值,Seal表示是安全签章,Sign表示是纯数字签名
+
+### BaseLoc
+
+ST_Loc 必选 指向包内的签名描述文件

package/src/core/ofd-core/Signatures/Signatures.ts

@@ -0,0 +1,247 @@
+import { Element } from 'xml-js';
+import OFDElement from '../OFDElement';
+// import PagesXml from '../Pages/PageXml';
+import { NameREG } from '../utils';
+import Asn1Utils from '../Asn.1Utils';
+
+// import DocumentResXml from './DocumentResXml';
+// import PublicResXml from './PublicResXml';
+// import { OFD_Q } from '../constant';
+import { Seal, Signature, Signatures, SignedInfo } from '../index.d';
+
+class SignaturesXml extends OFDElement {
+  static fileName: string;
+
+  static Signatures: Signatures[];
+  //  Doc_0/Signs/Signatures.xml 文件夹路径
+  signedPath: string;
+
+  constructor(fileName: string) {
+    super();
+    SignaturesXml.Signatures = [];
+    SignaturesXml.fileName = fileName;
+    // 获取 Doc_0/Signs/Signatures.xml 文件夹
+    this.signedPath = fileName.substring(0, fileName.lastIndexOf('/') + 1);
+    this.getSignatures();
+  }
+
+  getDocumentRes() {
+    // const res = this.getOFDElements(DocumnetXml.fileName, 'DocumentRes');
+    // if (res && res.elements) {
+    //   return new DocumentResXml(res.elements);
+    // }
+    // return null;
+  }
+
+  getPublicRes() {
+    // const res = this.getOFDElements(DocumnetXml.fileName, 'PublicRes');
+    // if (res && res.elements) {
+    //   return new PublicResXml(res.elements);
+    // }
+    return null;
+  }
+
+  getSeal(filePath: string) {
+    const result: Seal = {};
+    const SealInfo = new Asn1Utils(OFDElement.OFDElements[filePath] as string);
+    const pictureInfo = SealInfo.getPicture();
+    if (pictureInfo) {
+      result.picture = { ...pictureInfo };
+    }
+    return result;
+  }
+
+  getSignedInfo(signedInfoElement: Element[]): SignedInfo {
+    const result: SignedInfo = {};
+    for (let item of signedInfoElement) {
+      const { name, attributes, elements } = item;
+      if (name) {
+        const simpleName = name.replace(NameREG, '');
+        // 特殊处理 StampAnnot
+        if (simpleName === 'StampAnnot' && attributes) {
+          if (!result.StampAnnot) {
+            result.StampAnnot = [];
+          }
+          result.StampAnnot.push({
+            ...attributes
+          });
+          continue;
+        }
+        if (simpleName === 'Provider' && attributes) {
+          result.Provider = { ...attributes };
+          continue;
+        }
+        if (
+          (simpleName === 'SignatureMethod' ||
+            simpleName === 'SignatureDateTime') &&
+          elements
+        ) {
+          result[simpleName] = String(elements[0].text);
+          continue;
+        }
+        if (simpleName === 'References') {
+          result.ReferencesCheckMethod = String(
+            attributes?.CheckMethod || 'MD5'
+          );
+          if (elements?.length) {
+            if (!result.References) {
+              result.References = [];
+            }
+            elements.forEach(reference => {
+              const FileRef = String(reference.attributes?.FileRef || '');
+              if (reference.elements?.length) {
+                const CheckValueElement = reference.elements.find(
+                  ritem => ritem.name === this.OFDCommonQName('CheckValue')
+                );
+                if (CheckValueElement?.elements?.length) {
+                  result.References?.push({
+                    FileRef,
+                    CheckValue: String(CheckValueElement?.elements[0].text)
+                  });
+                }
+              }
+            });
+          }
+        }
+        // if (
+        //   simpleName === 'Seal' &&
+        //   elements &&
+        //   elements[0].name === this.OFDCommonQName('BaseLoc')
+        // ) {
+        //   const sealLoc = elements[0].elements
+        //     ? String(elements[0].elements[0].text)
+        //     : '';
+        //   console.log('sealLoc:', sealLoc);
+        //   result.Seal = this.getSeal(sealLoc.replace(/^\//, ''));
+        // }
+      }
+    }
+    return result;
+  }
+
+  getSignature(filePath: string) {
+    const res = this.getOFDElements(filePath, 'Signature');
+    if (res?.elements) {
+      const result: Signature = {};
+      for (let item of res?.elements) {
+        const { name, elements } = item;
+        if (name && elements?.length) {
+          const simpleName = name?.replace(NameREG, '');
+          if (simpleName === 'SignedValue') {
+            result.SignedValueLoc = String(elements[0]?.text || '');
+            if (!result.SignedInfo) {
+              result.SignedInfo = {};
+            }
+            // 此路径可能为 相对路径
+            const currentPath = filePath.substring(
+              0,
+              filePath.lastIndexOf('/') + 1
+            );
+            result.SignedInfo.Seal = this.getSeal(
+              currentPath +
+                result.SignedValueLoc.replace(
+                  new RegExp(currentPath),
+                  ''
+                ).replace(/^\//, '')
+            );
+          }
+          if (simpleName === 'SignedInfo') {
+            if (!result.SignedInfo) {
+              result.SignedInfo = {};
+            }
+            Object.assign(result.SignedInfo, this.getSignedInfo(elements));
+          }
+        }
+      }
+      return result;
+    }
+    return null;
+  }
+
+  /**
+   * 获取文档区域坐标
+   * @returns
+   */
+  getSignatures() {
+    const res = this.getOFDElements(SignaturesXml.fileName, 'Signatures');
+    if (res && res.elements) {
+      const SignaturesElements = res.elements;
+      SignaturesElements.forEach(item => {
+        if (item?.name) {
+          const { name, attributes } = item;
+          const simpleName = name.replace(NameREG, '');
+          if (simpleName === 'Signature' && attributes?.BaseLoc) {
+            // 获取Signature xml文件
+            const { ID, Type, BaseLoc } = attributes as {
+              ID: string;
+              Type: string;
+              BaseLoc: string;
+            };
+            // 此路径可能为 相对路径
+            const signedInfo = this.getSignature(
+              this.signedPath +
+                BaseLoc.replace(new RegExp(this.signedPath), '').replace(
+                  /^\//,
+                  ''
+                )
+            );
+            if (!SignaturesXml.Signatures) {
+              SignaturesXml.Signatures = [];
+            }
+            SignaturesXml.Signatures.push({
+              ID,
+              Type,
+              BaseLoc,
+              Signature: signedInfo
+            });
+          }
+        }
+      });
+      if (SignaturesXml.Signatures?.length) {
+        // 组装成方便遍历的数据，{[id:pageid]:info}
+        const result: { [key: string]: Signatures[] } = {};
+        SignaturesXml.Signatures.forEach(item => {
+          const { Signature } = item;
+          if (Signature?.SignedInfo?.StampAnnot?.length) {
+            const StampAnnot = Signature.SignedInfo.StampAnnot.map(sa => ({
+              ...sa
+            }));
+            StampAnnot.forEach(cItem => {
+              if (cItem?.PageRef) {
+                if (!result[cItem.PageRef]) {
+                  result[cItem.PageRef] = [];
+                }
+                const newItem = {
+                  ...item,
+                  Signature: {
+                    ...item.Signature,
+                    SignedInfo: {
+                      ...item.Signature?.SignedInfo,
+                      StampAnnot: item.Signature?.SignedInfo?.StampAnnot?.map(
+                        sa => ({ ...sa })
+                      )
+                    }
+                  }
+                };
+                if (newItem.Signature?.SignedInfo?.StampAnnot?.length) {
+                  newItem.Signature.SignedInfo.StampAnnot = StampAnnot.filter(
+                    sItem => sItem.PageRef === cItem.PageRef
+                  );
+                }
+                result[cItem.PageRef].push({
+                  ...newItem
+                });
+              }
+            });
+          }
+        });
+
+        OFDElement.Signatures = SignaturesXml.Signatures;
+        OFDElement.PageSignatures = result;
+      }
+    }
+    return null;
+  }
+}
+
+export default SignaturesXml;

package/src/core/ofd-core/TemplatePages/TemplatePages.ts

@@ -0,0 +1,56 @@
+import { Element } from 'xml-js';
+import { replacePathPriex } from '../utils';
+import VaildOFDError from '../../../errors/OFDErrors';
+
+import OFDElement from '../OFDElement';
+// import OFDXMl from '../ofd/OFDXml';
+// import { OFD_PATH } from '../constant';
+
+class TemplatePages extends OFDElement {
+  /**
+   * TemplatePages 文件，以数组存放，存在多页
+   * @date 2022/7/27 - 09:41:22
+   *
+   * @type {Element[]}
+   */
+  tplsXml: { [k: string]: Element } | null;
+  static fileName: string;
+  constructor(tplsElements: Element[]) {
+    super();
+    // 区分多页TemplatePages 暂时没有该类型OFD
+    if (tplsElements?.length) {
+      this.setTplsXml(tplsElements);
+    } else {
+      throw new VaildOFDError(9999, 'Documents下TemplatePage解析失败');
+    }
+    this.tplsXml = null;
+  }
+
+  formatTplsXml(tplsFile: { [k: string]: Element }) {
+    Object.entries(tplsFile).forEach(([keys, content]) => {
+      if (content && content.elements?.length) {
+        this.setTpls(content, keys);
+      }
+    });
+  }
+
+  setTplsXml(tplsElements: Element[]): void {
+    tplsElements.forEach(tplElement => {
+      if (tplElement?.attributes) {
+        const { BaseLoc, ID = '' } = tplElement.attributes;
+        const tplsPath = replacePathPriex(OFDElement.STLoc, `${BaseLoc}`);
+        if (!this.tplsXml) {
+          this.tplsXml = {};
+        }
+
+        this.tplsXml[ID] = OFDElement.OFDElements[tplsPath];
+      }
+    });
+    if (this.tplsXml) {
+      // 获取 Tpls xml 内数据
+      this.formatTplsXml(this.tplsXml);
+    }
+  }
+}
+
+export default TemplatePages;

package/src/core/ofd-core/asn.md

@@ -0,0 +1,60 @@
+# ASN.1 说明
+
+Abstract Syntax Notation One，抽象语法标记，ASN.1是描述数据格式的标准方法，它不管语言是如何执行、这些数据具体指什么、用什么类型的编码规则，是一种抽象的语法
+
+ASN.1由两部分组成：
+
+一部分描述信息内数据，数据类型及序列格式
+另一部分描述如何将各部分组成消息
+
+## 语法
+
+### 例如
+
+```C++
+ Report ::= SEQUENCE {
+author OCTET STRING,
+title OCTET STRING,
+body OCTET STRING,
+biblio Bibliography
+} 
+```
+
+### Report是结构体名称
+
+1. SEQUENCE表示消息是由许多数据单元构成的
+2. 中括号{}里面是各种类型的数据单元
+3. 前三个数据单元author/title/body的类型是OCTET STRING
+4. 最后一个数据单元biblio的类型是另一个ASN.1结构体
+
+``` C++
+Bibliography ::= SEQUENCE {
+author OCTET STRING
+title OCTET STRING
+publisher OCTET STRING
+year OCTET STRING
+}  
+```
+
+## 数据类型
+
+| 类型                          | 含义       |
+| ----------------------------- | ---------- |
+| NULL                          | 空         |
+| BOOLEAN                       | 布尔类型   |
+| INTEGER                       | 整型       |
+| REAL                          | 实数类型   |
+| BIT STRING                    | 比特串     |
+| OCTEC STRING                  | 字节串     |
+| OBJECT IDENTIFIER             | 实体标识符 |
+| ENUMERATED                    | 枚举类型   |
+| SEQUENCE                      | 序列       |
+| SEQUENCE OF                   | 类型的序列 |
+| SET                           | 集合       |
+| SET OF                        | 类型的集合 |
+| CHOICE                        | CHOICE类型 |
+| …STRING（有很多就不一一列举） | 字符串类型 |
+| UTCTime                       | 时间类型   |
+| GeneralizedTime               | 时间类型   |
+
+

package/src/core/ofd-core/constant.ts

@@ -0,0 +1,35 @@
+/**
+ * 命名空间 URI,《GB/T_33190-2016》 7.1 命名空间
+ */
+export const OFD_NAMESPACE_URI = 'http://www.ofdspec.org/2016' as string;
+
+/**
+ * 元素节点应使用命名空间标识符
+ * ————《GB/T 33190-2016》 7.1 命名空间
+ */
+export const OFD_VALUE = 'ofd' as string;
+
+/**
+ * OFD命名空间
+ */
+export const OFD_Q = 'ofd:' as string;
+
+/**
+ * OFD地址前缀 DOC_0/
+ */
+export const OFD_PATH = 'DOC_0/' as string;
+
+/**
+ * xs:date 类型日期格式化
+ */
+export const DATE_FORMATTER = 'yyyy-MM-dd' as string;
+
+/**
+ * xs:dateTime 类型时间日期格式化
+ */
+export const DATETIME_FORMATTER = "yyyy-MM-dd'T'hh:mm:ss" as string;
+
+/**
+ * OFD索引文件
+ */
+export const INDEX_FILE = 'OFD.xml' as string;