-
Notifications
You must be signed in to change notification settings - Fork 6
/
CryptoOps.yml
188 lines (181 loc) · 5.58 KB
/
CryptoOps.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
### YamlMime:TSType
name: CryptoOps
uid: '@azure/msal-browser.CryptoOps'
package: '@azure/msal-browser'
summary: >-
This class implements MSAL's crypto interface, which allows it to perform
base64 encoding and decoding, generating cryptographically random GUIDs and
implementing Proof Key for Code Exchange specs for the OAuth Authorization
Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636).
fullName: CryptoOps
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: 'CryptoOps(Logger, IPerformanceClient, CryptoOptions)'
uid: '@azure/msal-browser.CryptoOps.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new CryptoOps(logger: Logger, performanceClient?: IPerformanceClient,
cryptoConfig?: CryptoOptions)
parameters:
- id: logger
type: Logger
description: ''
- id: performanceClient
type: IPerformanceClient
description: ''
- id: cryptoConfig
type: <xref uid="@azure/msal-browser.CryptoOptions" />
description: ''
methods:
- name: base64Decode(string)
uid: '@azure/msal-browser.CryptoOps.base64Decode'
package: '@azure/msal-browser'
summary: Decodes input string from base64.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function base64Decode(input: string): string'
parameters:
- id: input
type: string
description: |+
return:
description: ''
type: string
- name: base64Encode(string)
uid: '@azure/msal-browser.CryptoOps.base64Encode'
package: '@azure/msal-browser'
summary: Encodes input string to base64.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function base64Encode(input: string): string'
parameters:
- id: input
type: string
description: |+
return:
description: ''
type: string
- name: clearKeystore()
uid: '@azure/msal-browser.CryptoOps.clearKeystore'
package: '@azure/msal-browser'
summary: Removes all cryptographic keys from IndexedDB storage
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function clearKeystore(): Promise<boolean>'
return:
description: ''
type: Promise<boolean>
- name: createNewGuid()
uid: '@azure/msal-browser.CryptoOps.createNewGuid'
package: '@azure/msal-browser'
summary: Creates a new random GUID - used to populate state and nonce.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function createNewGuid(): string'
return:
description: string (GUID)
type: string
- name: generatePkceCodes()
uid: '@azure/msal-browser.CryptoOps.generatePkceCodes'
package: '@azure/msal-browser'
summary: Generates PKCE codes used in Authorization Code Flow.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function generatePkceCodes(): Promise<PkceCodes>'
return:
description: ''
type: Promise<PkceCodes>
- name: getPublicKeyThumbprint(SignedHttpRequestParameters)
uid: '@azure/msal-browser.CryptoOps.getPublicKeyThumbprint'
package: '@azure/msal-browser'
summary: 'Generates a keypair, stores it and returns a thumbprint'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function getPublicKeyThumbprint(request: SignedHttpRequestParameters):
Promise<string>
parameters:
- id: request
type: SignedHttpRequestParameters
description: |+
return:
description: ''
type: Promise<string>
- name: hashString(string)
uid: '@azure/msal-browser.CryptoOps.hashString'
package: '@azure/msal-browser'
summary: Returns the SHA-256 hash of an input string
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function hashString(plainText: string): Promise<string>'
parameters:
- id: plainText
type: string
description: |+
return:
description: ''
type: Promise<string>
- name: removeTokenBindingKey(string)
uid: '@azure/msal-browser.CryptoOps.removeTokenBindingKey'
package: '@azure/msal-browser'
summary: Removes cryptographic keypair from key store matching the keyId passed in
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function removeTokenBindingKey(kid: string): Promise<boolean>'
parameters:
- id: kid
type: string
description: |+
return:
description: ''
type: Promise<boolean>
- name: 'signJwt(SignedHttpRequest, string, string)'
uid: '@azure/msal-browser.CryptoOps.signJwt'
package: '@azure/msal-browser'
summary: >-
Signs the given object as a jwt payload with private key retrieved by
given kid.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function signJwt(payload: SignedHttpRequest, kid: string,
correlationId?: string): Promise<string>
parameters:
- id: payload
type: <xref uid="@azure/msal-browser.SignedHttpRequest" />
description: ''
- id: kid
type: string
description: |+
- id: correlationId
type: string
description: ''
return:
description: ''
type: Promise<string>