-
-
Notifications
You must be signed in to change notification settings - Fork 392
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add RFC8628 - OAuth 2.0 Device Authorization Grant (Device Flow…
…) support
- Loading branch information
Showing
10 changed files
with
673 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /* eslint-disable camelcase */ | ||
| const { inspect } = require('util'); | ||
|
|
||
| const { RPError, OPError } = require('./errors'); | ||
| const instance = require('./helpers/weak_cache'); | ||
| const now = require('./helpers/unix_timestamp'); | ||
| const { authenticatedPost } = require('./helpers/client'); | ||
| const processResponse = require('./helpers/process_response'); | ||
| const TokenSet = require('./token_set'); | ||
|
|
||
| class DeviceFlowHandle { | ||
| constructor({ | ||
| client, exchangeBody, clientAssertionPayload, response, maxAge, | ||
| }) { | ||
| ['verification_uri', 'user_code', 'device_code'].forEach((prop) => { | ||
| if (typeof response[prop] !== 'string' || !response[prop]) { | ||
| throw new RPError(`expected ${prop} string to be returned by Device Authorization Response, got %j`, response[prop]); | ||
| } | ||
| }); | ||
|
|
||
| if (!Number.isSafeInteger(response.expires_in)) { | ||
| throw new RPError('expected expires_in number to be returned by Device Authorization Response, got %j', response.expires_in); | ||
| } | ||
|
|
||
| instance(this).expires_at = now() + response.expires_in; | ||
| instance(this).client = client; | ||
| instance(this).maxAge = maxAge; | ||
| instance(this).exchangeBody = exchangeBody; | ||
| instance(this).clientAssertionPayload = clientAssertionPayload; | ||
| instance(this).response = response; | ||
| instance(this).interval = response.interval * 1000 || 5000; | ||
| } | ||
|
|
||
| async poll() { | ||
| if (this.expired()) { | ||
| throw new RPError('the device code %j has expired and the device authorization session has concluded', this.device_code); | ||
| } | ||
|
|
||
| await new Promise((resolve) => setTimeout(resolve, instance(this).interval)); | ||
|
|
||
| const response = await authenticatedPost.call( | ||
| instance(this).client, | ||
| 'token', | ||
| { | ||
| form: true, | ||
| body: { | ||
| ...instance(this).exchangeBody, | ||
| grant_type: 'urn:ietf:params:oauth:grant-type:device_code', | ||
| device_code: this.device_code, | ||
| }, | ||
| json: true, | ||
| }, | ||
| { clientAssertionPayload: instance(this).clientAssertionPayload }, | ||
| ); | ||
|
|
||
| let responseBody; | ||
| try { | ||
| responseBody = processResponse(response); | ||
| } catch (err) { | ||
| switch (err instanceof OPError && err.error) { | ||
| case 'slow_down': | ||
| instance(this).interval += 5000; | ||
| case 'authorization_pending': // eslint-disable-line no-fallthrough | ||
| return this.poll(); | ||
| default: | ||
| throw err; | ||
| } | ||
| } | ||
|
|
||
| const tokenset = new TokenSet(responseBody); | ||
|
|
||
| if ('id_token' in tokenset) { | ||
| await instance(this).client.decryptIdToken(tokenset); | ||
| await instance(this).client.validateIdToken(tokenset, undefined, 'token', instance(this).maxAge); | ||
| } | ||
|
|
||
| return tokenset; | ||
| } | ||
|
|
||
| get device_code() { | ||
| return instance(this).response.device_code; | ||
| } | ||
|
|
||
| get user_code() { | ||
| return instance(this).response.user_code; | ||
| } | ||
|
|
||
| get verification_uri() { | ||
| return instance(this).response.verification_uri; | ||
| } | ||
|
|
||
| get verification_uri_complete() { | ||
| return instance(this).response.verification_uri_complete; | ||
| } | ||
|
|
||
| get expires_in() { | ||
| return Math.max.apply(null, [instance(this).expires_at - now(), 0]); | ||
| } | ||
|
|
||
| expired() { | ||
| return this.expires_in === 0; | ||
| } | ||
|
|
||
| /* istanbul ignore next */ | ||
| [inspect.custom]() { | ||
| return `${this.constructor.name} ${inspect(instance(this).response, { | ||
| depth: Infinity, | ||
| colors: process.stdout.isTTY, | ||
| compact: false, | ||
| sorted: true, | ||
| })}`; | ||
| } | ||
| } | ||
|
|
||
| module.exports = DeviceFlowHandle; |
Oops, something went wrong.