├── python ├── MANIFEST.in ├── test.py ├── README.md ├── setup.py ├── equihash │ └── __init__.py └── LICENSE ├── libequihash.pc.skel ├── .gitignore ├── equihash.h ├── ehwait ├── jni.cc ├── ehpuzzle ├── bench.cc ├── Makefile ├── equihash.hpp ├── LICENSE ├── README.md ├── main.c └── equihash.cc /python/MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include *.py 3 | -------------------------------------------------------------------------------- /python/test.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import equihash 4 | 5 | n=102 6 | k=5 7 | seed=b"some initial seed" 8 | sol = equihash.solve(n, k, seed) 9 | print(equihash.verify(n,k,seed,sol)) 10 | -------------------------------------------------------------------------------- /libequihash.pc.skel: -------------------------------------------------------------------------------- 1 | includedir=${prefix}/include 2 | 3 | Name: libequihash 4 | Description: Implementation of the equihash PoW protocol 5 | Version: 1.0.0 6 | Cflags: -I${includedir}/ 7 | Libs: -lequihash 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files 2 | *.slo 3 | *.lo 4 | *.o 5 | *.obj 6 | 7 | # Precompiled Headers 8 | *.gch 9 | *.pch 10 | 11 | # Compiled Dynamic libraries 12 | *.so 13 | *.dylib 14 | *.dll 15 | 16 | # Fortran module files 17 | *.mod 18 | 19 | # Compiled Static libraries 20 | *.lai 21 | *.la 22 | *.a 23 | *.lib 24 | 25 | # Executables 26 | *.exe 27 | *.out 28 | *.app 29 | bench 30 | 31 | # other 32 | .arch 33 | python/equihash/__pycache__ 34 | *.pc 35 | .zshhistory 36 | equihash 37 | -------------------------------------------------------------------------------- /equihash.h: -------------------------------------------------------------------------------- 1 | #ifndef __EQUIHASH_H 2 | #define __EQUIHASH_H 3 | 4 | #include 5 | #include 6 | 7 | const int LIST_LENGTH = 5; 8 | 9 | size_t solsize(const unsigned n, const unsigned k); 10 | int solve(const unsigned n, const unsigned k, const uint8_t *seed, const size_t seed_len, uint8_t *csol, const size_t csol_len); 11 | int verify(const unsigned n, const unsigned k, const uint8_t *seed, const size_t seed_len, const uint8_t *sol, const size_t sol_len); 12 | 13 | #endif //define __EQUIHASH_H 14 | -------------------------------------------------------------------------------- /python/README.md: -------------------------------------------------------------------------------- 1 | # pyequihash 2 | 3 | This is the python bindings for libequihash. 4 | 5 | ## installation 6 | 7 | you'll need https://github.com/stef/equihash/ 8 | which depends on libsodium. 9 | a simple `pip install pyequihash` should suffice to install the bindings. 10 | 11 | ## usage 12 | 13 | ```python 14 | import equihash 15 | 16 | # input parameters 17 | n=102 18 | k=5 19 | seed="some initial seed" 20 | # try to solve the challenge 21 | sol = equihash.solve(n, k, seed) 22 | # verify the solution 23 | print(equihash.verify(n,k,seed,sol)) 24 | ``` 25 | 26 | ## License 27 | 28 | GPLv3.0+ 29 | -------------------------------------------------------------------------------- /ehwait: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -e 4 | 5 | "${@}" 3> >( 6 | FRONTEND="${FRONTEND:-pinentry}" 7 | DATAPATH="${DATAPATH:-$HOME/.local/share/equihash}" 8 | read n k 9 | [[ -d "$DATAPATH" ]] || mkdir -p "$DATAPATH" 10 | [[ -f "$DATAPATH/$n-$k" ]] && 11 | txt="Solving this Equihash challenge will take approximately $(awk '{sum+=$1; ++n} END {printf "%.4f\n", sum/n}' $DATAPATH/$n-$k) seconds" || 12 | txt="Never saw this Equihash difficulty ($n,$k) before, unknown how long it will take.\nPlease wait." 13 | 14 | # this could also be some dbus stuff for popup notifications 15 | # or even conky or other stuff is possible whatever is prefered 16 | case "$FRONTEND" in 17 | zenity) zenity --progress --pulsate --no-cancel --title "Equihash challenge solving..." --text "$txt" & ;; 18 | pinentry) echo -ne "SETTITLE equihash challenge notification\nSETDESC $txt\nMESSAGE\n" | pinentry 1>/dev/null & ;; 19 | esac 20 | pid=$! 21 | 22 | read res || true 23 | echo "$res" >>"$DATAPATH/$n-$k" 24 | kill $pid 2>/dev/null 25 | ) 26 | -------------------------------------------------------------------------------- /python/setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | # SPDX-FileCopyrightText: 2021, Marsiske Stefan 4 | # SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | import os 7 | #from distutils.core import setup, Extension 8 | from setuptools import setup 9 | 10 | 11 | # Utility function to read the README file. 12 | # Used for the long_description. It's nice, because now 1) we have a top level 13 | # README file and 2) it's easier to type in the README file than to put a raw 14 | # string in below ... 15 | def read(fname): 16 | return open(os.path.join(os.path.dirname(__file__), fname)).read() 17 | 18 | setup(name = 'pyequihash', 19 | version = '0.2', 20 | description = 'python bindings for libequihash', 21 | license = "GPLv3", 22 | author = 'Stefan Marsiske', 23 | author_email = 'sphinx@ctrlc.hu', 24 | url = 'https://github.com/stef/equihash/python', 25 | long_description=read('README.md'), 26 | long_description_content_type="text/markdown", 27 | packages = ['equihash'], 28 | classifiers = ["Development Status :: 4 - Beta", 29 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 30 | "Topic :: Security :: Cryptography", 31 | "Topic :: Security", 32 | ], 33 | #ext_modules = [libequihash], 34 | ) 35 | -------------------------------------------------------------------------------- /jni.cc: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | extern "C" { 4 | 5 | #include "equihash.h" 6 | 7 | JNIEXPORT jbyteArray JNICALL Java_org_hsbp_equihash_Equihash_solve(JNIEnv *env, 8 | jobject ignore, jint n, jint k, jbyteArray seed) { 9 | jbyte* bufferPtrSeed = env->GetByteArrayElements(seed, NULL); 10 | const jsize seedLen = env->GetArrayLength(seed); 11 | 12 | const size_t csolLen = solsize(n, k); 13 | jbyteArray csol = env->NewByteArray(csolLen); 14 | jbyte* bufferPtrCSol = env->GetByteArrayElements(csol, NULL); 15 | 16 | int result = solve(n, k, (const uint8_t*)bufferPtrSeed, seedLen, 17 | (uint8_t*)bufferPtrCSol, csolLen); 18 | 19 | env->ReleaseByteArrayElements(csol, bufferPtrCSol, result ? 0 : JNI_ABORT); 20 | env->ReleaseByteArrayElements(seed, bufferPtrSeed, JNI_ABORT); 21 | 22 | return result ? csol : NULL; 23 | } 24 | 25 | JNIEXPORT jboolean JNICALL Java_org_hsbp_equihash_Equihash_verify(JNIEnv *env, 26 | jobject ignore, jint n, jint k, jbyteArray seed, jbyteArray sol) { 27 | jbyte* bufferPtrSeed = env->GetByteArrayElements(seed, NULL); 28 | jsize seedLen = env->GetArrayLength(seed); 29 | 30 | jbyte* bufferPtrSol = env->GetByteArrayElements( sol, NULL); 31 | jsize solLen = env->GetArrayLength( sol); 32 | 33 | int result = verify(n, k, (const uint8_t*)bufferPtrSeed, seedLen, 34 | (const uint8_t*)bufferPtrSol, solLen); 35 | 36 | env->ReleaseByteArrayElements( sol, bufferPtrSol , JNI_ABORT); 37 | env->ReleaseByteArrayElements(seed, bufferPtrSeed, JNI_ABORT); 38 | 39 | return result == 1 ? JNI_TRUE : JNI_FALSE; 40 | } 41 | 42 | } 43 | -------------------------------------------------------------------------------- /python/equihash/__init__.py: -------------------------------------------------------------------------------- 1 | """Wrapper for libequihash library 2 | 3 | Copyright (c) 2021, Marsiske Stefan. 4 | All rights reserved. 5 | 6 | This file is part of libequihash 7 | 8 | libequihash is free software: you can redistribute it and/or 9 | modify it under the terms of the GNU Lesser General Public License 10 | as published by the Free Software Foundation, either version 3 of 11 | the License, or (at your option) any later version. 12 | 13 | libequihash is distributed in the hope that it will be 14 | useful, but WITHOUT ANY WARRANTY; without even the implied 15 | warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 16 | See the GNU General Public License for more details. 17 | 18 | You should have received a copy of the GNU General Public License 19 | along with libequihash If not, see . 20 | """ 21 | 22 | import ctypes 23 | import ctypes.util 24 | from ctypes import sizeof, c_uint16, c_uint8, c_size_t, c_uint32 25 | 26 | equihashlib = ctypes.cdll.LoadLibrary(ctypes.util.find_library('equihash') or ctypes.util.find_library('libequihash')) 27 | 28 | if not equihashlib._name: 29 | raise ValueError('Unable to find libequihash') 30 | 31 | def __check(code): 32 | if code == 0: 33 | raise ValueError 34 | 35 | def solsize(n,k): 36 | return equihashlib.solsize(n,k) 37 | 38 | def solve(n, k, seed): 39 | sol_len = equihashlib.solsize(n,k) 40 | sol = ctypes.create_string_buffer(sol_len) 41 | __check(equihashlib.solve(n,k,seed,len(seed),sol,sol_len)) 42 | return sol.raw 43 | 44 | def verify(n,k,seed,sol): 45 | return equihashlib.verify(n,k,seed,len(seed),sol,len(sol)) == 1 46 | -------------------------------------------------------------------------------- /ehpuzzle: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | usage() { 6 | echo "usage:" 7 | echo "$ cat secret_key | $0 challenge n k /path/to/data >challenge" 8 | echo "$ $0 solve challenge >solution" 9 | echo "$ cat secret_key | $0 verify /path/to/challenge /path/to/solution" 10 | exit 0 11 | } 12 | 13 | challenge() { 14 | [ "${#}" -ne 3 ] && usage 15 | 16 | secret_key="$(cat)" 17 | n=$1 18 | k=$2 19 | data="$(cat "$3")" 20 | ts="$(date +%s)" 21 | sig=$(printf "%s %s %s %s" "$n" "$k" "$ts" "$data" | openssl dgst -sha256 -binary -hmac "$secret_key") 22 | printf "%s%s %s %s %s" "$sig" "$n" "$k" "$ts" "$data" 23 | } 24 | 25 | solve() { 26 | [ "${#}" -ne 1 ] && usage 27 | puzzle="$1" 28 | tail -c +33 "$puzzle" | { 29 | read -r n k ts data || true 30 | ehwait equihash solve -n "$n" -k "$k" -f "$puzzle" -s /dev/stdout 31 | } 32 | } 33 | 34 | const_cmp() { 35 | res=0 36 | for i in $(seq 0 31); do 37 | res=$((res | ($(printf "%d" "'${1:i:1}") ^ $(printf "%d" "'${2:i:1}") ) )) 38 | done 39 | return $res 40 | } 41 | #const_cmp "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" && echo ok || echo meh 42 | #const_cmp "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAb" && echo ok || echo meh 43 | #const_cmp "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" && echo ok || echo meh 44 | 45 | verify() { 46 | [ "${#}" -ne 2 ] && usage 47 | secret_key="$(cat)" 48 | puzzle="$1" 49 | solution="$2" 50 | sig="$(head -c 32 "$puzzle")" 51 | msg="$(tail -c +33 "$puzzle")" 52 | echo "$msg" | { 53 | read -r n k ts data || true 54 | sig2=$(printf "%s" "$msg" | openssl dgst -sha256 -binary -hmac "$secret_key") 55 | const_cmp "$sig" "$sig2" || { 56 | echo "error: invalid challenge" 57 | exit 1 58 | } 59 | equihash verify -v -n "$n" -k "$k" -f "$puzzle" -s "$solution" 60 | exit $? 61 | } 62 | } 63 | 64 | case "$1" in 65 | challenge) shift; challenge "${@}";; 66 | solve) shift; solve "${@}";; 67 | verify) shift; verify "${@}";; 68 | *) usage;; 69 | esac 70 | 71 | -------------------------------------------------------------------------------- /bench.cc: -------------------------------------------------------------------------------- 1 | /*Code by Dmitry Khovratovich, 2016 2 | CC0 license 3 | */ 4 | #include "equihash.hpp" 5 | extern "C" { 6 | #include "equihash.h" 7 | } 8 | 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | #include 16 | 17 | using namespace _POW; 18 | 19 | extern "C" { 20 | void bench(const uint32_t n, const uint32_t k, const uint32_t iter, const int verbose, const size_t seed_len, uint8_t *seed); 21 | } 22 | 23 | void bench(const uint32_t n, const uint32_t k, const uint32_t iter, const int verbose, const size_t seed_len, uint8_t *seed) { 24 | //printf("N:\t%" PRIu32 " \n", n); 25 | //printf("K:\t%" PRIu32 " \n", k); 26 | //printf("SEED: "); 27 | //for (unsigned i = 0; i < SEED_LENGTH; ++i) { 28 | // printf(" %02x", seed[i]); 29 | //} 30 | printf("n = %d k = %d memory needed: %" PRIu64 "KiB\t solution size: %" PRIu64 "\t\n", n, k, ((((uint32_t)1) << (n / (k + 1)))*LIST_LENGTH*k*sizeof(uint32_t)) / (1UL << 10), solsize(n,k)); 31 | double solve_time=0, verify_time=0; 32 | uint32_t failed = 0; 33 | for(uint32_t i=0; i 0 && seed_len > 1) seed[1]++; 71 | if((i % (1<<16)) == 0 && i > 0 && seed_len > 2) seed[2]++; 72 | if((i % (1<<24)) == 0 && i > 0 && seed_len > 3) seed[3]++; 73 | } 74 | 75 | if(verbose) printf("\n"); 76 | printf("%f\t", solve_time / iter); 77 | printf("%f\n", verify_time / iter); 78 | } 79 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | CFLAGS?=-Wall -g -O3 -fstack-protector-strong -D_FORTIFY_SOURCE=2 -fasynchronous-unwind-tables -fpic -Werror=format-security -Wl,-z,defs -Wl,-z,relro -ftrapv -Wl,-z,noexecstack 2 | CXXFLAGS?=-Wall -g -O3 -fstack-protector-strong -D_FORTIFY_SOURCE=2 -fasynchronous-unwind-tables -fpic -Werror=format-security -Wl,-z,defs -Wl,-z,relro -ftrapv -Wl,-z,noexecstack 3 | CXXFLAGS+=-std=c++17 4 | LIBS=-lsodium 5 | PREFIX?=/usr/local 6 | SOEXT?=so 7 | EXTRA_CXXFLAGS=-fstack-clash-protection 8 | #EXTRA_CXXFLAGS+=-march=native 9 | INSTALL?=install 10 | 11 | SYS=$(shell gcc -dumpmachine) 12 | ifneq (, $(findstring x86_64, $(SYS))) 13 | EXTRA_CXXFLAGS+=-fcf-protection=full 14 | endif 15 | 16 | all: libequihash.so libequihash.a equihash 17 | 18 | android: EXTRA_SOURCES=jni.cc 19 | android: CXXFLAGS+=-I$(SODIUM) -I$(SODIUM)/sodium -L. 20 | android: libequihash.so 21 | android: EXTRA_CXXFLAGS= 22 | 23 | equihash.o: equihash.cc equihash.h equihash.hpp Makefile 24 | $(CXX) -c $(CXXFLAGS) $(EXTRA_CXXFLAGS) -o equihash.o equihash.cc 25 | 26 | libequihash.so: equihash.o Makefile $(EXTRA_SOURCES) 27 | $(CXX) -shared $(CXXFLAGS) $(EXTRA_CXXFLAGS) -Wl,-soname,libequihash.so.0 -o libequihash.so equihash.o $(EXTRA_SOURCES) $(LIBS) 28 | 29 | libequihash.a: equihash.o 30 | ar rcs $@ $^ 31 | 32 | bench.o: bench.cc 33 | $(CXX) -c $(CXXFLAGS) -o bench.o bench.cc 34 | 35 | equihash: main.c bench.o libequihash.a 36 | $(CC) -g $(CFLAGS) main.c $(LIBS) bench.o libequihash.a $(LIBS) -lstdc++ -o equihash 37 | 38 | libequihash.pc: 39 | echo "prefix=$(PREFIX)" >libequihash.pc 40 | cat libequihash.pc.skel >>libequihash.pc 41 | 42 | install: $(DESTDIR)$(PREFIX)/lib/libequihash.$(SOEXT) $(DESTDIR)$(PREFIX)/lib/libequihash.a $(DESTDIR)$(PREFIX)/include/equihash.h $(DESTDIR)$(PREFIX)/share/pkgconfig/libequihash.pc $(DESTDIR)$(PREFIX)/bin/equihash $(DESTDIR)$(PREFIX)/bin/ehwait $(DESTDIR)$(PREFIX)/bin/ehpuzzle $(DESTDIR)$(PREFIX)/lib/libequihash.$(SOEXT).0 43 | 44 | $(DESTDIR)$(PREFIX)/lib/libequihash.$(SOEXT): libequihash.$(SOEXT) 45 | $(INSTALL) -D $< $@ 46 | 47 | $(DESTDIR)$(PREFIX)/lib/libequihash.$(SOEXT).0: $(DESTDIR)$(PREFIX)/lib/libequihash.$(SOEXT) 48 | ln -s $< $@ 49 | 50 | $(DESTDIR)$(PREFIX)/lib/libequihash.a: libequihash.a 51 | $(INSTALL) -D -m 0644 $< $@ 52 | 53 | $(DESTDIR)$(PREFIX)/include/equihash.h: equihash.h 54 | $(INSTALL) -D -m 0644 $< $@ 55 | 56 | $(DESTDIR)$(PREFIX)/share/pkgconfig/libequihash.pc: libequihash.pc 57 | $(INSTALL) -D -m 0644 $< $@ 58 | 59 | $(DESTDIR)$(PREFIX)/bin/equihash: equihash 60 | $(INSTALL) -D -m 0755 $< $@ 61 | 62 | $(DESTDIR)$(PREFIX)/bin/ehwait: ehwait 63 | $(INSTALL) -D -m 0755 $< $@ 64 | 65 | $(DESTDIR)$(PREFIX)/bin/ehpuzzle: ehpuzzle 66 | $(INSTALL) -D -m 0755 $< $@ 67 | 68 | clean: 69 | rm -f libequihash.so libequihash.pc libequihash.a equihash.o bench.o equihash 70 | -------------------------------------------------------------------------------- /equihash.hpp: -------------------------------------------------------------------------------- 1 | /*Code by Dmitry Khovratovich, 2016 2 | CC0 license 3 | */ 4 | 5 | #ifndef __EQUIHASH_HPP 6 | #define __EQUIHASH_HPP 7 | 8 | #include 9 | 10 | #include 11 | #include 12 | 13 | /* The block used to initialize the PoW search 14 | @v actual values 15 | */ 16 | 17 | namespace _POW{ 18 | /* Different nonces for PoW search 19 | @v actual values 20 | */ 21 | typedef uint32_t Nonce; 22 | typedef uint32_t Input; 23 | 24 | /*Actual proof of work */ 25 | struct Proof{ 26 | const unsigned n; 27 | const unsigned k; 28 | const uint8_t* seed; 29 | const uint16_t seed_len; 30 | const Nonce nonce; 31 | const std::vector inputs; 32 | const unsigned digitbits; 33 | const unsigned solsize; 34 | Proof(const unsigned n_v, const unsigned k_v, const uint8_t *I_v, const uint16_t seed_len, Nonce V_v, std::vector inputs_v): 35 | n(n_v), k(k_v), seed(I_v), seed_len(seed_len), nonce(V_v), inputs(inputs_v), digitbits(n_v/(k_v+1)), solsize(inputs_v.size() *(digitbits+1) / 8){}; 36 | Proof():n(0),k(1),seed(0), seed_len(0),nonce(0),inputs(std::vector()), digitbits(0), solsize(0) {}; 37 | bool operator ==(const Proof &b) const; 38 | int serialize(uint8_t *csol, const size_t csol_len); 39 | void dump(); 40 | bool verify(); 41 | }; 42 | 43 | Proof unserialize(const unsigned n, const unsigned k, const uint8_t *seed, const uint16_t seed_len, const uint8_t *input, const uint32_t blen); 44 | 45 | class Tuple { 46 | public: 47 | std::vector blocks; 48 | Input reference; 49 | Tuple(unsigned i) { blocks.resize(i); } 50 | Tuple(const Tuple &r) = default; 51 | Tuple& operator=(const Tuple &r) { 52 | blocks = r.blocks; 53 | reference = r.reference; 54 | return *this; 55 | } 56 | }; 57 | 58 | class Fork { 59 | public: 60 | Input ref1, ref2; 61 | Fork() {}; 62 | Fork(Input r1, Input r2) : ref1(r1), ref2(r2) {}; 63 | }; 64 | 65 | /*Algorithm class for creating proof 66 | Assumes that n/(k+1) <=32 67 | */ 68 | class Equihash{ 69 | std::vector> tupleList; 70 | std::vector filledList; 71 | std::vector solutions; 72 | std::vector> forks; 73 | const unsigned n; 74 | const unsigned k; 75 | const uint8_t *seed; 76 | const uint16_t seed_len; 77 | Nonce nonce; 78 | public: 79 | /* 80 | Initializes memory. 81 | */ 82 | Equihash(const unsigned n_in, const unsigned k_in, const uint8_t *s, const uint16_t l) :n(n_in), k(k_in), seed(s), seed_len(l) {}; 83 | ~Equihash() {}; 84 | Proof FindProof(); 85 | void FillMemory(uint32_t length); //fill with hash 86 | void InitializeMemory(); //allocate memory 87 | void ResolveCollisions(bool store); 88 | std::vector ResolveTree(Fork fork); 89 | std::vector ResolveTreeByLevel(Fork fork, unsigned level); 90 | void PrintTuples(FILE* fp); 91 | }; 92 | } 93 | 94 | #endif //define __EQUIHASH_HPP 95 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | 118 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Equihash (fork) 2 | 3 | This is a fork of https://github.com/khovratovich/equihash/ - it is changed to be used in production setup, by: 4 | - cleaning up the code, 5 | - removing benchmark and trace/debug output, 6 | - reading in arbitrary seeds, and 7 | - (de)serializing the solutions. 8 | - Wrapping all this in a library, 9 | - providing a simple C API (solve/verify), 10 | - and providing python bindings to this. 11 | 12 | This is an optimized C++ implementation of Equihash, the [memory-hard Proof-of-Work 13 | with fast verification](https://www.internetsociety.org/sites/default/files/blogs-media/equihash-asymmetric-proof-of-work-based-generalized-birthday-problem.pdf). Equihash is designed by Alex Biryukov and Dmitry Khovratovich, cryptographers at the [University of Luxembourg](https://www.cryptolux.org/index.php/Home). 14 | 15 | Equihash is an asymmetric proof-of-work algorithm based on a computationally 16 | hard generalized birthday problem, which requires a lot of memory to generate 17 | a proof, but is instant 18 | to verify. Equihash is adapted as the PoW in [Zcash](https://z.cash/) a public implementation 19 | of the cryptocurrency protocol [Zerocash](http://zerocash-project.org/paper). It is possible to use Equihash in TLS as a [client puzzle](https://tools.ietf.org/html/draft-nygren-tls-client-puzzles-00). 20 | 21 | Equihash has two parameters: **N** (width in bits) and **K** (length), which determine the complexity 22 | of the underlying problem and thus the memory and time complexity of the Equihash PoW. The underlying hash function is Blake2b, but any collision-resistant hash function would work too. 23 | 24 | The time complexity is proportional to K2^{N/(K+1)}, and memory complexity to 2^{K+N/(K+1)}. The proof size is 2^{K}(1+N/(K+1))+192 bits. Verification requires 2^K hashes and XORs. 25 | 26 | Please report bugs as issues on this repository. 27 | 28 | ## Recommended parameters (N,K) 29 | 30 | For cryptocurrencies: (100/110/120,4), (108/114/120/126,5). 31 | 32 | For client puzzles: (60/70/80/90,4), (90/96/102,5). 33 | 34 | ## Usage 35 | 36 | `make` builds the executable `equihash` and the library `libequihash.so`. 37 | 38 | ### Command-line utility 39 | 40 | `equihash` is a command-line utility to benchmark specific Equihash instances 41 | on your system and to solve challenges and verify solutions. To show usage instructions, run 42 | `./equihash` without arguments as 43 | 44 | ``` 45 | Usage: ./equihash [bench|solve|verify] [-v] [-n N] [-k K] [-i benchmark iterations][-f file] [-s file] 46 | Parameters: 47 | bench run benchmark 48 | solve solve puzzle 49 | verify verify solution 50 | size calculate size of solution 51 | -v verbose 52 | -n N Sets the tuple length of iterations to N 53 | -k K Sets the number of steps to K 54 | -i sample size for benchmark 55 | -f file Sets seed to file 56 | -s file Sets solution to file 57 | ``` 58 | 59 | For example, to compute Equihash using N=120 and k=5 using this 60 | projects Makefile as seed, consuming at least 32 MB of RAM 61 | 62 | ``` 63 | $ ./equihash -n 120 -k 5 -s Makefile 64 | ``` 65 | 66 | To solve a challenge consisting of the makefile of this project for 67 | N=40 and K=4: 68 | 69 | ``` 70 | $ ./equihash solve -v -n 40 -k 4 -f Makefile -s /tmp/s 71 | ``` 72 | 73 | When the equihash CLI frontend is solving a challenge, it emits on fd 74 | 3 a simple protocol that allows better UI integration (see also the 75 | ehwait wrapper below). 76 | 77 | To verify the solution of the previous example: 78 | ``` 79 | $ ./equihash verify -v -n 40 -k 4 -f Makefile -s /tmp/s 80 | ``` 81 | 82 | To calculate the size of a solution for a given N and K parameter simply run: 83 | ``` 84 | $ ./equihash size -n 40 -k 4 85 | 22 86 | ``` 87 | 88 | Additionally there is two simple wrapper scripts provided: ehwait and ehpuzzle. 89 | 90 | The `ehwait` wrapper is a simple bash wrapper, which understands the 91 | following simple notification protocol: 92 | 93 | On filedescriptor 3 any tool that supports this (pwdsphinx for example 94 | does) has to emit the an ASCII string containing the values of N and K 95 | and terminated by a newline as soon as an equihash calculation is 96 | started. When the calculation is finished, the time elapsed in seconds 97 | (with fractions, no terminating newline) is written also as an ASCII 98 | number to fd 3, the filedescriptor 3 closes immediately after 99 | this. This allows tools that might use significant time to solve an 100 | equihash challenge to notify the user about the waiting time. 101 | 102 | ehwait supports two frontends: pinentry (default) and zenity, simply 103 | prefix your call to `equihash` with `ehwait` (and optionally give the 104 | frontend variable if you have zenity and want that as a frontend.) 105 | 106 | ``` 107 | $ FRONTEND=zenity ./ehwait ./equihash solve -n 100 -k 4 -f Makefile -s /tmp/s 108 | ``` 109 | 110 | The other wrapper that comes with equihash is `ehpuzzle`, this is a 111 | simple bash wrapper which creates secure challenges that cannot be 112 | predicted or precomputed by solvers. The challenger and the verifer 113 | need to have a secret cryptographic key of 32 bytes to ensure 114 | authenticity of the challenges. 115 | 116 | To create a challenge: 117 | ``` 118 | ehpuzzle challenge 80 4 /tmp/data /tmp/challenge 119 | ``` 120 | All parameters are positional, in this order: 121 | - N 122 | - K 123 | - a file containing arbitrary data 124 | 125 | The wrapper needs the secret signing key on standard input and will 126 | write the challenge on standard output. 127 | 128 | A solver can then take the challenge and solve it: 129 | ``` 130 | ehpuzzle solve /tmp/challenge >/tmp/solution 131 | ``` 132 | 133 | The solving mode already makes use of ehwait so a user is also 134 | notified on the UI that this will take some time. 135 | 136 | Finally a verifier (which can be the same as the challenger) verifies 137 | if the challenge is valid, and if it is it also verifies the solution, 138 | if it is then the verifier returns with exit code 0: 139 | 140 | ``` 141 | ehpuzzle verify Makefile /tmp/solution 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | 10 | typedef enum { 11 | undefined, 12 | bench_mode, 13 | solve_mode, 14 | verify_mode, 15 | size_mode, 16 | } equihash_mode_t; 17 | 18 | void bench(const uint32_t n, const uint32_t k, const uint32_t iter, const int verbose, const size_t seed_len, uint8_t *seed); 19 | 20 | static void fatal(const char *error) { 21 | fprintf(stderr, "Error: %s\n", error); 22 | exit(1); 23 | } 24 | 25 | static void usage(const char *cmd) { 26 | printf("Usage: %s [bench|solve|verify|size] [-v] [-n N] [-k K] " 27 | "[-i benchmark iterations]" 28 | "[-f file] " 29 | "[-s file]\n", 30 | cmd); 31 | printf("Parameters:\n"); 32 | printf("\tbench \t\trun benchmark\n"); 33 | printf("\tsolve \t\tsolve puzzle\n"); 34 | printf("\tverify \t\tverify solution\n"); 35 | printf("\tsize \t\tget size of solution solution\n"); 36 | printf("\t-v \t\tverbose\n"); 37 | printf("\t-n N \t\tSets the tuple length of iterations to N\n"); 38 | printf("\t-k K\t\tSets the number of steps to K \n"); 39 | printf("\t-i \t\tsample size for benchmark\n"); 40 | printf("\t-f file\t\tSets seed to file\n"); 41 | printf("\t-s file\t\tSets solution to file\n"); 42 | } 43 | 44 | #if _WIN32 == 1 || _WIN64 == 1 45 | #include 46 | int is_fd_open(int fd) { 47 | struct _stat buf; 48 | return _fstat(fd, &buf); 49 | } 50 | #else 51 | int is_fd_open(int fd) { 52 | return fcntl(fd, F_GETFD); 53 | } 54 | #endif 55 | 56 | int main(int argc, char *argv[]) { 57 | uint32_t n = 60, k=4, iter=10; 58 | char *filename=NULL, *solution=NULL; 59 | int verbose = 0; 60 | 61 | if (argc < 2) { 62 | usage(argv[0]); 63 | return 1; 64 | } 65 | 66 | equihash_mode_t mode = undefined; 67 | 68 | /* parse options */ 69 | for (int i = 1; i < argc; i++) { 70 | const char *a = argv[i]; 71 | unsigned long input = 0; 72 | if (!strcmp(a, "bench")) { 73 | mode = bench_mode; 74 | continue; 75 | } 76 | 77 | if (!strcmp(a, "solve")) { 78 | mode = solve_mode; 79 | continue; 80 | } 81 | 82 | if (!strcmp(a, "verify")) { 83 | mode = verify_mode; 84 | continue; 85 | } 86 | 87 | if (!strcmp(a, "size")) { 88 | mode = size_mode; 89 | continue; 90 | } 91 | 92 | if (!strcmp(a, "-v")) { 93 | verbose = 1; 94 | continue; 95 | } 96 | 97 | if (!strcmp(a, "-n")) { 98 | if (i < argc - 1) { 99 | i++; 100 | input = strtoul(argv[i], NULL, 10); 101 | if (input == 0 || 102 | input > 255) { 103 | fatal("bad numeric input for -n"); 104 | } 105 | n = input; 106 | continue; 107 | } 108 | else { 109 | fatal("missing -n argument"); 110 | } 111 | } 112 | 113 | else if (!strcmp(a, "-k")) { 114 | if (i < argc - 1) { 115 | i++; 116 | input = strtoul(argv[i], NULL, 10); 117 | if (input == 0 || 118 | input > 20) { 119 | fatal("bad numeric input for -k"); 120 | } 121 | k = input; 122 | continue; 123 | } 124 | else { 125 | fatal("missing -k argument"); 126 | } 127 | } 128 | 129 | else if (!strcmp(a, "-i")) { 130 | if (i < argc - 1) { 131 | i++; 132 | input = strtoul(argv[i], NULL, 10); 133 | if (input == 0) { 134 | fatal("bad numeric input for -i"); 135 | } 136 | iter = input; 137 | continue; 138 | } 139 | else { 140 | fatal("missing -i argument"); 141 | } 142 | } 143 | 144 | else if (!strcmp(a, "-f")) { 145 | if (i < argc - 1) { 146 | i++; 147 | filename = argv[i]; 148 | continue; 149 | } 150 | else { 151 | fatal("missing -f argument"); 152 | } 153 | } 154 | 155 | else if (!strcmp(a, "-s")) { 156 | if (i < argc - 1) { 157 | i++; 158 | solution = argv[i]; 159 | continue; 160 | } 161 | else { 162 | fatal("missing -s argument"); 163 | } 164 | } 165 | } 166 | 167 | size_t seed_len = 0; 168 | if(filename==NULL) { 169 | if(mode != bench_mode && mode != size_mode) { 170 | fatal("must provide input file for non-benchmarking modes\n"); 171 | } 172 | seed_len = 16; // debian-style randomly and arbitrarily aus dem arsch gezogen 173 | } else { 174 | struct stat statbuf; 175 | if(0!=stat(filename, &statbuf)) { 176 | fprintf(stderr, "failed to stat file: %s\n", filename); 177 | return 1; 178 | } 179 | seed_len = statbuf.st_size; 180 | } 181 | 182 | uint8_t seed[seed_len]; 183 | if(filename) { 184 | FILE *fp = fopen(filename, "r"); 185 | if(fp==NULL) { 186 | perror("failed to open seed"); 187 | return 1; 188 | } 189 | if(1!=fread(seed,sizeof(seed),1, fp)) { 190 | fprintf(stderr,"failed to load %s\n", filename); 191 | return 1; 192 | } 193 | fclose(fp); 194 | } else { 195 | memset(seed,0,seed_len); 196 | } 197 | 198 | if(mode == bench_mode) { 199 | bench(n, k, iter, verbose, seed_len, seed); 200 | return 0; 201 | } 202 | 203 | if(mode == size_mode) { 204 | printf("%ld\n", solsize(n,k)); 205 | return 0; 206 | } 207 | 208 | if(mode == solve_mode) { 209 | size_t sol_len = solsize(n, k); 210 | uint8_t sol[sol_len]; 211 | FILE *status=NULL; 212 | if(-1!=is_fd_open(3)) { 213 | status = fdopen(3,"w"); 214 | if(status==NULL) { 215 | perror("error: failed to open fd 3 for status"); 216 | return 1; 217 | } 218 | } 219 | fprintf(status, "%d %d\n", n, k); 220 | fflush(status); 221 | clock_t start = clock(); 222 | 223 | if(!solve(n, k, seed, seed_len, sol, sol_len)) { 224 | fprintf(stderr,"no solution found\n"); 225 | return 1; 226 | } 227 | 228 | double delta = ((double)(clock() - start)) / CLOCKS_PER_SEC; 229 | fprintf(status, "%f", delta); 230 | fclose(status); 231 | 232 | FILE *fp = fopen(solution, "w"); 233 | if(fp==NULL) { 234 | perror("failed to open solution"); 235 | return 1; 236 | } 237 | if(1!=fwrite(sol,sizeof(sol),1, fp)) { 238 | fprintf(stderr,"failed to write solution to %s\n", solution); 239 | return 1; 240 | } 241 | fclose(fp); 242 | 243 | } else if (mode == verify_mode) { 244 | size_t sol_len = solsize(n, k); 245 | 246 | struct stat statbuf; 247 | if(0!=stat(solution, &statbuf)) { 248 | fprintf(stderr, "failed to stat solution: %s\n", solution); 249 | return 1; 250 | } 251 | if(statbuf.st_size<0 || sol_len!=(size_t)statbuf.st_size) { 252 | fprintf(stderr, "error: solution size(%ld) is incorrect, expected %ld", seed_len, sol_len); 253 | return 1; 254 | } 255 | uint8_t sol[sol_len]; 256 | FILE *fp = fopen(solution, "r"); 257 | if(1!=fread(sol,sizeof(sol),1, fp)) { 258 | fprintf(stderr,"failed to load %s\n", solution); 259 | return 1; 260 | } 261 | fclose(fp); 262 | 263 | return !verify(n, k, seed, seed_len, sol, sol_len); 264 | } 265 | 266 | return 0; 267 | } 268 | -------------------------------------------------------------------------------- /equihash.cc: -------------------------------------------------------------------------------- 1 | /*Code by Dmitry Khovratovich, 2016 2 | CC0 license 3 | */ 4 | 5 | #include "equihash.hpp" 6 | #include 7 | #include 8 | #ifdef _MSC_VER 9 | #include 10 | #else 11 | #include 12 | #endif 13 | #include 14 | 15 | extern "C" { 16 | #include "equihash.h" 17 | } 18 | 19 | //const int NONCE_LENGTH=24; //Length of nonce in bytes; 20 | const int MAX_NONCE = 0xFFFFF; 21 | const int MAX_N = 32; //Max length of n in bytes, should not exceed 32 22 | const unsigned FORK_MULTIPLIER=3; //Maximum collision factor 23 | 24 | using namespace _POW; 25 | using namespace std; 26 | 27 | void Equihash::InitializeMemory() { 28 | uint32_t tuple_n = ((uint32_t)1) << (n / (k + 1)); 29 | Tuple default_tuple(k); // k blocks to store (one left for index) 30 | std::vector def_tuples(LIST_LENGTH, default_tuple); 31 | tupleList = std::vector>(tuple_n, def_tuples); 32 | filledList= std::vector(tuple_n, 0); 33 | solutions.resize(0); 34 | forks.resize(0); 35 | } 36 | 37 | void Equihash::FillMemory(uint32_t length) { //works for k<=7 38 | const int seed_end_off = seed_len/sizeof(uint32_t); 39 | uint32_t input[seed_end_off + 2]; 40 | uint8_t *input_ptr=(uint8_t*) input; 41 | for (unsigned i = 0; i < seed_len; ++i) 42 | input_ptr[i] = seed[i]; 43 | input[seed_end_off] = nonce; 44 | input[seed_end_off + 1] = 0; 45 | uint32_t buf[MAX_N / 4]; 46 | for (unsigned i = 0; i < length; ++i, ++input[seed_end_off + 1]) { 47 | //blake2b((uint8_t*)buf, &input, NULL, sizeof(buf), sizeof(input), 0); 48 | crypto_generichash((uint8_t*)buf, sizeof(buf), input_ptr, sizeof(input), NULL,0); 49 | uint32_t index = buf[0] >> (32 - n / (k + 1)); 50 | unsigned count = filledList[index]; 51 | if (count < LIST_LENGTH) { 52 | for (unsigned j = 1; j < (k + 1); ++j) { 53 | //select j-th block of n/(k+1) bits 54 | tupleList[index][count].blocks[j - 1] = buf[j] >> (32 - n / (k + 1)); 55 | } 56 | tupleList[index][count].reference = i; 57 | filledList[index]++; 58 | } 59 | } 60 | } 61 | 62 | std::vector Equihash::ResolveTreeByLevel(Fork fork, unsigned level) { 63 | if (level == 0) 64 | return std::vector{fork.ref1, fork.ref2}; 65 | auto v1 = ResolveTreeByLevel(forks[level - 1][fork.ref1], level - 1); 66 | auto v2 = ResolveTreeByLevel(forks[level - 1][fork.ref2], level - 1); 67 | v1.insert(v1.end(), v2.begin(), v2.end()); 68 | return v1; 69 | } 70 | 71 | std::vector Equihash::ResolveTree(Fork fork) { 72 | return ResolveTreeByLevel(fork, forks.size()); 73 | } 74 | 75 | 76 | void Equihash::ResolveCollisions(bool store) { 77 | const unsigned tableLength = tupleList.size(); //number of rows in the hashtable 78 | const unsigned maxNewCollisions = tupleList.size()*FORK_MULTIPLIER; //max number of collisions to be found 79 | const unsigned newBlocks = tupleList[0][0].blocks.size() - 1;// number of blocks in the future collisions 80 | std::vector newForks(maxNewCollisions); //list of forks created at this step 81 | auto tableRow = vector(LIST_LENGTH, Tuple(newBlocks)); //Row in the hash table 82 | vector> collisionList(tableLength,tableRow); 83 | std::vector newFilledList(tableLength,0); //number of entries in rows 84 | uint32_t newColls = 0; //collision counter 85 | for (unsigned i = 0; i < tableLength; ++i) { 86 | for (unsigned j = 0; j < filledList[i]; ++j) { 87 | for (unsigned m = j + 1; m < filledList[i]; ++m) { //Collision 88 | //New index 89 | uint32_t newIndex = tupleList[i][j].blocks[0] ^ tupleList[i][m].blocks[0]; 90 | Fork newFork = Fork(tupleList[i][j].reference, tupleList[i][m].reference); 91 | //Check if we get a solution 92 | if (store) { //last step 93 | if (newIndex == 0) {//Solution 94 | std::vector solution_inputs = ResolveTree(newFork); 95 | solutions.push_back(Proof(n, k, seed, seed_len, nonce, solution_inputs)); 96 | } 97 | } 98 | else { //Resolve 99 | if (newFilledList[newIndex] < LIST_LENGTH && newColls < maxNewCollisions) { 100 | for (unsigned l = 0; l < newBlocks; ++l) { 101 | collisionList[newIndex][newFilledList[newIndex]].blocks[l] 102 | = tupleList[i][j].blocks[l+1] ^ tupleList[i][m].blocks[l+1]; 103 | } 104 | newForks[newColls] = newFork; 105 | collisionList[newIndex][newFilledList[newIndex]].reference = newColls; 106 | newFilledList[newIndex]++; 107 | newColls++; 108 | }//end of adding collision 109 | } 110 | } 111 | }//end of collision for i 112 | } 113 | forks.push_back(newForks); 114 | std::swap(tupleList, collisionList); 115 | std::swap(filledList, newFilledList); 116 | } 117 | 118 | Proof Equihash::FindProof(){ 119 | this->nonce = 1; 120 | while (nonce < MAX_NONCE) { 121 | nonce++; 122 | InitializeMemory(); //allocate 123 | FillMemory(4UL << (n / (k + 1)-1)); //fill with hashes 124 | for (unsigned i = 1; i <= k; ++i) { 125 | bool to_store = (i == k); 126 | ResolveCollisions(to_store); //XOR collisions, concatenate indices and shift 127 | } 128 | //Duplicate check 129 | for (unsigned i = 0; i < solutions.size(); ++i) { 130 | auto vec = solutions[i].inputs; 131 | std::sort(vec.begin(), vec.end()); 132 | bool dup = false; 133 | for (unsigned k = 0; k < vec.size() - 1; ++k) { 134 | if (vec[k] == vec[k + 1]) 135 | dup = true; 136 | } 137 | if (!dup) 138 | return solutions[i]; 139 | } 140 | } 141 | return Proof(n, k, seed, seed_len, nonce, std::vector()); 142 | } 143 | 144 | int Proof::serialize(uint8_t *csol, const size_t csol_len) { 145 | if(csol_len!=4+solsize) return 0; 146 | 147 | *((uint32_t*)csol)=htonl(nonce); 148 | 149 | uint8_t b; 150 | for (uint32_t i = 0, j = 0, bits_left = digitbits + 1; 151 | j < solsize; csol[4+j++] = b) { 152 | if (bits_left >=8) { 153 | // Read next 8 bits, stay at same sol index 154 | b = inputs[i] >> (bits_left -= 8); 155 | } else { // less than 8 bits to read 156 | // Read remaining bits and shift left to make space for next sol index 157 | b = inputs[i]; 158 | b <<= (8 - bits_left); // may also set b=0 if bits_left was 0, which is fine 159 | // Go to next sol index and read remaining bits 160 | bits_left += digitbits + 1 - 8; 161 | b |= inputs[++i] >> bits_left; 162 | } 163 | } 164 | return 1; 165 | } 166 | 167 | void Proof::dump() { 168 | printf("%08x ", nonce); 169 | for (unsigned i = 0; i < inputs.size(); ++i) { 170 | printf("%08x ", inputs[i]); 171 | } 172 | printf("\n"); 173 | } 174 | 175 | Proof _POW::unserialize(const unsigned n, const unsigned k, const uint8_t *seed, const uint16_t seed_len, const uint8_t *input, const uint32_t blen) { 176 | 177 | const unsigned digitbits = (n/(k+1)); 178 | const uint32_t proofsize = 1< sol; 188 | sol.resize(proofsize,0); 189 | 190 | for (uint32_t i = 0, j = 0, bits_left = digitbits + 1; 191 | i < blen-4; i++) { 192 | if(bits_left > 8) { 193 | sol[j] <<= 8; 194 | bits_left -= 8; 195 | sol[j] |= csol[i]; 196 | } else if(bits_left == 8) { 197 | sol[j] <<= 8; 198 | sol[j] |= csol[i]; 199 | bits_left = digitbits+1; 200 | j++; 201 | } else { 202 | sol[j] <<= bits_left; 203 | sol[j] |= (csol[i] >> (8-bits_left)) & ((1< blocks(k+1,0); 234 | for (unsigned i = 0; i < inputs.size(); ++i) { 235 | input[seed_end_off + 1] = inputs[i]; 236 | //blake2b((uint8_t*)buf, &input, NULL, sizeof(buf), sizeof(input), 0); 237 | crypto_generichash((uint8_t*)buf, sizeof(buf), input_ptr, sizeof(input), NULL,0); 238 | for (unsigned j = 0; j < (k + 1); ++j) { 239 | //select j-th block of n/(k+1) bits 240 | blocks[j] ^= buf[j] >> (32 - n / (k + 1)); 241 | } 242 | } 243 | bool b = true; 244 | for (unsigned j = 0; j < (k + 1); ++j) { 245 | b &= (blocks[j] == 0); 246 | } 247 | return b; 248 | } 249 | 250 | size_t solsize(const unsigned n, const unsigned k) { 251 | return ((1< 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------