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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
|
/** @file
Elliptic Curve and ECDH API implementation based on OpenSSL
Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/BaseCryptLib.h>
#include <Library/DebugLib.h>
/**
Initialize new opaque EcGroup object. This object represents an EC curve and
and is used for calculation within this group. This object should be freed
using EcGroupFree() function.
@param[in] CryptoNid Identifying number for the ECC curve (Defined in
BaseCryptLib.h).
@retval EcGroup object On success.
@retval NULL On failure.
**/
VOID *
EFIAPI
EcGroupInit (
IN UINTN CryptoNid
)
{
ASSERT (FALSE);
return NULL;
}
/**
Get EC curve parameters. While elliptic curve equation is Y^2 mod P = (X^3 + AX + B) Mod P.
This function will set the provided Big Number objects to the corresponding
values. The caller needs to make sure all the "out" BigNumber parameters
are properly initialized.
@param[in] EcGroup EC group object.
@param[out] BnPrime Group prime number.
@param[out] BnA A coefficient.
@param[out] BnB B coefficient..
@param[in] BnCtx BN context.
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcGroupGetCurve (
IN CONST VOID *EcGroup,
OUT VOID *BnPrime,
OUT VOID *BnA,
OUT VOID *BnB,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Get EC group order.
This function will set the provided Big Number object to the corresponding
value. The caller needs to make sure that the "out" BigNumber parameter
is properly initialized.
@param[in] EcGroup EC group object.
@param[out] BnOrder Group prime number.
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcGroupGetOrder (
IN VOID *EcGroup,
OUT VOID *BnOrder
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Free previously allocated EC group object using EcGroupInit().
@param[in] EcGroup EC group object to free.
**/
VOID
EFIAPI
EcGroupFree (
IN VOID *EcGroup
)
{
ASSERT (FALSE);
}
/**
Initialize new opaque EC Point object. This object represents an EC point
within the given EC group (curve).
@param[in] EC Group, properly initialized using EcGroupInit().
@retval EC Point object On success.
@retval NULL On failure.
**/
VOID *
EFIAPI
EcPointInit (
IN CONST VOID *EcGroup
)
{
ASSERT (FALSE);
return NULL;
}
/**
Free previously allocated EC Point object using EcPointInit().
@param[in] EcPoint EC Point to free.
@param[in] Clear TRUE iff the memory should be cleared.
**/
VOID
EFIAPI
EcPointDeInit (
IN VOID *EcPoint,
IN BOOLEAN Clear
)
{
ASSERT (FALSE);
}
/**
Get EC point affine (x,y) coordinates.
This function will set the provided Big Number objects to the corresponding
values. The caller needs to make sure all the "out" BigNumber parameters
are properly initialized.
@param[in] EcGroup EC group object.
@param[in] EcPoint EC point object.
@param[out] BnX X coordinate.
@param[out] BnY Y coordinate.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointGetAffineCoordinates (
IN CONST VOID *EcGroup,
IN CONST VOID *EcPoint,
OUT VOID *BnX,
OUT VOID *BnY,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Set EC point affine (x,y) coordinates.
@param[in] EcGroup EC group object.
@param[in] EcPoint EC point object.
@param[in] BnX X coordinate.
@param[in] BnY Y coordinate.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointSetAffineCoordinates (
IN CONST VOID *EcGroup,
IN VOID *EcPoint,
IN CONST VOID *BnX,
IN CONST VOID *BnY,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
EC Point addition. EcPointResult = EcPointA + EcPointB.
@param[in] EcGroup EC group object.
@param[out] EcPointResult EC point to hold the result. The point should
be properly initialized.
@param[in] EcPointA EC Point.
@param[in] EcPointB EC Point.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointAdd (
IN CONST VOID *EcGroup,
OUT VOID *EcPointResult,
IN CONST VOID *EcPointA,
IN CONST VOID *EcPointB,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Variable EC point multiplication. EcPointResult = EcPoint * BnPScalar.
@param[in] EcGroup EC group object.
@param[out] EcPointResult EC point to hold the result. The point should
be properly initialized.
@param[in] EcPoint EC Point.
@param[in] BnPScalar P Scalar.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointMul (
IN CONST VOID *EcGroup,
OUT VOID *EcPointResult,
IN CONST VOID *EcPoint,
IN CONST VOID *BnPScalar,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Calculate the inverse of the supplied EC point.
@param[in] EcGroup EC group object.
@param[in,out] EcPoint EC point to invert.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointInvert (
IN CONST VOID *EcGroup,
IN OUT VOID *EcPoint,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Check if the supplied point is on EC curve.
@param[in] EcGroup EC group object.
@param[in] EcPoint EC point to check.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE On curve.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointIsOnCurve (
IN CONST VOID *EcGroup,
IN CONST VOID *EcPoint,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Check if the supplied point is at infinity.
@param[in] EcGroup EC group object.
@param[in] EcPoint EC point to check.
@retval TRUE At infinity.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointIsAtInfinity (
IN CONST VOID *EcGroup,
IN CONST VOID *EcPoint
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Check if EC points are equal.
@param[in] EcGroup EC group object.
@param[in] EcPointA EC point A.
@param[in] EcPointB EC point B.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE A == B.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointEqual (
IN CONST VOID *EcGroup,
IN CONST VOID *EcPointA,
IN CONST VOID *EcPointB,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Set EC point compressed coordinates. Points can be described in terms of
their compressed coordinates. For a point (x, y), for any given value for x
such that the point is on the curve there will only ever be two possible
values for y. Therefore, a point can be set using this function where BnX is
the x coordinate and YBit is a value 0 or 1 to identify which of the two
possible values for y should be used.
@param[in] EcGroup EC group object.
@param[in] EcPoint EC Point.
@param[in] BnX X coordinate.
@param[in] YBit 0 or 1 to identify which Y value is used.
@param[in] BnCtx BN context, created with BigNumNewContext().
@retval TRUE On success.
@retval FALSE Otherwise.
**/
BOOLEAN
EFIAPI
EcPointSetCompressedCoordinates (
IN CONST VOID *EcGroup,
IN VOID *EcPoint,
IN CONST VOID *BnX,
IN UINT8 YBit,
IN VOID *BnCtx
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Allocates and Initializes one Elliptic Curve Context for subsequent use
with the NID.
@param[in] Nid cipher NID
@return Pointer to the Elliptic Curve Context that has been initialized.
If the allocations fails, EcNewByNid() returns NULL.
**/
VOID *
EFIAPI
EcNewByNid (
IN UINTN Nid
)
{
ASSERT (FALSE);
return NULL;
}
/**
Release the specified EC context.
@param[in] EcContext Pointer to the EC context to be released.
**/
VOID
EFIAPI
EcFree (
IN VOID *EcContext
)
{
ASSERT (FALSE);
}
/**
Generates EC key and returns EC public key (X, Y), Please note, this function uses
pseudo random number generator. The caller must make sure RandomSeed()
function was properly called before.
The Ec context should be correctly initialized by EcNewByNid.
This function generates random secret, and computes the public key (X, Y), which is
returned via parameter Public, PublicSize.
X is the first half of Public with size being PublicSize / 2,
Y is the second half of Public with size being PublicSize / 2.
EC context is updated accordingly.
If the Public buffer is too small to hold the public X, Y, FALSE is returned and
PublicSize is set to the required buffer size to obtain the public X, Y.
For P-256, the PublicSize is 64. First 32-byte is X, Second 32-byte is Y.
For P-384, the PublicSize is 96. First 48-byte is X, Second 48-byte is Y.
For P-521, the PublicSize is 132. First 66-byte is X, Second 66-byte is Y.
If EcContext is NULL, then return FALSE.
If PublicSize is NULL, then return FALSE.
If PublicSize is large enough but Public is NULL, then return FALSE.
@param[in, out] EcContext Pointer to the EC context.
@param[out] PublicKey Pointer to t buffer to receive generated public X,Y.
@param[in, out] PublicKeySize On input, the size of Public buffer in bytes.
On output, the size of data returned in Public buffer in bytes.
@retval TRUE EC public X,Y generation succeeded.
@retval FALSE EC public X,Y generation failed.
@retval FALSE PublicKeySize is not large enough.
**/
BOOLEAN
EFIAPI
EcGenerateKey (
IN OUT VOID *EcContext,
OUT UINT8 *PublicKey,
IN OUT UINTN *PublicKeySize
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Gets the public key component from the established EC context.
The Ec context should be correctly initialized by EcNewByNid, and successfully
generate key pair from EcGenerateKey().
For P-256, the PublicSize is 64. First 32-byte is X, Second 32-byte is Y.
For P-384, the PublicSize is 96. First 48-byte is X, Second 48-byte is Y.
For P-521, the PublicSize is 132. First 66-byte is X, Second 66-byte is Y.
@param[in, out] EcContext Pointer to EC context being set.
@param[out] PublicKey Pointer to t buffer to receive generated public X,Y.
@param[in, out] PublicKeySize On input, the size of Public buffer in bytes.
On output, the size of data returned in Public buffer in bytes.
@retval TRUE EC key component was retrieved successfully.
@retval FALSE Invalid EC key component.
**/
BOOLEAN
EFIAPI
EcGetPubKey (
IN OUT VOID *EcContext,
OUT UINT8 *PublicKey,
IN OUT UINTN *PublicKeySize
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Computes exchanged common key.
Given peer's public key (X, Y), this function computes the exchanged common key,
based on its own context including value of curve parameter and random secret.
X is the first half of PeerPublic with size being PeerPublicSize / 2,
Y is the second half of PeerPublic with size being PeerPublicSize / 2.
If EcContext is NULL, then return FALSE.
If PeerPublic is NULL, then return FALSE.
If PeerPublicSize is 0, then return FALSE.
If Key is NULL, then return FALSE.
If KeySize is not large enough, then return FALSE.
For P-256, the PeerPublicSize is 64. First 32-byte is X, Second 32-byte is Y.
For P-384, the PeerPublicSize is 96. First 48-byte is X, Second 48-byte is Y.
For P-521, the PeerPublicSize is 132. First 66-byte is X, Second 66-byte is Y.
@param[in, out] EcContext Pointer to the EC context.
@param[in] PeerPublic Pointer to the peer's public X,Y.
@param[in] PeerPublicSize Size of peer's public X,Y in bytes.
@param[in] CompressFlag Flag of PeerPublic is compressed or not.
@param[out] Key Pointer to the buffer to receive generated key.
@param[in, out] KeySize On input, the size of Key buffer in bytes.
On output, the size of data returned in Key buffer in bytes.
@retval TRUE EC exchanged key generation succeeded.
@retval FALSE EC exchanged key generation failed.
@retval FALSE KeySize is not large enough.
**/
BOOLEAN
EFIAPI
EcDhComputeKey (
IN OUT VOID *EcContext,
IN CONST UINT8 *PeerPublic,
IN UINTN PeerPublicSize,
IN CONST INT32 *CompressFlag,
OUT UINT8 *Key,
IN OUT UINTN *KeySize
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Carries out the EC-DSA signature.
This function carries out the EC-DSA signature.
If the Signature buffer is too small to hold the contents of signature, FALSE
is returned and SigSize is set to the required buffer size to obtain the signature.
If EcContext is NULL, then return FALSE.
If MessageHash is NULL, then return FALSE.
If HashSize need match the HashNid. HashNid could be SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512.
If SigSize is large enough but Signature is NULL, then return FALSE.
For P-256, the SigSize is 64. First 32-byte is R, Second 32-byte is S.
For P-384, the SigSize is 96. First 48-byte is R, Second 48-byte is S.
For P-521, the SigSize is 132. First 66-byte is R, Second 66-byte is S.
@param[in] EcContext Pointer to EC context for signature generation.
@param[in] HashNid hash NID
@param[in] MessageHash Pointer to octet message hash to be signed.
@param[in] HashSize Size of the message hash in bytes.
@param[out] Signature Pointer to buffer to receive EC-DSA signature.
@param[in, out] SigSize On input, the size of Signature buffer in bytes.
On output, the size of data returned in Signature buffer in bytes.
@retval TRUE Signature successfully generated in EC-DSA.
@retval FALSE Signature generation failed.
@retval FALSE SigSize is too small.
**/
BOOLEAN
EFIAPI
EcDsaSign (
IN VOID *EcContext,
IN UINTN HashNid,
IN CONST UINT8 *MessageHash,
IN UINTN HashSize,
OUT UINT8 *Signature,
IN OUT UINTN *SigSize
)
{
ASSERT (FALSE);
return FALSE;
}
/**
Verifies the EC-DSA signature.
If EcContext is NULL, then return FALSE.
If MessageHash is NULL, then return FALSE.
If Signature is NULL, then return FALSE.
If HashSize need match the HashNid. HashNid could be SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512.
For P-256, the SigSize is 64. First 32-byte is R, Second 32-byte is S.
For P-384, the SigSize is 96. First 48-byte is R, Second 48-byte is S.
For P-521, the SigSize is 132. First 66-byte is R, Second 66-byte is S.
@param[in] EcContext Pointer to EC context for signature verification.
@param[in] HashNid hash NID
@param[in] MessageHash Pointer to octet message hash to be checked.
@param[in] HashSize Size of the message hash in bytes.
@param[in] Signature Pointer to EC-DSA signature to be verified.
@param[in] SigSize Size of signature in bytes.
@retval TRUE Valid signature encoded in EC-DSA.
@retval FALSE Invalid signature or invalid EC context.
**/
BOOLEAN
EFIAPI
EcDsaVerify (
IN VOID *EcContext,
IN UINTN HashNid,
IN CONST UINT8 *MessageHash,
IN UINTN HashSize,
IN CONST UINT8 *Signature,
IN UINTN SigSize
)
{
ASSERT (FALSE);
return FALSE;
}
|