/
DeviceCodeClient.ts
210 lines (179 loc) · 8.17 KB
/
DeviceCodeClient.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License.
*/
import { DeviceCodeResponse, ServerDeviceCodeResponse } from "../response/DeviceCodeResponse";
import { BaseClient } from "./BaseClient";
import { DeviceCodeRequest } from "../request/DeviceCodeRequest";
import { ClientAuthError } from "../error/ClientAuthError";
import { RequestParameterBuilder } from "../server/RequestParameterBuilder";
import { Constants, GrantType } from "../utils/Constants";
import { ClientConfiguration } from "../config/ClientConfiguration";
import { TimeUtils } from "../utils/TimeUtils";
import { ServerAuthorizationTokenResponse } from "../server/ServerAuthorizationTokenResponse";
import { ScopeSet } from "../request/ScopeSet";
import { ResponseHandler } from "../response/ResponseHandler";
import { AuthenticationResult } from "../response/AuthenticationResult";
import { RequestThumbprint } from "../network/RequestThumbprint";
/**
* OAuth2.0 Device code client
*/
export class DeviceCodeClient extends BaseClient {
constructor(configuration: ClientConfiguration) {
super(configuration);
}
/**
* Gets device code from device code endpoint, calls back to with device code response, and
* polls token endpoint to exchange device code for tokens
* @param request
*/
public async acquireToken(request: DeviceCodeRequest): Promise<AuthenticationResult> {
const deviceCodeResponse: DeviceCodeResponse = await this.getDeviceCode(request);
request.deviceCodeCallback(deviceCodeResponse);
const response: ServerAuthorizationTokenResponse = await this.acquireTokenWithDeviceCode(
request,
deviceCodeResponse);
const responseHandler = new ResponseHandler(
this.config.authOptions.clientId,
this.cacheManager,
this.cryptoUtils,
this.logger
);
// Validate response. This function throws a server error if an error is returned by the server.
responseHandler.validateTokenResponse(response);
const tokenResponse = responseHandler.handleServerTokenResponse(
response,
this.authority
);
return tokenResponse;
}
/**
* Creates device code request and executes http GET
* @param request
*/
private async getDeviceCode(request: DeviceCodeRequest): Promise<DeviceCodeResponse> {
const thumbprint: RequestThumbprint = {
clientId: this.config.authOptions.clientId,
authority: request.authority,
scopes: request.scopes
};
const queryString = this.createQueryString(request);
const headers = this.createDefaultLibraryHeaders();
return this.executePostRequestToDeviceCodeEndpoint(this.authority.deviceCodeEndpoint, queryString, headers, thumbprint);
}
/**
* Executes POST request to device code endpoint
* @param deviceCodeEndpoint
* @param queryString
* @param headers
*/
private async executePostRequestToDeviceCodeEndpoint(
deviceCodeEndpoint: string,
queryString: string,
headers: Map<string, string>,
thumbprint: RequestThumbprint): Promise<DeviceCodeResponse> {
const {
body: {
user_code: userCode,
device_code: deviceCode,
verification_uri: verificationUri,
expires_in: expiresIn,
interval,
message
}
} = await this.networkManager.sendPostRequest<ServerDeviceCodeResponse>(
thumbprint,
deviceCodeEndpoint,
{
body: queryString,
headers: headers
});
return {
userCode,
deviceCode,
verificationUri,
expiresIn,
interval,
message
};
}
/**
* Create device code endpoint query parameters and returns string
*/
private createQueryString(request: DeviceCodeRequest): string {
const parameterBuilder: RequestParameterBuilder = new RequestParameterBuilder();
const scopeSet = new ScopeSet(request.scopes || []);
parameterBuilder.addScopes(scopeSet);
parameterBuilder.addClientId(this.config.authOptions.clientId);
return parameterBuilder.createQueryString();
}
/**
* Creates token request with device code response and polls token endpoint at interval set by the device code
* response
* @param request
* @param deviceCodeResponse
*/
private async acquireTokenWithDeviceCode(
request: DeviceCodeRequest,
deviceCodeResponse: DeviceCodeResponse): Promise<ServerAuthorizationTokenResponse> {
const requestBody = this.createTokenRequestBody(request, deviceCodeResponse);
const headers: Map<string, string> = this.createDefaultTokenRequestHeaders();
const deviceCodeExpirationTime = TimeUtils.nowSeconds() + deviceCodeResponse.expiresIn;
const pollingIntervalMilli = deviceCodeResponse.interval * 1000;
// Poll token endpoint while (device code is not expired AND operation has not been cancelled by
// setting CancellationToken.cancel = true). POST request is sent at interval set by pollingIntervalMilli
return new Promise<ServerAuthorizationTokenResponse>((resolve, reject) => {
const intervalId: ReturnType<typeof setTimeout> = setInterval(async () => {
try {
if (request.cancel) {
this.logger.error("Token request cancelled by setting DeviceCodeRequest.cancel = true");
clearInterval(intervalId);
reject(ClientAuthError.createDeviceCodeCancelledError());
} else if (TimeUtils.nowSeconds() > deviceCodeExpirationTime) {
this.logger.error(`Device code expired. Expiration time of device code was ${deviceCodeExpirationTime}`);
clearInterval(intervalId);
reject(ClientAuthError.createDeviceCodeExpiredError());
} else {
const thumbprint: RequestThumbprint = {
clientId: this.config.authOptions.clientId,
authority: request.authority,
scopes: request.scopes
};
const response = await this.executePostToTokenEndpoint(
this.authority.tokenEndpoint,
requestBody,
headers,
thumbprint);
if (response.body && response.body.error == Constants.AUTHORIZATION_PENDING) {
// user authorization is pending. Sleep for polling interval and try again
this.logger.info(response.body.error_description);
} else {
clearInterval(intervalId);
resolve(response.body);
}
}
} catch (error) {
clearInterval(intervalId);
reject(error);
}
}, pollingIntervalMilli);
});
}
/**
* Creates query parameters and converts to string.
* @param request
* @param deviceCodeResponse
*/
private createTokenRequestBody(request: DeviceCodeRequest, deviceCodeResponse: DeviceCodeResponse): string {
const requestParameters: RequestParameterBuilder = new RequestParameterBuilder();
const scopeSet = new ScopeSet(request.scopes || []);
requestParameters.addScopes(scopeSet);
requestParameters.addClientId(this.config.authOptions.clientId);
requestParameters.addGrantType(GrantType.DEVICE_CODE_GRANT);
requestParameters.addDeviceCode(deviceCodeResponse.deviceCode);
const correlationId = request.correlationId || this.config.cryptoInterface.createNewGuid();
requestParameters.addCorrelationId(correlationId);
requestParameters.addClientInfo();
return requestParameters.createQueryString();
}
}