diff --git a/core/LICENSE b/core/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/core/LICENSE @@ -0,0 +1,202 @@ + + 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 + (an example is provided in the Appendix below). + + "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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/core/NOTICE b/core/NOTICE new file mode 100644 index 0000000..b666e41 --- /dev/null +++ b/core/NOTICE @@ -0,0 +1,52 @@ +DocSigner +Copyright 2026 Resilient Software Services LLP + +This product includes software developed at Resilient Software Services LLP +(https://resilient.tech). + +Licensed under the Apache License, Version 2.0. See the LICENSE file. + +-------------------------------------------------------------------------- +Third-party material redistributed in this repository +-------------------------------------------------------------------------- + +Logo mark (assets/icon.svg, and every icon scripts/make_assets.py renders +from it) is drawn from the Lucide "signature" icon. + + Copyright (c) 2026 Lucide Contributors + + Permission to use, copy, modify, and/or distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +Lucide is a trademark of its maintainers, who do not endorse this project. + +Fonts bundled in core/docsigner_core/fonts/ are licensed under the SIL Open +Font License 1.1. Copyright holders and the full text: +core/docsigner_core/fonts/LICENSE-OFL.txt + +The logotype is set in Plus Jakarta Sans, also under the SIL Open Font +License 1.1. The one weight we ship, and the licence it travels with, are in +desktop/frontend/src/fonts/. + + Copyright 2020 The Plus Jakarta Sans Project Authors + (https://github.com/tokotype/PlusJakartaSans) + +The website serves Nunito Sans, again under the SIL Open Font License 1.1, as +the cross-platform stand-in for Avenir Next. The two weights and the licence +they travel with are in site/public/fonts/. + + Copyright 2016 The Nunito Project Authors + (https://github.com/googlefonts/nunito) + +Runtime dependencies are installed, not vendored, and carry their own +licenses (MIT, BSD, and Apache-2.0). Builds that bundle them -- the desktop +.app, .dmg and .exe -- ship those notices alongside the binary. diff --git a/core/README.md b/core/README.md index bff0000..e9e0cc2 100644 --- a/core/README.md +++ b/core/README.md @@ -1,27 +1,23 @@ # docsigner-core -The Python signing library the rest of DocSigner is built on. pyHanko does the -PDF work underneath; this package adds interrupted signing sessions (sign a hash -now, embed the signature later), PAdES / CAdES / XAdES assembly, LTV and -revocation embedding, PDF/A detection, appearance stamps, and validation. +Digital signing for Python, on top of [pyHanko](https://github.com/MatthiasValvekens/pyHanko). -It is a library, not an app. The server, host, desktop app, and the Frappe -integration all import it. +What it adds: **interrupted signing sessions** — sign a hash now, embed the +signature later — plus PAdES / CAdES / XAdES assembly, LTV and revocation +embedding, PDF/A detection, appearance stamps, and validation. -New here? Read [`../docs/core.md`](../docs/core.md) first: plain words, a flow -chart of how signing works, and the module map. - -## Install (development) - -From the repo root: +The interrupted session is the point. It lets the private key stay wherever it +lives — a USB token, an HSM, a browser — while the PDF work happens somewhere +else entirely. ```bash -pip install -e ./core # add [render] for rendering.py +pip install docsigner-core +pip install "docsigner-core[render]" # adds PDF rasterization for placement UIs ``` -## Use it +Python 3.10+, pure Python, Apache-2.0. -Two entry points cover most cases. A one-shot signature with a server-held key: +## Sign with a key you hold ```python from docsigner_core import sign_with_p12 @@ -29,7 +25,9 @@ from docsigner_core import sign_with_p12 signed = sign_with_p12(pdf_bytes, "key.p12", passphrase, options) ``` -An interrupted session, where the hash is signed elsewhere (a token, a browser): +## Sign with a key you don't + +Start the session, get a hash, sign it however you like, then complete: ```python from docsigner_core import SigningSession @@ -40,20 +38,21 @@ signed = SigningSession.complete(state, signature) ``` `state` is JSON-safe bytes (`state.to_bytes()` / `SessionState.from_bytes(...)`), -so `start` and `complete` can run in different processes. +so `start` and `complete` can run in different processes, or on different +machines, minutes apart. -Options, profiles and error codes are frozen in -[`../CONTRACTS.md`](../CONTRACTS.md). +Also exported: `validate`, `Profile`, `make_timestamper`, +`build_validation_context`, `render_page`, `page_size`, `placement_box`, +`SignerError`. -## Fonts +## Fonts for signature stamps -Five handwriting faces and one text face ship inside the package -(`docsigner_core/fonts/`, bundled through `package-data`), so a stamp renders the -same wherever the library is installed. Details in -[`docsigner_core/fonts/README.md`](docsigner_core/fonts/README.md). +Five handwriting faces and one text face ship inside the package, so a stamp +renders the same wherever it is installed — no reliance on a server having a +script font. `appearance.font` is a whitelist, because in a server it arrives from an HTTP -request. An application that owns its own font folder adds to that whitelist: +request. To add your own: ```python from docsigner_core.appearance import register_fonts @@ -61,21 +60,25 @@ from docsigner_core.appearance import register_fonts register_fonts("~/.config/myapp/fonts") # each .ttf/.otf stem becomes a slug ``` -Call it once at startup. The reference server never does, so no request can -reach a file outside the bundled five. +Call it once at startup. Without it, no request can reach a file outside the +bundled six. -## Pack it +## Documentation -Not published to PyPI. Everything in this repo consumes it by path -(`pip install -e ./core`), and the Frappe app pins it as a pip dependency. To -build a wheel and sdist anyway: +| | | +|---|---| +| How signing works, with a flow chart | [docs/core.md](https://github.com/resilient-tech/docsigner/blob/HEAD/docs/core.md) | +| Options, profiles and error codes, frozen | [CONTRACTS.md](https://github.com/resilient-tech/docsigner/blob/HEAD/CONTRACTS.md) | +| The rest of DocSigner | [the repository](https://github.com/resilient-tech/docsigner) | -```bash -pip install build -python -m build core # -> core/dist/docsigner_core-*.whl, *.tar.gz -``` +This is a library, not an application. The DocSigner server, token host, desktop +app and Frappe integration all import it. + +--- -## Tests +## Working on it + +From a clone of the repo: ```bash pip install -e ./core @@ -85,3 +88,6 @@ pytest core/tests No hardware needed: token signing is exercised against a fake PKCS#11 layer that does real RSA math. + +Releases are built and published from the repo — +[docs/releasing.md](https://github.com/resilient-tech/docsigner/blob/HEAD/docs/releasing.md). diff --git a/core/pyproject.toml b/core/pyproject.toml index cec347a..864bafe 100644 --- a/core/pyproject.toml +++ b/core/pyproject.toml @@ -6,6 +6,10 @@ build-backend = "setuptools.build_meta" name = "docsigner-core" version = "0.1.0" license = "Apache-2.0" +# Apache-2.0 asks for the licence and the NOTICE to travel with the code, and +# packaging tools cannot reach above the project directory to the repo root -- +# so core/ keeps its own copies. test_docs.py fails if they drift. +license-files = ["LICENSE", "NOTICE"] description = "Digital signing on top of pyHanko: interrupted signing sessions, PAdES/CAdES/XAdES, validation" # The README becomes the PyPI project page, so it is packaging, not decoration. readme = "README.md" @@ -30,8 +34,12 @@ dependencies = [ "qrcode>=7", ] +# Shown as links in PyPI's sidebar. Homepage points at core/ rather than the +# repo root: this is one package out of a monorepo, and the root is about the +# whole product. Repository stays the root, which is what a clone needs. [project.urls] -Homepage = "https://github.com/resilient-tech/docsigner" +Homepage = "https://github.com/resilient-tech/docsigner/tree/HEAD/core" +Documentation = "https://github.com/resilient-tech/docsigner/blob/HEAD/docs/core.md" Repository = "https://github.com/resilient-tech/docsigner" Issues = "https://github.com/resilient-tech/docsigner/issues" diff --git a/core/tests/test_docs.py b/core/tests/test_docs.py index 9215be8..13e5d06 100644 --- a/core/tests/test_docs.py +++ b/core/tests/test_docs.py @@ -55,3 +55,21 @@ def test_site_links_to_files_that_exist(path): f"site/src/config.ts links to {path}, which is not in the repo. " "Fix the link or restore the file." ) + + +# core/ ships to PyPI, and Apache-2.0 asks for the licence and the NOTICE to +# travel with the code. Packaging tools cannot reach above the project +# directory, so core/ carries its own copies -- which is a copy, and copies +# drift. Same rot as a module map, checked the same way. +@pytest.mark.parametrize("name", ["LICENSE", "NOTICE"]) +def test_core_ships_the_repo_licence(name): + original = (REPO / name).read_bytes() + shipped = REPO / "core" / name + assert shipped.is_file(), ( + f"core/{name} is missing. It is listed in core/pyproject.toml's " + f"license-files, so the wheel would be built without it." + ) + assert shipped.read_bytes() == original, ( + f"core/{name} has drifted from {name} at the repo root. " + f"Copy the root one over it." + )