-
Notifications
You must be signed in to change notification settings - Fork 5
/
Fido2.pas
2736 lines (2230 loc) · 79.8 KB
/
Fido2.pas
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
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// ###################################################################
// #### This file is part of the mathematics library project, and is
// #### offered under the licence agreement described on
// #### http://www.mrsoft.org/
// ####
// #### Copyright:(c) 2019, Michael R. . All rights reserved.
// ####
// #### Unless required by applicable law or agreed to in writing, software
// #### distributed under the License is distributed on an "AS IS" BASIS,
// #### WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// #### See the License for the specific language governing permissions and
// #### limitations under the License.
// ###################################################################
unit Fido2;
interface
uses SysUtils, Classes, Fido2dll, Generics.Collections, cbor;
type
EFidoBaseException = class(Exception);
EFidoAllocException = class(EFidoBaseException);
EFidoPropertyException = class(EFidoBaseException);
EFidoException = class(EFidoBaseException)
private
fErrCode : integer;
public
property ErrCode : integer read fErrCode;
constructor Create( aErrCode : integer );
end;
type
TFidoChallenge = Array[0..31] of byte; // from https://fidoalliance.org/specs/fido-v2.0-rd-20170927/fido-client-to-authenticator-protocol-v2.0-rd-20170927.html
TFidoUserId = Array[0..31] of byte; // here used as the same type as the challange
TFidoSHA256Hash = Array[0..31] of byte;
TFidoLogMsg = procedure(msg : string) of Object;
const cMaxSmallBlobLen = 32;
// ###################################################
// #### Encapsulation of the fido_cbor_xxx functions
// ###################################################
type
TFido2CBOROption = class(TObject)
private
fName : string;
fValue : boolean;
public
property Name : string read fName;
property Value : boolean read fValue;
constructor Create( aName : string; aVal: boolean);
end;
TFido2CBOR = class(TObject)
private
fCBORVersions : TStringList;
fCBORExtension : TStringList;
fCBORTransports : TStringList;
fCBORCertNames : TStringList;
fCBORUUID : TBytes;
fCBORGuid : string;
fCBORCose : Array of integer;
fCBOROptions : Array of TFido2CBOROption;
fCBORPinProtocols : TBytes;
fCBORmaxMsgSize : UInt64;
fCBORmaxLargeBlob : UInt64;
fCBORMaxCredCntLst : UInt64;
fCBORMaxCredidlen : UInt64;
fCBORMaxBlobLen : UInt64;
fCBORFWVersion : UInt64;
fCBORMaxrpidMinpinlen : UINT64;
fCBORMinPinLen : UINT64;
fCBORUVAttempts : UINT64;
fCBORUVMOdality : UINT64;
fCBORRKRemaining : INT64;
fCBORNewPinRequired : boolean;
procedure ReadProperties( dev : PFido_dev_t );
function GetOption(index: integer): TFido2CBOROption;
function GetOptionsCnt: integer;
function GetCoseAlgorithm(index: integer): integer;
function GetCoseAlgorithmCnt: integer;
function GetCertName(index: Integer): string;
function GetCertNameLen: integer;
public
property MaxMsgSize : UInt64 read fCBORmaxMsgSize;
property UUID : TBytes read fCBORUUID;
property OptionsCnt : integer read GetOptionsCnt;
property Options[index : integer] : TFido2CBOROption read GetOption;
property CertName[index : Integer] : string read GetCertName;
property CertNameLen : integer read GetCertNameLen;
property Versions : TStringList read fCBORVersions;
property Extensions : TStringList read fCBORExtension;
property PinProtocols : TBytes read fCBORPinProtocols;
property MaxBlobLen : UInt64 read fCBORMaxBlobLen;
property MaxLargeBlob : UInt64 read fCBORmaxLargeBlob;
property FWVersion : UInt64 read fCBORFWVersion;
property MaxCredCntList : UInt64 read fCBORMaxCredCntLst;
property MaxCredIDLen : UInt64 read fCBORMaxCredidlen;
property CoseAlgorithmCnt : integer read GetCoseAlgorithmCnt;
property CoseAlgorithms[index : integer] : integer read GetCoseAlgorithm;
function UUIDToGuid : String;
constructor Create( dev : PFido_dev_t );
destructor Destroy; override;
end;
// ###################################################
// #### Fido device
// ###################################################
type
TFido2DevFlag = (dfWink, dfCBOR, dfMSg);
TFidoDevFlags = set of TFido2DevFlag;
type
TFidoDevice = class;
TFidoDevList = TObjectList<TFidoDevice>;
TFidoDevice = class(TObject)
private
fDev : Pfido_dev_t;
fUSBPath : UTF8String;
fManufactStr : string;
fProductInfo : string;
fVendor : integer;
fProduct : integer;
fProtocol : byte;
fDevMajor : integer;
fDevMinor : integer;
fDevBuild : integer;
fRetryCnt : integer;
fSupportPin : boolean;
fSupportCredProtection : boolean;
fSupportPermissions : boolean;
fDevFlags : TFidoDevFlags;
fIsFido2 : boolean;
fCbor : TFido2CBOR;
fUVRetryCnt: integer;
fHasUserVerification: boolean;
fSupportUserVerification: boolean;
fSupportCredManager: boolean;
fHasBlobSupport: boolean;
fIsWinHello: boolean;
procedure OpenDevice;
procedure CloseDevice;
function GetFirmware: string;
function GetHasPin: boolean;
function GetLargeBlobRaw: TBytes;
function GetLargeBlob: TCborItem;
function GetLargeBlobKey(key: TBytes): TBytes;
protected
procedure ReadProperties(di : Pfido_dev_info_t);
procedure ReadDev;
public
// fetch the complete list of keys -> use this as the base enumeration
// note the function needs to be run in Administrator mode!
class function DevList : TFidoDevList;
property ManufactStr : string read fManufactStr;
property ProductInfo : string read fProductInfo;
property Vendor : integer read fVendor;
property Product : integer read fProduct;
property Firmware : string read GetFirmware;
property USBPath : UTF8String read fUSBPath;
property RetryCnt : integer read fRetryCnt;
property UserVerificatinRetryCount : integer read fUVRetryCnt;
property HasUserVerification : boolean read fHasUserVerification;
property Protocol : byte read fProtocol;
property Flags : TFidoDevFlags read fDevFlags;
property HasPin : boolean read GetHasPin;
property SupportPin : boolean read fSupportPin;
property SupportCredProtection : boolean read fSupportCredProtection;
property SupportUserVerification : boolean read fSupportUserVerification;
property SupportCredManager : boolean read fSupportCredManager;
property SupportPermissions : boolean read fSupportPermissions;
property DevHdl : Pfido_dev_t read fDev;
// only valid on fido2 devices
property CBOR : TFido2CBOR read FCBOR;
property IsFido2 : boolean read fIsFido2;
property IsWinHello : boolean read fIsWinHello;
property HasBlobSupport : boolean read fHasBlobSupport;
property LargeBlobRaw : TBytes read GetLargeBlobRaw;
property LargeBlobArr : TCborItem read GetLargeBlob;
property LargeBlob[ key : TBytes ] : TBytes read GetLargeBlobKey;
procedure SetLargeBlobArr( data : TBytes; pin : string ); overload;
procedure SetLargeBlob( key, data : TBytes; pin : string );
procedure SetLargeBlobArr( cborData : TCborItem; pin : string ); overload;
procedure SetTimeout( ms : integer );
procedure ForceFido2;
procedure ForceU2F;
function SetPin( oldPin : string; newPin : string; var ErrStr : string) : boolean;
// special Yubico Reset procedure: This function may only be called within 5 seconds after
// attaching the key.
procedure Reset;
// touch control
procedure BeginTouch;
function GetTouchStatus(waitMs : integer = 0) : integer;
// cancels the latest device operation (waiting for user interaction)
procedure Cancel;
// constructors
constructor CreateFromPath( usbPath : String );
constructor CreateFromDevInfo( di : Pfido_dev_info_t );
destructor Destroy; override;
end;
type
TFidoBiometricTemplate = class(TObject)
private
fTemplate : Pfido_bio_template_t;
fOwnsTemplate : boolean;
function GetID: TBytes;
function GetString: string;
procedure SetId(const Value: TBytes);
procedure SetString(const Value: string);
public
property Name : string read GetString write SetString;
property ID : TBytes read GetID write SetId;
constructor Create;
constructor CreateByRef( tpl : Pfido_bio_template_t );
destructor Destroy; override;
end;
TFidoBiometricTemplateArr = TObjectList<TFidoBiometricTemplate>;
type
TFidoBiometricDevice = class;
TFidoBiometricTplArray = class(TObject)
private
fArrObj : TFidoBiometricTemplateArr;
fTplArr : Pfido_bio_template_array_t;
procedure Clear;
procedure Init;
function GetCount: integer;
function GetItem(index: integer): TFidoBiometricTemplate;
public
property Count : integer read GetCount;
property Items[ index : integer ] : TFidoBiometricTemplate read GetItem;
procedure InitFromDev( dev : TFidoBiometricDevice; pin : string );
constructor Create;
destructor Destroy; override;
end;
TFidoBiometricEnroll = class(TObject)
private
fEnroll : Pfido_bio_enroll_t;
public
function LastStatus : byte;
function RemainingSamples : byte;
constructor Create;
destructor Destroy; override;
end;
TFidoBiometricInfo = class(TObject)
private
fInfo : Pfido_bio_info_t;
public
function MaxSamples : byte;
function DevType : byte;
constructor Create;
destructor Destroy; override;
end;
TFidoBiometricDevice = class(TFidoDevice)
private
fEnroll : TFidoBiometricEnroll;
fInfo : TFidoBiometricInfo;
public
function TemplateArr( pin : string ) : TFidoBiometricTplArray;
function GetInfo : TFidoBiometricInfo;
function EnrollBegin(pin : string; template : TFidoBiometricTemplate; timeout : UInt32) : TFidoBiometricEnroll;
procedure EnrollContinue( template : TFidoBiometricTemplate; timeout : UInt32 );
procedure EnrollCancel;
procedure EnrollRemove( template : TFidoBiometricTemplate; pin : string );
destructor Destroy; override;
end;
// ###################################################
// #### Credential api
// ###################################################
type
TFidoCredentialType = (ctCOSEES256 = COSE_ES256, ctCoseEDDSA = COSE_EDDSA, ctCoseES384 = COSE_ES384, ctCoseRS256 = COSE_RS256);
TFidoCredentialFmt = (fmNone, fmFido2, fmU2F, fmTPM);
TBaseFido2Credentials = class(TObject)
private
function GetCredID: TBytes;
function GetAAGuid: TBytes;
function GetCredSigCount: Integer;
procedure SetLargeBlobFlag(const Value: boolean);
procedure SetID(const Value: string);
procedure SetClientData(const Value: string);
function GetMinPinLen: integer;
procedure SetMinPinLen(const Value: integer);
protected
fCred : Pfido_cred_t;
fCredType : TFidoCredentialType;
fRelyingParty : string;
fRelyingPartyName : string;
fClientDataHash : TFidoSHA256Hash; // client data hash
fEnableHMACSecret : boolean;
fHMACSecret: UTF8String;
fResidentKey : fido_opt_t; // create a resident key on the device
fUserIdentification : fido_opt_t;
fLargeBlockKeyFlag : boolean;
fSmallBlob : TBytes;
fMinPinLen : integer;
// user identification
fUserName, fDisplaNamy : string;
fUserIcon : TBytes;
fUserId : TBytes;
// client
fID: string;
fClientData : string;
fFmt : TFidoCredentialFmt;
fsFmt : UTF8String;
procedure UpdateCredentials; virtual;
procedure InitCred;
procedure FreeCred;
procedure PrepareCredentials;
procedure SetCredType(const Value: TFidoCredentialType);
procedure SetDisplayName(const Value: string);
procedure SetHMACSecret(const Value: boolean);
procedure SetRelParty(const Value: string);
procedure SetRelPartyName(const Value: string);
procedure SetResidentKey(const Value: fido_opt_t);
procedure SetUserIdent(const Value: fido_opt_t);
procedure SetUserName(const Value: string);
procedure SetFmt(const Value: TFidoCredentialFmt);
procedure SetClientDataHash( cid : TFidoSHA256Hash );
public
property CredID : TBytes read GetCredID;
property CredentialType : TFidoCredentialType read fCredType write SetCredType;
property RelyingPartyName : string read fRelyingPartyName write SetRelPartyName;
property RelyingParty : string read fRelyingParty write SetRelParty;
property HMACSecretEnabled : boolean read fEnableHMACSecret write SetHMACSecret;
property LargeBlobEnabled : boolean read fLargeBlockKeyFlag write SetLargeBlobFlag;
property ResidentKey : fido_opt_t read fResidentKey write SetResidentKey;
property UserIdentification : fido_opt_t read fUserIdentification write SetUserIdent;
property UserName : string read fUserName write SetUserName;
property UserDisplayName : string read fDisplaNamy write SetDisplayName;
property Fmt : TFidoCredentialFmt read fFmt write SetFmt;
property ClientDataHash : TFidoSHA256Hash read fClientDataHash write SetClientDataHash;
property ID : string read fID write SetID;
property ClientData : string read fClientData write SetClientData;
property SigCount : Integer read GetCredSigCount;
property MinPinLen : integer read GetMinPinLen write SetMinPinLen;
property AAGuid : TBytes read GetAAGuid;
procedure CreateRandomUid( len : integer );
procedure SetUserId( uid : TBytes );
procedure SetLargeBlockKeyFlag( value : boolean );
procedure SetSmallBlob( data : TBytes );
procedure SavePKToStream( stream : TStream );
procedure SavePKToFile( fn : String );
procedure SaveUIDToStream( stream : TStream );
procedure SaveUIDToFile( fn : string);
procedure SaveCredIDToStream( stream : TStream );
procedure SaveCredIDToFile( fn : string );
procedure SaveSigToFile( fn : string );
procedure SaveSigToStream( stream : TStream );
procedure SaveX5cToFile( fn : string );
procedure SaveX5cToStream( stream : TStream );
procedure SaveBlob( fn : string );
procedure SaveBlobToStream( stream : TStream );
// converts the webauthn object described here https://www.w3.org/TR/webauthn/#authenticator-data
// -> basically converts to a raw cbor encoded bytes string
class function WebAuthNObjDataToAuthData( webAuthnauthData : TBytes ) : TBytes;
constructor Create;
destructor Destroy; override;
end;
// creation of a credential on a key
TFidoCredCreate = class(TBaseFido2Credentials)
public
procedure AddExcludeCred( cred : TBaseFido2Credentials );
procedure ClearExcludeList;
function CreateCredentials( dev : TFidoDevice; pin : string ) : boolean;
function CreateCredentialsAndVerify( dev : TFidoDevice; pin : string ) : boolean;
end;
// verifcation api for credentials -> after verify the public key can be extracted
TFidoCredVerify = class(TBaseFido2Credentials)
private
fAuthData : TBytes;
fx509 : TBytes;
fSig : TBytes;
protected
procedure UpdateCredentials; override;
public
function Verify( ClientDataHash : TFidoSHA256Hash ) : boolean;
// extract the large blob data (2.1 feature)
function LargeBlobKey : TBytes;
// copies the verification data from already generated credentials (e.g. CreateCredentials)
constructor Create( fromCred : TBaseFido2Credentials); overload;
// data from external sources
constructor Create( typ: TFidoCredentialType; fmt: TFidoCredentialFmt;
aRelyingPartyID, aRelyingPartyName : string;
authData : TBytes;
x509 : TBytes; Sig : TBytes; rk, uv : boolean;
ext : integer; smallBlob : TBytes); overload;
destructor Destroy; override;
end;
// ######################################################
// #### Assertion objects
// ######################################################
TBaseFidoAssert = class(TObject)
private
fErr : string;
fAssert : Pfido_assert_t;
fAssertType : TFidoCredentialType;
fRelyingParty : string;
fHMACSecret : UTF8String;
fClientHash : TFidoChallenge; // challange
fClientData : string;
fEnableHMACSecret : boolean;
fUserPresence : fido_opt_t;
fUserVerification : fido_opt_t; //
// user identification
fFmt : TFidoCredentialFmt;
procedure PrepareAssert;
procedure SetAssertType(const Value: TFidoCredentialType); virtual;
procedure SetFmt(const Value: TFidoCredentialFmt);
procedure SetHMACSecret(const Value: boolean);
procedure SetRelParty(const Value: string);
procedure SetUserIdent(const Value: fido_opt_t);
procedure SetUserPresence(const Value: fido_opt_t);
procedure SetHMACSecretValue(const Value: UTF8String);
procedure SetClientData(const Value: string);
protected
procedure InitAssert;
procedure FreeAssert;
procedure UpdateAssert; virtual;
public
property ErrorMsg : string read fErr;
property AssertType : TFidoCredentialType read fAssertType write SetAssertType;
property RelyingParty : string read fRelyingParty write SetRelParty;
property HMACSecretEnabled : boolean read fEnableHMACSecret write SetHMACSecret;
property HMACSecret : UTF8String read fHMACSecret write SetHMACSecretValue;
property UserVerification : fido_opt_t read fUserVerification write SetUserIdent;
property Fmt : TFidoCredentialFmt read fFmt write SetFmt;
property UserPresence : fido_opt_t read fUserPresence write SetUserPresence;
property ClientDataHash : TFidoChallenge read fClientHash write fClientHash;
property ClientData : string read fClientData write SetClientData;
procedure CreateRandomCID;
constructor Create;
destructor Destroy; override;
end;
// client side that performs the assertion on the key
TFidoAssert = class(TBaseFidoAssert)
private
fHMacSalt : TBytes;
fExtensions: integer;
function GetAuthData( idx : integer ): TBytes;
function GetSig( idx : integer ): TBytes;
function GetHMAC(idx: integer): TBytes;
function GetLargeBlob( idx : integer ): TBytes;
function GetSmallBlob( idx : integer ): TBytes;
public
property AuthData[ idx : integer] : TBytes read GetAuthData;
property Sig[ idx : integer ] : TBytes read GetSig;
property HMACSecret[ idx : integer ] : TBytes read GetHMAC;
property LargeBlob[ idx : Integer ] : TBytes read GetLargeBlob;
property Blob[ idx : integer ] : TBytes read GetSmallBlob;
property Extensions : integer read fExtensions;
procedure AddAllowedCredential( cred : TBaseFido2Credentials );
procedure ClearAllowedList;
procedure SetHMACSecretSalt( salt : TBytes );
function Perform( dev : TFidoDevice; sPin : string; var cnt : integer ) : boolean;
end;
// verification e.g. on the server
TFidoAssertVerify = class(TBaseFidoAssert)
private
fPK : TBytes;
fpk1 : Pes256_pk_t;
fpk2 : Peddsa_pk_t;
fpk3 : Prs256_pk_t;
fPK4 : Pes384_pk_t;
procedure SetAssertType(const Value: TFidoCredentialType); override;
procedure InitPublikKey;
procedure ClearPK;
function GetKeyPtr : Pointer;
procedure SetPK(const Value: TBytes);
public
property PK : TBytes read fPK write SetPK;
procedure LoadPKFromStream( stream : TStream );
procedure LoadPKFromFile( fn : string );
function Verify( authData : TBytes; sig : TBytes; ext : integer = 0 ) : boolean;
constructor Create;
destructor Destroy; override;
end;
// ####################################################
// #### credential management
// note this api is only available on Yubikey since Firmware > 5.2
// creation of this object will raise an invalid command error
type
TFido2RelayParty = class(TObject)
private
fIdx : integer;
fID : string;
fName : string;
fHash : TBytes;
public
property Idx : integer read fIdx;
property ID : String read fID;
property Name : string read fName;
property Hash : TBytes read fHash;
constructor Create( rp : Pfido_credman_rp_t; idx : size_t );
destructor Destroy; override;
end;
TFido2Credential = class(TBaseFido2Credentials)
private
fAuthData : TBytes;
fx509 : TBytes;
fSig : TBytes;
fCredId : TBytes;
// fCredGuid : TBytes;
public
constructor Create( cred : Pfido_cred_t );
end;
TFido2ResidentKey = class(TObject)
private
fCount : integer;
fCredList : Array of TFido2Credential;
function GetCred(idx: integer): TFido2Credential;
public
property Count : integer read fCount;
property Cred[idx : integer] : TFido2Credential read GetCred;
constructor Create( rk : Pfido_credman_rk_t );
destructor Destroy; override;
end;
type
TFido2RelayPartyList = TObjectList<TFido2RelayParty>;
TFido2ResidentKeyList = TObjectList<TFido2ResidentKey>;
TFido2CredentialManager = class(TObject)
private
fMetaCredMan : Pfido_credman_metadata_t;
fCredManRP : Pfido_credman_rp_t;
fNumResidentKeys : int64;
fNumResidentKeysRemain : int64;
fRelayPartyList : TFido2RelayPartyList;
fResidentKeyList : TFido2ResidentKeyList;
procedure ReadDev;
procedure ReadRelayingParties;
procedure Clear;
public
property NumResidentKeys : int64 read fNumResidentKeys;
property NumResidentKeysRemain : int64 read fNumResidentKeysRemain;
property RelayPartys : TFido2RelayPartyList read fRelayPartyList;
property ResidentKeys : TFido2ResidentKeyList read fResidentKeyList;
procedure DelResidentKey( dev : TFidoDevice; credId : TBytes; pin : string );
// returns fals if no credential management is avail
function Open(dev : TFidoDevice; pin : string; var ErrMsg : string) : boolean;
constructor Create;
destructor Destroy; override;
end;
// to get results from the logger initialize the Fido with the debug flag
// -> fido_init(cFidoInitDebug);
procedure InitFidoLogger( OnLog : TFidoLogMsg );
implementation
// ###########################################
// #### Fido logging
// ###########################################
var loc_fidoLog : TFidoLogMsg;
procedure FidoLog(msg : PAnsiChar); cdecl;
begin
if Assigned(loc_fidoLog) then
loc_fidoLog( String( UTF8String( msg ) ) );
end;
procedure InitFidoLogger( OnLog : TFidoLogMsg );
begin
loc_fidoLog := OnLog;
fido_set_log_handler(FidoLog);
end;
// #########################################################
// #### helper functions
// #########################################################
const cMaxFido2Len = 63;
procedure RandomInit(var blk; len : integer; ensureNonZeroFirstByte : boolean);
var i : integer;
pBlk : PByteArray;
begin
pBlk := @blk;
pBlk^[0] := 0;
// first byte may not be 0 or one (at least as for the user id)
repeat
pBlk^[0] := Byte( Random(High(Byte) + 1) );
until (ensureNonZeroFirstByte = False) or (pBlk^[0] > 1);
for i := 1 to len - 1 do
pBlk^[i] := Byte( Random(High(Byte) + 1) );
end;
function ptrToStr( ps : PAnsiChar ) : string;
begin
Result := '';
if Assigned(ps) then
Result := string(ps);
end;
function ptrToByteArr( pb : PByte; len : integer ) : TBytes;
begin
SetLength(Result, len);
if len > 0 then
Move( pb^, Result[0], len );
end;
procedure CR( aErrCode : integer );
begin
if aErrCode <> FIDO_OK then
raise EFidoException.Create(aErrCode);
end;
// #########################################################
// ####
// #########################################################
{ TFido2Dev }
// #########################################################
// #### Fido Device
// #########################################################
procedure TFidoDevice.ReadProperties(di: Pfido_dev_info_t);
begin
fManufactStr := String( fido_dev_info_manufacturer_string( di ));
fProductInfo := String( fido_dev_info_product_string( di ));
fVendor := fido_dev_info_vendor( di );
fProduct := fido_dev_info_product(di);
end;
class function TFidoDevice.DevList: TFidoDevList;
const cNumMaxDev : integer = 64;
var numFound : integer;
i : integer;
di : Pfido_dev_info_t;
aList : Pfido_dev_info_t;
dev : TFidoDevice;
begin
Result := TFidoDevList.Create( False );
aList := fido_dev_info_new( cNumMaxDev );
if aList = nil then
raise EFidoAllocException.Create('No list allocated');
try
numFound := 0;
CR(fido_dev_info_manifest( aList, cNumMaxDev, numFound ));
for i := 0 to numFound - 1 do
begin
di := fido_dev_info_ptr(aList, i);
assert(Assigned(di), 'Device pointer missing...');
dev := TFidoDevice.CreateFromDevInfo( di );
Result.Add(dev);
end;
finally
fido_dev_info_free( @aList, cNumMaxDev );
end;
end;
destructor TFidoDevice.Destroy;
begin
CloseDevice;
fCbor.Free;
inherited;
end;
constructor TFidoDevice.CreateFromPath(usbPath: String);
begin
fUSBPath := UTF8String(usbPath);
OpenDevice;
inherited Create;
end;
constructor TFidoDevice.CreateFromDevInfo(di: Pfido_dev_info_t);
begin
fUSBPath := UTF8String( fido_dev_info_path(di) );
ReadProperties(di);
ReadDev;
inherited Create;
end;
procedure TFidoDevice.OpenDevice;
var r : integer;
begin
if not Assigned(fDev) then
begin
fDev := fido_dev_new;
assert( Assigned(fDev), 'Error allocating memory for device');
r := fido_dev_open(fDev, PAnsiChar( fUSBPath ) );
if r <> FIDO_OK then
begin
fido_dev_free(fDev);
CR(r);
end;
end;
end;
procedure TFidoDevice.ReadDev;
var flags : byte;
begin
OpenDevice;
fProtocol := fido_dev_protocol(fDev);
fDevMajor := fido_dev_major(fDev);
fDevMinor := fido_dev_minor(fDev);
fDevBuild := fido_dev_build(fDev);
flags := fido_dev_flags(fDev);
fHasUserVerification := fido_dev_has_uv( fDev );
if fido_dev_get_retry_count(fDev, fRetryCnt) <> FIDO_OK then
fRetryCnt := -1;
if fido_dev_get_uv_retry_count(fDev, fUVRetryCnt) <> FIDO_OK then
fUVRetryCnt := -1; // set to -1 in case it is not defined
fDevFlags := [];
if flags and FIDO_CAP_WINK <> 0 then
include(fDevFlags, dfWink);
if flags and FIDO_CAP_CBOR <> 0 then
include(fDevFlags, dfCBOR);
if (flags and FIDO_CAP_NMSG) = 0 then
include(fDevFlags, dfMsg);
fIsFido2 := fido_dev_is_fido2( fdev );
fIsWinHello := fido_dev_is_winhello( fdev );
fSupportPin := fido_dev_supports_pin( fDev );
fSupportCredProtection := fido_dev_supports_cred_prot( fDev );
fSupportCredManager := fido_dev_supports_credman( fDev );
fSupportUserVerification := fido_dev_supports_uv( fDev );
fSupportPermissions := fido_dev_supports_permissions( fDev );
fCBOR := nil;
fHasBlobSupport := False;
if fIsFido2 then
begin
fCbor := TFido2CBOR.Create( fDev );
// as per mail with pedro martelletto
fHasBlobSupport := fCbor.Extensions.IndexOf('credBlob') >= 0 ; // ?!? better check for "largeBlobs" options as stated in fido 2.1 client to authenticator protocol
end;
end;
procedure TFidoDevice.SetLargeBlob(key, data: TBytes; pin: string);
var ansiPin : Utf8String;
begin
assert( Assigned( fDev ), 'Error no device opened');
assert( (Length(key) > 0) and (length(data) > 0), 'Error no data');
if not fHasBlobSupport then
raise EFidoPropertyException.Create('Error: blobs not supported by this device');
ansiPin := UTF8String( pin );
CR( fido_dev_largeblob_set( fDev, @key[0], Length(key), @data[0], Length(data), PAnsiChar( ansiPin ) ) );
end;
procedure TFidoDevice.SetLargeBlobArr(cborData: TCborItem; pin: string);
var data : TMemoryStream;
ansiPin : Utf8String;
begin
assert( Assigned( fDev ), 'Error no device opened' );
assert( Assigned( cborData ), 'Error no cbor item' );
if not fHasBlobSupport then
raise EFidoPropertyException.Create('Error: blobs not supported by this device');
data := TMemoryStream.Create;
try
cborData.CBOREncode(data);
ansiPin := UTF8String( pin );
CR( fido_dev_largeblob_set_array( fDev, data.Memory, data.Size, PAnsiChar(ansiPin) ) );
finally
data.Free;
end;
end;
procedure TFidoDevice.SetLargeBlobArr(data: TBytes; pin: string);
var ansiPin : Utf8String;
begin
assert( Assigned( fDev ), 'Error no device opened');
assert( (length(data) > 0), 'Error no data');
if not fHasBlobSupport then
raise EFidoPropertyException.Create('Error: blobs not supported by this device');
ansiPin := UTF8String( pin );
CR( fido_dev_largeblob_set_array( fDev, @data[0], Length(data), PAnsiChar( ansiPin ) ) );
end;
function TFidoDevice.SetPin(oldPin, newPin: string; var ErrStr : string): boolean;
var r : integer;
newPinUtf8 : utf8string;
begin
newPinUTF8 := UTF8String( newPin );
if (Length(newPinUtf8) < 4) or (LengtH(newPinUtf8) > 255) then
begin
ErrStr := '4 <= pin length <= 255';
exit(False);
end;
OpenDevice;
errStr := '';
r := fido_dev_set_pin( fDev, PAnsiChar( ansiString(newPin) ), PAnsiChar( AnsiString(oldPin) ) );
Result := r = FIDO_OK;
if not Result then
errStr := String( fido_strerr( r ) );
end;
procedure TFidoDevice.SetTimeout(ms: integer);
begin
assert( Assigned( fDev ), 'Error no device opened');
CR( fido_dev_set_timeout( fDev, ms ) );
end;
// To reset start this routine within 5 seconds after attaching the device!
procedure TFidoDevice.Reset;
begin
OpenDevice;
CR(fido_dev_reset( fDev ));
CloseDevice;
end;
procedure TFidoDevice.BeginTouch;
begin
assert( Assigned( fDev ), 'Error no device opened');
CR( fido_dev_get_touch_begin( fDev ) );
end;
procedure TFidoDevice.Cancel;
begin
assert( Assigned( fDev ), 'Error no device opened');
CR( fido_dev_cancel( fDev ) );
end;
procedure TFidoDevice.CloseDevice;
begin
if Assigned(fDev) then
begin
fido_dev_close(fDev);
fido_dev_free(fDev);
end;
fDev := nil;
end;
{ EFido2Exception }
constructor EFidoException.Create(aErrCode: integer);
var pMsg : PAnsiChar;
begin
pMsg := fido_strerr( aErrCode );
inherited Create( String( pMsg ) );
end;
{ TFido2CBOR }
constructor TFido2CBOR.Create(dev: PFido_dev_t);
begin
fCBORVersions := TStringList.Create;
fCBORExtension := TStringList.Create;
fCBORTransports := TStringList.Create;
fCBORCertNames := TStringList.Create;
if dev <> nil then
ReadProperties(dev);
inherited Create;
end;
procedure TFido2CBOR.ReadProperties(dev: PFido_dev_t);
var ci : Pfido_cbor_info_t;
infoLen : integer;
pInfo : PPAnsiChar;
i : integer;
pBGuid : PByte;
valuePtr : PBoolean;
pinProto : PByte;
pinProtoLen : integer;
pTransp : PPAnsiChar;
transpLen : integer;
algoCount : integer;
begin
ci := fido_cbor_info_new;
if ci = nil then
raise EFidoAllocException.Create('Error cannot create cbor info');
try
CR( fido_dev_get_cbor_info( dev, ci ) );
infoLen := fido_cbor_info_versions_len( ci );
pinfo := fido_cbor_info_versions_ptr( ci );
for i := 0 to infoLen - 1 do
begin
fCBORVersions.Add( String( pInfo^ ) );
inc(pInfo);
end;
infoLen := fido_cbor_info_extensions_len( ci );
pInfo := fido_cbor_info_extensions_ptr( ci );
for i := 0 to infoLen - 1 do
begin
fCBORExtension.Add( String( pinfo^ ) );
inc(pInfo);
end;
infoLen := fido_cbor_info_certs_len( ci );
pInfo := fido_cbor_info_certs_name_ptr( ci );
for i := 0 to infoLen - 1 do
begin
fCBORCertNames.Add( String( pinfo^ ) );