passport-wpoauth
Version:
Authentication strategy for Passport for Wordpress with WP-OAuth plugin.
634 lines (632 loc) • 19.8 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for lib/strategy.js</title>
<meta charset="utf-8">
<link rel="stylesheet" href="../prettify.css">
<link rel="stylesheet" href="../base.css">
<style type='text/css'>
div.coverage-summary .sorter {
background-image: url(../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class="header medium">
<h1>Code coverage report for <span class="entity">lib/strategy.js</span></h1>
<h2>
Statements: <span class="metric">55% <small>(33 / 60)</small></span>
Branches: <span class="metric">41.86% <small>(18 / 43)</small></span>
Functions: <span class="metric">50% <small>(4 / 8)</small></span>
Lines: <span class="metric">55% <small>(33 / 60)</small></span>
Ignored: <span class="metric"><span class="ignore-none">none</span></span>
</h2>
<div class="path"><a href="../index.html">All files</a> » <a href="index.html">lib/</a> » strategy.js</div>
</div>
<div class="body">
<pre><table class="coverage">
<tr><td class="line-count">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</td><td class="line-coverage"><span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-yes">10</span>
<span class="cline-any cline-yes">10</span>
<span class="cline-any cline-yes">10</span>
<span class="cline-any cline-yes">10</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">10</span>
<span class="cline-any cline-yes">8</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">10</span>
<span class="cline-any cline-yes">9</span>
<span class="cline-any cline-yes">9</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">9</span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-yes">4</span>
<span class="cline-any cline-yes">4</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">4</span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3</span>
<span class="cline-any cline-yes">3</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2</span>
<span class="cline-any cline-yes">2</span>
<span class="cline-any cline-yes">2</span>
<span class="cline-any cline-yes">2</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1</span>
<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">'use strict';
/**
* Module dependencies.
*/
var util = require('util'),
OAuth2Strategy = require('passport-oauth2'),
Profile = require('./profile'),
InternalOAuthError = require('passport-oauth2').InternalOAuthError;
// Polyfills
require('string.prototype.endswith');
/**
* `Strategy` constructor.
*
* The WP-OAuth authentication strategy authenticates requests by delegating
* to the configured WP-OAuth Server using the OAuth 2.0 protocol.
*
* Applications must supply a `verify` callback which accepts an `accessToken`,
* `refreshToken` and the service-specific `profile`, an then calls the `done`
* callback supplying a `user`, which should be set to `false` if the
* credentials are not valid. If an exception/error occured, `err` is set.
*
* Options:
* - `clientID` the Client ID you created in WP-OAuth
* - `clientSecret` the corresponding Client Secret
* - `callbackURL` URL to which WP-OAuth will redirect the user after granting authorization.
*
* - `authorizationURL` the URL to the authorization endpoint, defaults to localhost.
* - `tokenURL` the URL to get token endpoint, defaults to localhost.
* - `userProfileURL` the URL to the profile information endpoint, defaults to localhost.
*
* Examples:
*
* passport.use(new WPOAuthStrategy({
* clientID: '123abc456def789ghi',
* clientSecret: 'shhh-its-a-secret',
* callbackURL: 'https://www.example.net/auth/wpoauth/callback',
* authorizationURL: 'https://www.example.net/blog/oauth/authorize',
* tokenURL: 'https://www.example.net/blog/oauth/token',
* userProfileURL: 'https://www.example.net/blog/oauth/me'
* }, function(accessToken, refreshToken, profile, done) {
* User.findOrCreate(..., function(err, user) {
* ...
* done(err, user);
* });
* }
* ));
*
* @param {Object} options
* @param {Function} verify
* @api public
*/
function Strategy(o, verify) {
var options = JSON.parse(JSON.stringify(o)) || {};
options.authorizationURL = options.authorizationURL || 'http://localhost/oauth/authorize';
options.tokenURL = options.tokenURL || 'http://localhost/oauth/token';
options.customHeaders = options.customHeaders || {};
if (!options.customHeaders['User-Agent']) {
options.customHeaders['User-Agent'] = options.userAgent || 'passport-wpoauth';
}
OAuth2Strategy.call(this, options, verify);
this.name = 'wpoauth';
this._userProfileURL = options.userProfileURL || 'http://localhost/oauth/me/';
// Otherwise we get a 301 which unforutunaly not handled by http/https
if (!this._userProfileURL.endsWith('/')) {
this._userProfileURL = this._userProfileURL + '/';
}
}
/**
* Inherit from `OAuth2Strategy`.
*/
util.inherits(Strategy, OAuth2Strategy);
/**
*
*/
Strategy.prototype.authenticate = <span class="fstat-no" title="function not covered" >function(req, options) {</span>
<span class="cstat-no" title="statement not covered" > options = options || {};</span>
<span class="cstat-no" title="statement not covered" > var self = this;</span>
<span class="cstat-no" title="statement not covered" > if (req && req.query && req.query.error) {</span>
<span class="cstat-no" title="statement not covered" > return self.error('Request not provided or has errors');</span>
}
<span class="cstat-no" title="statement not covered" > if (!req.body) {</span>
<span class="cstat-no" title="statement not covered" > return self.error();</span>
}
<span class="cstat-no" title="statement not covered" > if (!req.body.redirectUri) {</span>
<span class="cstat-no" title="statement not covered" > return self.error('You need to provide a redirectUri');</span>
} else {
<span class="cstat-no" title="statement not covered" > self._callbackURL = req.body.redirectUri;</span>
}
<span class="cstat-no" title="statement not covered" > var authCode = req.body.code || req.query.code;</span>
<span class="cstat-no" title="statement not covered" > if (!authCode) {</span>
<span class="cstat-no" title="statement not covered" > return self.error();</span>
}
<span class="cstat-no" title="statement not covered" > self._exchangeAuthCode(authCode,</span>
<span class="fstat-no" title="function not covered" > function(error, accessToken, refreshToken, results) {</span>
<span class="cstat-no" title="statement not covered" > if (error) {</span>
<span class="cstat-no" title="statement not covered" > return self.error(error);</span>
}
<span class="cstat-no" title="statement not covered" > self.userProfile(accessToken, <span class="fstat-no" title="function not covered" >function(err, profile) {</span></span>
<span class="cstat-no" title="statement not covered" > if (err) {</span>
<span class="cstat-no" title="statement not covered" > return self.fail(err);</span>
}
<span class="cstat-no" title="statement not covered" > var verified = <span class="fstat-no" title="function not covered" >function(e, user, info) {</span></span>
<span class="cstat-no" title="statement not covered" > if (e) {</span>
<span class="cstat-no" title="statement not covered" > return self.error(e);</span>
}
<span class="cstat-no" title="statement not covered" > if (!user) {</span>
<span class="cstat-no" title="statement not covered" > return self.fail(info);</span>
}
<span class="cstat-no" title="statement not covered" > self.success(user, info);</span>
};
<span class="cstat-no" title="statement not covered" > if (self._passReqToCallback) {</span>
<span class="cstat-no" title="statement not covered" > self._verify(req, accessToken, refreshToken, profile, verified);</span>
} else {
<span class="cstat-no" title="statement not covered" > self._verify(accessToken, refreshToken, profile, verified);</span>
}
});
});
};
/**
* Exchange authorization code for tokens
*
* @param {String} authCode
* @param {Function} done
* @api private
*/
Strategy.prototype._exchangeAuthCode = function(authCode, done) {
var params = {
'grant_type': 'authorization_code',
'redirect_uri': this._callbackURL
};
this._oauth2.getOAuthAccessToken(authCode, params, done);
};
/**
* Retrive user profile from WP OAuth.
*
* This function constructs a normalized profile with the following properties:
*
* - `provider` always set to `wpoauth`
* - `id` the user's WordPress ID
* - `username` the user's login name
* - `displayName` the user's preferred identification (can be username or full name or both)
* - `emails` the user's email address
*
* @param {String} accessToken
* @param {Function} done
* @api protected
*/
Strategy.prototype.userProfile = function(accessToken, done) {
this._oauth2.get(this._userProfileURL, accessToken, function(err, body, res) {
var json;
if (err) {
return done(new InternalOAuthError('Failed to fetch user profile', err));
}
try {
json = JSON.parse(body);
} catch (ex) {
return done(ex);
}
var profile = Profile.parse(json);
profile.provider = 'wpoauth';
profile._raw = body;
profile._json = json;
done(null, profile);
});
};
/**
* Expose `Strategy`.
*/
module.exports = Strategy;
</pre></td></tr>
</table></pre>
</div>
<div class="footer">
<div class="meta">Generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Mar 15 2016 15:48:35 GMT+0100 (CET)</div>
</div>
<script src="../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../sorter.js"></script>
</body>
</html>