Metadata-Version: 2.1
Name: python-relic
Version: 0.2.1
Summary: Python bindings for the relic toolkit
Home-page: https://github.com/sebastinas/pyrelic
Author: Sebastian Ramacher
Author-email: sebastian.ramacher@ait.ac.at
License: MIT
Description: # Python bindings for relic
        
        `python-relic` (`pyrelic` for short) provides Python bindings for
        [relic](https://github.com/relic-toolkit/relic). Note though, that the bindings are driven by my
        personal needs and they do not cover the full `relic` API.
        
        ## Dependencies
        
        `pyrelic` requires the following dependencies to successfully build and install:
        * `relic >= 0.5.0` with pairing support enabled.
        * `Cython >= 0.28` (optional, only for building). If Cython is not available, the C files are not
          regenerated from their source.
        * `pkgconfig` (optional, only for building). If `pkgconfig` is not available, the build system
          assumes that `relic` can be linked as `-lrelic`.
        
        ## Quick installation guide
        
        If you are running Ubuntu 20.04, the easiest way to install `pyrelic` is via my
        [PPA](https://launchpad.net/~s-ramacher/+archive/ubuntu/ait):
        ```sh
        sudo add-apt-repository -u ppa:s-ramacher/ait
        sudo apt install python3-pyrelic
        ```
        It comes with a prebuilt version of `relic` configured for the pairing-friendly BLS12-381 curve.
        
        Otherwise, `pyrelic` can be installed via `pip`:
        ```sh
        pip install python-relic
        ```
        or by running:
        ```sh
        python3 setup.py install
        ```
        Note though that these two approaches require a pairing-enabled build of `relic` to be available.
        
        ## Examples
        
        `pyrelic` includes some examples that demonstrate the use of the module and also showcases some
        pairing-based schemes:
        * `examples/bls.py`: Implements the [Boneh-Lynn-Shacham signature
          scheme](https://doi.org/10.1007%2Fs00145-004-0314-9).
        * `examples/bfibe.py`: Implements the [Boneh-Franklin identity-based encryption
          scheme](https://doi.org/10.1007/3-540-44647-8_13) (BasicIdent).
        * `examples/hpra.py`: Implements [homomorphic proxy
          re-authenticators](https://doi.org/10.1007/978-3-319-70972-7_7) for linear functions.
        * `examples/bfe.py`: Imeplemnts [Bloom Filter KEM](https://doi.org/10.1007/978-3-319-78372-7_14)
          based on the BF IBE.
        
        ## License
        
        The code is licensed under the MIT license.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
