forked from ANSSI-FR/IPECC
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hw_accelerator_driver.h
250 lines (207 loc) · 7.51 KB
/
hw_accelerator_driver.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/*
* Copyright (C) 2023 - This file is part of IPECC project
*
* Authors:
* Karim KHALFALLAH <[email protected]>
* Ryad BENADJILA <[email protected]>
*
* Contributors:
* Adrian THILLARD
* Emmanuel PROUFF
*
* This software is licensed under GPL v2 license.
* See LICENSE file at the root folder of the project.
*/
#ifndef __HW_ACCELERATOR_DRIVER_H__
#define __HW_ACCELERATOR_DRIVER_H__
#include <stdint.h>
#include <stdbool.h>
#if defined(WITH_EC_HW_ACCELERATOR)
/* Hardware/external accelerator driver abstraction
*
* NOTE: big numbers are in BIG ENDIAN format, and their size is in bytes. No particular
* hypothesis must be taken on the address or size alignment of the buffers, or on the zero padding.
*
* For instance, the representation of the big number 0xabcdef can be either { 0xab, 0xcd, 0xef } on three
* bytes, or {0x00, 0x00, 0xab, 0xcd, 0xef } on five bytes.
*/
#ifdef KP_TRACE
#include <stdbool.h>
#endif
/* Supported command types */
typedef enum {
PT_ADD = 0,
PT_DBL = 1,
PT_CHK = 2,
PT_EQU = 3,
PT_OPP = 4,
PT_KP = 5,
PT_NEG = 6,
} ip_ecc_command;
/* Reset the hardware */
int hw_driver_reset(void);
/* To know if the IP is in 'debug' or 'production' mode */
int hw_driver_is_debug(uint32_t*);
/* Get all three version nbs of the IP (major, minor & patch) */
int hw_driver_get_version_tags(uint32_t*, uint32_t*, uint32_t*);
/* Enable TRNG post-processing logic (a call upon is required in Debug mode
* or the TRNG won't ever provide a single byte). */
int hw_driver_trng_post_proc_enable(void);
/* Enable TRNG post-processing logic */
int hw_driver_trng_post_proc_disable(void);
/* Set the curve parameters a, b, p and q */
int hw_driver_set_curve(const uint8_t *a, uint32_t a_sz, const uint8_t *b, uint32_t b_sz,
const uint8_t *p, uint32_t p_sz, const uint8_t *q, uint32_t q_sz);
/* Activate the blinding for scalar multiplication */
int hw_driver_set_blinding(uint32_t blinding_size);
/* Disable the blinding for scalar multiplication */
int hw_driver_disable_blinding(void);
/* Activate the shuffling for scalar multiplication */
int hw_driver_set_shuffling(void);
/* Disable the shuffling for scalar multiplication */
int hw_driver_disable_shuffling(void);
/* Activate and configure the periodic Z-remasking countermeasure
* (the 'period' arguement is expressed in number of bits of the scalar */
int hw_driver_set_zremask(uint32_t period);
/* Disable the periodic Z-remasking countermeasure for scalar multiplication */
int hw_driver_disable_zremask(void);
/* Debug feature: disable the XY-shuffling countermeasure */
int hw_driver_disable_xyshuf(void);
/* Debug feature: re-enble the XY-shuffling countermeasure */
int hw_driver_enable_xyshuf(void);
/* Check if an affine point (x, y) is on the curve that has been previously set in the hardware */
int hw_driver_is_on_curve(const uint8_t *x, uint32_t x_sz, const uint8_t *y, uint32_t y_sz,
int *on_curve);
/* Check if affine points (x1, y1) and (x2, y2) are equal */
int hw_driver_eq(const uint8_t *x1, uint32_t x1_sz, const uint8_t *y1, uint32_t y1_sz,
const uint8_t *x2, uint32_t x2_sz, const uint8_t *y2, uint32_t y2_sz,
int *is_eq);
/* Check if affine points (x1, y1) and (x2, y2) are opposite */
int hw_driver_opp(const uint8_t *x1, uint32_t x1_sz, const uint8_t *y1, uint32_t y1_sz,
const uint8_t *x2, uint32_t x2_sz, const uint8_t *y2, uint32_t y2_sz,
int *is_opp);
/* Check if the infinity point flag is set in the hardware for
* point at index idx
*/
int hw_driver_point_iszero(uint8_t idx, int *iszero);
/* Set the infinity point flag in the hardware for
* point at index idx
*/
int hw_driver_point_zero(uint8_t idx);
/* Unset the infinity point flag in the hardware for
* point at index idx
*/
int hw_driver_point_unzero(uint8_t idx);
/* Return (out_x, out_y) = -(x, y) */
int hw_driver_neg(const uint8_t *x, uint32_t x_sz, const uint8_t *y, uint32_t y_sz,
uint8_t *out_x, uint32_t *out_x_sz, uint8_t *out_y, uint32_t *out_y_sz);
/* Return (out_x, out_y) = 2 * (x, y) */
int hw_driver_dbl(const uint8_t *x, uint32_t x_sz, const uint8_t *y, uint32_t y_sz,
uint8_t *out_x, uint32_t *out_x_sz, uint8_t *out_y, uint32_t *out_y_sz);
/* Return (out_x, out_y) = (x1, y1) + (x2, y2) */
int hw_driver_add(const uint8_t *x1, uint32_t x1_sz, const uint8_t *y1, uint32_t y1_sz,
const uint8_t *x2, uint32_t x2_sz, const uint8_t *y2, uint32_t y2_sz,
uint8_t *out_x, uint32_t *out_x_sz, uint8_t *out_y, uint32_t *out_y_sz);
typedef struct {
uint32_t r0z;
uint32_t r1z;
uint32_t kap;
uint32_t kapp;
uint32_t zu;
uint32_t zc;
uint32_t jnbbit;
} kp_exp_flags_t;
/* The following 'kp_trace_info' structure allows any calling program (stat. linked with
* the driver) to get a certain number of IP internal states/infos collected during a [k]P
* computation through breakpoints and step-by-step execution (this includes e.g values of
* a few random numbers/masks, coordinates of intermiediate points, etc).
*/
typedef struct {
/* Main security parameter nn */
uint32_t nn;
/* Random values (along with a valig flag for each) */
uint32_t* lambda;
bool lambda_valid;
uint32_t* phi0;
bool phi0_valid;
uint32_t* phi1;
bool phi1_valid;
uint32_t* alpha;
bool alpha_valid;
/* Nb of trace steps (roughly the nb of opcodes for this [k]P run) */
uint32_t nb_steps;
/* Temporary value of XR0, YR0, XR1 and YR1 */
uint32_t* nb_xr0;
uint32_t* nb_yr0;
uint32_t* nb_xr1;
uint32_t* nb_yr1;
uint32_t* nb_zr01;
/* A huge char buffer to printf all required infos. */
char* msg;
uint32_t msgsz;
uint32_t msgsz_max;
} kp_trace_info_t;
/* The size of the statically allocated buffer that field
* 'msgsz_max' of struct 'kp_trace_info_t' above should not
* exceed. */
#define KP_TRACE_PRINTF_SZ (16*1024*1024) /* 16 MB */
/* Return (out_x, out_y) = scalar * (x, y) */
int hw_driver_mul(const uint8_t *x, uint32_t x_sz, const uint8_t *y, uint32_t y_sz,
const uint8_t *scalar, uint32_t scalar_sz,
uint8_t *out_x, uint32_t *out_x_sz, uint8_t *out_y, uint32_t *out_y_sz,
kp_trace_info_t* ktrc);
/* Set the small scalar size in the hardware */
int hw_driver_set_small_scalar_size(uint32_t bit_sz);
/* Complete bypass the TRNG function (both entropy source,
* post-processing, and server) */
int hw_driver_bypass_full_trng_DBG(uint32_t bit);
/* Disable token feature */
int hw_driver_disable_token_DBG(void);
/* (Re-)enable token feature */
int hw_driver_enable_token_DBG(void);
/* Patching microcode in the IP */
int hw_driver_patch_microcode_DBG(uint32_t*, uint32_t, uint32_t);
/*
* Error/printf formating
*/
#ifdef TERM_CTRL_AND_COLORS
#define KNRM "\x1B[0m"
#define KRED "\x1B[31m"
#define KGRN "\x1B[32m"
#define KYEL "\x1B[33m"
#define KBLU "\x1B[34m"
#define KMAG "\x1B[35m"
#define KCYN "\x1B[36m"
#define KWHT "\x1B[37m"
#define KORA "\033[93m"
#define KUNK "\033[91m"
#define KVIO "\033[38;5;199m"
#define KERASELINE "\033[2K"
#define KMVUP1LINE "\033[1A"
#define KBOLD "\033[1m"
#define KNOBOLD "\033[22m"
#define KCURSORVIS "\033[?25h"
#define KCURSORINVIS "\033[?25l"
#else
#define KNRM ""
#define KRED ""
#define KGRN ""
#define KYEL ""
#define KBLU ""
#define KMAG ""
#define KCYN ""
#define KWHT ""
#define KORA ""
#define KUNK "\033[91m"
#define KVIO ""
#define KERASELINE ""
#define KMVUP1LINE ""
#define KBOLD ""
#define KNOBOLD ""
#define KCURSORVIS ""
#define KCURSORINVIS ""
#endif /* TERM_COLORS */
#define KERR KUNK
#define KINF KORA
#endif /* !WITH_EC_HW_ACCELERATOR */
#endif /* __HW_ACCELERATOR_DRIVER_H__ */