New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor basic, bearer, digest auth logic into separate class #1360
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| 'use strict' | ||
|
|
||
| var caseless = require('caseless') | ||
| , uuid = require('node-uuid') | ||
| , helpers = require('./helpers') | ||
|
|
||
| var md5 = helpers.md5 | ||
| , toBase64 = helpers.toBase64 | ||
|
|
||
|
|
||
| function Auth () { | ||
| // define all public properties here | ||
| this.hasAuth = false | ||
| this.sentAuth = false | ||
| this.bearerToken = null | ||
| this.user = null | ||
| this.pass = null | ||
| } | ||
|
|
||
| Auth.prototype.basic = function (user, pass, sendImmediately) { | ||
| var self = this | ||
| if (typeof user !== 'string' || (pass !== undefined && typeof pass !== 'string')) { | ||
| throw new Error('auth() received invalid user or password') | ||
| } | ||
| self.user = user | ||
| self.pass = pass | ||
| self.hasAuth = true | ||
| var header = typeof pass !== 'undefined' ? user + ':' + pass : user | ||
| if (sendImmediately || typeof sendImmediately === 'undefined') { | ||
| var authHeader = 'Basic ' + toBase64(header) | ||
| self.sentAuth = true | ||
| return authHeader | ||
| } | ||
| } | ||
|
|
||
| Auth.prototype.bearer = function (bearer, sendImmediately) { | ||
| var self = this | ||
| self.bearerToken = bearer | ||
| self.hasAuth = true | ||
| if (sendImmediately || typeof sendImmediately === 'undefined') { | ||
| if (typeof bearer === 'function') { | ||
| bearer = bearer() | ||
| } | ||
| var authHeader = 'Bearer ' + bearer | ||
| self.sentAuth = true | ||
| return authHeader | ||
| } | ||
| } | ||
|
|
||
| Auth.prototype.digest = function (method, path, authHeader) { | ||
| // TODO: More complete implementation of RFC 2617. | ||
| // - check challenge.algorithm | ||
| // - support algorithm="MD5-sess" | ||
| // - handle challenge.domain | ||
| // - support qop="auth-int" only | ||
| // - handle Authentication-Info (not necessarily?) | ||
| // - check challenge.stale (not necessarily?) | ||
| // - increase nc (not necessarily?) | ||
| // For reference: | ||
| // http://tools.ietf.org/html/rfc2617#section-3 | ||
| // https://github.com/bagder/curl/blob/master/lib/http_digest.c | ||
|
|
||
| var self = this | ||
|
|
||
| var challenge = {} | ||
| var re = /([a-z0-9_-]+)=(?:"([^"]+)"|([a-z0-9_-]+))/gi | ||
| for (;;) { | ||
| var match = re.exec(authHeader) | ||
| if (!match) { | ||
| break | ||
| } | ||
| challenge[match[1]] = match[2] || match[3] | ||
| } | ||
|
|
||
| var ha1 = md5(self.user + ':' + challenge.realm + ':' + self.pass) | ||
| var ha2 = md5(method + ':' + path) | ||
| var qop = /(^|,)\s*auth\s*($|,)/.test(challenge.qop) && 'auth' | ||
| var nc = qop && '00000001' | ||
| var cnonce = qop && uuid().replace(/-/g, '') | ||
| var digestResponse = qop | ||
| ? md5(ha1 + ':' + challenge.nonce + ':' + nc + ':' + cnonce + ':' + qop + ':' + ha2) | ||
| : md5(ha1 + ':' + challenge.nonce + ':' + ha2) | ||
| var authValues = { | ||
| username: self.user, | ||
| realm: challenge.realm, | ||
| nonce: challenge.nonce, | ||
| uri: path, | ||
| qop: qop, | ||
| response: digestResponse, | ||
| nc: nc, | ||
| cnonce: cnonce, | ||
| algorithm: challenge.algorithm, | ||
| opaque: challenge.opaque | ||
| } | ||
|
|
||
| authHeader = [] | ||
| for (var k in authValues) { | ||
| if (authValues[k]) { | ||
| if (k === 'qop' || k === 'nc' || k === 'algorithm') { | ||
| authHeader.push(k + '=' + authValues[k]) | ||
| } else { | ||
| authHeader.push(k + '="' + authValues[k] + '"') | ||
| } | ||
| } | ||
| } | ||
| authHeader = 'Digest ' + authHeader.join(', ') | ||
| self.sentAuth = true | ||
| return authHeader | ||
| } | ||
|
|
||
| Auth.prototype.response = function (method, path, headers) { | ||
| var self = this | ||
| if (!self.hasAuth || self.sentAuth) { return null } | ||
|
|
||
| var c = caseless(headers) | ||
|
|
||
| var authHeader = c.get('www-authenticate') | ||
| var authVerb = authHeader && authHeader.split(' ')[0].toLowerCase() | ||
| // debug('reauth', authVerb) | ||
|
|
||
| switch (authVerb) { | ||
| case 'basic': | ||
| return self.basic(self.user, self.pass, true) | ||
|
|
||
| case 'bearer': | ||
| return self.bearer(self.bearerToken, true) | ||
|
|
||
| case 'digest': | ||
| return self.digest(method, path, authHeader) | ||
| } | ||
| } | ||
|
|
||
| exports.Auth = Auth |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of passing the raw headers, you could pass
response.caselessand save yourself a second conversion step from headers -> caseless inside of auth.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I intentionally made it that way, so that the module knows less about the consumer, and it can work with more generic input data parameters.
Also in
caselessthat's just an assignment, so I don't think it degrades performance or anything like that.