-
-
Notifications
You must be signed in to change notification settings - Fork 223
feat(signature): prototype cryptographic signature renderer #214
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c17be85
feat(presets): integrate signature renderer into all preset
p4535992 2737fa7
Merge branch 'flyfish-dev:main' into feature/rendition-dss
p4535992 9484a4a
Merge branch 'flyfish-dev:main' into feature/rendition-dss
p4535992 7b83a72
chore(signature): finalize rPGP migration cleanup
p4535992 c7270d8
Merge upstream main v2.4.0 into feature/rendition-dss
p4535992 da62d52
chore:fix
p4535992 2b351fe
Merge branch 'flyfish-dev:main' into feature/rendition-dss
p4535992 700e097
fix(signature): preserve multi-signer fixture line endings
p4535992 0214e7a
chore: remove temporary rendition DSS validation workflow
p4535992 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, and | ||
| distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by the copyright | ||
| owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all other entities | ||
| that control, are controlled by, or are under common control with that entity. | ||
| For the purposes of this definition, "control" means (i) the power, direct or | ||
| indirect, to cause the direction or management of such entity, whether by | ||
| contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity exercising | ||
| permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, including | ||
| but not limited to software source code, documentation source, and configuration | ||
| files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical transformation or | ||
| translation of a Source form, including but not limited to compiled object code, | ||
| generated documentation, and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or Object form, | ||
| made available under the License, as indicated by a copyright notice that is | ||
| included in or attached to the work. | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object form, that | ||
| is based on (or derived from) the Work and for which the editorial revisions, | ||
| annotations, elaborations, or other modifications represent, as a whole, an | ||
| original work of authorship. For the purposes of this License, Derivative Works | ||
| shall not include works that remain separable from, or merely link (or bind by | ||
| name) to the interfaces of, the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including the original version | ||
| of the Work and any modifications or additions to that Work or Derivative Works | ||
| thereof, that is intentionally submitted to Licensor for inclusion in the Work by | ||
| the copyright owner or by an individual or Legal Entity authorized to submit on | ||
| behalf of the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent to the | ||
| Licensor or its representatives, including but not limited to communication on | ||
| electronic mailing lists, source code control systems, and issue tracking systems | ||
| that are managed by, or on behalf of, the Licensor for the purpose of discussing | ||
| and improving the Work, but excluding communication that is conspicuously marked | ||
| or otherwise designated in writing by the copyright owner as "Not a | ||
| Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity on behalf | ||
| of whom a Contribution has been received by Licensor and subsequently | ||
| incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of this | ||
| License, each Contributor hereby grants to You a perpetual, worldwide, | ||
| non-exclusive, no-charge, royalty-free, irrevocable copyright license to | ||
| reproduce, prepare Derivative Works of, publicly display, publicly perform, | ||
| sublicense, and distribute the Work and such Derivative Works in Source or | ||
| Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of this License, | ||
| each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, | ||
| no-charge, royalty-free, irrevocable (except as stated in this section) patent | ||
| license to make, have made, use, offer to sell, sell, import, and otherwise | ||
| transfer the Work, where such license applies only to those patent claims | ||
| licensable by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) with the Work to | ||
| which such Contribution(s) was submitted. If You institute patent litigation | ||
| against any entity (including a cross-claim or counterclaim in a lawsuit) | ||
| alleging that the Work or a Contribution incorporated within the Work | ||
| constitutes direct or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate as of the date | ||
| such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the Work or | ||
| Derivative Works thereof in any medium, with or without modifications, and in | ||
| Source or Object form, provided that You meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or Derivative Works a copy of | ||
| this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices stating that | ||
| You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works that You | ||
| distribute, all copyright, patent, trademark, and attribution notices from the | ||
| Source form of the Work, excluding those notices that do not pertain to any part | ||
| of the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its distribution, then | ||
| any Derivative Works that You distribute must include a readable copy of the | ||
| attribution notices contained within such NOTICE file, excluding those notices | ||
| that do not pertain to any part of the Derivative Works, in at least one of the | ||
| following places: within a NOTICE text file distributed as part of the Derivative | ||
| Works; within the Source form or documentation, if provided along with the | ||
| Derivative Works; or, within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents of the NOTICE | ||
| file are for informational purposes only and do not modify the License. You may | ||
| add Your own attribution notices within Derivative Works that You distribute, | ||
| alongside or as an addendum to the NOTICE text from the Work, provided that such | ||
| additional attribution notices cannot be construed as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and may provide | ||
| additional or different license terms and conditions for use, reproduction, or | ||
| distribution of Your modifications, or for any such Derivative Works as a whole, | ||
| provided Your use, reproduction, and distribution of the Work otherwise complies | ||
| with the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, any | ||
| Contribution intentionally submitted for inclusion in the Work by You to the | ||
| Licensor shall be under the terms and conditions of this License, without any | ||
| additional terms or conditions. Notwithstanding the above, nothing herein shall | ||
| supersede or modify the terms of any separate license agreement you may have | ||
| executed with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade names, | ||
| trademarks, service marks, or product names of the Licensor, except as required | ||
| for reasonable and customary use in describing the origin of the Work and | ||
| reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in | ||
| writing, Licensor provides the Work (and each Contributor provides its | ||
| Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied, including, without limitation, any warranties or | ||
| conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any risks | ||
| associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, whether in | ||
| tort (including negligence), contract, or otherwise, unless required by | ||
| applicable law (such as deliberate and grossly negligent acts) or agreed to in | ||
| writing, shall any Contributor be liable to You for damages, including any | ||
| direct, indirect, special, incidental, or consequential damages of any character | ||
| arising as a result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, work stoppage, | ||
| computer failure or malfunction, or any and all other commercial damages or | ||
| losses), even if such Contributor has been advised of the possibility of such | ||
| damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing the Work or | ||
| Derivative Works thereof, You may choose to offer, and charge a fee for, | ||
| acceptance of support, warranty, indemnity, or other liability obligations and/or | ||
| rights consistent with this License. However, in accepting such obligations, You | ||
| may act only on Your own behalf and on Your sole responsibility, not on behalf of | ||
| any other Contributor, and only if You agree to indemnify, defend, and hold each | ||
| Contributor harmless for any liability incurred by, or claims asserted against, | ||
| such Contributor by reason of your accepting any such warranty or additional | ||
| liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| Copyright 2026 Flyfish Viewer |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| # @file-viewer/renderer-signature | ||
|
|
||
| Optional, browser-local renderer for cryptographic signatures and timestamp containers. It keeps CMS/CAdES/RFC 3161/RFC 5544 support in TypeScript/Web Crypto and adds OpenPGP inspection through an optional rPGP WebAssembly backend. | ||
|
|
||
| ## Supported formats | ||
|
|
||
| - CMS / PKCS#7 / CAdES-adjacent containers: `.p7m`, `.p7s`, `.p7b`, `.p7c`, `.pkcs7`, `.cms`, `.cmsc` | ||
| - RFC 3161 timestamp requests, responses and tokens: `.tsq`, `.tsr`, `.tst` | ||
| - RFC 5544 `TimeStampedData`: `.tsd` | ||
| - OpenPGP routing and inspection: `.asc`, `.sig`, `.pgp`, `.gpg` | ||
|
|
||
| The renderer uses content detection as well as extensions. An `.asc` file can therefore be classified as a message, detached signature, cleartext-signed message, public key or private key instead of being treated as a single fixed format. | ||
|
|
||
| ASiC, ERS, PAdES, XMLDSig/XAdES and JWS/JAdES remain outside the current implementation. | ||
|
|
||
| ## Optional registration | ||
|
|
||
| ```ts | ||
| import { signatureRenderer } from '@file-viewer/renderer-signature'; | ||
|
|
||
| const options = { | ||
| rendererMode: 'replace', | ||
| renderers: [signatureRenderer], | ||
| }; | ||
| ``` | ||
|
|
||
| To preview extracted PDF or literal data, compose the signature renderer with the relevant optional renderer: | ||
|
|
||
| ```ts | ||
| import { pdfRenderer } from '@file-viewer/renderer-pdf'; | ||
| import { signatureRenderer } from '@file-viewer/renderer-signature'; | ||
|
|
||
| const options = { | ||
| rendererMode: 'replace', | ||
| renderers: [signatureRenderer, pdfRenderer], | ||
| }; | ||
| ``` | ||
|
|
||
| `@file-viewer/preset-all` includes this renderer explicitly, but `@file-viewer/core` does not import it. | ||
|
|
||
| ## OpenPGP backend | ||
|
|
||
| OpenPGP is implemented with rPGP (`pgp` crate `0.20.0`) compiled to WebAssembly. The renderer therefore uses the Rust rPGP backend directly; no additional JavaScript cryptography dependency, GnuPG executable, keyserver integration or server-side conversion is required. | ||
|
|
||
| The loading path is deliberately lazy: | ||
|
|
||
| ```text | ||
| File Viewer starts | ||
| → no rPGP Worker or WASM is loaded | ||
| → an OpenPGP file is routed to renderer-signature | ||
| → ./openpgp/client.js is dynamically imported | ||
| → signature.worker.js is created | ||
| → the Worker dynamically imports rpgp_wrapper.js | ||
| → rpgp_wrapper_bg.wasm is initialized inside the Worker | ||
| ``` | ||
|
|
||
| The Rust wrapper intentionally exposes only three operations: | ||
|
|
||
| ```text | ||
| classify_openpgp | ||
| inspect_openpgp | ||
| verify_detached_signature | ||
| ``` | ||
|
|
||
| It does not expose the low-level rPGP object model to JavaScript. | ||
|
|
||
| ### OpenPGP scope | ||
|
|
||
| The current backend supports classification and bounded inspection of armored or binary OpenPGP messages, detached signatures, public keys, private-key blocks and unencrypted literal-data messages. Detached signatures can be verified with host/user-supplied public keys. Safely bounded unencrypted literal data can be passed to File Viewer's nested renderer mechanism. | ||
|
|
||
| Encrypted messages are inspection-only. Compressed messages are not recursively expanded unless a future implementation can enforce strict decompressed-output limits. Private-key blocks expose only public metadata derived from the key; secret MPIs, private scalars, passphrases and session keys are never returned to TypeScript. | ||
|
|
||
| Signing, key generation, private-key unlocking and message decryption are intentionally not exposed in this phase. | ||
|
|
||
| Host applications may supply public keys with `options.signature.openPgpPublicKeys`. Detached original content continues to use `options.signature.originalContent`. | ||
|
|
||
| ## Default OpenPGP resource limits | ||
|
|
||
| The browser client applies conservative defaults before sending work to WASM: | ||
|
|
||
| | Limit | Default | | ||
| | --- | ---: | | ||
| | input | 32 MiB | | ||
| | extracted output | 16 MiB | | ||
| | packet count | 4096 | | ||
| | nesting depth | 16 | | ||
| | user IDs | 128 | | ||
| | subkeys | 128 | | ||
| | signatures | 256 | | ||
|
|
||
| They can be overridden with `options.signature.openPgpLimits`. The Rust boundary revalidates input size and bounds returned literal data. No untrusted input is intentionally processed on the main UI thread beyond lightweight routing hints. | ||
|
|
||
| ## CMS and timestamp behavior | ||
|
|
||
| The existing browser-local CMS/timestamp implementation can inspect CMS `SignedData`, certificate-only containers and CRLs, parse DER and CMS PEM, recognize CAdES `signingCertificateV2`, verify supported RSA/ECDSA signatures using Web Crypto, compare detached `messageDigest` values, inspect RFC 3161 requests/responses/tokens, and inspect RFC 5544 `TimeStampedData` with embedded or external content. | ||
|
|
||
| External RFC 5544 `dataUri` values are displayed as untrusted metadata and are never fetched automatically. | ||
|
|
||
| ## Security and validation boundary | ||
|
|
||
| Successful parsing is not signature verification. Successful cryptographic verification is not certificate/key trust, policy compliance, identity assurance, qualified-signature status or legal validity. The issue #206 CMS/timestamp fixture CA is synthetic and deliberately untrusted. | ||
|
|
||
| The OpenPGP Worker never persists keys or file contents, never performs automatic network lookup and can be terminated through the renderer client cleanup path. The first rPGP phase avoids private-key cryptographic operations; this also avoids depending on private-key RSA operations for which upstream RustCrypto/rPGP documentation requires additional side-channel consideration. | ||
|
|
||
| ## Building the rPGP WASM backend | ||
|
|
||
| A Rust toolchain is required only when building the optional OpenPGP backend: | ||
|
|
||
| ```bash | ||
| rustup target add wasm32-unknown-unknown | ||
| cargo install wasm-bindgen-cli | ||
| pnpm --filter @file-viewer/renderer-signature build:wasm | ||
| ``` | ||
|
|
||
| `wasm-opt` is optional; when installed, the build script applies `-Oz`. The script generates `rust/Cargo.lock` if it does not exist, then performs a locked release build and reports raw and Brotli WASM size. | ||
|
|
||
| The regular TypeScript type-check does not require Rust: | ||
|
|
||
| ```bash | ||
| pnpm --filter @file-viewer/renderer-signature type-check | ||
| ``` | ||
|
|
||
| ## Verification | ||
|
|
||
| The repository contains the contributed non-secret CMS/timestamp fixture corpus under `test/fixtures/github-206-contributed`. | ||
|
|
||
| ```bash | ||
| pnpm --filter @file-viewer/renderer-signature verify:github-206 | ||
| pnpm --filter @file-viewer/renderer-signature verify:fixtures | ||
| pnpm --filter @file-viewer/renderer-signature verify:openpgp | ||
| ``` | ||
|
|
||
| `verify:openpgp` checks the lazy Worker/WASM boundary, pinned rPGP configuration, absence of GnuPG invocation, restricted wrapper API and TypeScript content-detection behavior. Runtime rPGP fixture tests require the WASM backend to be built first. | ||
|
|
||
| ## Third-party licensing | ||
|
|
||
| The Rust backend uses the permissively licensed rPGP `pgp` crate. See `THIRD_PARTY_NOTICES.md`. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding this dependency exposes signature support through the ESM preset, but the CDN/IIFE path maintains separate tables in
packages/components/web-full/src/iife.ts(lazyRendererLines) andscripts/build-iife.mjs(rendererBuilds), neither of which containssignature. Consequently the published web-full IIFE neither builds a signature renderer bundle nor maps.p7m/.p7s/timestamp/OpenPGP extensions to one, so those files remain unsupported in that advertised full-package deployment.Useful? React with 👍 / 👎.