commit 3d24f0c813c31c7faad449e57ac4854d5b616249 Author: Richard Ramos Date: Fri Mar 31 17:59:45 2023 -0400 initial commit diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..ddce3de --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "zerokit"] + path = zerokit + url = git@github.com:vacp2p/zerokit.git diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bdb8bb8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 (c) 2022 Status Research & Development GmbH + + 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/Makefile b/Makefile new file mode 100644 index 0000000..bbe0e77 --- /dev/null +++ b/Makefile @@ -0,0 +1,9 @@ +.PHONY: rlnlib + +SHELL := bash # the shell used internally by Make + +GOBIN ?= $(shell which go) + +rlnlib: + scripts/build.sh + cd zerokit/rln && cbindgen --config ../../cbindgen.toml --crate rln --output ../../rln/librln.h --lang c diff --git a/README.md b/README.md new file mode 100644 index 0000000..249c0eb --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +This project is used in https://github.com/waku-org/go-zerokit-rln to bypass the 500mb limit for go modules +``` +git clone https://github.com/waku-org/go-zerokit-rln_apple +cd go-zerokit-rln_apple +git submodule init +git submodule update --recursive +make +``` diff --git a/cbindgen.toml b/cbindgen.toml new file mode 100644 index 0000000..e69de29 diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..f2aecef --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/waku-org/go-zerokit-rln-apple + +go 1.19 diff --git a/rln/librln.h b/rln/librln.h new file mode 100644 index 0000000..b7c6a71 --- /dev/null +++ b/rln/librln.h @@ -0,0 +1,88 @@ +#include +#include +#include +#include + +#define TEST_PARAMETERS_INDEX 2 + +/** + * The RLN object. + * + * It implements the methods required to update the internal Merkle Tree, generate and verify RLN ZK proofs. + * + * I/O is mostly done using writers and readers implementing `std::io::Write` and `std::io::Read`, respectively. + */ +typedef struct RLN RLN; + +/** + * Buffer struct is taken from + * + * + * Also heavily inspired by + */ +typedef struct Buffer { + const uint8_t *ptr; + uintptr_t len; +} Buffer; + +bool new(uintptr_t tree_height, const struct Buffer *input_buffer, struct RLN **ctx); + +bool new_with_params(uintptr_t tree_height, + const struct Buffer *circom_buffer, + const struct Buffer *zkey_buffer, + const struct Buffer *vk_buffer, + struct RLN **ctx); + +bool set_tree(struct RLN *ctx, uintptr_t tree_height); + +bool delete_leaf(struct RLN *ctx, uintptr_t index); + +bool set_leaf(struct RLN *ctx, uintptr_t index, const struct Buffer *input_buffer); + +bool set_next_leaf(struct RLN *ctx, const struct Buffer *input_buffer); + +bool set_leaves_from(struct RLN *ctx, uintptr_t index, const struct Buffer *input_buffer); + +bool init_tree_with_leaves(struct RLN *ctx, const struct Buffer *input_buffer); + +bool get_root(const struct RLN *ctx, struct Buffer *output_buffer); + +bool get_proof(const struct RLN *ctx, uintptr_t index, struct Buffer *output_buffer); + +bool prove(struct RLN *ctx, const struct Buffer *input_buffer, struct Buffer *output_buffer); + +bool verify(const struct RLN *ctx, const struct Buffer *proof_buffer, bool *proof_is_valid_ptr); + +bool generate_rln_proof(struct RLN *ctx, + const struct Buffer *input_buffer, + struct Buffer *output_buffer); + +bool verify_rln_proof(const struct RLN *ctx, + const struct Buffer *proof_buffer, + bool *proof_is_valid_ptr); + +bool verify_with_roots(const struct RLN *ctx, + const struct Buffer *proof_buffer, + const struct Buffer *roots_buffer, + bool *proof_is_valid_ptr); + +bool key_gen(const struct RLN *ctx, struct Buffer *output_buffer); + +bool seeded_key_gen(const struct RLN *ctx, + const struct Buffer *input_buffer, + struct Buffer *output_buffer); + +bool extended_key_gen(const struct RLN *ctx, struct Buffer *output_buffer); + +bool seeded_extended_key_gen(const struct RLN *ctx, + const struct Buffer *input_buffer, + struct Buffer *output_buffer); + +bool recover_id_secret(const struct RLN *ctx, + const struct Buffer *input_proof_buffer_1, + const struct Buffer *input_proof_buffer_2, + struct Buffer *output_buffer); + +bool hash(const struct Buffer *input_buffer, struct Buffer *output_buffer); + +bool poseidon_hash(const struct Buffer *input_buffer, struct Buffer *output_buffer); diff --git a/rln/link.go b/rln/link.go new file mode 100644 index 0000000..cbb5e51 --- /dev/null +++ b/rln/link.go @@ -0,0 +1,9 @@ +package rln + +/* +#cgo LDFLAGS:-lrln -ldl -lm +#cgo darwin,386,!ios LDFLAGS:-L${SRCDIR}/../libs/i686-apple-darwin +#cgo darwin,arm64,!ios LDFLAGS:-L${SRCDIR}/../libs/aarch64-apple-darwin +#cgo darwin,amd64,!ios LDFLAGS:-L${SRCDIR}/../libs/x86_64-apple-darwin +*/ +import "C" diff --git a/rln/wrapper.go b/rln/wrapper.go new file mode 100644 index 0000000..1a5e336 --- /dev/null +++ b/rln/wrapper.go @@ -0,0 +1,148 @@ +package rln + +/* +#include "./librln.h" +*/ +import "C" +import ( + "errors" + "unsafe" +) + +// RLN represents the context used for rln. +type RLN struct { + ptr *C.RLN +} + +func toCBufferPtr(input []byte) *C.Buffer { + buf := toBuffer(input) + + size := int(unsafe.Sizeof(buf)) + in := (*C.Buffer)(C.malloc(C.size_t(size))) + *in = buf + + return in +} + +// toBuffer converts the input to a buffer object that is used to communicate data with the rln lib +func toBuffer(data []byte) C.Buffer { + dataPtr, dataLen := sliceToPtr(data) + return C.Buffer{ + ptr: dataPtr, + len: C.uintptr_t(dataLen), + } +} + +func sliceToPtr(slice []byte) (*C.uchar, C.int) { + if len(slice) == 0 { + return nil, 0 + } else { + return (*C.uchar)(unsafe.Pointer(&slice[0])), C.int(len(slice)) + } +} + +func NewWithParams(depth int, wasm []byte, zkey []byte, verifKey []byte) (*RLN, error) { + wasmBuffer := toCBufferPtr(wasm) + zkeyBuffer := toCBufferPtr(zkey) + verifKeyBuffer := toCBufferPtr(verifKey) + r := &RLN{} + + if !bool(C.new_with_params(C.uintptr_t(depth), wasmBuffer, zkeyBuffer, verifKeyBuffer, &r.ptr)) { + return nil, errors.New("failed to initialize") + } + + return r, nil +} + +func NewWithFolder(depth int, resourcesFolderPath string) (*RLN, error) { + r := &RLN{} + pathBuffer := toCBufferPtr([]byte(resourcesFolderPath)) + if !bool(C.new(C.uintptr_t(depth), pathBuffer, &r.ptr)) { + return nil, errors.New("failed to initialize") + } + return r, nil +} + +func (r *RLN) ExtendedKeyGen() []byte { + buffer := toBuffer([]byte{}) + if !bool(C.extended_key_gen(r.ptr, &buffer)) { + return nil + } + return C.GoBytes(unsafe.Pointer(buffer.ptr), C.int(buffer.len)) +} + +func (r *RLN) Hash(input []byte) ([]byte, error) { + inpBuff := toCBufferPtr(input) + + var output []byte + out := toBuffer(output) + + if !bool(C.hash(inpBuff, &out)) { + return nil, errors.New("failed to hash") + } + + return C.GoBytes(unsafe.Pointer(out.ptr), C.int(out.len)), nil +} + +func (r *RLN) PoseidonHash(input []byte) ([]byte, error) { + inpBuff := toCBufferPtr(input) + + var output []byte + out := toBuffer(output) + + if !bool(C.poseidon_hash(inpBuff, &out)) { + return nil, errors.New("error in poseidon hash") + } + + return C.GoBytes(unsafe.Pointer(out.ptr), C.int(out.len)), nil +} + +func (r *RLN) GenerateRLNProof(input []byte) ([]byte, error) { + inputBuffer := toCBufferPtr(input) + + var output []byte + out := toBuffer(output) + + if !bool(C.generate_rln_proof(r.ptr, inputBuffer, &out)) { + return nil, errors.New("could not generate the proof") + } + + return C.GoBytes(unsafe.Pointer(out.ptr), C.int(out.len)), nil +} + +func (r *RLN) VerifyWithRoots(input []byte, roots []byte) (bool, error) { + proofBuf := toCBufferPtr(input) + rootBuf := toCBufferPtr(roots) + + res := C.bool(false) + if !bool(C.verify_with_roots(r.ptr, proofBuf, rootBuf, &res)) { + return false, errors.New("could not verify with roots") + } + + return bool(res), nil +} + +func (r *RLN) SetNextLeaf(idcommitment []byte) bool { + buff := toCBufferPtr(idcommitment[:]) + return bool(C.set_next_leaf(r.ptr, buff)) +} + +func (r *RLN) SetLeavesFrom(index uint, idcommitments []byte) bool { + idCommBuffer := toCBufferPtr(idcommitments) + return bool(C.set_leaves_from(r.ptr, C.uintptr_t(index), idCommBuffer)) +} + +func (r *RLN) DeleteLeaf(index uint) bool { + return bool(C.delete_leaf(r.ptr, C.uintptr_t(index))) +} + +func (r *RLN) GetRoot() ([]byte, error) { + var output []byte + out := toBuffer(output) + + if !bool(C.get_root(r.ptr, &out)) { + return nil, errors.New("could not get the root") + } + + return C.GoBytes(unsafe.Pointer(out.ptr), C.int(out.len)), nil +} diff --git a/scripts/build.sh b/scripts/build.sh new file mode 100755 index 0000000..03e7e43 --- /dev/null +++ b/scripts/build.sh @@ -0,0 +1,32 @@ +#!/bin/bash + +export RUSTFLAGS="-Ccodegen-units=1" + +rustup default stable + +cargo install cross --git https://github.com/cross-rs/cross --branch main + +pushd zerokit/rln + +cargo clean + +cargo install cargo-lipo +rustup target add aarch64-apple-ios x86_64-apple-ios x86_64-apple-darwin aarch64-apple-darwin +cargo build --release --target=x86_64-apple-darwin --lib +cargo build --release --target=aarch64-apple-darwin --lib +#cargo build --release --target=x86_64-apple-ios --lib +#cargo build --release --target=aarch64-apple-ios --lib +cargo lipo --release + +popd + +DIRECTORY=./libs +TOOLS_DIR=`dirname $0` +COMPILE_DIR=${TOOLS_DIR}/../zerokit/target +rm -rf $COMPILE_DIR/x86_64-apple-ios $COMPILE_DIR/aarch64-apple-ios +for platform in `ls ${COMPILE_DIR} | grep -v release | grep -v debug | grep -v CACHEDIR.TAG` +do + PLATFORM_DIR=${DIRECTORY}/$platform + mkdir -p ${PLATFORM_DIR} + cp ${COMPILE_DIR}/$platform/release/librln.a ${PLATFORM_DIR} +done diff --git a/zerokit b/zerokit new file mode 160000 index 0000000..2e868d6 --- /dev/null +++ b/zerokit @@ -0,0 +1 @@ +Subproject commit 2e868d6cbf68ee0f87975a89a25aa0333971d398