diff --git a/README.md b/README.md index 935a348..64aa336 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ [![DOI](https://zenodo.org/badge/285924323.svg)](https://zenodo.org/badge/latestdoi/285924323) + # Mercurial-Signatures -We implement Delegatable Anonymous Credentials in python using Mercurial Signatures following E. Crites's [dissertation](https://doi.org/10.26300/tj7d-3h94). The implementation itself relies on the [miracl/core](https://github.com/burkh4rt/miracl-core) cryptographic library, in particular on its BN-254 pairing-friendly curve implementation and related utility functions (cf. [Barreto \& Naehrig](https://eprint.iacr.org/2005/133)). +We implement Delegatable Anonymous Credentials in python using Mercurial +Signatures following E. Crites's +[dissertation](https://doi.org/10.26300/tj7d-3h94). The implementation itself +relies on the [miracl/core](https://github.com/burkh4rt/miracl-core) +cryptographic library, in particular on its BN-254 pairing-friendly curve +implementation and related utility functions (cf. +[Barreto \& Naehrig](https://eprint.iacr.org/2005/133)). -The code is mainly intended to be proof-of-concept, following E.C.'s Section 3.2 for the construction of a mercurial signature scheme from a type III bilinear pairing and then Section 4.3 for the construction of delegatable anonymous credentials using said signature scheme. The C/C++ and rust code only implements Mercurial Signatures (not credentials). +The code is mainly intended to be proof-of-concept, following E.C.'s Section +3.2 for the construction of a mercurial signature scheme from a type III +bilinear pairing and then Section 4.3 for the construction of delegatable +anonymous credentials using said signature scheme. The C/C++ and rust code only +implements Mercurial Signatures (not credentials). diff --git a/c/README.md b/c/README.md new file mode 100644 index 0000000..c53352c --- /dev/null +++ b/c/README.md @@ -0,0 +1,8 @@ +## c code + +Example usage, with docker: + +```sh +docker build -t merc-sigs-c . +docker run merc-sigs +``` diff --git a/c/dockerfile b/c/dockerfile index d696ad9..90f6252 100644 --- a/c/dockerfile +++ b/c/dockerfile @@ -6,7 +6,7 @@ WORKDIR /usr/ RUN apt-get update \ && apt-get install -y --no-install-recommends cmake \ && git clone https://github.com/burkh4rt/miracl-core.git \ - && git --git-dir=./miracl-core/.git checkout -fq 0f80745 \ + && git -C miracl-core checkout -fq 0f80745 \ && mkdir ./miracl_core_c_bn254/ \ && cp ./miracl-core/c/* ./miracl_core_c_bn254/ \ && rm -rf ./miracl-core/ \ @@ -21,4 +21,4 @@ COPY . . RUN mv miracl_core_c_bn254-CMakeLists.txt ./miracl_core_c_bn254/CMakeLists.txt \ && cmake . \ && make \ - && ./dac_hg_sigs + && ./dac_hg_sigs \ No newline at end of file diff --git a/cpp/README.md b/cpp/README.md new file mode 100644 index 0000000..010976d --- /dev/null +++ b/cpp/README.md @@ -0,0 +1,7 @@ +## c++ code + +Example usage, with docker: + +```sh +docker build -t merc-sigs-cpp . +``` diff --git a/cpp/dockerfile b/cpp/dockerfile index 8d9bc8f..b45e888 100644 --- a/cpp/dockerfile +++ b/cpp/dockerfile @@ -6,7 +6,7 @@ WORKDIR /usr/ RUN apt-get update \ && apt-get install -y --no-install-recommends cmake \ && git clone https://github.com/burkh4rt/miracl-core.git \ - && git --git-dir=./miracl-core/.git checkout -fq 0f80745 \ + && git -C miracl-core checkout -fq 0f80745 \ && mkdir ./miracl_core_cpp_bn254/ \ && cp ./miracl-core/cpp/* ./miracl_core_cpp_bn254/ \ && rm -rf ./miracl-core/ \ diff --git a/python/README.md b/python/README.md index cc6ae36..fdb40d2 100644 --- a/python/README.md +++ b/python/README.md @@ -1,7 +1,7 @@ -### python +## python code -Runs with [docker](docker.com): +Runs with docker: + +``` +docker build -t merc-sigs-python . ``` -docker build -t merc-sigs . -docker run merc-sigs -``` \ No newline at end of file diff --git a/rust/README.md b/rust/README.md new file mode 100644 index 0000000..1b9a383 --- /dev/null +++ b/rust/README.md @@ -0,0 +1,8 @@ +## rust code + +Runs with docker: + +```sh +docker build -t merc-sigs-rust . +docker run merc-sigs-rust +``` diff --git a/rust/dockerfile b/rust/dockerfile index 2881a0e..ed8401e 100644 --- a/rust/dockerfile +++ b/rust/dockerfile @@ -5,7 +5,7 @@ WORKDIR /usr/src/ ENV USER root RUN git clone https://github.com/burkh4rt/miracl-core.git \ - && git --git-dir=./miracl-core/.git checkout -fq c340052 \ + && git -C miracl-core checkout -fq c340052 \ && mkdir ./rust-core/ \ && cp ./miracl-core/rust/* ./rust-core/ \ && rm -rf ./miracl-core/ \