generated from sergiodxa/remix-auth-strategy-template
-
-
Notifications
You must be signed in to change notification settings - Fork 50
/
index.ts
336 lines (296 loc) · 10.1 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
import {
AppLoadContext,
json,
redirect,
SessionStorage,
} from "@remix-run/server-runtime";
import createDebug from "debug";
import {
AuthenticateOptions,
Strategy,
StrategyVerifyCallback,
} from "remix-auth";
import { v4 as uuid } from "uuid";
let debug = createDebug("OAuth2Strategy");
export interface OAuth2Profile {
provider: string;
id?: string;
displayName?: string;
name?: {
familyName?: string;
givenName?: string;
middleName?: string;
};
emails?: Array<{
value: string;
type?: string;
}>;
photos?: Array<{ value: string }>;
}
export interface OAuth2StrategyOptions {
authorizationURL: string;
tokenURL: string;
clientID: string;
clientSecret: string;
callbackURL: string;
}
export interface OAuth2StrategyVerifyParams<
Profile extends OAuth2Profile,
ExtraParams extends Record<string, unknown> = Record<string, never>
> {
accessToken: string;
refreshToken: string;
extraParams: ExtraParams;
profile: Profile;
context?: AppLoadContext;
}
/**
* The OAuth 2.0 authentication strategy authenticates requests using the OAuth
* 2.0 framework.
*
* OAuth 2.0 provides a facility for delegated authentication, whereby users can
* authenticate using a third-party service such as Facebook. Delegating in
* this manner involves a sequence of events, including redirecting the user to
* the third-party service for authorization. Once authorization has been
* granted, the user is redirected back to the application and an authorization
* code can be used to obtain credentials.
*
* Applications must supply a `verify` callback, for which the function
* signature is:
*
* function(accessToken, refreshToken, profile) { ... }
*
* The verify callback is responsible for finding or creating the user, and
* returning the resulting user object.
*
* An AuthorizationError should be raised to indicate an authentication failure.
*
* Options:
* - `authorizationURL` URL used to obtain an authorization grant
* - `tokenURL` URL used to obtain an access token
* - `clientID` identifies client to service provider
* - `clientSecret` secret used to establish ownership of the client identifier
* - `callbackURL` URL to which the service provider will redirect the user after obtaining authorization
*
* @example
* authenticator.use(new OAuth2Strategy(
* {
* authorizationURL: 'https://www.example.com/oauth2/authorize',
* tokenURL: 'https://www.example.com/oauth2/token',
* clientID: '123-456-789',
* clientSecret: 'shhh-its-a-secret'
* callbackURL: 'https://www.example.net/auth/example/callback'
* },
* async ({ accessToken, refreshToken, profile }) => {
* return await User.findOrCreate(...);
* }
* ));
*/
export class OAuth2Strategy<
User,
Profile extends OAuth2Profile,
ExtraParams extends Record<string, unknown> = Record<string, never>
> extends Strategy<User, OAuth2StrategyVerifyParams<Profile, ExtraParams>> {
name = "oauth2";
protected authorizationURL: string;
protected tokenURL: string;
protected clientID: string;
protected clientSecret: string;
protected callbackURL: string;
private sessionStateKey = "oauth2:state";
constructor(
options: OAuth2StrategyOptions,
verify: StrategyVerifyCallback<
User,
OAuth2StrategyVerifyParams<Profile, ExtraParams>
>
) {
super(verify);
this.authorizationURL = options.authorizationURL;
this.tokenURL = options.tokenURL;
this.clientID = options.clientID;
this.clientSecret = options.clientSecret;
this.callbackURL = options.callbackURL;
}
async authenticate(
request: Request,
sessionStorage: SessionStorage,
options: AuthenticateOptions
): Promise<User> {
debug("Request URL", request.url);
let url = new URL(request.url);
let session = await sessionStorage.getSession(
request.headers.get("Cookie")
);
let user: User | null = session.get(options.sessionKey) ?? null;
// User is already authenticated
if (user) {
debug("User is authenticated");
return this.success(user, request, sessionStorage, options);
}
let callbackURL = this.getCallbackURL(url);
debug("Callback URL", callbackURL);
// Redirect the user to the callback URL
if (url.pathname !== callbackURL.pathname) {
debug("Redirecting to callback URL");
let state = this.generateState();
debug("State", state);
session.set(this.sessionStateKey, state);
throw redirect(this.getAuthorizationURL(request, state).toString(), {
headers: { "Set-Cookie": await sessionStorage.commitSession(session) },
});
}
// Validations of the callback URL params
let stateUrl = url.searchParams.get("state");
debug("State from URL", stateUrl);
if (!stateUrl)
throw json({ message: "Missing state on URL." }, { status: 400 });
let stateSession = session.get(this.sessionStateKey);
debug("State from session", stateSession);
if (!stateSession) {
throw json({ message: "Missing state on session." }, { status: 400 });
}
if (stateSession === stateUrl) {
debug("State is valid");
session.unset(this.sessionStateKey);
} else throw json({ message: "State doesn't match." }, { status: 400 });
let code = url.searchParams.get("code");
if (!code) throw json({ message: "Missing code." }, { status: 400 });
// Get the access token
let params = new URLSearchParams(this.tokenParams());
params.set("grant_type", "authorization_code");
params.set("redirect_uri", callbackURL.toString());
let { accessToken, refreshToken, extraParams } =
await this.fetchAccessToken(code, params);
// Get the profile
let profile = await this.userProfile(accessToken, extraParams);
// Verify the user and return it, or redirect
try {
user = await this.verify({
accessToken,
refreshToken,
extraParams,
profile,
context: options.context,
});
} catch (error) {
debug("Failed to verify user", error);
let message = (error as Error).message;
return await this.failure(message, request, sessionStorage, options);
}
debug("User authenticated");
return await this.success(user, request, sessionStorage, options);
}
/**
* Retrieve user profile from service provider.
*
* OAuth 2.0-based authentication strategies can override this function in
* order to load the user's profile from the service provider. This assists
* applications (and users of those applications) in the initial registration
* process by automatically submitting required information.
*/
protected async userProfile(
// eslint-disable-next-line @typescript-eslint/no-unused-vars
accessToken: string,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
params: ExtraParams
): Promise<Profile> {
return { provider: "oauth2" } as Profile;
}
/**
* Return extra parameters to be included in the authorization request.
*
* Some OAuth 2.0 providers allow additional, non-standard parameters to be
* included when requesting authorization. Since these parameters are not
* standardized by the OAuth 2.0 specification, OAuth 2.0-based authentication
* strategies can override this function in order to populate these
* parameters as required by the provider.
*/
protected authorizationParams(params: URLSearchParams): URLSearchParams {
return new URLSearchParams(params);
}
/**
* Return extra parameters to be included in the token request.
*
* Some OAuth 2.0 providers allow additional, non-standard parameters to be
* included when requesting an access token. Since these parameters are not
* standardized by the OAuth 2.0 specification, OAuth 2.0-based authentication
* strategies can override this function in order to populate these
* parameters as required by the provider.
*/
protected tokenParams(): URLSearchParams {
return new URLSearchParams();
}
protected async getAccessToken(response: Response): Promise<{
accessToken: string;
refreshToken: string;
extraParams: ExtraParams;
}> {
let { access_token, refresh_token, ...extraParams } = await response.json();
return {
accessToken: access_token as string,
refreshToken: refresh_token as string,
extraParams,
} as const;
}
private getCallbackURL(url: URL) {
if (
this.callbackURL.startsWith("http:") ||
this.callbackURL.startsWith("https:")
) {
return new URL(this.callbackURL);
}
if (this.callbackURL.startsWith("/")) {
return new URL(this.callbackURL, url);
}
return new URL(`${url.protocol}//${this.callbackURL}`);
}
private getAuthorizationURL(request: Request, state: string) {
let params = new URLSearchParams(
this.authorizationParams(new URL(request.url).searchParams)
);
params.set("response_type", "code");
params.set("client_id", this.clientID);
params.set("redirect_uri", this.callbackURL);
params.set("state", state);
let url = new URL(this.authorizationURL);
url.search = params.toString();
return url;
}
private generateState() {
return uuid();
}
/**
* Format the data to be sent in the request body to the token endpoint.
*/
private async fetchAccessToken(
code: string,
params: URLSearchParams
): Promise<{
accessToken: string;
refreshToken: string;
extraParams: ExtraParams;
}> {
params.set("client_id", this.clientID);
params.set("client_secret", this.clientSecret);
if (params.get("grant_type") === "refresh_token") {
params.set("refresh_token", code);
} else {
params.set("code", code);
}
let response = await fetch(this.tokenURL, {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: params,
});
if (!response.ok) {
try {
let body = await response.text();
throw new Response(body, { status: 401 });
} catch (error) {
throw new Response((error as Error).message, { status: 401 });
}
}
return await this.getAccessToken(response.clone() as unknown as Response);
}
}