Add reference implementation

This replaces the earlier implementation with a reference implementation for the specification. See spec.pdf. The algorithm has changed significantly and the implementation has as well. The public API in picnic.h is no longer compatible with the previous version. Signed-off-by: Greg Zaverucha <[email protected]>
microsoft · Oct 31, 2017 · c3cdc22 · c3cdc22
1 parent b1e1fbf
commit c3cdc22
Show file tree

Hide file tree

Showing 37 changed files with 4,985 additions and 0 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,7 @@
+Greg Zaverucha
+
+This reference implementation is derived from the earlier Picnic implementation
+at https://github.com/Microsoft/Picnic by Steven Goldfeder and Greg Zaverucha.
+
+The SHA-3 implementation redistributed here is from the Keccak Code Package,
+see https://github.com/gvanas/KeccakCodePackage for authorship. 
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Steven Goldfeder and Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE
diff --git a/Makefile b/Makefile
@@ -0,0 +1,56 @@
+
+CC=gcc
+WARNING_FLAGS=-Wall -Wextra -Wpedantic -Werror
+CFLAGS= -O2 -march=native $(WARNING_FLAGS) -std=gnu99 -D__LINUX__ -D__X64__ -I./sha3
+CFLAGS_DEBUG= -g -march=native $(WARNING_FLAGS) -std=gnu99 -fsanitize=address -D__LINUX__ -D__X64__ -I./sha3
+SHA3LIB=libshake.a
+SHA3_PATH=sha3
+LDFLAGS= $(SHA3_PATH)/$(SHA3LIB) 
+
+SOURCES= picnic_impl.c picnic.c lowmc_constants.c
+PICNIC_OBJECTS= picnic_impl.o picnic.o lowmc_constants.o hash.o picnic_types.o
+PICNIC_LIB= libpicnic.a
+EXECUTABLE_EXAMPLE=example
+EXECUTABLE_TESTVECTORS=create_test_vectors
+EXECUTABLE_UNITTEST=unit_test
+EXECUTABLE_BENCHMARK=bench
+
+all: $(SHA3LIB) $(SOURCES) $(PICNIC_LIB) $(EXECUTABLE_EXAMPLE) $(EXECUTABLE_TESTVECTORS) $(EXECUTABLE_UNITTEST)
+
+$(SHA3LIB):
+		$(MAKE) -C $(SHA3_PATH) 
+
+# debug build
+debug: CFLAGS = $(CFLAGS_DEBUG)
+debug: all
+
+$(EXECUTABLE_EXAMPLE): $(PICNIC_LIB)
+	    $(CC) $(@).c $(CFLAGS) $(PICNIC_LIB) -o $@ $(LDFLAGS)
+
+$(EXECUTABLE_UNITTEST): $(PICNIC_LIB)
+	    $(CC) $(@).c $(CFLAGS) $(PICNIC_LIB) -o $@ $(LDFLAGS)
+
+$(EXECUTABLE_TESTVECTORS): $(PICNIC_LIB)
+	    $(CC) $(@).c $(CFLAGS) $(PICNIC_LIB) -o $@ $(LDFLAGS)
+
+$(EXECUTABLE_BENCHMARK): $(PICNIC_LIB)
+	    $(CC) $(@).c $(CFLAGS) $(PICNIC_LIB) -o $@ $(LDFLAGS)
+
+
+.c.o: 
+	    $(CC) -c $(CFLAGS) $< -o $@
+
+$(PICNIC_LIB): $(PICNIC_OBJECTS)
+	ar rcs $@ $^
+
+
+clean:
+	    rm *.o 2>/dev/null || true
+	    rm *.exe 2>/dev/null || true
+	    rm $(EXECUTABLE_TESTVECTORS) 2>/dev/null || true
+	    rm $(EXECUTABLE_EXAMPLE) 2>/dev/null || true
+	    rm $(EXECUTABLE_UNITTEST) 2>/dev/null || true
+	    rm $(EXECUTABLE_TESTVECTORS) 2>/dev/null || true
+	    rm $(EXECUTABLE_BENCHMARK) 2>/dev/null || true
+		rm $(PICNIC_LIB) 2>/dev/null || true
+		$(MAKE) -C $(SHA3_PATH) clean
diff --git a/README.md b/README.md
@@ -0,0 +1,49 @@
+# Picnic: Post Quantum Signatures 
+
+The Picnic signature scheme is a family of digital signature schemes secure
+against attacks by quantum computers.  This is a reference implementation of these schemes. 
+The scheme and parameter sets are specified in the [Picnic Specification Document](https://github.com/Microsoft/Picnic/blob/master/spec.pdf).  
+
+A research paper describing the signature scheme is also available. 
+  **Post-Quantum Zero-Knowledge and Signatures from Symmetric-Key Primitives**  
+  Melissa Chase and David Derler and Steven Goldfeder and Claudio Orlandi and
+  Sebastian Ramacher and Christian Rechberger and Daniel Slamanig and Greg
+  Zaverucha. 
+  *In Proceedings of ACM CCS 2017*. 
+  *Cryptology ePrint Archive: Report 2017/279*   
+  <http://eprint.iacr.org/2017/279>   
+
+The library is provided under the MIT License.  The authors are Steven Goldfeder and Greg Zaverucha.
+
+The library builds a static library.  The public API surface is defined in [picnic.h](https://github.com/Microsoft/Picnic/blob/master/picnic.h).
+
+## Linux Build Instructions
+
+Tested on Ubuntu Linux, and the Windows Subsystem for Linux on Windows 10 (build 1709).
+
+1. `make`  
+This will build the project.  `make debug` will build with symbols and address
+sanitizer.
+
+2. `./example`  
+Runs an example program that exercises the keygen, sign, verify and
+serialization APIs.  See [example.c](https://github.com/Microsoft/Picnic/blob/master/example.c).
+
+
+## Windows Build Instructions
+
+Tested on Windows 10 with Visual Studio 2017.
+
+Open the solution in `VisualStudio\picnic.sln`, and build the projects. 
+
+The project `libpicnic` creates a `.lib` file, containing the functions defined `in picnic.h`.  
+See the `example` project for a simple application that calls functions in 
+
+### Acknowledgments
+Thanks to Christian Paquin for providing feedback on picnic.h and for adding
+support for a Windows build
+
+
+### Contributing
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
diff --git a/VisualStudio/create_test_vectors.vcxproj b/VisualStudio/create_test_vectors.vcxproj
@@ -0,0 +1,147 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup Label="ProjectConfigurations">
+    <ProjectConfiguration Include="Debug|Win32">
+      <Configuration>Debug</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|Win32">
+      <Configuration>Release</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug|x64">
+      <Configuration>Debug</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|x64">
+      <Configuration>Release</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+  <PropertyGroup Label="Globals">
+    <VCProjectVersion>15.0</VCProjectVersion>
+    <ProjectGuid>{647784DD-10A4-43D2-AA0D-6B58682CB6E1}</ProjectGuid>
+    <RootNamespace>createtestvectors</RootNamespace>
+    <WindowsTargetPlatformVersion>10.0.16299.0</WindowsTargetPlatformVersion>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v141</PlatformToolset>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v141</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v141</PlatformToolset>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v141</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
+  <ImportGroup Label="ExtensionSettings">
+  </ImportGroup>
+  <ImportGroup Label="Shared">
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <PropertyGroup Label="UserMacros" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\$(ProjectName)\</OutDir>
+    <IntDir>$(Platform)\$(Configuration)\$(ProjectName)\</IntDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <IntDir>$(Platform)\$(Configuration)\$(ProjectName)\</IntDir>
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\$(ProjectName)\</OutDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\$(ProjectName)\</OutDir>
+    <IntDir>$(Platform)\$(Configuration)\$(ProjectName)\</IntDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <OutDir>$(SolutionDir)$(Platform)\$(Configuration)\$(ProjectName)\</OutDir>
+    <IntDir>$(Platform)\$(Configuration)\$(ProjectName)\</IntDir>
+  </PropertyGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <SDLCheck>true</SDLCheck>
+    </ClCompile>
+    <Link>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <AdditionalDependencies>bcrypt.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <SDLCheck>true</SDLCheck>
+    </ClCompile>
+    <Link>
+      <AdditionalDependencies>bcrypt.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <SDLCheck>true</SDLCheck>
+    </ClCompile>
+    <Link>
+      <AdditionalDependencies>bcrypt.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <SDLCheck>true</SDLCheck>
+    </ClCompile>
+    <Link>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <AdditionalDependencies>bcrypt.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemGroup>
+    <ClCompile Include="..\create_test_vectors.c" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="libpicnic.vcxproj">
+      <Project>{ce0f4c42-fd63-4b44-a722-a4772d1988e9}</Project>
+    </ProjectReference>
+  </ItemGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <ImportGroup Label="ExtensionTargets">
+  </ImportGroup>
+</Project>