@sudoplatform/sudo-common 5.6.0 → 5.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -1
- package/bin/yarn-audit-with-suppression.sh +1 -1
- package/dependencies-report.json +2 -2
- package/docs/.nojekyll +1 -0
- package/docs/assets/highlight.css +57 -0
- package/docs/assets/icons.css +1043 -0
- package/docs/assets/{images/icons.png → icons.png} +0 -0
- package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
- package/docs/assets/main.js +52 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1384 -0
- package/docs/assets/{images/widgets.png → widgets.png} +0 -0
- package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
- package/docs/classes/AccountLockedError.html +7 -332
- package/docs/classes/AuthenticationError.html +8 -339
- package/docs/classes/Base64.html +3 -283
- package/docs/classes/Buffer.html +3 -324
- package/docs/classes/ConfigurationNotSetError.html +8 -333
- package/docs/classes/ConfigurationSetNotFoundError.html +7 -338
- package/docs/classes/DecodeError.html +7 -338
- package/docs/classes/DefaultConfigurationManager.html +18 -333
- package/docs/classes/DefaultLogger.html +19 -417
- package/docs/classes/DefaultSudoKeyArchive.html +61 -598
- package/docs/classes/DefaultSudoKeyManager.html +60 -1110
- package/docs/classes/FatalError.html +8 -339
- package/docs/classes/IllegalArgumentError.html +7 -338
- package/docs/classes/IllegalStateError.html +8 -339
- package/docs/classes/InsufficientEntitlementsError.html +8 -333
- package/docs/classes/InvalidOwnershipProofError.html +7 -332
- package/docs/classes/InvalidTokenError.html +7 -332
- package/docs/classes/KeyArchiveDecodingError.html +7 -338
- package/docs/classes/KeyArchiveIncorrectPasswordError.html +7 -338
- package/docs/classes/KeyArchiveMissingError.html +7 -338
- package/docs/classes/KeyArchiveNoPasswordRequiredError.html +7 -338
- package/docs/classes/KeyArchivePasswordRequiredError.html +7 -338
- package/docs/classes/KeyArchiveTypeError.html +7 -338
- package/docs/classes/KeyArchiveUnknownKeyTypeError.html +7 -338
- package/docs/classes/KeyArchiveVersionError.html +7 -338
- package/docs/classes/KeyNotFoundError.html +7 -338
- package/docs/classes/KeyStoreNotExportableError.html +7 -338
- package/docs/classes/LimitExceededError.html +8 -333
- package/docs/classes/NoEntitlementsError.html +7 -332
- package/docs/classes/NotAuthorizedError.html +8 -339
- package/docs/classes/NotRegisteredError.html +7 -338
- package/docs/classes/NotSignedInError.html +8 -333
- package/docs/classes/OperationNotImplementedError.html +7 -338
- package/docs/classes/RegisterError.html +8 -339
- package/docs/classes/RequestFailedError.html +12 -380
- package/docs/classes/ServiceError.html +9 -340
- package/docs/classes/SignOutError.html +7 -338
- package/docs/classes/SudoCryptoProviderDefaults.html +1 -224
- package/docs/classes/UnknownGraphQLError.html +7 -338
- package/docs/classes/UnrecognizedAlgorithmError.html +7 -0
- package/docs/classes/UserNotConfirmedError.html +8 -333
- package/docs/classes/VersionMismatchError.html +10 -335
- package/docs/enums/CachePolicy.html +4 -170
- package/docs/enums/EncryptionAlgorithm.html +5 -171
- package/docs/enums/KeyArchiveKeyType.html +4 -198
- package/docs/enums/KeyDataKeyFormat.html +18 -202
- package/docs/enums/KeyDataKeyType.html +3 -197
- package/docs/enums/ListOperationResultStatus.html +10 -0
- package/docs/enums/PublicKeyFormat.html +1 -162
- package/docs/index.html +14 -369
- package/docs/interfaces/AsymmetricEncryptionOptions.html +3 -163
- package/docs/interfaces/BooleanFilter.html +3 -177
- package/docs/interfaces/ConfigurationManager.html +37 -349
- package/docs/interfaces/KeyData.html +8 -236
- package/docs/interfaces/ListOperationFailureResult.html +5 -0
- package/docs/interfaces/ListOperationPartialResult.html +10 -0
- package/docs/interfaces/ListOperationSuccessResult.html +7 -0
- package/docs/interfaces/ListOutput.html +3 -185
- package/docs/interfaces/Logger.html +39 -401
- package/docs/interfaces/Owner.html +1 -170
- package/docs/interfaces/PublicKey.html +1 -170
- package/docs/interfaces/StringFilter.html +3 -191
- package/docs/interfaces/SudoCryptoProvider.html +172 -1305
- package/docs/interfaces/SudoKeyArchive.html +54 -490
- package/docs/interfaces/SudoKeyManager.html +167 -1298
- package/docs/interfaces/SymmetricEncryptionOptions.html +3 -177
- package/docs/modules.html +33 -895
- package/github/CHANGELOG.md +5 -1
- package/github/bin/yarn-audit-with-suppression.sh +1 -1
- package/github/docs/.nojekyll +1 -0
- package/github/docs/assets/highlight.css +57 -0
- package/github/docs/assets/icons.css +1043 -0
- package/github/docs/assets/{images/icons.png → icons.png} +0 -0
- package/github/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
- package/github/docs/assets/main.js +52 -0
- package/github/docs/assets/search.js +1 -0
- package/github/docs/assets/style.css +1384 -0
- package/github/docs/assets/{images/widgets.png → widgets.png} +0 -0
- package/github/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
- package/github/docs/classes/AccountLockedError.html +7 -332
- package/github/docs/classes/AuthenticationError.html +8 -339
- package/github/docs/classes/Base64.html +3 -283
- package/github/docs/classes/Buffer.html +3 -324
- package/github/docs/classes/ConfigurationNotSetError.html +8 -333
- package/github/docs/classes/ConfigurationSetNotFoundError.html +7 -338
- package/github/docs/classes/DecodeError.html +7 -338
- package/github/docs/classes/DefaultConfigurationManager.html +18 -333
- package/github/docs/classes/DefaultLogger.html +19 -417
- package/github/docs/classes/DefaultSudoKeyArchive.html +61 -598
- package/github/docs/classes/DefaultSudoKeyManager.html +60 -1110
- package/github/docs/classes/FatalError.html +8 -339
- package/github/docs/classes/IllegalArgumentError.html +7 -338
- package/github/docs/classes/IllegalStateError.html +8 -339
- package/github/docs/classes/InsufficientEntitlementsError.html +8 -333
- package/github/docs/classes/InvalidOwnershipProofError.html +7 -332
- package/github/docs/classes/InvalidTokenError.html +7 -332
- package/github/docs/classes/KeyArchiveDecodingError.html +7 -338
- package/github/docs/classes/KeyArchiveIncorrectPasswordError.html +7 -338
- package/github/docs/classes/KeyArchiveMissingError.html +7 -338
- package/github/docs/classes/KeyArchiveNoPasswordRequiredError.html +7 -338
- package/github/docs/classes/KeyArchivePasswordRequiredError.html +7 -338
- package/github/docs/classes/KeyArchiveTypeError.html +7 -338
- package/github/docs/classes/KeyArchiveUnknownKeyTypeError.html +7 -338
- package/github/docs/classes/KeyArchiveVersionError.html +7 -338
- package/github/docs/classes/KeyNotFoundError.html +7 -338
- package/github/docs/classes/KeyStoreNotExportableError.html +7 -338
- package/github/docs/classes/LimitExceededError.html +8 -333
- package/github/docs/classes/NoEntitlementsError.html +7 -332
- package/github/docs/classes/NotAuthorizedError.html +8 -339
- package/github/docs/classes/NotRegisteredError.html +7 -338
- package/github/docs/classes/NotSignedInError.html +8 -333
- package/github/docs/classes/OperationNotImplementedError.html +7 -338
- package/github/docs/classes/RegisterError.html +8 -339
- package/github/docs/classes/RequestFailedError.html +12 -380
- package/github/docs/classes/ServiceError.html +9 -340
- package/github/docs/classes/SignOutError.html +7 -338
- package/github/docs/classes/SudoCryptoProviderDefaults.html +1 -224
- package/github/docs/classes/UnknownGraphQLError.html +7 -338
- package/github/docs/classes/UnrecognizedAlgorithmError.html +7 -0
- package/github/docs/classes/UserNotConfirmedError.html +8 -333
- package/github/docs/classes/VersionMismatchError.html +10 -335
- package/github/docs/enums/CachePolicy.html +4 -170
- package/github/docs/enums/EncryptionAlgorithm.html +5 -171
- package/github/docs/enums/KeyArchiveKeyType.html +4 -198
- package/github/docs/enums/KeyDataKeyFormat.html +18 -202
- package/github/docs/enums/KeyDataKeyType.html +3 -197
- package/github/docs/enums/ListOperationResultStatus.html +10 -0
- package/github/docs/enums/PublicKeyFormat.html +1 -162
- package/github/docs/index.html +14 -369
- package/github/docs/interfaces/AsymmetricEncryptionOptions.html +3 -163
- package/github/docs/interfaces/BooleanFilter.html +3 -177
- package/github/docs/interfaces/ConfigurationManager.html +37 -349
- package/github/docs/interfaces/KeyData.html +8 -236
- package/github/docs/interfaces/ListOperationFailureResult.html +5 -0
- package/github/docs/interfaces/ListOperationPartialResult.html +10 -0
- package/github/docs/interfaces/ListOperationSuccessResult.html +7 -0
- package/github/docs/interfaces/ListOutput.html +3 -185
- package/github/docs/interfaces/Logger.html +39 -401
- package/github/docs/interfaces/Owner.html +1 -170
- package/github/docs/interfaces/PublicKey.html +1 -170
- package/github/docs/interfaces/StringFilter.html +3 -191
- package/github/docs/interfaces/SudoCryptoProvider.html +172 -1305
- package/github/docs/interfaces/SudoKeyArchive.html +54 -490
- package/github/docs/interfaces/SudoKeyManager.html +167 -1298
- package/github/docs/interfaces/SymmetricEncryptionOptions.html +3 -177
- package/github/docs/modules.html +33 -895
- package/github/package.json +19 -16
- package/github/src/errors/error.ts +10 -0
- package/github/src/sudoKeyArchive/sudoKeyArchive.ts +1 -1
- package/github/src/sudoKeyManager/sudoCryptoProvider.ts +12 -0
- package/github/src/sudoKeyManager/sudoKeyManager.ts +12 -0
- package/github/src/types/types.ts +78 -0
- package/github/test/utils/listOperationResult.spec.ts +84 -0
- package/github/yarn.lock +871 -1264
- package/lib/errors/error.d.ts +6 -0
- package/lib/errors/error.js +16 -2
- package/lib/logging/bunyanLogger.js +1 -1
- package/lib/sudoKeyArchive/keyArchive.js +2 -2
- package/lib/sudoKeyArchive/keyInfo.js +1 -1
- package/lib/sudoKeyArchive/sudoKeyArchive.d.ts +1 -2
- package/lib/sudoKeyArchive/sudoKeyArchive.js +1 -1
- package/lib/sudoKeyManager/keyData.js +1 -1
- package/lib/sudoKeyManager/sudoCryptoProvider.d.ts +12 -0
- package/lib/sudoKeyManager/sudoKeyManager.d.ts +12 -0
- package/lib/types/types.d.ts +71 -0
- package/lib/types/types.js +14 -2
- package/package.json +20 -17
- package/src/errors/error.ts +10 -0
- package/src/sudoKeyArchive/sudoKeyArchive.ts +1 -1
- package/src/sudoKeyManager/sudoCryptoProvider.ts +12 -0
- package/src/sudoKeyManager/sudoKeyManager.ts +12 -0
- package/src/types/types.ts +78 -0
- package/test/utils/listOperationResult.spec.ts +84 -0
- package/yarn.lock +871 -1264
- package/docs/assets/css/main.css +0 -2660
- package/docs/assets/js/main.js +0 -248
- package/docs/assets/js/search.js +0 -1
- package/github/docs/assets/css/main.css +0 -2660
- package/github/docs/assets/js/main.js +0 -248
- package/github/docs/assets/js/search.js +0 -1
- package/github/src/sudoKeyManager/encryptionAlgorithmTransformer.ts +0 -21
- package/lib/sudoKeyManager/encryptionAlgorithmTransformer.d.ts +0 -9
- package/lib/sudoKeyManager/encryptionAlgorithmTransformer.js +0 -28
- package/src/sudoKeyManager/encryptionAlgorithmTransformer.ts +0 -21
|
@@ -1,1305 +1,172 @@
|
|
|
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
|
-
<div class="
|
|
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
|
-
</aside>
|
|
174
|
-
<div class="tsd-comment tsd-typography">
|
|
175
|
-
<div class="lead">
|
|
176
|
-
<p>Adds a private key to the secure store.</p>
|
|
177
|
-
</div>
|
|
178
|
-
</div>
|
|
179
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
180
|
-
<ul class="tsd-parameters">
|
|
181
|
-
<li>
|
|
182
|
-
<h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
183
|
-
<div class="tsd-comment tsd-typography">
|
|
184
|
-
<p>The private key to store securely.</p>
|
|
185
|
-
</div>
|
|
186
|
-
</li>
|
|
187
|
-
<li>
|
|
188
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
189
|
-
<div class="tsd-comment tsd-typography">
|
|
190
|
-
<p>The name of the private key to be stored.</p>
|
|
191
|
-
</div>
|
|
192
|
-
</li>
|
|
193
|
-
</ul>
|
|
194
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
195
|
-
</li>
|
|
196
|
-
</ul>
|
|
197
|
-
</section>
|
|
198
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
199
|
-
<a name="addPublicKey" class="tsd-anchor"></a>
|
|
200
|
-
<h3>add<wbr>Public<wbr>Key</h3>
|
|
201
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
202
|
-
<li class="tsd-signature tsd-kind-icon">add<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
203
|
-
</ul>
|
|
204
|
-
<ul class="tsd-descriptions">
|
|
205
|
-
<li class="tsd-description">
|
|
206
|
-
<aside class="tsd-sources">
|
|
207
|
-
<ul>
|
|
208
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:156</li>
|
|
209
|
-
</ul>
|
|
210
|
-
</aside>
|
|
211
|
-
<div class="tsd-comment tsd-typography">
|
|
212
|
-
<div class="lead">
|
|
213
|
-
<p>Adds a public key to the secure store.</p>
|
|
214
|
-
</div>
|
|
215
|
-
</div>
|
|
216
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
217
|
-
<ul class="tsd-parameters">
|
|
218
|
-
<li>
|
|
219
|
-
<h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
220
|
-
<div class="tsd-comment tsd-typography">
|
|
221
|
-
<p>The public key to store securely.</p>
|
|
222
|
-
</div>
|
|
223
|
-
</li>
|
|
224
|
-
<li>
|
|
225
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
226
|
-
<div class="tsd-comment tsd-typography">
|
|
227
|
-
<p>The name of the public key to be stored.</p>
|
|
228
|
-
</div>
|
|
229
|
-
</li>
|
|
230
|
-
</ul>
|
|
231
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
232
|
-
</li>
|
|
233
|
-
</ul>
|
|
234
|
-
</section>
|
|
235
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
236
|
-
<a name="addSymmetricKey" class="tsd-anchor"></a>
|
|
237
|
-
<h3>add<wbr>Symmetric<wbr>Key</h3>
|
|
238
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
239
|
-
<li class="tsd-signature tsd-kind-icon">add<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
240
|
-
</ul>
|
|
241
|
-
<ul class="tsd-descriptions">
|
|
242
|
-
<li class="tsd-description">
|
|
243
|
-
<aside class="tsd-sources">
|
|
244
|
-
<ul>
|
|
245
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:77</li>
|
|
246
|
-
</ul>
|
|
247
|
-
</aside>
|
|
248
|
-
<div class="tsd-comment tsd-typography">
|
|
249
|
-
<div class="lead">
|
|
250
|
-
<p>Adds a symmetric key to the secure store.</p>
|
|
251
|
-
</div>
|
|
252
|
-
</div>
|
|
253
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
254
|
-
<ul class="tsd-parameters">
|
|
255
|
-
<li>
|
|
256
|
-
<h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
257
|
-
<div class="tsd-comment tsd-typography">
|
|
258
|
-
<p>The symmetric key.</p>
|
|
259
|
-
</div>
|
|
260
|
-
</li>
|
|
261
|
-
<li>
|
|
262
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
263
|
-
<div class="tsd-comment tsd-typography">
|
|
264
|
-
<p>The name for the symmetric key.</p>
|
|
265
|
-
</div>
|
|
266
|
-
</li>
|
|
267
|
-
</ul>
|
|
268
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
269
|
-
</li>
|
|
270
|
-
</ul>
|
|
271
|
-
</section>
|
|
272
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
273
|
-
<a name="decryptWithPrivateKey" class="tsd-anchor"></a>
|
|
274
|
-
<h3>decrypt<wbr>With<wbr>Private<wbr>Key</h3>
|
|
275
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
276
|
-
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
277
|
-
</ul>
|
|
278
|
-
<ul class="tsd-descriptions">
|
|
279
|
-
<li class="tsd-description">
|
|
280
|
-
<aside class="tsd-sources">
|
|
281
|
-
<ul>
|
|
282
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:319</li>
|
|
283
|
-
</ul>
|
|
284
|
-
</aside>
|
|
285
|
-
<div class="tsd-comment tsd-typography">
|
|
286
|
-
<div class="lead">
|
|
287
|
-
<p>Decrypts the given data with the specified private key.</p>
|
|
288
|
-
</div>
|
|
289
|
-
</div>
|
|
290
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
291
|
-
<ul class="tsd-parameters">
|
|
292
|
-
<li>
|
|
293
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
294
|
-
<div class="tsd-comment tsd-typography">
|
|
295
|
-
<p>The name of the private key to use for decryption.</p>
|
|
296
|
-
</div>
|
|
297
|
-
</li>
|
|
298
|
-
<li>
|
|
299
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
300
|
-
<div class="tsd-comment tsd-typography">
|
|
301
|
-
<p>The data to decrypt.</p>
|
|
302
|
-
</div>
|
|
303
|
-
</li>
|
|
304
|
-
<li>
|
|
305
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a></h5>
|
|
306
|
-
</li>
|
|
307
|
-
</ul>
|
|
308
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
309
|
-
<p>Decrypted data or undefined if the private key is not found.</p>
|
|
310
|
-
</li>
|
|
311
|
-
</ul>
|
|
312
|
-
</section>
|
|
313
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
314
|
-
<a name="decryptWithSymmetricKey" class="tsd-anchor"></a>
|
|
315
|
-
<h3>decrypt<wbr>With<wbr>Symmetric<wbr>Key</h3>
|
|
316
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
317
|
-
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
318
|
-
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
319
|
-
</ul>
|
|
320
|
-
<ul class="tsd-descriptions">
|
|
321
|
-
<li class="tsd-description">
|
|
322
|
-
<aside class="tsd-sources">
|
|
323
|
-
<ul>
|
|
324
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:277</li>
|
|
325
|
-
</ul>
|
|
326
|
-
</aside>
|
|
327
|
-
<div class="tsd-comment tsd-typography">
|
|
328
|
-
<dl class="tsd-comment-tags">
|
|
329
|
-
<dt>deprecated</dt>
|
|
330
|
-
<dd><p>Use version with <code>options</code> param.</p>
|
|
331
|
-
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
332
|
-
</dd>
|
|
333
|
-
</dl>
|
|
334
|
-
</div>
|
|
335
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
336
|
-
<ul class="tsd-parameters">
|
|
337
|
-
<li>
|
|
338
|
-
<h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
339
|
-
</li>
|
|
340
|
-
<li>
|
|
341
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
342
|
-
<div class="tsd-comment tsd-typography">
|
|
343
|
-
<p>The data to decrypt.</p>
|
|
344
|
-
</div>
|
|
345
|
-
</li>
|
|
346
|
-
<li>
|
|
347
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
348
|
-
<div class="tsd-comment tsd-typography">
|
|
349
|
-
<p>Optional Initialization Vector.</p>
|
|
350
|
-
</div>
|
|
351
|
-
</li>
|
|
352
|
-
</ul>
|
|
353
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
354
|
-
<p>Decrypted data</p>
|
|
355
|
-
</li>
|
|
356
|
-
<li class="tsd-description">
|
|
357
|
-
<aside class="tsd-sources">
|
|
358
|
-
<ul>
|
|
359
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:291</li>
|
|
360
|
-
</ul>
|
|
361
|
-
</aside>
|
|
362
|
-
<div class="tsd-comment tsd-typography">
|
|
363
|
-
<div class="lead">
|
|
364
|
-
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
365
|
-
</div>
|
|
366
|
-
</div>
|
|
367
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
368
|
-
<ul class="tsd-parameters">
|
|
369
|
-
<li>
|
|
370
|
-
<h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
371
|
-
</li>
|
|
372
|
-
<li>
|
|
373
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
374
|
-
<div class="tsd-comment tsd-typography">
|
|
375
|
-
<p>The data to decrypt.</p>
|
|
376
|
-
</div>
|
|
377
|
-
</li>
|
|
378
|
-
<li>
|
|
379
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5>
|
|
380
|
-
</li>
|
|
381
|
-
</ul>
|
|
382
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
383
|
-
<p>Decrypted data</p>
|
|
384
|
-
</li>
|
|
385
|
-
</ul>
|
|
386
|
-
</section>
|
|
387
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
388
|
-
<a name="decryptWithSymmetricKeyName" class="tsd-anchor"></a>
|
|
389
|
-
<h3>decrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name</h3>
|
|
390
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
391
|
-
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
392
|
-
<li class="tsd-signature tsd-kind-icon">decrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
393
|
-
</ul>
|
|
394
|
-
<ul class="tsd-descriptions">
|
|
395
|
-
<li class="tsd-description">
|
|
396
|
-
<aside class="tsd-sources">
|
|
397
|
-
<ul>
|
|
398
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:215</li>
|
|
399
|
-
</ul>
|
|
400
|
-
</aside>
|
|
401
|
-
<div class="tsd-comment tsd-typography">
|
|
402
|
-
<dl class="tsd-comment-tags">
|
|
403
|
-
<dt>deprecated</dt>
|
|
404
|
-
<dd><p>Use version with <code>options</code> param.</p>
|
|
405
|
-
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
406
|
-
</dd>
|
|
407
|
-
</dl>
|
|
408
|
-
</div>
|
|
409
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
410
|
-
<ul class="tsd-parameters">
|
|
411
|
-
<li>
|
|
412
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
413
|
-
<div class="tsd-comment tsd-typography">
|
|
414
|
-
<p>The name of the symmetric key to use to decrypt.</p>
|
|
415
|
-
</div>
|
|
416
|
-
</li>
|
|
417
|
-
<li>
|
|
418
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
419
|
-
<div class="tsd-comment tsd-typography">
|
|
420
|
-
<p>The data to decrypt.</p>
|
|
421
|
-
</div>
|
|
422
|
-
</li>
|
|
423
|
-
<li>
|
|
424
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
425
|
-
<div class="tsd-comment tsd-typography">
|
|
426
|
-
<p>Optional Initialization Vector.</p>
|
|
427
|
-
</div>
|
|
428
|
-
</li>
|
|
429
|
-
</ul>
|
|
430
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
431
|
-
<p>Decrypted data</p>
|
|
432
|
-
</li>
|
|
433
|
-
<li class="tsd-description">
|
|
434
|
-
<aside class="tsd-sources">
|
|
435
|
-
<ul>
|
|
436
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:229</li>
|
|
437
|
-
</ul>
|
|
438
|
-
</aside>
|
|
439
|
-
<div class="tsd-comment tsd-typography">
|
|
440
|
-
<div class="lead">
|
|
441
|
-
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
442
|
-
</div>
|
|
443
|
-
</div>
|
|
444
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
445
|
-
<ul class="tsd-parameters">
|
|
446
|
-
<li>
|
|
447
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
448
|
-
<div class="tsd-comment tsd-typography">
|
|
449
|
-
<p>The name of the symmetric key to use to decrypt.</p>
|
|
450
|
-
</div>
|
|
451
|
-
</li>
|
|
452
|
-
<li>
|
|
453
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
454
|
-
<div class="tsd-comment tsd-typography">
|
|
455
|
-
<p>The data to decrypt.</p>
|
|
456
|
-
</div>
|
|
457
|
-
</li>
|
|
458
|
-
<li>
|
|
459
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5>
|
|
460
|
-
</li>
|
|
461
|
-
</ul>
|
|
462
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
463
|
-
<p>Decrypted data</p>
|
|
464
|
-
</li>
|
|
465
|
-
</ul>
|
|
466
|
-
</section>
|
|
467
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
468
|
-
<a name="deleteKeyPair" class="tsd-anchor"></a>
|
|
469
|
-
<h3>delete<wbr>Key<wbr>Pair</h3>
|
|
470
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
471
|
-
<li class="tsd-signature tsd-kind-icon">delete<wbr>Key<wbr>Pair<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
472
|
-
</ul>
|
|
473
|
-
<ul class="tsd-descriptions">
|
|
474
|
-
<li class="tsd-description">
|
|
475
|
-
<aside class="tsd-sources">
|
|
476
|
-
<ul>
|
|
477
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:131</li>
|
|
478
|
-
</ul>
|
|
479
|
-
</aside>
|
|
480
|
-
<div class="tsd-comment tsd-typography">
|
|
481
|
-
<div class="lead">
|
|
482
|
-
<p>Deletes a key pair from the secure store.</p>
|
|
483
|
-
</div>
|
|
484
|
-
</div>
|
|
485
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
486
|
-
<ul class="tsd-parameters">
|
|
487
|
-
<li>
|
|
488
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
489
|
-
<div class="tsd-comment tsd-typography">
|
|
490
|
-
<p>The name of the key pair to be deleted.</p>
|
|
491
|
-
</div>
|
|
492
|
-
</li>
|
|
493
|
-
</ul>
|
|
494
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
495
|
-
</li>
|
|
496
|
-
</ul>
|
|
497
|
-
</section>
|
|
498
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
499
|
-
<a name="deletePassword" class="tsd-anchor"></a>
|
|
500
|
-
<h3>delete<wbr>Password</h3>
|
|
501
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
502
|
-
<li class="tsd-signature tsd-kind-icon">delete<wbr>Password<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
503
|
-
</ul>
|
|
504
|
-
<ul class="tsd-descriptions">
|
|
505
|
-
<li class="tsd-description">
|
|
506
|
-
<aside class="tsd-sources">
|
|
507
|
-
<ul>
|
|
508
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:61</li>
|
|
509
|
-
</ul>
|
|
510
|
-
</aside>
|
|
511
|
-
<div class="tsd-comment tsd-typography">
|
|
512
|
-
<div class="lead">
|
|
513
|
-
<p>Deletes a password from the secure store.</p>
|
|
514
|
-
</div>
|
|
515
|
-
</div>
|
|
516
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
517
|
-
<ul class="tsd-parameters">
|
|
518
|
-
<li>
|
|
519
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
520
|
-
<div class="tsd-comment tsd-typography">
|
|
521
|
-
<p>The name of the password to delete.</p>
|
|
522
|
-
</div>
|
|
523
|
-
</li>
|
|
524
|
-
</ul>
|
|
525
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
526
|
-
</li>
|
|
527
|
-
</ul>
|
|
528
|
-
</section>
|
|
529
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
530
|
-
<a name="deleteSymmetricKey" class="tsd-anchor"></a>
|
|
531
|
-
<h3>delete<wbr>Symmetric<wbr>Key</h3>
|
|
532
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
533
|
-
<li class="tsd-signature tsd-kind-icon">delete<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
534
|
-
</ul>
|
|
535
|
-
<ul class="tsd-descriptions">
|
|
536
|
-
<li class="tsd-description">
|
|
537
|
-
<aside class="tsd-sources">
|
|
538
|
-
<ul>
|
|
539
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:93</li>
|
|
540
|
-
</ul>
|
|
541
|
-
</aside>
|
|
542
|
-
<div class="tsd-comment tsd-typography">
|
|
543
|
-
<div class="lead">
|
|
544
|
-
<p>Deletes a symmetric key from the secure store.</p>
|
|
545
|
-
</div>
|
|
546
|
-
</div>
|
|
547
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
548
|
-
<ul class="tsd-parameters">
|
|
549
|
-
<li>
|
|
550
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
551
|
-
<div class="tsd-comment tsd-typography">
|
|
552
|
-
<p>The name of the symmetric key.</p>
|
|
553
|
-
</div>
|
|
554
|
-
</li>
|
|
555
|
-
</ul>
|
|
556
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
557
|
-
</li>
|
|
558
|
-
</ul>
|
|
559
|
-
</section>
|
|
560
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
561
|
-
<a name="encryptWithPublicKey" class="tsd-anchor"></a>
|
|
562
|
-
<h3>encrypt<wbr>With<wbr>Public<wbr>Key</h3>
|
|
563
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
564
|
-
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
565
|
-
</ul>
|
|
566
|
-
<ul class="tsd-descriptions">
|
|
567
|
-
<li class="tsd-description">
|
|
568
|
-
<aside class="tsd-sources">
|
|
569
|
-
<ul>
|
|
570
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:305</li>
|
|
571
|
-
</ul>
|
|
572
|
-
</aside>
|
|
573
|
-
<div class="tsd-comment tsd-typography">
|
|
574
|
-
<div class="lead">
|
|
575
|
-
<p>Encrypts the given data with the specified public key.</p>
|
|
576
|
-
</div>
|
|
577
|
-
</div>
|
|
578
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
579
|
-
<ul class="tsd-parameters">
|
|
580
|
-
<li>
|
|
581
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
582
|
-
<div class="tsd-comment tsd-typography">
|
|
583
|
-
<p>The name of the public key to use for encryption.</p>
|
|
584
|
-
</div>
|
|
585
|
-
</li>
|
|
586
|
-
<li>
|
|
587
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
588
|
-
<div class="tsd-comment tsd-typography">
|
|
589
|
-
<p>The data to encrypt.</p>
|
|
590
|
-
</div>
|
|
591
|
-
</li>
|
|
592
|
-
<li>
|
|
593
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a></h5>
|
|
594
|
-
</li>
|
|
595
|
-
</ul>
|
|
596
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
597
|
-
<p>Encrypted data</p>
|
|
598
|
-
</li>
|
|
599
|
-
</ul>
|
|
600
|
-
</section>
|
|
601
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
602
|
-
<a name="encryptWithSymmetricKey" class="tsd-anchor"></a>
|
|
603
|
-
<h3>encrypt<wbr>With<wbr>Symmetric<wbr>Key</h3>
|
|
604
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
605
|
-
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
606
|
-
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
607
|
-
</ul>
|
|
608
|
-
<ul class="tsd-descriptions">
|
|
609
|
-
<li class="tsd-description">
|
|
610
|
-
<aside class="tsd-sources">
|
|
611
|
-
<ul>
|
|
612
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:246</li>
|
|
613
|
-
</ul>
|
|
614
|
-
</aside>
|
|
615
|
-
<div class="tsd-comment tsd-typography">
|
|
616
|
-
<dl class="tsd-comment-tags">
|
|
617
|
-
<dt>deprecated</dt>
|
|
618
|
-
<dd><p>Use version with <code>options</code> param.</p>
|
|
619
|
-
<p>Encrypts the given data with the specified key</p>
|
|
620
|
-
</dd>
|
|
621
|
-
</dl>
|
|
622
|
-
</div>
|
|
623
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
624
|
-
<ul class="tsd-parameters">
|
|
625
|
-
<li>
|
|
626
|
-
<h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
627
|
-
</li>
|
|
628
|
-
<li>
|
|
629
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
630
|
-
<div class="tsd-comment tsd-typography">
|
|
631
|
-
<p>Data to encrypt.</p>
|
|
632
|
-
</div>
|
|
633
|
-
</li>
|
|
634
|
-
<li>
|
|
635
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
636
|
-
<div class="tsd-comment tsd-typography">
|
|
637
|
-
<p>Optional Initialization Vector.</p>
|
|
638
|
-
</div>
|
|
639
|
-
</li>
|
|
640
|
-
</ul>
|
|
641
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
642
|
-
<p>Encrypted data and IV</p>
|
|
643
|
-
</li>
|
|
644
|
-
<li class="tsd-description">
|
|
645
|
-
<aside class="tsd-sources">
|
|
646
|
-
<ul>
|
|
647
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:260</li>
|
|
648
|
-
</ul>
|
|
649
|
-
</aside>
|
|
650
|
-
<div class="tsd-comment tsd-typography">
|
|
651
|
-
<div class="lead">
|
|
652
|
-
<p>Encrypts the given data with the specified key</p>
|
|
653
|
-
</div>
|
|
654
|
-
</div>
|
|
655
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
656
|
-
<ul class="tsd-parameters">
|
|
657
|
-
<li>
|
|
658
|
-
<h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
659
|
-
</li>
|
|
660
|
-
<li>
|
|
661
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
662
|
-
<div class="tsd-comment tsd-typography">
|
|
663
|
-
<p>Data to encrypt.</p>
|
|
664
|
-
</div>
|
|
665
|
-
</li>
|
|
666
|
-
<li>
|
|
667
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5>
|
|
668
|
-
</li>
|
|
669
|
-
</ul>
|
|
670
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
671
|
-
<p>Encrypted data and IV</p>
|
|
672
|
-
</li>
|
|
673
|
-
</ul>
|
|
674
|
-
</section>
|
|
675
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
676
|
-
<a name="encryptWithSymmetricKeyName" class="tsd-anchor"></a>
|
|
677
|
-
<h3>encrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name</h3>
|
|
678
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
679
|
-
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
680
|
-
<li class="tsd-signature tsd-kind-icon">encrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
681
|
-
</ul>
|
|
682
|
-
<ul class="tsd-descriptions">
|
|
683
|
-
<li class="tsd-description">
|
|
684
|
-
<aside class="tsd-sources">
|
|
685
|
-
<ul>
|
|
686
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:183</li>
|
|
687
|
-
</ul>
|
|
688
|
-
</aside>
|
|
689
|
-
<div class="tsd-comment tsd-typography">
|
|
690
|
-
<dl class="tsd-comment-tags">
|
|
691
|
-
<dt>deprecated</dt>
|
|
692
|
-
<dd><p>Use version with <code>options</code> param.</p>
|
|
693
|
-
<p>Encrypts the given data with the specified symmetric key stored in the secure store.</p>
|
|
694
|
-
</dd>
|
|
695
|
-
</dl>
|
|
696
|
-
</div>
|
|
697
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
698
|
-
<ul class="tsd-parameters">
|
|
699
|
-
<li>
|
|
700
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
701
|
-
<div class="tsd-comment tsd-typography">
|
|
702
|
-
<p>The name of the symmetric key to use to encrypt.</p>
|
|
703
|
-
</div>
|
|
704
|
-
</li>
|
|
705
|
-
<li>
|
|
706
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
707
|
-
<div class="tsd-comment tsd-typography">
|
|
708
|
-
<p>Data to encrypt.</p>
|
|
709
|
-
</div>
|
|
710
|
-
</li>
|
|
711
|
-
<li>
|
|
712
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
713
|
-
<div class="tsd-comment tsd-typography">
|
|
714
|
-
<p>Optional Initialization Vector.</p>
|
|
715
|
-
</div>
|
|
716
|
-
</li>
|
|
717
|
-
</ul>
|
|
718
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
719
|
-
<p>Encrypted data and IV</p>
|
|
720
|
-
</li>
|
|
721
|
-
<li class="tsd-description">
|
|
722
|
-
<aside class="tsd-sources">
|
|
723
|
-
<ul>
|
|
724
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:198</li>
|
|
725
|
-
</ul>
|
|
726
|
-
</aside>
|
|
727
|
-
<div class="tsd-comment tsd-typography">
|
|
728
|
-
<div class="lead">
|
|
729
|
-
<p>Encrypts the given data with the specified symmetric key stored in the secure store.</p>
|
|
730
|
-
</div>
|
|
731
|
-
</div>
|
|
732
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
733
|
-
<ul class="tsd-parameters">
|
|
734
|
-
<li>
|
|
735
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
736
|
-
<div class="tsd-comment tsd-typography">
|
|
737
|
-
<p>The name of the symmetric key to use to encrypt.</p>
|
|
738
|
-
</div>
|
|
739
|
-
</li>
|
|
740
|
-
<li>
|
|
741
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
742
|
-
<div class="tsd-comment tsd-typography">
|
|
743
|
-
<p>Data to encrypt.</p>
|
|
744
|
-
</div>
|
|
745
|
-
</li>
|
|
746
|
-
<li>
|
|
747
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5>
|
|
748
|
-
</li>
|
|
749
|
-
</ul>
|
|
750
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
751
|
-
<p>Encrypted data and IV</p>
|
|
752
|
-
</li>
|
|
753
|
-
</ul>
|
|
754
|
-
</section>
|
|
755
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
756
|
-
<a name="exportKeys" class="tsd-anchor"></a>
|
|
757
|
-
<h3>export<wbr>Keys</h3>
|
|
758
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
759
|
-
<li class="tsd-signature tsd-kind-icon">export<wbr>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyData.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
760
|
-
</ul>
|
|
761
|
-
<ul class="tsd-descriptions">
|
|
762
|
-
<li class="tsd-description">
|
|
763
|
-
<aside class="tsd-sources">
|
|
764
|
-
<ul>
|
|
765
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:347</li>
|
|
766
|
-
</ul>
|
|
767
|
-
</aside>
|
|
768
|
-
<div class="tsd-comment tsd-typography">
|
|
769
|
-
<div class="lead">
|
|
770
|
-
<p>Export all keys and passwords from the key store as an
|
|
771
|
-
array of KeyData items.</p>
|
|
772
|
-
</div>
|
|
773
|
-
</div>
|
|
774
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyData.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
775
|
-
<p>Array of exported keys and passwords</p>
|
|
776
|
-
</li>
|
|
777
|
-
</ul>
|
|
778
|
-
</section>
|
|
779
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
780
|
-
<a name="generateHash" class="tsd-anchor"></a>
|
|
781
|
-
<h3>generate<wbr>Hash</h3>
|
|
782
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
783
|
-
<li class="tsd-signature tsd-kind-icon">generate<wbr>Hash<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
784
|
-
</ul>
|
|
785
|
-
<ul class="tsd-descriptions">
|
|
786
|
-
<li class="tsd-description">
|
|
787
|
-
<aside class="tsd-sources">
|
|
788
|
-
<ul>
|
|
789
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:339</li>
|
|
790
|
-
</ul>
|
|
791
|
-
</aside>
|
|
792
|
-
<div class="tsd-comment tsd-typography">
|
|
793
|
-
<div class="lead">
|
|
794
|
-
<p>Creates a SHA256 hash of the specified data.</p>
|
|
795
|
-
</div>
|
|
796
|
-
</div>
|
|
797
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
798
|
-
<ul class="tsd-parameters">
|
|
799
|
-
<li>
|
|
800
|
-
<h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
801
|
-
<div class="tsd-comment tsd-typography">
|
|
802
|
-
<p>Data to hash.</p>
|
|
803
|
-
</div>
|
|
804
|
-
</li>
|
|
805
|
-
</ul>
|
|
806
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
807
|
-
<p>The SHA256 hash of data</p>
|
|
808
|
-
</li>
|
|
809
|
-
</ul>
|
|
810
|
-
</section>
|
|
811
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
812
|
-
<a name="generateKeyPair" class="tsd-anchor"></a>
|
|
813
|
-
<h3>generate<wbr>Key<wbr>Pair</h3>
|
|
814
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
815
|
-
<li class="tsd-signature tsd-kind-icon">generate<wbr>Key<wbr>Pair<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
816
|
-
</ul>
|
|
817
|
-
<ul class="tsd-descriptions">
|
|
818
|
-
<li class="tsd-description">
|
|
819
|
-
<aside class="tsd-sources">
|
|
820
|
-
<ul>
|
|
821
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:330</li>
|
|
822
|
-
</ul>
|
|
823
|
-
</aside>
|
|
824
|
-
<div class="tsd-comment tsd-typography">
|
|
825
|
-
<div class="lead">
|
|
826
|
-
<p>Generates and securely stores a key pair for public key cryptography.</p>
|
|
827
|
-
</div>
|
|
828
|
-
</div>
|
|
829
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
830
|
-
<ul class="tsd-parameters">
|
|
831
|
-
<li>
|
|
832
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
833
|
-
<div class="tsd-comment tsd-typography">
|
|
834
|
-
<p>The name of the key pair to be generated.</p>
|
|
835
|
-
</div>
|
|
836
|
-
</li>
|
|
837
|
-
</ul>
|
|
838
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
839
|
-
</li>
|
|
840
|
-
</ul>
|
|
841
|
-
</section>
|
|
842
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
843
|
-
<a name="generateRandomData" class="tsd-anchor"></a>
|
|
844
|
-
<h3>generate<wbr>Random<wbr>Data</h3>
|
|
845
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
846
|
-
<li class="tsd-signature tsd-kind-icon">generate<wbr>Random<wbr>Data<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
847
|
-
</ul>
|
|
848
|
-
<ul class="tsd-descriptions">
|
|
849
|
-
<li class="tsd-description">
|
|
850
|
-
<aside class="tsd-sources">
|
|
851
|
-
<ul>
|
|
852
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:124</li>
|
|
853
|
-
</ul>
|
|
854
|
-
</aside>
|
|
855
|
-
<div class="tsd-comment tsd-typography">
|
|
856
|
-
<div class="lead">
|
|
857
|
-
<p>Generate random bytes using a secure random number generator.</p>
|
|
858
|
-
</div>
|
|
859
|
-
</div>
|
|
860
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
861
|
-
<ul class="tsd-parameters">
|
|
862
|
-
<li>
|
|
863
|
-
<h5>size: <span class="tsd-signature-type">number</span></h5>
|
|
864
|
-
<div class="tsd-comment tsd-typography">
|
|
865
|
-
<p>Number of random bytes to generate</p>
|
|
866
|
-
</div>
|
|
867
|
-
</li>
|
|
868
|
-
</ul>
|
|
869
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
870
|
-
<p>ArrayBuffer containing the random bytes.</p>
|
|
871
|
-
</li>
|
|
872
|
-
</ul>
|
|
873
|
-
</section>
|
|
874
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
875
|
-
<a name="generateSymmetricKey" class="tsd-anchor"></a>
|
|
876
|
-
<h3>generate<wbr>Symmetric<wbr>Key</h3>
|
|
877
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
878
|
-
<li class="tsd-signature tsd-kind-icon">generate<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
879
|
-
</ul>
|
|
880
|
-
<ul class="tsd-descriptions">
|
|
881
|
-
<li class="tsd-description">
|
|
882
|
-
<aside class="tsd-sources">
|
|
883
|
-
<ul>
|
|
884
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:100</li>
|
|
885
|
-
</ul>
|
|
886
|
-
</aside>
|
|
887
|
-
<div class="tsd-comment tsd-typography">
|
|
888
|
-
<div class="lead">
|
|
889
|
-
<p>Generates a symmetric key and stores it securely.</p>
|
|
890
|
-
</div>
|
|
891
|
-
</div>
|
|
892
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
893
|
-
<ul class="tsd-parameters">
|
|
894
|
-
<li>
|
|
895
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
896
|
-
<div class="tsd-comment tsd-typography">
|
|
897
|
-
<p>The name for the symmetric key.</p>
|
|
898
|
-
</div>
|
|
899
|
-
</li>
|
|
900
|
-
</ul>
|
|
901
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
902
|
-
</li>
|
|
903
|
-
</ul>
|
|
904
|
-
</section>
|
|
905
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
906
|
-
<a name="generateSymmetricKeyFromPassword" class="tsd-anchor"></a>
|
|
907
|
-
<h3>generate<wbr>Symmetric<wbr>Key<wbr>From<wbr>Password</h3>
|
|
908
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
909
|
-
<li class="tsd-signature tsd-kind-icon">generate<wbr>Symmetric<wbr>Key<wbr>From<wbr>Password<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>rounds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
910
|
-
</ul>
|
|
911
|
-
<ul class="tsd-descriptions">
|
|
912
|
-
<li class="tsd-description">
|
|
913
|
-
<aside class="tsd-sources">
|
|
914
|
-
<ul>
|
|
915
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:111</li>
|
|
916
|
-
</ul>
|
|
917
|
-
</aside>
|
|
918
|
-
<div class="tsd-comment tsd-typography">
|
|
919
|
-
<div class="lead">
|
|
920
|
-
<p>Generates a symmetric key from a password using PBKDF2.</p>
|
|
921
|
-
</div>
|
|
922
|
-
</div>
|
|
923
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
924
|
-
<ul class="tsd-parameters">
|
|
925
|
-
<li>
|
|
926
|
-
<h5>password: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
927
|
-
<div class="tsd-comment tsd-typography">
|
|
928
|
-
<p>The password from which to generate the symmetric key</p>
|
|
929
|
-
</div>
|
|
930
|
-
</li>
|
|
931
|
-
<li>
|
|
932
|
-
<h5>salt: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
933
|
-
<div class="tsd-comment tsd-typography">
|
|
934
|
-
<p>Salt to use in generation of the key</p>
|
|
935
|
-
</div>
|
|
936
|
-
</li>
|
|
937
|
-
<li>
|
|
938
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>rounds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
939
|
-
<ul class="tsd-parameters">
|
|
940
|
-
<li class="tsd-parameter">
|
|
941
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> rounds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
|
942
|
-
</li>
|
|
943
|
-
</ul>
|
|
944
|
-
</li>
|
|
945
|
-
</ul>
|
|
946
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
947
|
-
<p>The generated symmetric key.</p>
|
|
948
|
-
</li>
|
|
949
|
-
</ul>
|
|
950
|
-
</section>
|
|
951
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
952
|
-
<a name="getNamespace" class="tsd-anchor"></a>
|
|
953
|
-
<h3>get<wbr>Namespace</h3>
|
|
954
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
955
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Namespace<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
956
|
-
</ul>
|
|
957
|
-
<ul class="tsd-descriptions">
|
|
958
|
-
<li class="tsd-description">
|
|
959
|
-
<aside class="tsd-sources">
|
|
960
|
-
<ul>
|
|
961
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:36</li>
|
|
962
|
-
</ul>
|
|
963
|
-
</aside>
|
|
964
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
965
|
-
</li>
|
|
966
|
-
</ul>
|
|
967
|
-
</section>
|
|
968
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
969
|
-
<a name="getPassword" class="tsd-anchor"></a>
|
|
970
|
-
<h3>get<wbr>Password</h3>
|
|
971
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
972
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Password<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
973
|
-
</ul>
|
|
974
|
-
<ul class="tsd-descriptions">
|
|
975
|
-
<li class="tsd-description">
|
|
976
|
-
<aside class="tsd-sources">
|
|
977
|
-
<ul>
|
|
978
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:54</li>
|
|
979
|
-
</ul>
|
|
980
|
-
</aside>
|
|
981
|
-
<div class="tsd-comment tsd-typography">
|
|
982
|
-
<div class="lead">
|
|
983
|
-
<p>Retrieves a password from the secure store.</p>
|
|
984
|
-
</div>
|
|
985
|
-
</div>
|
|
986
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
987
|
-
<ul class="tsd-parameters">
|
|
988
|
-
<li>
|
|
989
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
990
|
-
<div class="tsd-comment tsd-typography">
|
|
991
|
-
<p>The name of the password to retrieve.</p>
|
|
992
|
-
</div>
|
|
993
|
-
</li>
|
|
994
|
-
</ul>
|
|
995
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
996
|
-
<p>The password or undefined if a password with the given name was not found.</p>
|
|
997
|
-
</li>
|
|
998
|
-
</ul>
|
|
999
|
-
</section>
|
|
1000
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
1001
|
-
<a name="getPrivateKey" class="tsd-anchor"></a>
|
|
1002
|
-
<h3>get<wbr>Private<wbr>Key</h3>
|
|
1003
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
1004
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Private<wbr>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
1005
|
-
</ul>
|
|
1006
|
-
<ul class="tsd-descriptions">
|
|
1007
|
-
<li class="tsd-description">
|
|
1008
|
-
<aside class="tsd-sources">
|
|
1009
|
-
<ul>
|
|
1010
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:148</li>
|
|
1011
|
-
</ul>
|
|
1012
|
-
</aside>
|
|
1013
|
-
<div class="tsd-comment tsd-typography">
|
|
1014
|
-
<div class="lead">
|
|
1015
|
-
<p>Retrieves a private key from the secure store.</p>
|
|
1016
|
-
</div>
|
|
1017
|
-
</div>
|
|
1018
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1019
|
-
<ul class="tsd-parameters">
|
|
1020
|
-
<li>
|
|
1021
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
1022
|
-
<div class="tsd-comment tsd-typography">
|
|
1023
|
-
<p>The name of the private key to be retrieved.</p>
|
|
1024
|
-
</div>
|
|
1025
|
-
</li>
|
|
1026
|
-
</ul>
|
|
1027
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
1028
|
-
<p>Requested private key or undefined if the key was not found.</p>
|
|
1029
|
-
</li>
|
|
1030
|
-
</ul>
|
|
1031
|
-
</section>
|
|
1032
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
1033
|
-
<a name="getPublicKey" class="tsd-anchor"></a>
|
|
1034
|
-
<h3>get<wbr>Public<wbr>Key</h3>
|
|
1035
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
1036
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="PublicKey.html" class="tsd-signature-type" data-tsd-kind="Interface">PublicKey</a><span class="tsd-signature-symbol">></span></li>
|
|
1037
|
-
</ul>
|
|
1038
|
-
<ul class="tsd-descriptions">
|
|
1039
|
-
<li class="tsd-description">
|
|
1040
|
-
<aside class="tsd-sources">
|
|
1041
|
-
<ul>
|
|
1042
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:165</li>
|
|
1043
|
-
</ul>
|
|
1044
|
-
</aside>
|
|
1045
|
-
<div class="tsd-comment tsd-typography">
|
|
1046
|
-
<div class="lead">
|
|
1047
|
-
<p>Retrieves the public key from the secure store.</p>
|
|
1048
|
-
</div>
|
|
1049
|
-
</div>
|
|
1050
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1051
|
-
<ul class="tsd-parameters">
|
|
1052
|
-
<li>
|
|
1053
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
1054
|
-
<div class="tsd-comment tsd-typography">
|
|
1055
|
-
<p>The name of the public key.</p>
|
|
1056
|
-
</div>
|
|
1057
|
-
</li>
|
|
1058
|
-
</ul>
|
|
1059
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="PublicKey.html" class="tsd-signature-type" data-tsd-kind="Interface">PublicKey</a><span class="tsd-signature-symbol">></span></h4>
|
|
1060
|
-
<p>The public key or undefined if the key was not found.</p>
|
|
1061
|
-
</li>
|
|
1062
|
-
</ul>
|
|
1063
|
-
</section>
|
|
1064
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
1065
|
-
<a name="getServiceName" class="tsd-anchor"></a>
|
|
1066
|
-
<h3>get<wbr>Service<wbr>Name</h3>
|
|
1067
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
1068
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Service<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
1069
|
-
</ul>
|
|
1070
|
-
<ul class="tsd-descriptions">
|
|
1071
|
-
<li class="tsd-description">
|
|
1072
|
-
<aside class="tsd-sources">
|
|
1073
|
-
<ul>
|
|
1074
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:37</li>
|
|
1075
|
-
</ul>
|
|
1076
|
-
</aside>
|
|
1077
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
1078
|
-
</li>
|
|
1079
|
-
</ul>
|
|
1080
|
-
</section>
|
|
1081
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
1082
|
-
<a name="getSymmetricKey" class="tsd-anchor"></a>
|
|
1083
|
-
<h3>get<wbr>Symmetric<wbr>Key</h3>
|
|
1084
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
1085
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Symmetric<wbr>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li>
|
|
1086
|
-
</ul>
|
|
1087
|
-
<ul class="tsd-descriptions">
|
|
1088
|
-
<li class="tsd-description">
|
|
1089
|
-
<aside class="tsd-sources">
|
|
1090
|
-
<ul>
|
|
1091
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:86</li>
|
|
1092
|
-
</ul>
|
|
1093
|
-
</aside>
|
|
1094
|
-
<div class="tsd-comment tsd-typography">
|
|
1095
|
-
<div class="lead">
|
|
1096
|
-
<p>Retrieves a symmetric key from the secure store.</p>
|
|
1097
|
-
</div>
|
|
1098
|
-
</div>
|
|
1099
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1100
|
-
<ul class="tsd-parameters">
|
|
1101
|
-
<li>
|
|
1102
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
1103
|
-
<div class="tsd-comment tsd-typography">
|
|
1104
|
-
<p>The name of the symmetric key.</p>
|
|
1105
|
-
</div>
|
|
1106
|
-
</li>
|
|
1107
|
-
</ul>
|
|
1108
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4>
|
|
1109
|
-
<p>The symmetric key or undefined if not found.</p>
|
|
1110
|
-
</li>
|
|
1111
|
-
</ul>
|
|
1112
|
-
</section>
|
|
1113
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
1114
|
-
<a name="removeAllKeys" class="tsd-anchor"></a>
|
|
1115
|
-
<h3>remove<wbr>All<wbr>Keys</h3>
|
|
1116
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
1117
|
-
<li class="tsd-signature tsd-kind-icon">remove<wbr>All<wbr>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
1118
|
-
</ul>
|
|
1119
|
-
<ul class="tsd-descriptions">
|
|
1120
|
-
<li class="tsd-description">
|
|
1121
|
-
<aside class="tsd-sources">
|
|
1122
|
-
<ul>
|
|
1123
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:170</li>
|
|
1124
|
-
</ul>
|
|
1125
|
-
</aside>
|
|
1126
|
-
<div class="tsd-comment tsd-typography">
|
|
1127
|
-
<div class="lead">
|
|
1128
|
-
<p>Clear all types of keys</p>
|
|
1129
|
-
</div>
|
|
1130
|
-
</div>
|
|
1131
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
1132
|
-
</li>
|
|
1133
|
-
</ul>
|
|
1134
|
-
</section>
|
|
1135
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
1136
|
-
<a name="updatePassword" class="tsd-anchor"></a>
|
|
1137
|
-
<h3>update<wbr>Password</h3>
|
|
1138
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
1139
|
-
<li class="tsd-signature tsd-kind-icon">update<wbr>Password<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
1140
|
-
</ul>
|
|
1141
|
-
<ul class="tsd-descriptions">
|
|
1142
|
-
<li class="tsd-description">
|
|
1143
|
-
<aside class="tsd-sources">
|
|
1144
|
-
<ul>
|
|
1145
|
-
<li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:69</li>
|
|
1146
|
-
</ul>
|
|
1147
|
-
</aside>
|
|
1148
|
-
<div class="tsd-comment tsd-typography">
|
|
1149
|
-
<div class="lead">
|
|
1150
|
-
<p>Updates a password stored in the secure store.</p>
|
|
1151
|
-
</div>
|
|
1152
|
-
</div>
|
|
1153
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1154
|
-
<ul class="tsd-parameters">
|
|
1155
|
-
<li>
|
|
1156
|
-
<h5>password: <span class="tsd-signature-type">ArrayBuffer</span></h5>
|
|
1157
|
-
<div class="tsd-comment tsd-typography">
|
|
1158
|
-
<p>The new password.</p>
|
|
1159
|
-
</div>
|
|
1160
|
-
</li>
|
|
1161
|
-
<li>
|
|
1162
|
-
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
1163
|
-
<div class="tsd-comment tsd-typography">
|
|
1164
|
-
<p>The name of the password to update.</p>
|
|
1165
|
-
</div>
|
|
1166
|
-
</li>
|
|
1167
|
-
</ul>
|
|
1168
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
1169
|
-
</li>
|
|
1170
|
-
</ul>
|
|
1171
|
-
</section>
|
|
1172
|
-
</section>
|
|
1173
|
-
</div>
|
|
1174
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
1175
|
-
<nav class="tsd-navigation primary">
|
|
1176
|
-
<ul>
|
|
1177
|
-
<li class=" ">
|
|
1178
|
-
<a href="../modules.html">Exports</a>
|
|
1179
|
-
</li>
|
|
1180
|
-
</ul>
|
|
1181
|
-
</nav>
|
|
1182
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
1183
|
-
<ul class="before-current">
|
|
1184
|
-
</ul>
|
|
1185
|
-
<ul class="current">
|
|
1186
|
-
<li class="current tsd-kind-interface">
|
|
1187
|
-
<a href="SudoCryptoProvider.html" class="tsd-kind-icon">Sudo<wbr>Crypto<wbr>Provider</a>
|
|
1188
|
-
<ul>
|
|
1189
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1190
|
-
<a href="SudoCryptoProvider.html#addPassword" class="tsd-kind-icon">add<wbr>Password</a>
|
|
1191
|
-
</li>
|
|
1192
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1193
|
-
<a href="SudoCryptoProvider.html#addPrivateKey" class="tsd-kind-icon">add<wbr>Private<wbr>Key</a>
|
|
1194
|
-
</li>
|
|
1195
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1196
|
-
<a href="SudoCryptoProvider.html#addPublicKey" class="tsd-kind-icon">add<wbr>Public<wbr>Key</a>
|
|
1197
|
-
</li>
|
|
1198
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1199
|
-
<a href="SudoCryptoProvider.html#addSymmetricKey" class="tsd-kind-icon">add<wbr>Symmetric<wbr>Key</a>
|
|
1200
|
-
</li>
|
|
1201
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1202
|
-
<a href="SudoCryptoProvider.html#decryptWithPrivateKey" class="tsd-kind-icon">decrypt<wbr>With<wbr>Private<wbr>Key</a>
|
|
1203
|
-
</li>
|
|
1204
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1205
|
-
<a href="SudoCryptoProvider.html#decryptWithSymmetricKey" class="tsd-kind-icon">decrypt<wbr>With<wbr>Symmetric<wbr>Key</a>
|
|
1206
|
-
</li>
|
|
1207
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1208
|
-
<a href="SudoCryptoProvider.html#decryptWithSymmetricKeyName" class="tsd-kind-icon">decrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name</a>
|
|
1209
|
-
</li>
|
|
1210
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1211
|
-
<a href="SudoCryptoProvider.html#deleteKeyPair" class="tsd-kind-icon">delete<wbr>Key<wbr>Pair</a>
|
|
1212
|
-
</li>
|
|
1213
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1214
|
-
<a href="SudoCryptoProvider.html#deletePassword" class="tsd-kind-icon">delete<wbr>Password</a>
|
|
1215
|
-
</li>
|
|
1216
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1217
|
-
<a href="SudoCryptoProvider.html#deleteSymmetricKey" class="tsd-kind-icon">delete<wbr>Symmetric<wbr>Key</a>
|
|
1218
|
-
</li>
|
|
1219
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1220
|
-
<a href="SudoCryptoProvider.html#encryptWithPublicKey" class="tsd-kind-icon">encrypt<wbr>With<wbr>Public<wbr>Key</a>
|
|
1221
|
-
</li>
|
|
1222
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1223
|
-
<a href="SudoCryptoProvider.html#encryptWithSymmetricKey" class="tsd-kind-icon">encrypt<wbr>With<wbr>Symmetric<wbr>Key</a>
|
|
1224
|
-
</li>
|
|
1225
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1226
|
-
<a href="SudoCryptoProvider.html#encryptWithSymmetricKeyName" class="tsd-kind-icon">encrypt<wbr>With<wbr>Symmetric<wbr>Key<wbr>Name</a>
|
|
1227
|
-
</li>
|
|
1228
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1229
|
-
<a href="SudoCryptoProvider.html#exportKeys" class="tsd-kind-icon">export<wbr>Keys</a>
|
|
1230
|
-
</li>
|
|
1231
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1232
|
-
<a href="SudoCryptoProvider.html#generateHash" class="tsd-kind-icon">generate<wbr>Hash</a>
|
|
1233
|
-
</li>
|
|
1234
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1235
|
-
<a href="SudoCryptoProvider.html#generateKeyPair" class="tsd-kind-icon">generate<wbr>Key<wbr>Pair</a>
|
|
1236
|
-
</li>
|
|
1237
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1238
|
-
<a href="SudoCryptoProvider.html#generateRandomData" class="tsd-kind-icon">generate<wbr>Random<wbr>Data</a>
|
|
1239
|
-
</li>
|
|
1240
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1241
|
-
<a href="SudoCryptoProvider.html#generateSymmetricKey" class="tsd-kind-icon">generate<wbr>Symmetric<wbr>Key</a>
|
|
1242
|
-
</li>
|
|
1243
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1244
|
-
<a href="SudoCryptoProvider.html#generateSymmetricKeyFromPassword" class="tsd-kind-icon">generate<wbr>Symmetric<wbr>Key<wbr>From<wbr>Password</a>
|
|
1245
|
-
</li>
|
|
1246
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1247
|
-
<a href="SudoCryptoProvider.html#getNamespace" class="tsd-kind-icon">get<wbr>Namespace</a>
|
|
1248
|
-
</li>
|
|
1249
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1250
|
-
<a href="SudoCryptoProvider.html#getPassword" class="tsd-kind-icon">get<wbr>Password</a>
|
|
1251
|
-
</li>
|
|
1252
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1253
|
-
<a href="SudoCryptoProvider.html#getPrivateKey" class="tsd-kind-icon">get<wbr>Private<wbr>Key</a>
|
|
1254
|
-
</li>
|
|
1255
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1256
|
-
<a href="SudoCryptoProvider.html#getPublicKey" class="tsd-kind-icon">get<wbr>Public<wbr>Key</a>
|
|
1257
|
-
</li>
|
|
1258
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1259
|
-
<a href="SudoCryptoProvider.html#getServiceName" class="tsd-kind-icon">get<wbr>Service<wbr>Name</a>
|
|
1260
|
-
</li>
|
|
1261
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1262
|
-
<a href="SudoCryptoProvider.html#getSymmetricKey" class="tsd-kind-icon">get<wbr>Symmetric<wbr>Key</a>
|
|
1263
|
-
</li>
|
|
1264
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1265
|
-
<a href="SudoCryptoProvider.html#removeAllKeys" class="tsd-kind-icon">remove<wbr>All<wbr>Keys</a>
|
|
1266
|
-
</li>
|
|
1267
|
-
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
1268
|
-
<a href="SudoCryptoProvider.html#updatePassword" class="tsd-kind-icon">update<wbr>Password</a>
|
|
1269
|
-
</li>
|
|
1270
|
-
</ul>
|
|
1271
|
-
</li>
|
|
1272
|
-
</ul>
|
|
1273
|
-
<ul class="after-current">
|
|
1274
|
-
</ul>
|
|
1275
|
-
</nav>
|
|
1276
|
-
</div>
|
|
1277
|
-
</div>
|
|
1278
|
-
</div>
|
|
1279
|
-
<footer class="with-border-bottom">
|
|
1280
|
-
<div class="container">
|
|
1281
|
-
<h2>Legend</h2>
|
|
1282
|
-
<div class="tsd-legend-group">
|
|
1283
|
-
<ul class="tsd-legend">
|
|
1284
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
1285
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
1286
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
1287
|
-
</ul>
|
|
1288
|
-
<ul class="tsd-legend">
|
|
1289
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
1290
|
-
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
1291
|
-
</ul>
|
|
1292
|
-
<ul class="tsd-legend">
|
|
1293
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
1294
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
1295
|
-
</ul>
|
|
1296
|
-
</div>
|
|
1297
|
-
</div>
|
|
1298
|
-
</footer>
|
|
1299
|
-
<div class="container tsd-generator">
|
|
1300
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
1301
|
-
</div>
|
|
1302
|
-
<div class="overlay"></div>
|
|
1303
|
-
<script src="../assets/js/main.js"></script>
|
|
1304
|
-
</body>
|
|
1305
|
-
</html>
|
|
1
|
+
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SudoCryptoProvider | @sudoplatform/sudo-common</title><meta name="description" content="Documentation for @sudoplatform/sudo-common"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-common</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@sudoplatform/sudo-common</a></li><li><a href="SudoCryptoProvider.html">SudoCryptoProvider</a></li></ul><h1>Interface SudoCryptoProvider</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>CryptoProvider instance interface</p>
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SudoCryptoProvider</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPassword" class="tsd-kind-icon">add<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPrivateKey" class="tsd-kind-icon">add<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPublicKey" class="tsd-kind-icon">add<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addSymmetricKey" class="tsd-kind-icon">add<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithPrivateKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithSymmetricKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithSymmetricKeyName" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deleteKeyPair" class="tsd-kind-icon">delete<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deletePassword" class="tsd-kind-icon">delete<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deleteSymmetricKey" class="tsd-kind-icon">delete<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithPublicKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithSymmetricKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithSymmetricKeyName" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#exportKeys" class="tsd-kind-icon">export<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateHash" class="tsd-kind-icon">generate<wbr/>Hash</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateKeyPair" class="tsd-kind-icon">generate<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateRandomData" class="tsd-kind-icon">generate<wbr/>Random<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateSymmetricKey" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateSymmetricKeyFromPassword" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key<wbr/>From<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getNamespace" class="tsd-kind-icon">get<wbr/>Namespace</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPassword" class="tsd-kind-icon">get<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPrivateKey" class="tsd-kind-icon">get<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPublicKey" class="tsd-kind-icon">get<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getServiceName" class="tsd-kind-icon">get<wbr/>Service<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getSymmetricKey" class="tsd-kind-icon">get<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#removeAllKeys" class="tsd-kind-icon">remove<wbr/>All<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#updatePassword" class="tsd-kind-icon">update<wbr/>Password</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addPassword" class="tsd-anchor"></a><h3>add<wbr/>Password</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Password<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:45</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
+
<p>Adds as password to the secure store.</p>
|
|
5
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>password: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
+
<p>The password to store.</p>
|
|
7
|
+
</div></div></li><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
|
+
<p>The name of the password.</p>
|
|
9
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addPrivateKey" class="tsd-anchor"></a><h3>add<wbr/>Private<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Private<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:139</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
|
+
<p>Adds a private key to the secure store.</p>
|
|
11
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
+
<p>The private key to store securely.</p>
|
|
13
|
+
</div></div></li><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
14
|
+
<p>The name of the private key to be stored.</p>
|
|
15
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addPublicKey" class="tsd-anchor"></a><h3>add<wbr/>Public<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Public<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:156</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
16
|
+
<p>Adds a public key to the secure store.</p>
|
|
17
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
18
|
+
<p>The public key to store securely.</p>
|
|
19
|
+
</div></div></li><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
|
+
<p>The name of the public key to be stored.</p>
|
|
21
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="addSymmetricKey" class="tsd-anchor"></a><h3>add<wbr/>Symmetric<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:77</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
22
|
+
<p>Adds a symmetric key to the secure store.</p>
|
|
23
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
24
|
+
<p>The symmetric key.</p>
|
|
25
|
+
</div></div></li><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
26
|
+
<p>The name for the symmetric key.</p>
|
|
27
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="decryptWithPrivateKey" class="tsd-anchor"></a><h3>decrypt<wbr/>With<wbr/>Private<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">decrypt<wbr/>With<wbr/>Private<wbr/>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:331</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
28
|
+
<p>Decrypts the given data with the specified private key.</p>
|
|
29
|
+
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/UnrecognizedAlgorithmError.html">UnrecognizedAlgorithmError</a></p>
|
|
30
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
31
|
+
<p>The name of the private key to use for decryption.</p>
|
|
32
|
+
</div></div></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
33
|
+
<p>The data to decrypt.</p>
|
|
34
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Decrypted data or undefined if the private key is not found.</p>
|
|
35
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="decryptWithSymmetricKey" class="tsd-anchor"></a><h3>decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:283</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>Use version with <code>options</code> param.</p>
|
|
36
|
+
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
37
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
38
|
+
<p>The data to decrypt.</p>
|
|
39
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
40
|
+
<p>Optional Initialization Vector.</p>
|
|
41
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Decrypted data</p>
|
|
42
|
+
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:299</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
43
|
+
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
44
|
+
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/UnrecognizedAlgorithmError.html">UnrecognizedAlgorithmError</a></p>
|
|
45
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
46
|
+
<p>The data to decrypt.</p>
|
|
47
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Decrypted data</p>
|
|
48
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="decryptWithSymmetricKeyName" class="tsd-anchor"></a><h3>decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:217</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>Use version with <code>options</code> param.</p>
|
|
49
|
+
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
50
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
51
|
+
<p>The name of the symmetric key to use to decrypt.</p>
|
|
52
|
+
</div></div></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
53
|
+
<p>The data to decrypt.</p>
|
|
54
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
55
|
+
<p>Optional Initialization Vector.</p>
|
|
56
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Decrypted data</p>
|
|
57
|
+
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:233</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
58
|
+
<p>Decrypt the given data with the specified symmetric key stored in the secure store.</p>
|
|
59
|
+
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/UnrecognizedAlgorithmError.html">UnrecognizedAlgorithmError</a></p>
|
|
60
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
61
|
+
<p>The name of the symmetric key to use to decrypt.</p>
|
|
62
|
+
</div></div></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
63
|
+
<p>The data to decrypt.</p>
|
|
64
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Decrypted data</p>
|
|
65
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteKeyPair" class="tsd-anchor"></a><h3>delete<wbr/>Key<wbr/>Pair</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Key<wbr/>Pair<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:131</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
66
|
+
<p>Deletes a key pair from the secure store.</p>
|
|
67
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
68
|
+
<p>The name of the key pair to be deleted.</p>
|
|
69
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deletePassword" class="tsd-anchor"></a><h3>delete<wbr/>Password</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Password<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:61</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
70
|
+
<p>Deletes a password from the secure store.</p>
|
|
71
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
72
|
+
<p>The name of the password to delete.</p>
|
|
73
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="deleteSymmetricKey" class="tsd-anchor"></a><h3>delete<wbr/>Symmetric<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:93</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
74
|
+
<p>Deletes a symmetric key from the secure store.</p>
|
|
75
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
76
|
+
<p>The name of the symmetric key.</p>
|
|
77
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="encryptWithPublicKey" class="tsd-anchor"></a><h3>encrypt<wbr/>With<wbr/>Public<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">encrypt<wbr/>With<wbr/>Public<wbr/>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:315</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
78
|
+
<p>Encrypts the given data with the specified public key.</p>
|
|
79
|
+
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/UnrecognizedAlgorithmError.html">UnrecognizedAlgorithmError</a></p>
|
|
80
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
81
|
+
<p>The name of the public key to use for encryption.</p>
|
|
82
|
+
</div></div></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
83
|
+
<p>The data to encrypt.</p>
|
|
84
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="AsymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AsymmetricEncryptionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Encrypted data</p>
|
|
85
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="encryptWithSymmetricKey" class="tsd-anchor"></a><h3>encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:250</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>Use version with <code>options</code> param.</p>
|
|
86
|
+
<p>Encrypts the given data with the specified key</p>
|
|
87
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
88
|
+
<p>Data to encrypt.</p>
|
|
89
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
90
|
+
<p>Optional Initialization Vector.</p>
|
|
91
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Encrypted data and IV</p>
|
|
92
|
+
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:266</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
93
|
+
<p>Encrypts the given data with the specified key</p>
|
|
94
|
+
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/UnrecognizedAlgorithmError.html">UnrecognizedAlgorithmError</a></p>
|
|
95
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">ArrayBuffer</span></h5></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
96
|
+
<p>Data to encrypt.</p>
|
|
97
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Encrypted data and IV</p>
|
|
98
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="encryptWithSymmetricKeyName" class="tsd-anchor"></a><h3>encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, iv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:183</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>Use version with <code>options</code> param.</p>
|
|
99
|
+
<p>Encrypts the given data with the specified symmetric key stored in the secure store.</p>
|
|
100
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
101
|
+
<p>The name of the symmetric key to use to encrypt.</p>
|
|
102
|
+
</div></div></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
103
|
+
<p>Data to encrypt.</p>
|
|
104
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> iv: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
105
|
+
<p>Optional Initialization Vector.</p>
|
|
106
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Encrypted data and IV</p>
|
|
107
|
+
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:200</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
108
|
+
<p>Encrypts the given data with the specified symmetric key stored in the secure store.</p>
|
|
109
|
+
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/UnrecognizedAlgorithmError.html">UnrecognizedAlgorithmError</a></p>
|
|
110
|
+
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
111
|
+
<p>The name of the symmetric key to use to encrypt.</p>
|
|
112
|
+
</div></div></li><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
113
|
+
<p>Data to encrypt.</p>
|
|
114
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="SymmetricEncryptionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SymmetricEncryptionOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Encrypted data and IV</p>
|
|
115
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="exportKeys" class="tsd-anchor"></a><h3>export<wbr/>Keys</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">export<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyData.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:359</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
116
|
+
<p>Export all keys and passwords from the key store as an
|
|
117
|
+
array of KeyData items.</p>
|
|
118
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="KeyData.html" class="tsd-signature-type" data-tsd-kind="Interface">KeyData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>Array of exported keys and passwords</p>
|
|
119
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="generateHash" class="tsd-anchor"></a><h3>generate<wbr/>Hash</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Hash<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:351</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
120
|
+
<p>Creates a SHA256 hash of the specified data.</p>
|
|
121
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
122
|
+
<p>Data to hash.</p>
|
|
123
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>The SHA256 hash of data</p>
|
|
124
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="generateKeyPair" class="tsd-anchor"></a><h3>generate<wbr/>Key<wbr/>Pair</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Key<wbr/>Pair<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:342</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
125
|
+
<p>Generates and securely stores a key pair for public key cryptography.</p>
|
|
126
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
127
|
+
<p>The name of the key pair to be generated.</p>
|
|
128
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="generateRandomData" class="tsd-anchor"></a><h3>generate<wbr/>Random<wbr/>Data</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Random<wbr/>Data<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:124</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
129
|
+
<p>Generate random bytes using a secure random number generator.</p>
|
|
130
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>size: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
131
|
+
<p>Number of random bytes to generate</p>
|
|
132
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>ArrayBuffer containing the random bytes.</p>
|
|
133
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="generateSymmetricKey" class="tsd-anchor"></a><h3>generate<wbr/>Symmetric<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:100</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
134
|
+
<p>Generates a symmetric key and stores it securely.</p>
|
|
135
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
136
|
+
<p>The name for the symmetric key.</p>
|
|
137
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="generateSymmetricKeyFromPassword" class="tsd-anchor"></a><h3>generate<wbr/>Symmetric<wbr/>Key<wbr/>From<wbr/>Password</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key<wbr/>From<wbr/>Password<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, salt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>rounds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:111</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
138
|
+
<p>Generates a symmetric key from a password using PBKDF2.</p>
|
|
139
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>password: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
140
|
+
<p>The password from which to generate the symmetric key</p>
|
|
141
|
+
</div></div></li><li><h5>salt: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
142
|
+
<p>Salt to use in generation of the key</p>
|
|
143
|
+
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>rounds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> rounds<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>The generated symmetric key.</p>
|
|
144
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getNamespace" class="tsd-anchor"></a><h3>get<wbr/>Namespace</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Namespace<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:36</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPassword" class="tsd-anchor"></a><h3>get<wbr/>Password</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Password<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:54</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
145
|
+
<p>Retrieves a password from the secure store.</p>
|
|
146
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
147
|
+
<p>The name of the password to retrieve.</p>
|
|
148
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>The password or undefined if a password with the given name was not found.</p>
|
|
149
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPrivateKey" class="tsd-anchor"></a><h3>get<wbr/>Private<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Private<wbr/>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:148</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
150
|
+
<p>Retrieves a private key from the secure store.</p>
|
|
151
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
152
|
+
<p>The name of the private key to be retrieved.</p>
|
|
153
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Requested private key or undefined if the key was not found.</p>
|
|
154
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getPublicKey" class="tsd-anchor"></a><h3>get<wbr/>Public<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Public<wbr/>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="PublicKey.html" class="tsd-signature-type" data-tsd-kind="Interface">PublicKey</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:165</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
155
|
+
<p>Retrieves the public key from the secure store.</p>
|
|
156
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
157
|
+
<p>The name of the public key.</p>
|
|
158
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="PublicKey.html" class="tsd-signature-type" data-tsd-kind="Interface">PublicKey</a><span class="tsd-signature-symbol">></span></h4><div><p>The public key or undefined if the key was not found.</p>
|
|
159
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getServiceName" class="tsd-anchor"></a><h3>get<wbr/>Service<wbr/>Name</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Service<wbr/>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:37</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getSymmetricKey" class="tsd-anchor"></a><h3>get<wbr/>Symmetric<wbr/>Key</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Symmetric<wbr/>Key<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:86</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
160
|
+
<p>Retrieves a symmetric key from the secure store.</p>
|
|
161
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
162
|
+
<p>The name of the symmetric key.</p>
|
|
163
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>The symmetric key or undefined if not found.</p>
|
|
164
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="removeAllKeys" class="tsd-anchor"></a><h3>remove<wbr/>All<wbr/>Keys</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">remove<wbr/>All<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:170</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
165
|
+
<p>Clear all types of keys</p>
|
|
166
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="updatePassword" class="tsd-anchor"></a><h3>update<wbr/>Password</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">update<wbr/>Password<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:69</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
167
|
+
<p>Updates a password stored in the secure store.</p>
|
|
168
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>password: <span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
169
|
+
<p>The new password.</p>
|
|
170
|
+
</div></div></li><li><h5>name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
171
|
+
<p>The name of the password to update.</p>
|
|
172
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SudoCryptoProvider.html" class="tsd-kind-icon">Sudo<wbr/>Crypto<wbr/>Provider</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPassword" class="tsd-kind-icon">add<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPrivateKey" class="tsd-kind-icon">add<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPublicKey" class="tsd-kind-icon">add<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addSymmetricKey" class="tsd-kind-icon">add<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithPrivateKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithSymmetricKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithSymmetricKeyName" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deleteKeyPair" class="tsd-kind-icon">delete<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deletePassword" class="tsd-kind-icon">delete<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deleteSymmetricKey" class="tsd-kind-icon">delete<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithPublicKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithSymmetricKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithSymmetricKeyName" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#exportKeys" class="tsd-kind-icon">export<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateHash" class="tsd-kind-icon">generate<wbr/>Hash</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateKeyPair" class="tsd-kind-icon">generate<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateRandomData" class="tsd-kind-icon">generate<wbr/>Random<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateSymmetricKey" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateSymmetricKeyFromPassword" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key<wbr/>From<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getNamespace" class="tsd-kind-icon">get<wbr/>Namespace</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPassword" class="tsd-kind-icon">get<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPrivateKey" class="tsd-kind-icon">get<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPublicKey" class="tsd-kind-icon">get<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getServiceName" class="tsd-kind-icon">get<wbr/>Service<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getSymmetricKey" class="tsd-kind-icon">get<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#removeAllKeys" class="tsd-kind-icon">remove<wbr/>All<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#updatePassword" class="tsd-kind-icon">update<wbr/>Password</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|