fherma-lang 0.1.0__tar.gz

fherma_lang-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+# Virtual environments and caches
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+
+# Build artefacts
+dist/
+build/
+*.egg-info/
+
+# Scratch: scaffolds and parse results written while trying things out
+/bundle/
+/out.txt
+/parsed.json
+/*.fhk

fherma_lang-0.1.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+Versions follow [semantic versioning](https://semver.org). For this package the
+public surface is two things: the language a `.fhk` file is written in, and the
+shape of the bundle `emit` produces. A change to either is a change other people
+have to react to, and is versioned accordingly.
+
+## 0.1.0
+
+First release.
+
+- The FHERMA Kernel Language: lexer, parser, and the diagnostics named in the
+  specification (`E-LEX-1` through `E-REFINE-6`).
+- `parse` and `lex` for reading a declaration; `to_plain` and `from_plain` for
+  storing one and reading it back; `reference` for what a declaration calls
+  itself.
+- `emit` for the testing scaffold — the shared module derived from the
+  signature, and stubs for the generator, the oracle and the verifier.
+- `fherma-lang`, a command line entry point, for anything that would rather call
+  a program than import a library.

fherma_lang-0.1.0/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.

fherma_lang-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.5
+Name: fherma-lang
+Version: 0.1.0
+Summary: FHERMA Kernel Language: lexer, parser, checks and emitters
+Project-URL: Homepage, https://fherma.io
+Author: FairMath
+License: Apache-2.0
+License-File: LICENSE
+Keywords: compiler,cryptography,fhe,kernels,mlir,parser
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# fherma-lang
+
+FHERMA Kernel Language: lexer, parser and emitters. A standalone package —
+text in, structure out. It knows nothing about any platform, has no
+dependencies, and is what everything else builds on: the `fherma` command line
+tool, a server, a build script, an editor.
+
+```shell
+pip install fherma-lang
+```
+
+Most people arrive through `pip install fherma`, which brings this package along
+— the command line tool is built on it. Install it directly when you want the
+language and nothing else: a server validating a signature, an editor, a build
+step.
+
+## The language in one example
+
+A **kernel** states a computational problem as generally as it is true. A
+**specification** refines it: it settles the types, names the dimensions and adds
+whatever the representation needs.
+
+```text
+kernel poly_mult<T: Numeric, N: uint>(
+    %a: tensor<N x T>,
+    %b: tensor<N x T>,
+) -> %c: tensor<N x T>
+```
+
+```text
+spec rlwe 1.0.0 "Cyclotomic, at RLWE parameters" {
+    kernel poly_mult<T: i64, N: uint, L: uint, q: uint>(
+        %a: tensor<N x L x T>,
+        %b: tensor<N x L x T>,
+    ) -> %c: tensor<N x L x T>
+}
+```
+
+Both are the same production: a specification is a header wrapping a kernel
+declaration. What tells them apart is not syntax but how much they leave open.
+
+## Reading a declaration
+
+```console
+$ fherma-lang parse sig.fhk
+specification  rlwe 1.0.0
+               Cyclotomic, at RLWE parameters
+refines kernel poly_mult
+parameters
+    T          i64
+    N          uint
+    L          uint
+    q          uint
+arguments
+    %a         tensor<N x L x T>
+    %b         tensor<N x L x T>
+results
+    %c         tensor<N x L x T>
+```
+
+`--json` prints the parse result for another tool to consume, and it can be fed
+straight back in — see below.
+
+Failures carry a code from the specification of the language, the place, and
+something to do about it:
+
+```console
+$ fherma-lang parse bad.fhk
+E-TYPE-1: Field is neither a class nor a type of this language
+  line 1, column 13
+  kernel f<T: Field>(%x: T) -> %y: T
+              ^
+  Classes are Numeric, Integer, Real. Types are i8…i64, f8…f64, index, uint, int, real.
+```
+
+## Emitting a scaffold
+
+A scaffold is a pure function of a declaration: the same signature always gives
+the same tree, which is what lets a command line tool and a web button hand out
+identical bundles without coordinating.
+
+```console
+$ fherma-lang emit --testing sig.fhk
+testing scaffold in poly_mult-rlwe-1.0.0
+    fherma.py        3729  generated
+    generate.py       558  yours
+    oracle.py         504  yours
+    verify.py         625  yours
+    README.md         889  generated
+```
+
+`fherma.py` holds the types derived from the signature — `Point`, `Inputs`,
+`Outputs` — along with the deterministic `Stream` and the codec. The three stubs
+are where an author writes the generator, the oracle and the verifier.
+
+Name the parts to scaffold one or two of them:
+
+```shell
+fherma-lang emit --testing sig.fhk --oracle --verifier
+```
+
+Either a declaration or a stored parse result will do; the tool tells them apart
+by looking at the first character, and does the rest:
+
+```shell
+fherma-lang parse --json sig.fhk > parsed.json
+fherma-lang emit --testing parsed.json --out ./bundle
+```
+
+## As a library
+
+```python
+from fherma_lang import emit, parse
+
+declaration = parse(open("sig.fhk").read())
+for file in emit(declaration, kind="testing", parts=["oracle"]):
+    print(file.path, file.generated)
+```
+
+```python
+from fherma_lang import reference                    # "poly_mult/rlwe@1.0.0"
+from fherma_lang.serde import from_plain, to_plain   # a declaration to JSON and back
+```
+
+`reference` is what a declaration calls itself, and there is one definition of
+it because more than one thing depends on the exact string: it keys the
+deterministic stream, and a bundle records it as its own origin.
+
+## What is refused, and why
+
+A scaffold needs every parameter settled, because there is no honest Python type
+for an open one. This is about abstraction, not about the shape of the
+declaration: a kernel that pins all of its parameters scaffolds fine.
+
+```text
+E-SPEC-3: parameter T is constrained to Numeric rather than settled
+  A class admits many types; pick one, as in <T: i64>.
+```
+
+Secrecy is a different matter. Where a signature hides a value, the scaffold sees
+through it: the generator and the oracle always work in cleartext, since
+encryption — where there is any — happens between them and the run.
+
+## Exit codes
+
+```text
+0  done          1  the declaration was rejected          2  called wrongly
+```

fherma_lang-0.1.0/README.md

@@ -0,0 +1,148 @@
+# fherma-lang
+
+FHERMA Kernel Language: lexer, parser and emitters. A standalone package —
+text in, structure out. It knows nothing about any platform, has no
+dependencies, and is what everything else builds on: the `fherma` command line
+tool, a server, a build script, an editor.
+
+```shell
+pip install fherma-lang
+```
+
+Most people arrive through `pip install fherma`, which brings this package along
+— the command line tool is built on it. Install it directly when you want the
+language and nothing else: a server validating a signature, an editor, a build
+step.
+
+## The language in one example
+
+A **kernel** states a computational problem as generally as it is true. A
+**specification** refines it: it settles the types, names the dimensions and adds
+whatever the representation needs.
+
+```text
+kernel poly_mult<T: Numeric, N: uint>(
+    %a: tensor<N x T>,
+    %b: tensor<N x T>,
+) -> %c: tensor<N x T>
+```
+
+```text
+spec rlwe 1.0.0 "Cyclotomic, at RLWE parameters" {
+    kernel poly_mult<T: i64, N: uint, L: uint, q: uint>(
+        %a: tensor<N x L x T>,
+        %b: tensor<N x L x T>,
+    ) -> %c: tensor<N x L x T>
+}
+```
+
+Both are the same production: a specification is a header wrapping a kernel
+declaration. What tells them apart is not syntax but how much they leave open.
+
+## Reading a declaration
+
+```console
+$ fherma-lang parse sig.fhk
+specification  rlwe 1.0.0
+               Cyclotomic, at RLWE parameters
+refines kernel poly_mult
+parameters
+    T          i64
+    N          uint
+    L          uint
+    q          uint
+arguments
+    %a         tensor<N x L x T>
+    %b         tensor<N x L x T>
+results
+    %c         tensor<N x L x T>
+```
+
+`--json` prints the parse result for another tool to consume, and it can be fed
+straight back in — see below.
+
+Failures carry a code from the specification of the language, the place, and
+something to do about it:
+
+```console
+$ fherma-lang parse bad.fhk
+E-TYPE-1: Field is neither a class nor a type of this language
+  line 1, column 13
+  kernel f<T: Field>(%x: T) -> %y: T
+              ^
+  Classes are Numeric, Integer, Real. Types are i8…i64, f8…f64, index, uint, int, real.
+```
+
+## Emitting a scaffold
+
+A scaffold is a pure function of a declaration: the same signature always gives
+the same tree, which is what lets a command line tool and a web button hand out
+identical bundles without coordinating.
+
+```console
+$ fherma-lang emit --testing sig.fhk
+testing scaffold in poly_mult-rlwe-1.0.0
+    fherma.py        3729  generated
+    generate.py       558  yours
+    oracle.py         504  yours
+    verify.py         625  yours
+    README.md         889  generated
+```
+
+`fherma.py` holds the types derived from the signature — `Point`, `Inputs`,
+`Outputs` — along with the deterministic `Stream` and the codec. The three stubs
+are where an author writes the generator, the oracle and the verifier.
+
+Name the parts to scaffold one or two of them:
+
+```shell
+fherma-lang emit --testing sig.fhk --oracle --verifier
+```
+
+Either a declaration or a stored parse result will do; the tool tells them apart
+by looking at the first character, and does the rest:
+
+```shell
+fherma-lang parse --json sig.fhk > parsed.json
+fherma-lang emit --testing parsed.json --out ./bundle
+```
+
+## As a library
+
+```python
+from fherma_lang import emit, parse
+
+declaration = parse(open("sig.fhk").read())
+for file in emit(declaration, kind="testing", parts=["oracle"]):
+    print(file.path, file.generated)
+```
+
+```python
+from fherma_lang import reference                    # "poly_mult/rlwe@1.0.0"
+from fherma_lang.serde import from_plain, to_plain   # a declaration to JSON and back
+```
+
+`reference` is what a declaration calls itself, and there is one definition of
+it because more than one thing depends on the exact string: it keys the
+deterministic stream, and a bundle records it as its own origin.
+
+## What is refused, and why
+
+A scaffold needs every parameter settled, because there is no honest Python type
+for an open one. This is about abstraction, not about the shape of the
+declaration: a kernel that pins all of its parameters scaffolds fine.
+
+```text
+E-SPEC-3: parameter T is constrained to Numeric rather than settled
+  A class admits many types; pick one, as in <T: i64>.
+```
+
+Secrecy is a different matter. Where a signature hides a value, the scaffold sees
+through it: the generator and the oracle always work in cleartext, since
+encryption — where there is any — happens between them and the run.
+
+## Exit codes
+
+```text
+0  done          1  the declaration was rejected          2  called wrongly
+```

fherma_lang-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "fherma-lang"
+version = "0.1.0"
+description = "FHERMA Kernel Language: lexer, parser, checks and emitters"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "Apache-2.0" }
+authors = [{ name = "FairMath" }]
+keywords = ["fhe", "cryptography", "compiler", "parser", "kernels", "mlir"]
+
+# What the index shows, and what people filter on. "3 - Alpha" is the honest
+# reading of a language whose specification is younger than its parser.
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Security :: Cryptography",
+  "Topic :: Software Development :: Compilers",
+  "Topic :: Scientific/Engineering :: Mathematics",
+  "Typing :: Typed",
+]
+
+# The language is the platform's core asset, and it has exactly one
+# implementation. Both the CLI and the backend depend on this package, which is
+# why it carries no dependencies of its own: nothing here should ever constrain
+# what either of them can install.
+dependencies = []
+
+# No `Source`: the repository is private, and a link that asks the reader to log
+# in and then tells them no is worse than no link. What the language *is* — the
+# normative specification, the diagnostics — belongs on the site, and that is
+# where a reader is sent.
+[project.urls]
+Homepage = "https://fherma.io"
+
+[project.scripts]
+# A machine-facing entry point. The backend calls this rather than reimplementing
+# the language in TypeScript.
+fherma-lang = "fherma_lang.__main__:main"
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "ruff>=0.6"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/fherma_lang"]
+
+[tool.ruff]
+line-length = 96
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

fherma_lang-0.1.0/src/fherma_lang/__init__.py

@@ -0,0 +1,29 @@
+"""FHERMA Kernel Language — a standalone tool for the language itself.
+
+Text in, structure out. It knows nothing about any platform, and is used by the
+CLI, by servers, by CI and by anything else that needs to read a signature.
+"""
+
+from .ast import (  # noqa: F401
+    Binding,
+    Bound,
+    Declaration,
+    KernelDecl,
+    Parameter,
+    Scalar,
+    Secret,
+    SpecDecl,
+    Tensor,
+    Type,
+    TypeVar,
+    reference,
+    satisfies,
+    strip_secret,
+)
+from .emit import File, emit  # noqa: F401
+from .errors import Diagnostic, LanguageError  # noqa: F401
+from .lex import lex  # noqa: F401
+from .parse import parse  # noqa: F401
+
+__all__ = ["parse", "lex", "emit", "File", "reference", "LanguageError", "Diagnostic"]
+__version__ = "0.1.0"