Real World Cryptography for Engineers and Practitioners

This repository contains code for the beta version of the Cry.College lecture. As part of the lecture, students have to implement the missing chunks.

Setup

The reference version is Python 3.10. The code is only tested for this version, but should work for any reasonably recent Python version (> 3.5). Only one package is required as an external dependency. That is pytest which is required to run the (you guessed it) tests.

Please install pytest only via the Python package manager pip. In an own virtual environment this can be achieved with:

# Build the env
python -m venv crycollege_env
# Activate the env for the current shell
source crycollege_env/bin/activate
# Install pytest
pip install pytest

Remember that you have to activate the env (aka source crycollege_env/bin/activate) everytime you open a new shell.

Code and Tasks

In order to run implementations and tasks, add the working directory to the PYTHONPATH:

# CD into the root directory of this repository
cd Cry.College
# Add dir to Python's search path
export PYTHONPATH="$(pwd)"

This is needed for the Python interpreter to find the CryCollege library. In case you don't want to set an environment variable, you can configure vscode to set the variable.

Test Code

After you have written code, you can test it locally using pytest. To test a file, just run:

pytest CryCollege/week3/weierstrass_curve.py

Build and Test Scripts

To run scripts, you need to have pytest installed on your system. You can check if you have it installed by running pytest --version on your command prompt or terminal.

If you are using Linux then you can use the bash script in the scripts folder to test your written code. It automates the process of running tests for the repository. The script will prompt you to enter a week number between 1-8 and displays the available classes for that week. You can then choose a week and a class by entering a corresponding number. To run the test you just go to the scripts directory and run ./run_tests.sh.

To run the script on Windows, navigate to the scripts directory in your terminal and run .\run_tests.cmd. The script will prompt you to enter a week number between 1 and 8. After entering a valid week number, the script will display the available classes for that week. You can then choose a class by entering its name.

License

To keep people from publishing solutions, we had to choose a restrictive license. You can do what you want with the software on your own machine. But if you publish solutions or a modified version, we will sue you. No joke, we'll sue the crap out of you.

License text

You may use the Software without charge. You may distribute exact copies of the Software to anyone.

YOU MAY NOT PUBLISH MODIFIED, ADAPTED, TRANSLATED, OR DERIVATIVE WORKS BASED UPON THE SOFTWARE OR ANY PART THEREOF.