├── views ├── index.html ├── secrethideout.html ├── register.html └── login.html ├── config.example.js ├── database.js ├── package.json ├── models └── user.js ├── .gitignore ├── routes.js ├── index.js ├── controllers ├── pages.js └── authentication.js ├── README.md └── LICENSE /views/index.html: -------------------------------------------------------------------------------- 1 |

Hi there!

2 | 3 |

Would you like to login or register?

4 | -------------------------------------------------------------------------------- /views/secrethideout.html: -------------------------------------------------------------------------------- 1 |

Batman's super secret hideout!

2 | 3 |

Welcome to this totally secret hideout, {{email}}. Would you like to leave?

4 | -------------------------------------------------------------------------------- /config.example.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | mongo: { 3 | username: '', 4 | password: '', 5 | url: '.mongolab.com:', 6 | database: 'authdb' 7 | }, 8 | server: { 9 | hostname: 'localhost', 10 | port: 1337 11 | } 12 | }; -------------------------------------------------------------------------------- /views/register.html: -------------------------------------------------------------------------------- 1 |

Register

2 | 3 |
4 |

5 |

6 |

7 |
8 | -------------------------------------------------------------------------------- /views/login.html: -------------------------------------------------------------------------------- 1 |

Login

2 | 3 |

{{errorMessage}}

4 | 5 |
6 |

7 |

8 |

9 |
10 | -------------------------------------------------------------------------------- /database.js: -------------------------------------------------------------------------------- 1 | var Mongoose = require('mongoose'); 2 | var Config = require('./config'); 3 | 4 | //load database 5 | // Mongoose.connect('mongodb://localhost/test'); 6 | Mongoose.connect('mongodb://' + Config.mongo.username + ':' + Config.mongo.password + '@' + Config.mongo.url + '/' + Config.mongo.database); 7 | var db = Mongoose.connection; 8 | 9 | db.on('error', console.error.bind(console, 'connection error')); 10 | db.once('open', function callback() { 11 | console.log("Connection with database succeeded."); 12 | }); 13 | 14 | exports.Mongoose = Mongoose; 15 | exports.db = db; -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "authProject", 3 | "version": "2.0.0", 4 | "description": "A simple webserver with authentication built with Hapi, Hapi-auth-cookie, and Mongoose", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "author": "Kevin Adegeest", 10 | "license": "MIT", 11 | "dependencies": { 12 | "handlebars": "^4.0.3", 13 | "hapi": "^10.4.0", 14 | "hapi-auth-cookie": "^3.1.0", 15 | "joi": "^6.9.0", 16 | "mongoose": "^4.1.10", 17 | "passport-local-mongoose": "^3.1.0", 18 | "vision": "^3.0.0" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /models/user.js: -------------------------------------------------------------------------------- 1 | var Mongoose = require('../database').Mongoose; 2 | 3 | //create the schema 4 | var userSchema = new Mongoose.Schema({ 5 | email: { 6 | type: String, 7 | required: true 8 | }, 9 | password: { 10 | type: String, 11 | required: true 12 | }, 13 | creationDate: { 14 | type: Date, 15 | required: true, 16 | default: Date.now 17 | } 18 | }); 19 | 20 | userSchema.plugin(require('passport-local-mongoose'), { 21 | usernameField: 'email', 22 | hashField: 'password', 23 | usernameLowerCase: true 24 | }); 25 | 26 | //create the model and add it to the exports 27 | module.exports = Mongoose.model('User', userSchema, 'Users'); 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # Compiled binary addons (http://nodejs.org/api/addons.html) 20 | build/Release 21 | 22 | # Dependency directory 23 | # Commenting this out is preferred by some people, see 24 | # https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git 25 | node_modules 26 | 27 | # Users Environment Variables 28 | .lock-wscript 29 | 30 | # Hide the config file 31 | config.js -------------------------------------------------------------------------------- /routes.js: -------------------------------------------------------------------------------- 1 | var Pages = require('./controllers/pages'); 2 | var Authentication = require('./controllers/authentication'); 3 | 4 | /** 5 | * Contains the list of all routes, i.e. methods, paths and the config functions 6 | * that take care of the actions 7 | */ 8 | exports.endpoints = [ 9 | { method: 'GET', path: '/', config: Pages.index }, 10 | { method: 'GET', path: '/login', config: Pages.login }, 11 | { method: 'GET', path: '/register', config: Pages.register }, 12 | { method: 'GET', path: '/batmanshideout', config: Pages.secret }, 13 | 14 | { method: 'POST', path: '/login', config: Authentication.login }, 15 | { method: 'GET', path: '/logout', config: Authentication.logout }, 16 | { method: 'POST', path: '/register', config: Authentication.register }, 17 | ]; -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var Hapi = require('hapi'); 2 | var Routes = require('./routes'); 3 | var Config = require('./config'); 4 | // var User = require('./models/user').User; 5 | 6 | // Create a server with a host and port 7 | var server = new Hapi.Server(); 8 | server.connection({ port: Config.server.port }); 9 | 10 | // Register the plugin 11 | server.register([require('hapi-auth-cookie'), require('vision')], function (err) { 12 | 13 | if (err) { 14 | throw err; 15 | } 16 | 17 | // Set our strategy 18 | server.auth.strategy('session', 'cookie', { 19 | password: 'worldofwalmart', // cookie secret 20 | cookie: 'session', // Cookie name 21 | isSecure: false, // required for non-https applications 22 | ttl: 24* 60 * 60 * 1000 // Set session to 1 day 23 | }); 24 | 25 | // Set our view engine, we'll use handlebars 26 | server.views({ 27 | engines: { 28 | html: require('handlebars') 29 | }, 30 | path: __dirname + '/views' 31 | }); 32 | }); 33 | 34 | // Print some information about the incoming request for debugging purposes 35 | server.ext('onRequest', function (request, reply) { 36 | console.log(request.path, request.query); 37 | return reply.continue(); 38 | }); 39 | 40 | server.route(Routes.endpoints); 41 | 42 | // Start the server 43 | server.start(function() { 44 | console.log("The server has started on port: " + server.info.port); 45 | }); 46 | -------------------------------------------------------------------------------- /controllers/pages.js: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * Handles a call to / and shows some text with links to login and registration 4 | */ 5 | exports.index = { 6 | auth: { 7 | mode: 'try', 8 | strategy: 'session' 9 | }, 10 | handler: function (request, reply) { 11 | 12 | if (request.auth.isAuthenticated) { 13 | // The user is already logged in, redirect it to the hideout 14 | return reply.redirect('/batmanshideout'); 15 | } 16 | 17 | return reply.view('index'); 18 | } 19 | }; 20 | 21 | /** 22 | * Handles a call to /login and shows a login form 23 | */ 24 | exports.login = { 25 | auth: { 26 | mode: 'try', 27 | strategy: 'session' 28 | }, 29 | handler: function (request, reply) { 30 | 31 | if (request.auth.isAuthenticated) { 32 | // The user is already logged in, redirect it to the hideout 33 | return reply.redirect('/batmanshideout'); 34 | } 35 | 36 | return reply.view('login'); 37 | } 38 | }; 39 | 40 | /** 41 | * Handles a call to /register and shows a registration form 42 | */ 43 | exports.register = { 44 | auth: { 45 | mode: 'try', 46 | strategy: 'session' 47 | }, 48 | handler: function (request, reply) { 49 | 50 | if (request.auth.isAuthenticated) { 51 | // The user is already logged in, redirect it to the hideout 52 | return reply.redirect('/batmanshideout'); 53 | } 54 | 55 | return reply.view('register'); 56 | } 57 | }; 58 | 59 | /** 60 | * Handles a call to /batmanshideout and shows super secret stuff 61 | */ 62 | exports.secret = { 63 | auth: 'session', 64 | handler: function (request, reply) { 65 | return reply.view('secrethideout', { 66 | email: request.auth.credentials.email 67 | }); 68 | } 69 | }; 70 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | AuthProject 2 | =========== 3 | 4 | > __Accompanying blog posts__ 5 | > 6 | > First version: 7 | > Source code of a post regarding User authentication with Hapi, Passport and Mongoose located at: 8 | > 9 | > 10 | > Second version (Hapi 6): 11 | > 12 | > 13 | > Third version (Hapi 8): 14 | > 15 | 16 | ## Version 2.0.0 17 | 18 | Lots of changes in this version, since some major dependencies have had several updates. 19 | 20 | Most notably: passport-local-mongoose. Earlier versions used passport-local-mongoose 0.3.0. It has since been updated to 3.1.0 and due to security implications it switched from sha1 to sha256. If you decide to upgrade a production system remember that your users will not be able to log in since the digest algorithm was changed! 21 | 22 | The update also provided certain new error messages which have been added to AuthProject 2.0.0. 23 | 24 | Additionally, I have added [Vision](https://github.com/hapijs/vision), Hapi's view engine plugin, to get rid of the HTML in the route handlers. 25 | 26 | ## Getting it to run 27 | 28 | Before you're able to get it working you have to enter your MongoLab credentials or alter to code to use a local MongoDB database. Copy the `config.example.js` file to `config.js` and enter the following information: 29 | 30 | - Username of your dbuser 31 | - Password of that dbuser (dbpassword) 32 | - Replace the first part of the hostname in the url 33 | - Replace the port number in the url 34 | 35 | These are all supplied by MongoLab. 36 | 37 | After changing these settings don't forget to run 38 | ``` 39 | npm install 40 | ``` 41 | 42 | to install the dependencies. 43 | 44 | =========== 45 | 46 | Feel free to do whatever you like with the code. 47 | -------------------------------------------------------------------------------- /controllers/authentication.js: -------------------------------------------------------------------------------- 1 | var Joi = require('joi'); 2 | var User = require('../models/user'); 3 | 4 | /** 5 | * Responds to POST /login and logs the user in, well, soon. 6 | */ 7 | exports.login = { 8 | handler: function (request, reply) { 9 | 10 | // In the version with Travelogue and Mongoose this was all handled by Passport (hence we retrieved 11 | // Passport and inserted the request and reply variables). 12 | User.authenticate()(request.payload.email, request.payload.password, function (err, user, passwordError) { 13 | 14 | // There has been an error, do something with it. I just print it to console for demo purposes. 15 | if (err) { 16 | console.error(err); 17 | return reply.redirect('/login'); 18 | } 19 | 20 | // Something went wrong with the login process, could be any of: 21 | // https://github.com/saintedlama/passport-local-mongoose#error-messages 22 | if (passwordError) { 23 | // For now, just show the error and login form 24 | console.log(passwordError); 25 | return reply.view('login', { 26 | errorMessage: passwordError.message, 27 | }); 28 | } 29 | 30 | // If the authentication failed user will be false. If it's not false, we store the user 31 | // in our session and redirect the user to the hideout 32 | if (user) { 33 | request.auth.session.set(user); 34 | return reply.redirect('/batmanshideout'); 35 | } 36 | 37 | return reply.redirect('/login'); 38 | 39 | }); 40 | } 41 | }; 42 | 43 | /** 44 | * Responds to GET /logout and logs out the user 45 | */ 46 | exports.logout = { 47 | auth: 'session', 48 | handler: function (request, reply) { 49 | request.auth.session.clear(); 50 | reply().redirect('/'); 51 | } 52 | }; 53 | 54 | /** 55 | * Responds to POST /register and creates a new user. 56 | */ 57 | exports.register = { 58 | validate: { 59 | payload: { 60 | email: Joi.string().email().required(), 61 | password: Joi.string().required() 62 | } 63 | }, 64 | handler: function(request, reply) { 65 | 66 | // Create a new user, this is the place where you add firstName, lastName etc. 67 | // Just don't forget to add them to the validator above. 68 | var newUser = new User({ 69 | email: request.payload.email 70 | }); 71 | 72 | // The register function has been added by passport-local-mongoose and takes as first parameter 73 | // the user object, as second the password it has to hash and finally a callback with user info. 74 | User.register(newUser, request.payload.password, function(err, user) { 75 | 76 | // Return error if present 77 | if (err) { 78 | return reply(err); 79 | } 80 | 81 | console.log('registered'); 82 | return reply.redirect('/login'); 83 | }); 84 | } 85 | }; 86 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. --------------------------------------------------------------------------------