blackbird-server
Version:
HTTP for JavaScript
240 lines (239 loc) • 7.76 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for modules/middleware/basicAuth.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../prettify.css" />
<link rel="stylesheet" href="../../base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="../../index.html">all files</a> / <a href="index.html">modules/middleware/</a> basicAuth.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">94.44% </span>
<span class="quiet">Statements</span>
<span class='fraction'>17/18</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">70% </span>
<span class="quiet">Branches</span>
<span class='fraction'>7/10</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>4/4</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">94.44% </span>
<span class="quiet">Lines</span>
<span class='fraction'>17/18</span>
</div>
</div>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">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</td><td class="line-coverage quiet"><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-neutral"> </span>
<span class="cline-any cline-yes">1×</span>
<span class="cline-any cline-yes">1×</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">3×</span>
<span class="cline-any cline-yes">3×</span>
<span class="cline-any cline-yes">3×</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-yes">3×</span>
<span class="cline-any cline-yes">3×</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-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-yes">2×</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-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></td><td class="text"><pre class="prettyprint lang-js">/**
* A middleware that performs basic auth on the incoming request before passing
* it downstream.
*
* The `validate` argument must be a function that accepts two arguments: the
* username and password given in the request. It must return the username to
* use for the request (or simply `true` to indicate the given username is
* valid) or a promise for such a value. The validated username is stored in the
* `remoteUser` request variable.
*
* When authorization fails, the client automatically receives a 401 Unauthorized
* response with the appropriate challenge in the WWW-Authenticate header.
*
* Example:
*
* mach.basicAuth(app, function (user, pass) {
* // Return a boolean value to indicate the given credentials are valid.
* return (user === 'admin' && pass === 'secret');
* });
*
* mach.basicAuth(app, function (user, pass) {
* // Return a promise for the actual username to use.
* return query('SELECT username FROM users WHERE handle=? AND password=?', user, pass);
* });
*/
module.exports = (function (mach, Promise, R) {
"use strict";
mach.extend(require("../extensions/server"));
function basicAuth(app, options) {
<span class="missing-if-branch" title="else path not taken" >E</span>if (R.is(Function, options)) {
options = {validate: options};
}
const realm = options.realm || "Authorization Required";
return function (conn) {
<span class="missing-if-branch" title="if path not taken" >I</span>if (conn.remoteUser) {
<span class="cstat-no" title="statement not covered" > return conn.call(app); </span>// Don't overwrite existing remoteUser.
}
const credentials = conn.auth.split(":", 2);
let username = credentials[0], password = credentials[1];
return Promise.resolve(options.validate(username, password)).then(function (user) {
if (user) {
conn.remoteUser = user === true ? username : <span class="branch-1 cbranch-no" title="branch not covered" >user;</span>
return conn.call(app);
}
conn.response.headers["WWW-Authenticate"] = `Basic realm="${realm}"`;
conn.text(401, "Not Authorized");
});
};
}
return basicAuth;
}(
require("../index"),
require("bluebird"),
require("ramda")
));
</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jul 06 2016 20:37:18 GMT-0500 (CDT)
</div>
</div>
<script src="../../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../../sorter.js"></script>
</body>
</html>