forked from PeculiarVentures/xmldsigjs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
1112 lines (964 loc) · 34.9 KB
/
index.d.ts
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
import { XmlCollection, XmlObject } from "xml-core";
declare namespace XmlDSigJs {
//#region algorithms/ecdsa_sign
export const ECDSA = "ECDSA";
export const ECDSA_SHA1_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1";
export const ECDSA_SHA256_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256";
export const ECDSA_SHA384_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384";
export const ECDSA_SHA512_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512";
export class EcdsaSha1 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class EcdsaSha256 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class EcdsaSha384 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class EcdsaSha512 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
//#endregion
//#region algorithms/hmac_sign
export const HMAC = "HMAC";
export const HMAC_SHA1_NAMESPACE = "http://www.w3.org/2000/09/xmldsig#hmac-sha1";
export const HMAC_SHA256_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#hmac-sha256";
export const HMAC_SHA384_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#hmac-sha384";
export const HMAC_SHA512_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#hmac-sha512";
export class HmacSha1 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class HmacSha256 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class HmacSha384 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class HmacSha512 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
//#endregion
//#region algorithms/rsa_hash
export const SHA1 = "SHA-1";
export const SHA256 = "SHA-256";
export const SHA384 = "SHA-384";
export const SHA512 = "SHA-512";
export const SHA1_NAMESPACE = "http://www.w3.org/2000/09/xmldsig#sha1";
export const SHA256_NAMESPACE = "http://www.w3.org/2001/04/xmlenc#sha256";
export const SHA384_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#sha384";
export const SHA512_NAMESPACE = "http://www.w3.org/2001/04/xmlenc#sha512";
export class Sha1 extends HashAlgorithm {
public algorithm: {
name: string;
};
public namespaceURI: string;
}
export class Sha256 extends HashAlgorithm {
public algorithm: {
name: string;
};
public namespaceURI: string;
}
export class Sha384 extends HashAlgorithm {
public algorithm: {
name: string;
};
public namespaceURI: string;
}
export class Sha512 extends HashAlgorithm {
public algorithm: {
name: string;
};
public namespaceURI: string;
}
//#endregion
//#region algorithms/rsa_pkcs1_sign
export const RSA_PKCS1 = "RSASSA-PKCS1-v1_5";
export const RSA_PKCS1_SHA1_NAMESPACE = "http://www.w3.org/2000/09/xmldsig#rsa-sha1";
export const RSA_PKCS1_SHA256_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256";
export const RSA_PKCS1_SHA384_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#rsa-sha384";
export const RSA_PKCS1_SHA512_NAMESPACE = "http://www.w3.org/2001/04/xmldsig-more#rsa-sha512";
export class RsaPkcs1Sha1 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class RsaPkcs1Sha256 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class RsaPkcs1Sha384 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class RsaPkcs1Sha512 extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
//#endregion
//#region algorithms/rsa_pss_sign
export const RSA_PSS = "RSA-PSS";
export const RSA_PSS_WITH_PARAMS_NAMESPACE = "http://www.w3.org/2007/05/xmldsig-more#rsa-pss";
export class RsaPssBase extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
constructor(saltLength?: number);
}
export class RsaPssSha1 extends RsaPssBase {
constructor(saltLength?: number);
}
export class RsaPssSha256 extends RsaPssBase {
constructor(saltLength?: number);
}
export class RsaPssSha384 extends RsaPssBase {
constructor(saltLength?: number);
}
export class RsaPssSha512 extends RsaPssBase {
constructor(saltLength?: number);
}
//#endregion
//#region algorithms/rsa_pss_without_params_sign
export const RSA_PSS_SHA1_NAMESPACE = "http://www.w3.org/2007/05/xmldsig-more#sha1-rsa-MGF1";
export const RSA_PSS_SHA256_NAMESPACE = "http://www.w3.org/2007/05/xmldsig-more#sha256-rsa-MGF1";
export const RSA_PSS_SHA384_NAMESPACE = "http://www.w3.org/2007/05/xmldsig-more#sha384-rsa-MGF1";
export const RSA_PSS_SHA512_NAMESPACE = "http://www.w3.org/2007/05/xmldsig-more#sha512-rsa-MGF1";
export class RsaPssWithoutParamsBase extends SignatureAlgorithm {
public algorithm: any;
public namespaceURI: string;
}
export class RsaPssWithoutParamsSha1 extends RsaPssWithoutParamsBase { }
export class RsaPssWithoutParamsSha256 extends RsaPssWithoutParamsBase { }
export class RsaPssWithoutParamsSha384 extends RsaPssBase { }
export class RsaPssWithoutParamsSha512 extends RsaPssBase { }
//#endregion
//#region pki/x509
export type DigestAlgorithm = "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512";
/**
* Represents an <X509Certificate> element.
*/
export class X509Certificate {
/**
* Gets a serial number of the certificate in HEX format
*/
public readonly SerialNumber: string;
/**
* Gets a issuer name of the certificate
*/
public readonly Issuer: string;
/**
* Gets a subject name of the certificate
*/
public readonly Subject: string;
/**
* Gets the public key from the X509Certificate
*/
public readonly PublicKey: CryptoKey | null;
protected raw: Uint8Array;
protected publicKey: CryptoKey | null;
constructor(rawData?: BufferSource);
/**
* Returns a thumbprint of the certificate
* @param {DigestAlgorithm="SHA-1"} algName Digest algorithm name
* @returns PromiseLike
*/
public Thumbprint(algName?: DigestAlgorithm): PromiseLike<ArrayBuffer>;
/**
* Returns DER raw of X509Certificate
*/
public GetRaw(): Uint8Array;
/**
* Returns public key from X509Certificate
* @param {Algorithm} algorithm
* @returns Promise
*/
public exportKey(algorithm: Algorithm): Promise<CryptoKey>;
/**
* Loads X509Certificate from DER data
* @param {Uint8Array} rawData
*/
protected LoadRaw(rawData: BufferSource): void;
}
//#endregion
//#region xml/key_info/ecdsa_key
export type NamedCurveType = string | "P-256" | "P-384" | "P-521";
export class EcdsaPublicKey extends XmlObject {
public X: Uint8Array;
public Y: Uint8Array;
}
export class NamedCurve extends XmlObject {
public Uri: string;
}
export class DomainParameters extends XmlObject {
public NamedCurve: NamedCurve;
}
/**
* Represents the <ECKeyValue> element of an XML signature.
*/
export class EcdsaKeyValue extends KeyInfoClause {
public DomainParameters: DomainParameters;
public PublicKey: EcdsaPublicKey;
/**
* Gets the NamedCurve value of then public key
*/
public readonly NamedCurve: string;
protected name: string;
protected key: CryptoKey | null;
protected jwk: JsonWebKey | null;
protected keyUsage: string[] | null;
/**
* Imports key to the ECKeyValue object
* @param {CryptoKey} key
* @returns Promise
*/
public importKey(key: CryptoKey): PromiseLike<this>;
/**
* Exports key from the ECKeyValue object
* @param {Algorithm} alg
* @returns Promise
*/
public exportKey(alg: Algorithm): PromiseLike<CryptoKey>;
}
//#endregion
//#region xml/key_info/key_info_clause
export abstract class KeyInfoClause extends XmlSignatureObject {
public Key: CryptoKey | null;
public abstract importKey(key: CryptoKey): PromiseLike<this>;
public abstract exportKey(alg: Algorithm): PromiseLike<CryptoKey>;
}
//#endregion
//#region xml/key_info/key_value
/**
* Represents the <KeyValue> element of an XML signature.
*/
export class KeyValue extends KeyInfoClause {
public Value: KeyInfoClause;
protected value: KeyInfoClause;
constructor(value?: KeyInfoClause);
public importKey(key: CryptoKey): PromiseLike<this>;
public exportKey(alg: Algorithm): PromiseLike<CryptoKey>;
protected OnGetXml(element: Element): void;
}
//#endregion
//#region xml/key_info/rsa_key
export interface IJwkRsa {
alg: string;
kty: string;
e: string;
n: string;
ext: boolean;
}
export interface RsaPSSSignParams extends RsaPssParams, Algorithm {
hash: AlgorithmIdentifier;
}
/**
* Represents the <RSAKeyValue> element of an XML signature.
*/
export class RsaKeyValue extends KeyInfoClause {
/**
* Gets the Modulus of the public key
*/
public Modulus: Uint8Array | null;
/**
* Gets the Exponent of the public key
*/
public Exponent: Uint8Array | null;
protected key: CryptoKey | null;
protected jwk: JsonWebKey | null;
protected keyUsage: string[];
/**
* Imports key to the RSAKeyValue object
* @param {CryptoKey} key
* @returns Promise
*/
public importKey(key: CryptoKey): PromiseLike<this>;
/**
* Exports key from the RSAKeyValue object
* @param {Algorithm} alg
* @returns Promise
*/
public exportKey(alg: Algorithm): PromiseLike<CryptoKey>;
/**
* Loads an RSA key clause from an XML element.
* @param {Element | string} element
* @returns void
*/
public LoadXml(node: Element | string): void;
}
export class MaskGenerationFunction extends XmlObject {
public DigestMethod: DigestMethod;
public Algorithm: string;
}
export class PssAlgorithmParams extends XmlObject {
public static FromAlgorithm(algorithm: RsaPSSSignParams): PssAlgorithmParams;
public DigestMethod: DigestMethod;
public MGF: MaskGenerationFunction;
public SaltLength: number;
public TrailerField: number;
constructor(algorithm?: RsaPSSSignParams);
public FromAlgorithm(algorithm: RsaPSSSignParams): void;
}
//#endregion
//#region xml/key_info/spki_data
export class SPKIData extends KeyInfoClause {
public Key: CryptoKey;
public SPKIexp: Uint8Array | null;
public importKey(key: CryptoKey): PromiseLike<this>;
public exportKey(alg: Algorithm): PromiseLike<CryptoKey>;
}
//#endregion
//#region xml/key_info/x509_data
export class X509IssuerSerial extends XmlSignatureObject {
public X509IssuerName: string;
public X509SerialNumber: string;
}
export enum X509IncludeOption {
None = 0,
EndCertOnly = 1,
ExcludeRoot = 2,
WholeChain = 3,
}
export interface IX509IssuerSerial {
issuerName: string;
serialNumber: string;
}
/**
* Represents an <X509Data> sub element of an XMLDSIG or XML Encryption <KeyInfo> element.
*/
export class KeyInfoX509Data extends KeyInfoClause {
/**
* Gets public key of the X509Data
*/
public readonly Key: CryptoKey | null;
/**
* Gets a list of the X.509v3 certificates contained in the KeyInfoX509Data object.
*/
public readonly Certificates: X509Certificate[];
/**
* Gets or sets the Certificate Revocation List (CRL) contained within the KeyInfoX509Data object.
*/
public CRL: Uint8Array | null;
/**
* Gets a list of X509IssuerSerial structures that represent an issuer name and serial number pair.
*/
public readonly IssuerSerials: IX509IssuerSerial[];
/**
* Gets a list of the subject key identifiers (SKIs) contained in the KeyInfoX509Data object.
*/
public readonly SubjectKeyIds: Uint8Array[];
/**
* Gets a list of the subject names of the entities contained in the KeyInfoX509Data object.
*/
public readonly SubjectNames: string[];
constructor();
constructor(rgbCert: Uint8Array);
constructor(cert: X509Certificate, includeOptions?: X509IncludeOption);
public importKey(key: CryptoKey): Promise<this>;
/**
* Exports key from X509Data object
* @param {Algorithm} alg
* @returns Promise
*/
public exportKey(alg: Algorithm): Promise<CryptoKey>;
/**
* Adds the specified X.509v3 certificate to the KeyInfoX509Data.
* @param {X509Certificate} certificate
* @returns void
*/
public AddCertificate(certificate: X509Certificate): void;
/**
* Adds the specified issuer name and serial number pair to the KeyInfoX509Data object.
* @param {string} issuerName
* @param {string} serialNumber
* @returns void
*/
public AddIssuerSerial(issuerName: string, serialNumber: string): void;
/**
* Adds the specified subject key identifier (SKI) to the KeyInfoX509Data object.
* @param {string | Uint8Array} subjectKeyId
* @returns void
*/
public AddSubjectKeyId(subjectKeyId: string): void;
public AddSubjectKeyId(subjectKeyId: Uint8Array): void;
/**
* Adds the subject name of the entity that was issued an X.509v3 certificate to the KeyInfoX509Data object.
* @param {string} subjectName
* @returns void
*/
public AddSubjectName(subjectName: string): void;
/**
* Returns an XML representation of the KeyInfoX509Data object.
* @returns Element
*/
public GetXml(): Element;
/**
* Parses the input XmlElement object and configures the internal state of the KeyInfoX509Data object to match.
* @param {Element} element
* @returns void
*/
public LoadXml(element: Element): void;
}
//#endregion
//#region xml/transforms/base64
export class XmlDsigBase64Transform extends Transform {
public Algorithm: string;
/**
* Returns the output of the current XmlDsigBase64Transform object
*/
public GetOutput(): any;
}
//#endregion
//#region xml/transforms/c14n
/**
* Represents the C14N XML canonicalization transform for a digital signature
* as defined by the World Wide Web Consortium (W3C), without comments.
*/
export class XmlDsigC14NTransform extends Transform {
public Algorithm: string;
/**
* Returns the output of the current XmlDsigC14NTransform object.
* @returns string
*/
protected xmlCanonicalizer: XmlCanonicalizer;
public GetOutput(): string;
}
/**
* Represents the C14N XML canonicalization transform for a digital signature
* as defined by the World Wide Web Consortium (W3C), with comments.
*/
export class XmlDsigC14NWithCommentsTransform extends XmlDsigC14NTransform {
public Algorithm: string;
protected xmlCanonicalizer: XmlCanonicalizer;
}
//#endregion
//#region xml/transforms/enveloped_signature
/**
* Represents the enveloped signature transform for an XML digital signature as defined by the W3C.
*/
export class XmlDsigEnvelopedSignatureTransform extends Transform {
public Algorithm: string;
/**
* Returns the output of the current XmlDsigEnvelopedSignatureTransform object.
* @returns string
*/
public GetOutput(): any;
}
//#endregion
//#region xml/transforms/exc_c14n
/**
* Represents the exclusive C14N XML canonicalization transform for a digital signature
* as defined by the World Wide Web Consortium (W3C), without comments.
*/
export class XmlDsigExcC14NTransform extends Transform {
public Algorithm: string;
/**
* Gets or sets a string that contains namespace prefixes to canonicalize
* using the standard canonicalization algorithm.
*/
public InclusiveNamespacesPrefixList: string;
protected xmlCanonicalizer: XmlCanonicalizer;
/**
* Returns the output of the current XmlDsigExcC14NTransform object
*/
public GetOutput(): string;
}
/**
* Represents the exclusive C14N XML canonicalization transform for a digital signature
* as defined by the World Wide Web Consortium (W3C), with comments.
*/
export class XmlDsigExcC14NWithCommentsTransform extends XmlDsigExcC14NTransform {
public Algorithm: string;
protected xmlCanonicalizer: XmlCanonicalizer;
}
//#endregion
//#region xml/canonicalization_method
/**
* Canonicalization method
*
* @export
* @class CanonicalizationMethod
* @extends {XmlSignatureObject}
*/
export class CanonicalizationMethod extends XmlSignatureObject {
public Algorithm: string;
}
//#endregion
//#region xml/data_object
/**
* Represents the object element of an XML signature that holds data to be signed.
*/
export class DataObject extends XmlSignatureObject {
public Id: string;
public MimeType: string;
public Encoding: string;
}
export class DataObjects extends XmlSignatureCollection<DataObject> {
}
//#endregion
//#region xml/digest_method
export class DigestMethod extends XmlSignatureObject {
public Algorithm: string;
}
//#endregion
//#region xml/key_info
/**
* Represents an XML digital signature or XML encryption <KeyInfo> element.
*/
export class KeyInfo extends XmlSignatureCollection<KeyInfoClause> {
public Id: string;
protected OnLoadXml(element: Element): void;
}
//#endregion
//#region xml/reference
/**
* Represents the <reference> element of an XML signature.
*/
export class Reference extends XmlSignatureObject {
/**
* Gets or sets the ID of the current Reference.
*/
public Id: string;
/**
* Gets or sets the Uri of the current Reference.
*/
public Uri?: string;
/**
* Gets or sets the type of the object being signed.
*/
public Type: string;
public Transforms: Transforms;
/**
* Gets or sets the digest method Uniform Resource Identifier (URI) of the current
*/
public DigestMethod: DigestMethod;
/**
* Gets or sets the digest value of the current Reference.
*/
public DigestValue: Uint8Array;
constructor(uri?: string);
}
export class References extends XmlSignatureCollection<Reference> {
}
//#endregion
//#region xml/signature
/**
* Represents the <Signature> element of an XML signature.
*/
export class Signature extends XmlSignatureObject {
/**
* Gets or sets the ID of the current Signature.
*/
public Id: string;
/**
* Gets or sets the SignedInfo of the current Signature.
*/
public SignedInfo: SignedInfo;
/**
* Gets or sets the value of the digital signature.
*/
public SignatureValue: Uint8Array | null;
/**
* Gets or sets the KeyInfo of the current Signature.
*/
public KeyInfo: KeyInfo;
public ObjectList: DataObjects;
}
//#endregion
//#region xml/signature_method
export class SignatureMethodOther extends XmlSignatureCollection<XmlObject> {
public OnLoadXml(element: Element): void;
}
export class SignatureMethod extends XmlSignatureObject {
public Algorithm: string;
/**
* Parameters for the XML Signature HMAC Algorithm.
* The parameters include an optional output length which specifies the MAC truncation length in bits.
*
* @type {number}
* @memberOf SignatureMethod
*/
public HMACOutputLength: number;
public Any: SignatureMethodOther;
}
//#endregion
//#region xml/signed_info
/**
* The SignedInfo class represents the <SignedInfo> element
* of an XML signature defined by the XML digital signature specification
*
* @export
* @class SignedInfo
* @extends {XmlSignatureObject}
*/
export class SignedInfo extends XmlSignatureObject {
/**
* Gets or sets the ID of the current SignedInfo object.
*
* @type {string}
* @memberOf SignedInfo
*/
public Id: string;
/**
* Gets or sets the canonicalization algorithm that is used before signing
* for the current SignedInfo object.
*/
public CanonicalizationMethod: CanonicalizationMethod;
/**
* Gets or sets the name of the algorithm used for signature generation
* and validation for the current SignedInfo object.
*/
public SignatureMethod: SignatureMethod;
public References: References;
}
//#endregion
//#region xml/transform
export interface ITransform extends XmlCore.IXmlSerializable {
Algorithm: string;
LoadInnerXml(node: Node): void;
GetInnerXml(): Node | null;
GetOutput(): any;
}
export interface ITransformConstructable {
new(): Transform;
}
/**
* The Transform element contains a single transformation
*/
export class Transform extends XmlSignatureObject implements ITransform {
public Algorithm: string;
/**
* XPath of the transformation
*/
public XPath: string;
protected innerXml: Node | null;
/**
* When overridden in a derived class, returns the output of the current Transform object.
*/
public GetOutput(): string;
public LoadInnerXml(node: Node): void;
public GetInnerXml(): Node | null;
}
/**
* The Transforms element contains a collection of transformations
*/
export class Transforms extends XmlSignatureCollection<Transform> {
protected OnLoadXml(element: Element): void;
}
//#endregion
//#region xml/xml_names
export const XmlSignature: {
DefaultCanonMethod: string;
DefaultDigestMethod: string;
DefaultPrefix: string;
ElementNames: {
CanonicalizationMethod: string;
DigestMethod: string;
DigestValue: string;
DSAKeyValue: string;
DomainParameters: string;
EncryptedKey: string;
HMACOutputLength: string;
RSAPSSParams: string;
MaskGenerationFunction: string;
SaltLength: string;
KeyInfo: string;
KeyName: string;
KeyValue: string;
Modulus: string;
Exponent: string;
Manifest: string;
Object: string;
Reference: string;
RetrievalMethod: string;
RSAKeyValue: string;
ECDSAKeyValue: string;
NamedCurve: string;
PublicKey: string;
Signature: string;
SignatureMethod: string;
SignatureValue: string;
SignedInfo: string;
Transform: string;
Transforms: string;
X509Data: string;
PGPData: string;
SPKIData: string;
SPKIexp: string;
MgmtData: string;
X509IssuerSerial: string;
X509IssuerName: string;
X509SerialNumber: string;
X509SKI: string;
X509SubjectName: string;
X509Certificate: string;
X509CRL: string;
XPath: string;
X: string;
Y: string;
};
AttributeNames: {
Algorithm: string;
Encoding: string;
Id: string;
MimeType: string;
Type: string;
URI: string;
};
AlgorithmNamespaces: {
XmlDsigBase64Transform: string;
XmlDsigC14NTransform: string;
XmlDsigC14NWithCommentsTransform: string;
XmlDsigEnvelopedSignatureTransform: string;
XmlDsigXPathTransform: string;
XmlDsigXsltTransform: string;
XmlDsigExcC14NTransform: string;
XmlDsigExcC14NWithCommentsTransform: string;
XmlDecryptionTransform: string;
XmlLicenseTransform: string;
};
Uri: {
Manifest: string;
};
NamespaceURI: string;
NamespaceURIMore: string;
NamespaceURIPss: string;
};
//#endregion
//#region xml/xml_object
export abstract class XmlSignatureObject extends XmlObject {
}
export abstract class XmlSignatureCollection<I extends XmlSignatureObject> extends XmlCollection<I> {
}
//#endregion
//#region algorithm
export type BASE64 = string;
export interface IAlgorithm {
algorithm: Algorithm;
namespaceURI: string;
getAlgorithmName(): string;
}
export interface IHashAlgorithm extends IAlgorithm {
Digest(xml: BufferSource | string | Node): PromiseLike<Uint8Array>;
}
export interface IHashAlgorithmConstructable {
new(): IHashAlgorithm;
}
export abstract class XmlAlgorithm implements IAlgorithm {
public algorithm: Algorithm;
public namespaceURI: string;
public getAlgorithmName(): string;
}
export abstract class HashAlgorithm extends XmlAlgorithm implements IHashAlgorithm {
public Digest(xml: BufferSource | string | Node): PromiseLike<Uint8Array>;
}
export interface ISignatureAlgorithm extends IAlgorithm {
Sign(signedInfo: string, signingKey: CryptoKey, algorithm: Algorithm): PromiseLike<ArrayBuffer>;
Verify(signedInfo: string, key: CryptoKey, signatureValue: Uint8Array, algorithm?: Algorithm): PromiseLike<boolean>;
}
export interface ISignatureAlgorithmConstructable {
new(): ISignatureAlgorithm;
}
export abstract class SignatureAlgorithm extends XmlAlgorithm implements ISignatureAlgorithm {
/**
* Sign the given string using the given key
*/
public Sign(signedInfo: string, signingKey: CryptoKey, algorithm: Algorithm): PromiseLike<ArrayBuffer>;
/**
* Verify the given signature of the given string using key
*/
public Verify(signedInfo: string, key: CryptoKey, signatureValue: Uint8Array, algorithm?: Algorithm): PromiseLike<boolean>;
}
//#endregion
//#region application
export interface CryptoEx extends Crypto {
name: string;
}
export class Application {
public static readonly crypto: CryptoEx;
/**
* Sets crypto engine for the current Application
* @param {string} name
* @param {Crypto} crypto
* @returns void
*/
public static setEngine(name: string, crypto: Crypto): void;
/**
* Gets the crypto module from the Application
*/
public static isNodePlugin(): boolean;
}
//#endregion
//#region canonicalizer
export enum XmlCanonicalizerState {
BeforeDocElement = 0,
InsideDocElement = 1,
AfterDocElement = 2,
}
export class XmlCanonicalizer {
public InclusiveNamespacesPrefixList: string;
protected withComments: boolean;
protected exclusive: boolean;
protected propagatedNamespaces: XmlCore.NamespaceManager;
protected document: Document;
protected result: string[];
protected visibleNamespaces: XmlCore.NamespaceManager;
protected inclusiveNamespacesPrefixList: string[];
protected state: XmlCanonicalizerState;
constructor(withComments: boolean, excC14N: boolean, propagatedNamespaces?: XmlCore.NamespaceManager);
public Canonicalize(node: Node): string;
protected WriteNode(node: Node): void;
protected WriteDocumentNode(node: Node): void;
protected WriteTextNode(node: Node): void;
protected WriteCommentNode(node: Node): void;
protected WriteProcessingInstructionNode(node: Node): void;
protected WriteElementNode(node: Element): void;
protected WriteNamespacesAxis(node: Element): number;
protected WriteAttributesAxis(node: Node): void;
protected NormalizeString(input: string | null, type: XmlCore.XmlNodeType): string;
protected IsTextNode(type: XmlCore.XmlNodeType): boolean;
protected IsNamespaceInclusive(node: Element, prefix: string | null): boolean;
protected IsNamespaceRendered(prefix: string | null, uri: string | null): boolean;
}
//#endregion
//#region crypto_config
export class CryptoConfig {
/**
* Creates Transform from given name
* if name is not exist then throws error
*
* @static
* @param {(string |)} [name=null]
* @returns
*
* @memberOf CryptoConfig
*/
public static CreateFromName(name: string | null): Transform;
public static CreateSignatureAlgorithm(method: SignatureMethod): SignatureAlgorithm;
public static CreateHashAlgorithm(namespace: string): HashAlgorithm;
public static GetHashAlgorithm(algorithm: AlgorithmIdentifier): IHashAlgorithm;
public static GetSignatureAlgorithm(algorithm: Algorithm): ISignatureAlgorithm;
}
//#endregion
//#region signed_xml
export type OptionsSignTransform = "enveloped" | "c14n" | "exc-c14n" | "c14n-com" | "exc-c14n-com" | "base64";
export interface OptionsSignReference {
/**
* Id of Reference
*
* @type {string}
* @memberOf OptionsSignReference
*/
id?: string;