Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Utilities/Ecc256.hpp@7:471901a04573, 2019-03-04 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Mar 04 08:10:00 2019 -0600
Revision:
7:471901a04573
Parent:
6:a8c83a2e6fa4 
Updated to version 1.7.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:f77ad7f72d04 1 /*******************************************************************************
IanBenzMaxim 0:f77ad7f72d04 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:f77ad7f72d04 3 *
IanBenzMaxim 0:f77ad7f72d04 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:f77ad7f72d04 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:f77ad7f72d04 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:f77ad7f72d04 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:f77ad7f72d04 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:f77ad7f72d04 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:f77ad7f72d04 10 *
IanBenzMaxim 0:f77ad7f72d04 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:f77ad7f72d04 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:f77ad7f72d04 13 *
IanBenzMaxim 0:f77ad7f72d04 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:f77ad7f72d04 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:f77ad7f72d04 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:f77ad7f72d04 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:f77ad7f72d04 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:f77ad7f72d04 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:f77ad7f72d04 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:f77ad7f72d04 21 *
IanBenzMaxim 0:f77ad7f72d04 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:f77ad7f72d04 25 *
IanBenzMaxim 0:f77ad7f72d04 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:f77ad7f72d04 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:f77ad7f72d04 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:f77ad7f72d04 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:f77ad7f72d04 30 * ownership rights.
IanBenzMaxim 0:f77ad7f72d04 31 *******************************************************************************/
IanBenzMaxim 0:f77ad7f72d04 32
IanBenzMaxim 0:f77ad7f72d04 33 #ifndef MaximInterface_Ecc256
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_Ecc256
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <stdint.h>
IanBenzMaxim 6:a8c83a2e6fa4 37 #include "array_span.hpp"
IanBenzMaxim 0:f77ad7f72d04 38 #include "Export.h"
IanBenzMaxim 0:f77ad7f72d04 39 #include "ManId.hpp"
IanBenzMaxim 0:f77ad7f72d04 40 #include "RomId.hpp"
IanBenzMaxim 0:f77ad7f72d04 41
IanBenzMaxim 0:f77ad7f72d04 42 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 43 namespace Ecc256 {
IanBenzMaxim 0:f77ad7f72d04 44
IanBenzMaxim 6:a8c83a2e6fa4 45 typedef array_span<uint_least8_t, 32> Scalar;
IanBenzMaxim 6:a8c83a2e6fa4 46
IanBenzMaxim 0:f77ad7f72d04 47 struct Point {
IanBenzMaxim 6:a8c83a2e6fa4 48 struct const_span {
IanBenzMaxim 6:a8c83a2e6fa4 49 Scalar::const_span x;
IanBenzMaxim 6:a8c83a2e6fa4 50 Scalar::const_span y;
IanBenzMaxim 6:a8c83a2e6fa4 51 };
IanBenzMaxim 6:a8c83a2e6fa4 52
IanBenzMaxim 6:a8c83a2e6fa4 53 struct span {
IanBenzMaxim 6:a8c83a2e6fa4 54 Scalar::span x;
IanBenzMaxim 6:a8c83a2e6fa4 55 Scalar::span y;
IanBenzMaxim 6:a8c83a2e6fa4 56
IanBenzMaxim 6:a8c83a2e6fa4 57 operator const_span() const {
IanBenzMaxim 6:a8c83a2e6fa4 58 const const_span sp = {x, y};
IanBenzMaxim 6:a8c83a2e6fa4 59 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 60 }
IanBenzMaxim 6:a8c83a2e6fa4 61 };
IanBenzMaxim 6:a8c83a2e6fa4 62
IanBenzMaxim 6:a8c83a2e6fa4 63 struct array {
IanBenzMaxim 6:a8c83a2e6fa4 64 Scalar::array x;
IanBenzMaxim 6:a8c83a2e6fa4 65 Scalar::array y;
IanBenzMaxim 6:a8c83a2e6fa4 66
IanBenzMaxim 6:a8c83a2e6fa4 67 operator span() {
IanBenzMaxim 6:a8c83a2e6fa4 68 const span sp = {x, y};
IanBenzMaxim 6:a8c83a2e6fa4 69 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 70 }
IanBenzMaxim 6:a8c83a2e6fa4 71
IanBenzMaxim 6:a8c83a2e6fa4 72 operator const_span() const {
IanBenzMaxim 6:a8c83a2e6fa4 73 const const_span sp = {x, y};
IanBenzMaxim 6:a8c83a2e6fa4 74 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 75 }
IanBenzMaxim 6:a8c83a2e6fa4 76 };
IanBenzMaxim 3:f818ea5172ed 77
IanBenzMaxim 6:a8c83a2e6fa4 78 private:
IanBenzMaxim 6:a8c83a2e6fa4 79 Point(); // deleted
IanBenzMaxim 0:f77ad7f72d04 80 };
IanBenzMaxim 0:f77ad7f72d04 81
IanBenzMaxim 6:a8c83a2e6fa4 82 MaximInterface_EXPORT void copy(Point::const_span src, Point::span dst);
IanBenzMaxim 6:a8c83a2e6fa4 83
IanBenzMaxim 0:f77ad7f72d04 84 typedef Scalar PrivateKey;
IanBenzMaxim 0:f77ad7f72d04 85 typedef Point PublicKey;
IanBenzMaxim 6:a8c83a2e6fa4 86
IanBenzMaxim 0:f77ad7f72d04 87 struct KeyPair {
IanBenzMaxim 6:a8c83a2e6fa4 88 struct const_span {
IanBenzMaxim 6:a8c83a2e6fa4 89 PrivateKey::const_span privateKey;
IanBenzMaxim 6:a8c83a2e6fa4 90 PublicKey::const_span publicKey;
IanBenzMaxim 6:a8c83a2e6fa4 91 };
IanBenzMaxim 6:a8c83a2e6fa4 92
IanBenzMaxim 6:a8c83a2e6fa4 93 struct span {
IanBenzMaxim 6:a8c83a2e6fa4 94 PrivateKey::span privateKey;
IanBenzMaxim 6:a8c83a2e6fa4 95 PublicKey::span publicKey;
IanBenzMaxim 6:a8c83a2e6fa4 96
IanBenzMaxim 6:a8c83a2e6fa4 97 operator const_span() const {
IanBenzMaxim 6:a8c83a2e6fa4 98 const const_span sp = {privateKey, publicKey};
IanBenzMaxim 6:a8c83a2e6fa4 99 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 100 }
IanBenzMaxim 6:a8c83a2e6fa4 101 };
IanBenzMaxim 6:a8c83a2e6fa4 102
IanBenzMaxim 6:a8c83a2e6fa4 103 struct array {
IanBenzMaxim 6:a8c83a2e6fa4 104 PrivateKey::array privateKey;
IanBenzMaxim 6:a8c83a2e6fa4 105 PublicKey::array publicKey;
IanBenzMaxim 6:a8c83a2e6fa4 106
IanBenzMaxim 6:a8c83a2e6fa4 107 operator span() {
IanBenzMaxim 6:a8c83a2e6fa4 108 const span sp = {privateKey, publicKey};
IanBenzMaxim 6:a8c83a2e6fa4 109 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 110 }
IanBenzMaxim 6:a8c83a2e6fa4 111
IanBenzMaxim 6:a8c83a2e6fa4 112 operator const_span() const {
IanBenzMaxim 6:a8c83a2e6fa4 113 const const_span sp = {privateKey, publicKey};
IanBenzMaxim 6:a8c83a2e6fa4 114 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 115 }
IanBenzMaxim 6:a8c83a2e6fa4 116 };
IanBenzMaxim 3:f818ea5172ed 117
IanBenzMaxim 6:a8c83a2e6fa4 118 private:
IanBenzMaxim 6:a8c83a2e6fa4 119 KeyPair(); // deleted
IanBenzMaxim 0:f77ad7f72d04 120 };
IanBenzMaxim 0:f77ad7f72d04 121
IanBenzMaxim 6:a8c83a2e6fa4 122 MaximInterface_EXPORT void copy(KeyPair::const_span src, KeyPair::span dst);
IanBenzMaxim 6:a8c83a2e6fa4 123
IanBenzMaxim 0:f77ad7f72d04 124 struct Signature {
IanBenzMaxim 6:a8c83a2e6fa4 125 struct const_span {
IanBenzMaxim 6:a8c83a2e6fa4 126 Scalar::const_span r;
IanBenzMaxim 6:a8c83a2e6fa4 127 Scalar::const_span s;
IanBenzMaxim 6:a8c83a2e6fa4 128 };
IanBenzMaxim 6:a8c83a2e6fa4 129
IanBenzMaxim 6:a8c83a2e6fa4 130 struct span {
IanBenzMaxim 6:a8c83a2e6fa4 131 Scalar::span r;
IanBenzMaxim 6:a8c83a2e6fa4 132 Scalar::span s;
IanBenzMaxim 6:a8c83a2e6fa4 133
IanBenzMaxim 6:a8c83a2e6fa4 134 operator const_span() const {
IanBenzMaxim 6:a8c83a2e6fa4 135 const const_span sp = {r, s};
IanBenzMaxim 6:a8c83a2e6fa4 136 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 137 }
IanBenzMaxim 6:a8c83a2e6fa4 138 };
IanBenzMaxim 6:a8c83a2e6fa4 139
IanBenzMaxim 6:a8c83a2e6fa4 140 struct array {
IanBenzMaxim 6:a8c83a2e6fa4 141 Scalar::array r;
IanBenzMaxim 6:a8c83a2e6fa4 142 Scalar::array s;
IanBenzMaxim 6:a8c83a2e6fa4 143
IanBenzMaxim 6:a8c83a2e6fa4 144 operator span() {
IanBenzMaxim 6:a8c83a2e6fa4 145 const span sp = {r, s};
IanBenzMaxim 6:a8c83a2e6fa4 146 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 147 }
IanBenzMaxim 6:a8c83a2e6fa4 148
IanBenzMaxim 6:a8c83a2e6fa4 149 operator const_span() const {
IanBenzMaxim 6:a8c83a2e6fa4 150 const const_span sp = {r, s};
IanBenzMaxim 6:a8c83a2e6fa4 151 return sp;
IanBenzMaxim 6:a8c83a2e6fa4 152 }
IanBenzMaxim 6:a8c83a2e6fa4 153 };
IanBenzMaxim 3:f818ea5172ed 154
IanBenzMaxim 6:a8c83a2e6fa4 155 private:
IanBenzMaxim 6:a8c83a2e6fa4 156 Signature(); // deleted
IanBenzMaxim 0:f77ad7f72d04 157 };
IanBenzMaxim 0:f77ad7f72d04 158
IanBenzMaxim 6:a8c83a2e6fa4 159 MaximInterface_EXPORT void copy(Signature::const_span src, Signature::span dst);
IanBenzMaxim 6:a8c83a2e6fa4 160
IanBenzMaxim 0:f77ad7f72d04 161 /// Data used to create a device key certificate for ECC-256 authenticators.
IanBenzMaxim 6:a8c83a2e6fa4 162 class CertificateData {
IanBenzMaxim 6:a8c83a2e6fa4 163 public:
IanBenzMaxim 6:a8c83a2e6fa4 164 typedef array_span<uint_least8_t, 2 * Scalar::size + RomId::size + ManId::size>
IanBenzMaxim 6:a8c83a2e6fa4 165 Result;
IanBenzMaxim 6:a8c83a2e6fa4 166
IanBenzMaxim 6:a8c83a2e6fa4 167 CertificateData() : result_() {}
IanBenzMaxim 6:a8c83a2e6fa4 168
IanBenzMaxim 6:a8c83a2e6fa4 169 /// Formatted data result.
IanBenzMaxim 6:a8c83a2e6fa4 170 Result::const_span result() const { return result_; }
IanBenzMaxim 6:a8c83a2e6fa4 171
IanBenzMaxim 7:471901a04573 172 /// @name Public Key
IanBenzMaxim 7:471901a04573 173 /// @brief Public key of the device.
IanBenzMaxim 6:a8c83a2e6fa4 174 /// @{
IanBenzMaxim 7:471901a04573 175
IanBenzMaxim 7:471901a04573 176 /// Get mutable Public Key.
IanBenzMaxim 6:a8c83a2e6fa4 177 MaximInterface_EXPORT PublicKey::span publicKey();
IanBenzMaxim 7:471901a04573 178
IanBenzMaxim 7:471901a04573 179 /// Get immutable Public Key.
IanBenzMaxim 6:a8c83a2e6fa4 180 PublicKey::const_span publicKey() const {
IanBenzMaxim 6:a8c83a2e6fa4 181 return const_cast<CertificateData &>(*this).publicKey();
IanBenzMaxim 6:a8c83a2e6fa4 182 }
IanBenzMaxim 6:a8c83a2e6fa4 183
IanBenzMaxim 7:471901a04573 184 /// Set Public Key.
IanBenzMaxim 6:a8c83a2e6fa4 185 CertificateData & setPublicKey(PublicKey::const_span publicKey) {
IanBenzMaxim 6:a8c83a2e6fa4 186 copy(publicKey, this->publicKey());
IanBenzMaxim 6:a8c83a2e6fa4 187 return *this;
IanBenzMaxim 6:a8c83a2e6fa4 188 }
IanBenzMaxim 7:471901a04573 189
IanBenzMaxim 6:a8c83a2e6fa4 190 /// @}
IanBenzMaxim 0:f77ad7f72d04 191
IanBenzMaxim 7:471901a04573 192 /// @name ROM ID
IanBenzMaxim 7:471901a04573 193 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 6:a8c83a2e6fa4 194 /// @{
IanBenzMaxim 7:471901a04573 195
IanBenzMaxim 7:471901a04573 196 /// Get mutable ROM ID.
IanBenzMaxim 6:a8c83a2e6fa4 197 RomId::span romId() {
IanBenzMaxim 6:a8c83a2e6fa4 198 return make_span(result_).subspan<romIdIdx, RomId::size>();
IanBenzMaxim 6:a8c83a2e6fa4 199 }
IanBenzMaxim 6:a8c83a2e6fa4 200
IanBenzMaxim 7:471901a04573 201 /// Get immutable ROM ID.
IanBenzMaxim 6:a8c83a2e6fa4 202 RomId::const_span romId() const {
IanBenzMaxim 6:a8c83a2e6fa4 203 return const_cast<CertificateData &>(*this).romId();
IanBenzMaxim 6:a8c83a2e6fa4 204 }
IanBenzMaxim 6:a8c83a2e6fa4 205
IanBenzMaxim 7:471901a04573 206 /// Set ROM ID.
IanBenzMaxim 6:a8c83a2e6fa4 207 CertificateData & setRomId(RomId::const_span romId) {
IanBenzMaxim 6:a8c83a2e6fa4 208 copy(romId, this->romId());
IanBenzMaxim 6:a8c83a2e6fa4 209 return *this;
IanBenzMaxim 6:a8c83a2e6fa4 210 }
IanBenzMaxim 7:471901a04573 211
IanBenzMaxim 6:a8c83a2e6fa4 212 /// @}
IanBenzMaxim 6:a8c83a2e6fa4 213
IanBenzMaxim 7:471901a04573 214 /// @name MAN ID
IanBenzMaxim 7:471901a04573 215 /// @brief Manufacturer ID of the device.
IanBenzMaxim 6:a8c83a2e6fa4 216 /// @{
IanBenzMaxim 7:471901a04573 217
IanBenzMaxim 7:471901a04573 218 /// Get mutable MAN ID.
IanBenzMaxim 6:a8c83a2e6fa4 219 ManId::span manId() {
IanBenzMaxim 6:a8c83a2e6fa4 220 return make_span(result_).subspan<manIdIdx, ManId::size>();
IanBenzMaxim 6:a8c83a2e6fa4 221 }
IanBenzMaxim 6:a8c83a2e6fa4 222
IanBenzMaxim 7:471901a04573 223 /// Get immutable MAN ID.
IanBenzMaxim 6:a8c83a2e6fa4 224 ManId::const_span manId() const {
IanBenzMaxim 6:a8c83a2e6fa4 225 return const_cast<CertificateData &>(*this).manId();
IanBenzMaxim 6:a8c83a2e6fa4 226 }
IanBenzMaxim 6:a8c83a2e6fa4 227
IanBenzMaxim 7:471901a04573 228 /// Set MAN ID.
IanBenzMaxim 6:a8c83a2e6fa4 229 CertificateData & setManId(ManId::const_span manId) {
IanBenzMaxim 6:a8c83a2e6fa4 230 copy(manId, this->manId());
IanBenzMaxim 6:a8c83a2e6fa4 231 return *this;
IanBenzMaxim 6:a8c83a2e6fa4 232 }
IanBenzMaxim 7:471901a04573 233
IanBenzMaxim 6:a8c83a2e6fa4 234 /// @}
IanBenzMaxim 6:a8c83a2e6fa4 235
IanBenzMaxim 6:a8c83a2e6fa4 236 private:
IanBenzMaxim 6:a8c83a2e6fa4 237 typedef Result::span::index_type index;
IanBenzMaxim 6:a8c83a2e6fa4 238
IanBenzMaxim 6:a8c83a2e6fa4 239 static const index publicKeyIdx = 0;
IanBenzMaxim 6:a8c83a2e6fa4 240 static const index romIdIdx = publicKeyIdx + 2 * Scalar::size;
IanBenzMaxim 6:a8c83a2e6fa4 241 static const index manIdIdx = romIdIdx + RomId::size;
IanBenzMaxim 6:a8c83a2e6fa4 242
IanBenzMaxim 6:a8c83a2e6fa4 243 Result::array result_;
IanBenzMaxim 6:a8c83a2e6fa4 244 };
IanBenzMaxim 0:f77ad7f72d04 245
IanBenzMaxim 0:f77ad7f72d04 246 } // namespace Ecc256
IanBenzMaxim 0:f77ad7f72d04 247 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 248
IanBenzMaxim 0:f77ad7f72d04 249 #endif