| David Brown | fecda2d | 2017-09-07 10:20:34 -0600 | [diff] [blame] | 1 | |
| 2 | ================================================================================ |
| 3 | |
| 4 | TinyCrypt Cryptographic Library |
| 5 | |
| 6 | ================================================================================ |
| 7 | |
| Fabio Utzig | 3efe6b6 | 2017-09-22 16:03:24 -0300 | [diff] [blame] | 8 | Copyright (c) 2017, Intel Corporation. All rights reserved. |
| David Brown | fecda2d | 2017-09-07 10:20:34 -0600 | [diff] [blame] | 9 | |
| 10 | Redistribution and use in source and binary forms, with or without modification, |
| 11 | are permitted provided that the following conditions are met: |
| 12 | |
| 13 | - Redistributions of source code must retain the above copyright notice, this |
| 14 | list of conditions and the following disclaimer. |
| 15 | |
| 16 | - Redistributions in binary form must reproduce the above copyright notice, |
| 17 | this list of conditions and the following disclaimer in the documentation |
| 18 | and/or other materials provided with the distribution. |
| 19 | |
| 20 | - Neither the name of the Intel Corporation nor the names of its contributors |
| 21 | may be used to endorse or promote products derived from this software |
| 22 | without specific prior written permission. |
| 23 | |
| 24 | |
| 25 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
| 26 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| 27 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 28 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR |
| 29 | ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
| 30 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| 31 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
| 32 | ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 33 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| 34 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 35 | |
| 36 | ================================================================================ |
| 37 | |
| 38 | Overview: |
| 39 | |
| 40 | The TinyCrypt Library provides an implementation for constrained devices of a |
| 41 | minimal set of standard cryptography primitives. |
| 42 | |
| 43 | Please, ***SEE THE DOCUMENTATION*** folder for more information on the supported |
| 44 | cryptographic primitives and the limitations of TinyCrypt library. For usage, |
| 45 | security and technicalities, please see the corresponding header file of each |
| 46 | cryptographic primitive. |
| 47 | |
| 48 | ================================================================================ |
| 49 | |
| 50 | Organization: |
| 51 | |
| 52 | /lib: C source code of the cryptographic primitives. |
| Fabio Utzig | 3efe6b6 | 2017-09-22 16:03:24 -0300 | [diff] [blame] | 53 | /lib/include/tinycrypt: C header files of the cryptographic primitives. |
| David Brown | fecda2d | 2017-09-07 10:20:34 -0600 | [diff] [blame] | 54 | /tests: Test vectors of the cryptographic primitives. |
| 55 | /doc: Documentation of TinyCrypt. |
| 56 | |
| 57 | ================================================================================ |
| 58 | |
| 59 | Building: |
| 60 | |
| 61 | 1) In Makefile.conf set: |
| 62 | - CFLAGS for compiler flags. |
| 63 | - CC for compiler. |
| Fabio Utzig | 3efe6b6 | 2017-09-22 16:03:24 -0300 | [diff] [blame] | 64 | - ENABLE_TESTS for enabling (true) or disabling (false) tests compilation. |
| David Brown | fecda2d | 2017-09-07 10:20:34 -0600 | [diff] [blame] | 65 | 2) In lib/Makefile select the primitives required by your project. |
| 66 | 3) In tests/Makefile select the corresponding tests of the selected primitives. |
| 67 | 4) make |
| 68 | 5) run tests in tests/ |
| 69 | |
| 70 | ================================================================================ |
| 71 | |