[Cryptech-Commits] [hardware] branch master updated: Add readme and license files

[git at cryptech.is]

This is an automated email from the git hooks/post-receive script.

paul at psgd.org pushed a commit to branch master
in repository hardware.

The following commit(s) were added to refs/heads/master by this push:
     new 552d123  Add readme and license files
552d123 is described below

commit 552d123e1a9138e29350dca4389f634e07bba009
Author: Paul Selkirk <paul at psgd.org>
AuthorDate: Tue May 1 18:42:07 2018 -0400

    Add readme and license files
---
 LICENSE.txt | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md   | 37 +++++++++++++++++++++++++++++++++++++
 2 files changed, 98 insertions(+)

diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..60c0552
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,61 @@
+Copyright (c) 2014-2016 NORDUnet A/S
+All rights reserved.
+
+  Redistribution and use in source and binary forms, with or
+  without modification, are permitted provided that the following
+  conditions are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above
+       copyright notice, this list of conditions and the following
+       disclaimer in the documentation and/or other materials provided
+       with the distribution.
+    3. Neither the name of the NORDUnet nor the names of its
+       contributors may be used to endorse or promote products derived
+       from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+
+The "Noise generator" and "Amplifier" parts of the circuit diagram are
+copied from the ARRGH project and therefore covered by this license
+(from http://www.stepladder-it.com/Downloads/arrgh-0.2.1alpha.txz):
+
+/*-
+ * Copyright (c) 2013-2014 Benedikt Stockebrand
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ */
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..58c48f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+STM32 firmware for Cryptech Alpha board
+=======================================
+
+The Alpha board is our first full prototype for an open-source hardware
+security module (HSM). It is a custom board with an STM32 Cortex-M4
+microcontroller and an Artix-7 FPGA, flash-based keystore, separate memory
+for the Key Encryption Key, etc. See the wiki for design documents.
+
+Copyrights
+==========
+
+The license for all work done on this in the CrypTech project is a
+3-clause BSD license.
+
+The "Noise generator" and "Amplifier" parts of the circuit diagram are
+copied from Benedikt Stockebrand's ARRGH project. 
+
+Both copyright statements are included in LICENSE.txt.
+
+Board Revisions
+===============
+
+1. `rev01` was the "dev-bridge" board, a daughterboard for the Novena,
+   which talked to the Novena's FPGA through the high-speed expansion
+   connector.
+
+2. `rev02` is the Alpha board, our first full prototype for an open-source
+   hardware security module (HSM). It is a custom board with an STM32
+   Cortex-M4 microcontroller and an Artix-7 FPGA, flash-based keystore,
+   separate memory for the Key Encryption Key, etc.
+
+   The board's form factor (4 x 4 in, 101.6 x 101.6 mm) was based on the
+   Intel NUC mini-PC, but there were some issues sourcing enough cases, so
+   only a few of these boards were made.
+
+3. `rev03` is functionally the same as `rev02`, but in a Eurocard form
+   factor (100 x 120 mm, aka "3Ux120").

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.