├── .gitignore ├── LICENSE ├── README.md └── zkp.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 codeesura 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Zero-Knowledge Proof (ZKP) Python Implementation 2 | 3 | Zero-Knowledge Proofs (ZKP) are a cryptographic concept where one party (the prover) can prove to another party (the verifier) that they know a value, without conveying any information apart from the fact that they know the value. This concept is fundamental in various privacy-preserving technologies, including cryptocurrencies and secure multi-party computations. 4 | 5 | The prover does not reveal the actual secret during the interaction, maintaining the secrecy of the information. It's a form of "interactive proof system." 6 | 7 | This repository contains a simple implementation of Zero-Knowledge Proofs (ZKP) in Python. 8 | 9 | ## Table of Contents 10 | 1. [Requirements](#requirements) 11 | 2. [Usage](#usage) 12 | 3. [Example](#example) 13 | 4. [License](#license) 14 | 15 | ## Requirements 16 | 17 | The Python version required for this script is Python 3.7+. The script also makes use of the `hashlib`, `os`, and `random` libraries, which are included in the standard Python distribution. 18 | 19 | ## Usage 20 | 21 | The main script is `zkp.py`, which contains the `ZKProof` class. Here's a step-by-step guide on how to use it: 22 | 23 | 1. **Import the `ZKProof` class from the `zkp.py` script.** This class contains the main methods for generating proofs and verifying them. 24 | 2. **Initialize a `ZKProof` object.** When initializing, the object generates a random 'salt' value, used in the hashing process to increase security. 25 | 3. **Generate a proof using a secret value.** Call the `generate_proof` method on the object, passing the secret value you want to prove knowledge of. This will return a hashed value of a randomly generated number. This hashed number is a commitment that the prover sends to the verifier. 26 | 4. **Verify a guessed value.** To verify a guessed value, call the `verify` method on the object, passing the guessed value. This will return `True` if the hashed guessed value matches the stored hashed value, and `False` otherwise. 27 | 28 | ## Example 29 | 30 | ```python 31 | zkp = ZKProof() 32 | x = zkp.generate_proof('secret_value') 33 | print('Proof:', x) 34 | response = input('Enter the value to verify: ') 35 | print('Verified:', zkp.verify(response)) 36 | ``` 37 | 38 | In this example, the script will print the hashed proof and wait for a user input. If the input matches the secret value, it will print `Verified: True`; otherwise, it will print `Verified: False`. 39 | 40 | ## License 41 | 42 | This project is licensed under the terms of the [MIT](https://github.com/codeesura/Zero-Knowledge-Proof-Python-Implementation/blob/main/LICENSE) license. You are free to use, modify, and distribute the code under this license. 43 | -------------------------------------------------------------------------------- /zkp.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import os 3 | import random 4 | 5 | class ZKProof: 6 | def __init__(self): 7 | self.N = 20 8 | self.salt = os.urandom(16) 9 | 10 | def _hash(self, x): 11 | return hashlib.sha256(x.encode('utf-8') + self.salt).hexdigest() 12 | 13 | def generate_proof(self, secret): 14 | self.secret = secret 15 | self.v = self._hash(secret) 16 | r = str(random.randint(1, self.N)) 17 | self.x = self._hash(r) 18 | return self.x 19 | 20 | def get_secret(self): 21 | return self.secret 22 | 23 | def verify(self, response): 24 | return self.v == self._hash(response) 25 | 26 | zkp = ZKProof() 27 | 28 | secret_card = 'spade_two' # Here we define the secret card 29 | x = zkp.generate_proof(secret_card) 30 | print('Proof:', x) 31 | 32 | response = input('Enter the card to verify: ') 33 | print('Verified:', zkp.verify(response)) 34 | --------------------------------------------------------------------------------