A python implementation of the XEdDSA signature scheme.

Project description

python-xeddsa

A python implementation of the XEdDSA signature scheme.

This python library offers an open implementation of the XEdDSA signature scheme as specified here.

!!! IMPORTANT WARNING !!!

This code was not written by a cryptographer and is most probably NOT SECURE.

Installation

Install the package using pip (pip install XEdDSA) or manually using python setup.py install, as you're used to.

NOTE: On UNIX, the installation uses the cmake and make tools.

NOTE: On Windows, cmake is used and a MinGW environment is required. If compilation fails, precompiled binaries are downloaded during the installation. Make sure you have an active internet connection and access to https://github.com. The installation requires the Microsoft Visual C++ Build Tools. Those can be installed using the standalone version you can download here, or as part of Visual Studio, for example the free Community Edition.

Manually building ref10

Following section explains how to manually compile the ref10 library, which is not required when using pip or python setup.py install.

For detailed information on what the ref10 library is and how it was built, look at ref10/README.md.

Building ref10 on UNIX

On UNIX, run following commands to build the ref10 library:

$ cd ref10/
$ mkdir build
$ cd build/
$ cmake -G "Unix Makefiles" ..
$ make

To clean up the build artifacts, just delete the whole build and bin directories inside of the ref10 directory.

Building ref10 on Windows

On Windows, building ref10 is just as simple. Make sure you are in a MinGW environment an run:

$ cd ref10/
$ mkdir build
$ cd build/
$ cmake -G "MinGW Makefiles" ..
$ mingw32-make

To clean up the build artifacts, just delete the whole build and bin directories inside of the ref10 directory.

NOTICE

This implementation is meant as a transitional solution until one of the big crypto-libraries like libsodium picks up XEdDSA. The version 1.0 roadmap of libsodium lists XEdDSA, it might only take a few more months to get a stable and secure implementation.