diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..3f8e778 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,60 @@ +{ + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributors": [ + { + "login": "beardaway", + "name": "Conrad Sopala", + "avatar_url": "https://avatars3.githubusercontent.com/u/11062800?v=4", + "profile": "https://twitter.com/beardaway", + "contributions": [ + "review", + "maintenance" + ] + }, + { + "login": "Annyv2", + "name": "Annyv2", + "avatar_url": "https://avatars3.githubusercontent.com/u/5016479?v=4", + "profile": "https://github.com/Annyv2", + "contributions": [ + "code" + ] + }, + { + "login": "Amialc", + "name": "Vladyslav Martynets", + "avatar_url": "https://avatars0.githubusercontent.com/u/1114365?v=4", + "profile": "https://github.com/Amialc", + "contributions": [ + "code" + ] + }, + { + "login": "pose", + "name": "Alberto Pose", + "avatar_url": "https://avatars3.githubusercontent.com/u/419703?v=4", + "profile": "https://github.com/pose", + "contributions": [ + "code" + ] + }, + { + "login": "Root-Core", + "name": "Root-Core", + "avatar_url": "https://avatars2.githubusercontent.com/u/5329652?v=4", + "profile": "https://github.com/Root-Core", + "contributions": [ + "code" + ] + } + ], + "contributorsPerLine": 7, + "projectName": "auth0-socketio-jwt", + "projectOwner": "auth0-community", + "repoType": "github", + "repoHost": "https://github.com" +} diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..22810c1 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,36 @@ +# Issue Report + +If you are reporting a bug, please fill the sections below (if they are applicable), otherwise feel free to delete those that don't apply. Thank you! πŸ™πŸΌ + +### Description + +What are you reporting? + +### Expected behaviour + +Tell us what you think should happen. + +### Actual behaviour + +Tell us what actually happens. + +### Steps to reproduce the problem + +Tell us what we should do to reproduce the issue. + +### Language / Framework Versions + +1. **Language used:** +2. **Framework used:** + +### Testing environment + +1. **Operating system:** +2. **Browser version:** + +### Screenshots + +Feel free to insert here any screenshots that you consider helpful in solving your issue. + + +**Filling this, you're helping yourself and repo maintainers in solving your issues quicker! Teamwork makes the dreamwork πŸ€œπŸΌπŸ€›πŸ»** diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..fa3bf58 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +# Pull Request Report + +Please include a summary of the change you made with relevant motivation and context why such change has been made. Filling sections below will allow us to get your changes reviewed and merged easier. If you feel like certain section is not applicable, feel free to delete it. Thanks for co-operation! πŸ™πŸΌ + +### Description + +Tell us what you changed, why you did it and what additional value it will bring. + +### Type of change + +- [ ] Bug fix (fix to an issue) +- [ ] New feature (changes to functionality) +- [ ] Big change (fix or feature that would cause existing functionality to work as expected) + +### Testing + +Please describe the tests that you ran to verify your changes. Provide any instructions that will allow us to reproduce it. Please also list any relevant details for your test configuration. + +**Test Configuration** + +* Framework version: +* Language version: +* Browser version: + +### Additional info + +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings and errors +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes diff --git a/README.md b/README.md index d9b9bc1..e631786 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,42 @@ -[![Build Status](https://travis-ci.org/auth0/socketio-jwt.svg)](https://travis-ci.org/auth0/socketio-jwt) +# socketio-jwt +[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors) +
+ +### Contributors + +Thanks goes to these wonderful people who contribute(d) or maintain(ed) this repo ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + +
Conrad Sopala
Conrad Sopala
πŸ‘€ 🚧		Annyv2
Annyv2
πŸ’»		Vladyslav Martynets
Vladyslav Martynets
πŸ’»		Alberto Pose
Alberto Pose
πŸ’»		Root-Core
Root-Core
πŸ’»
+ + + +## Intro Authenticate socket.io incoming connections with JWTs. This is useful if you are build a single page application and you are not using cookies as explained in this blog post: [Cookies vs Tokens. Getting auth right with Angular.JS](http://blog.auth0.com/2014/01/07/angularjs-authentication-with-cookies-vs-token/). -## Installation +This repo is supported and maintained by Community Developers, not Auth0. For more information about different support levels check https://auth0.com/docs/support/matrix . + +## Getting started + +Chrome extensions are packaged as `.crx` files for distribution but may be loaded "unpacked" for development. For more information on how to load an unpacked extension, see the [Chrome extension docs](https://developer.chrome.com/extensions/getstarted#unpacked). + +### Installation ``` npm install socketio-jwt ``` -## Example usage +## Usage ```javascript // set authorization for socket.io @@ -24,7 +52,7 @@ io.sockets **Note:** If you are using a base64-encoded secret (e.g. your Auth0 secret key), you need to convert it to a Buffer: `Buffer('your secret key', 'base64')` -__Client side__: +**Client side** ```javascript var socket = io.connect('http://localhost:9000'); @@ -41,9 +69,9 @@ socket.on('connect', function () { }); ``` -## One roundtrip +### One roundtrip -The previous approach uses a second roundtrip to send the jwt, there is a way you can authenticate on the handshake by sending the JWT as a query string, the caveat is that intermediary HTTP servers can log the url. +The previous approach uses a second roundtrip to send the jwt. There is a way you can authenticate on the handshake by sending the JWT as a query string, the caveat is that intermediary HTTP servers can log the url. ```javascript var io = require("socket.io")(server); @@ -54,14 +82,12 @@ io.set('authorization', socketioJwt.authorize({ secret: 'your secret or public key', handshake: true })); -////////////////////////////// //// With socket.io >= 1.0 //// io.use(socketioJwt.authorize({ secret: 'your secret or public key', handshake: true })); -/////////////////////////////// io.on('connection', function (socket) { // in socket.io < 1.0 @@ -74,7 +100,7 @@ io.on('connection', function (socket) { For more validation options see [auth0/jsonwebtoken](https://github.com/auth0/node-jsonwebtoken). -__Client side__: +**Client side** Append the jwt token using query string: @@ -84,9 +110,9 @@ var socket = io.connect('http://localhost:9000', { }); ``` -## Handling token expiration +### Handling token expiration -__Server side__: +**Server side** When you sign the token with an expiration time: @@ -94,9 +120,9 @@ When you sign the token with an expiration time: var token = jwt.sign(user_profile, jwt_secret, {expiresInMinutes: 60}); ``` -Your client-side code should handle it as below. +Your client-side code should handle it as below: -__Client side__: +**Client side** ```javascript socket.on("unauthorized", function(error) { @@ -107,15 +133,15 @@ socket.on("unauthorized", function(error) { }); ``` -## Handling invalid token +### Handling invalid token Token sent by client is invalid. -__Server side__: +**Server side**: No further configuration needed. -__Client side__: +**Client side** Add a callback client-side to execute socket disconnect server-side. @@ -129,7 +155,7 @@ socket.on("unauthorized", function(error, callback) { }); ``` -__Server side__: +**Server side** To disconnect socket server-side without client-side callback: @@ -137,15 +163,15 @@ To disconnect socket server-side without client-side callback: io.sockets.on('connection', socketioJwt.authorize({ secret: 'secret goes here', // No client-side callback, terminate connection server-side - callback: false + callback: false })) ``` -__Client side__: +**Client side** Nothing needs to be changed client-side if callback is false. -__Server side__: +**Server side** To disconnect socket server-side while giving client-side 15 seconds to execute callback: @@ -153,13 +179,13 @@ To disconnect socket server-side while giving client-side 15 seconds to execute io.sockets.on('connection', socketioJwt.authorize({ secret: 'secret goes here', // Delay server-side socket disconnect to wait for client-side callback - callback: 15000 + callback: 15000 })) ``` -Your client-side code should handle it as below. +Your client-side code should handle it as below: -__Client side__: +**Client side** ```javascript socket.on("unauthorized", function(error, callback) { @@ -171,13 +197,14 @@ socket.on("unauthorized", function(error, callback) { }); ``` -## Getting the secret dynamically -You can pass a function instead of an string when configuring secret. +### Getting the secret dynamically + +You can pass a function instead of a string when configuring secret. This function receives the request, the decoded token and a callback. This way, you are allowed to use a different secret based on the request and / or the provided token. -__Server side__: +**Server side** ```javascript var SECRETS = { @@ -187,33 +214,68 @@ var SECRETS = { io.use(socketioJwt.authorize({ secret: function(request, decodedToken, callback) { - // SECRETS[decodedToken.userId] will be used a a secret or + // SECRETS[decodedToken.userId] will be used as a secret or // public key for connection user. callback(null, SECRETS[decodedToken.userId]); }, handshake: false })); - ``` ## Contribute -You are always welcome to open an issue or provide a pull-request! +Feel like contributing to this repo? We're glad to hear that! Before you start contributing please visit our [Contributing Guideline](https://github.com/auth0-community/getting-started/blob/master/CONTRIBUTION.md). -Also check out the unit tests: -```bash -npm test -``` +Here you can also find the [PR template](https://github.com/auth0-community/socketio-jwt/blob/master/PULL_REQUEST_TEMPLATE.md) to fill once creating a PR. It will automatically appear once you open a pull request. -## Issue Reporting +## Issues Reporting -If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues. +Spotted a bug or any other kind of issue? We're just humans and we're always waiting for constructive feedback! Check our section on how to [report issues](https://github.com/auth0-community/getting-started/blob/master/CONTRIBUTION.md#issues)! -## Author +Here you can also find the [Issue template](https://github.com/auth0-community/socketio-jwt/blob/master/ISSUE_TEMPLATE.md) to fill once opening a new issue. It will automatically appear once you create an issue. -[Auth0](auth0.com) +## Repo Community + +Feel like PRs and issues are not enough? Want to dive into further discussion about the tool? We created topics for each Auth0 Community repo so that you can join discussion on stack available on our repos. Here it is for this one: [socketio-jwt](https://community.auth0.com/t/auth0-community-oss-socketio-jwt/20024) + + + + ## License -This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info. +This project is licensed under the MIT license. See the [LICENSE](https://github.com/auth0-community/socketio-jwt/blob/master/LICENSE) file for more info. + +## What is Auth0? + +Auth0 helps you to: + +* Add authentication with [multiple authentication sources](https://docs.auth0.com/identityproviders), either social like + * Google + * Facebook + * Microsoft + * Linkedin + * GitHub + * Twitter + * Box + * Salesforce + * etc. + + **or** enterprise identity systems like: + * Windows Azure AD + * Google Apps + * Active Directory + * ADFS + * Any SAML Identity Provider + +* Add authentication through more traditional [username/password databases](https://docs.auth0.com/mysql-connection-tutorial) +* Add support for [linking different user accounts](https://docs.auth0.com/link-accounts) with the same user +* Support for generating signed [JSON Web Tokens](https://docs.auth0.com/jwt) to call your APIs and create user identity flow securely +* Analytics of how, when and where users are logging in +* Pull data from other sources and add it to user profile, through [JavaScript rules](https://docs.auth0.com/rules) + +## Create a free Auth0 account + +* Go to [Auth0 website](https://auth0.com/signup) +* Hit the **SIGN UP** button in the upper-right corner diff --git a/assets/join_auth0_community_badge.png b/assets/join_auth0_community_badge.png new file mode 100644 index 0000000..72c7058 Binary files /dev/null and b/assets/join_auth0_community_badge.png differ diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..9157c92 --- /dev/null +++ b/example/README.md @@ -0,0 +1,3 @@ +# Deprecation Notice + +This sample has been deprecated. Please see the [auth0-samples](https://github.com/auth0-samples) org for the latest Auth0 samples. \ No newline at end of file diff --git a/example/socketsio-auth0-sample/README.md b/example/socketsio-auth0-sample/README.md deleted file mode 100644 index ccc146e..0000000 --- a/example/socketsio-auth0-sample/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Auth0 + Socket.io - -This is the seed project you need to use if you're going to create a Socket.io single page app that will use Auth0. - -### Configure your Auth0 credentials - -First, you need to set the ClientSecret, ClientId and Domain for your Auth0 app as environment variables with the following names respectively: `AUTH0_CLIENT_SECRET`, `AUTH0_CLIENT_ID` and `AUTH0_DOMAIN`. You can find this information in your Auth0 Dashboard. - -So, create a file named `.env` in the directory and set the values like the following: - -````bash -# .env file -AUTH0_CLIENT_SECRET=myCoolSecret -AUTH0_CLIENT_ID=myCoolClientId -AUTH0_DOMAIN=myCoolDomain -```` - -### Set up the Allowed Origin (CORS) in Auth0 - -Then, you need to put `http://localhost:3001` as an Allowed Origin (CORS) in the Application Settings on your Auth0.com dashboard. - -### Running the example - -In order to run the example, you need to have `node` installed. - -1. run `npm install` -1. run `node index.js` in the directory of this project. - - -Go to [http://localhost:3001](http://localhost:3001) and you'll see the app running :). diff --git a/example/socketsio-auth0-sample/index.js b/example/socketsio-auth0-sample/index.js deleted file mode 100644 index aba5f43..0000000 --- a/example/socketsio-auth0-sample/index.js +++ /dev/null @@ -1,41 +0,0 @@ -var express = require('express'); -var app = express(); -var http = require('http').Server(app); -var io = require('socket.io')(http); -var socketioJwt = require('socketio-jwt'); -var dotenv = require('dotenv'); - -dotenv.load(); - -var env = { - AUTH0_CLIENT_ID: process.env.AUTH0_CLIENT_ID, - AUTH0_DOMAIN: process.env.AUTH0_DOMAIN -}; -var port = process.env.PORT || 3001; - -app.set('views', __dirname + '/views'); -app.set('view engine', 'pug'); - -io - .on('connection', socketioJwt.authorize({ - secret: Buffer(JSON.stringify(process.env.AUTH0_CLIENT_SECRET), 'base64'), - timeout: 15000 // 15 seconds to send the authentication message - })) - .on('authenticated', function(socket){ - console.log('connected & authenticated: ' + JSON.stringify(socket.decoded_token)); - socket.on('chat message', function(msg){ - debugger; - io.emit('chat message', msg); - }); - }); - -app.use(express.static(__dirname + '/public')); - -app.get('/', function (req, res) { - res.render('index', { env: env }); -}); - -http.listen(port, function(){ - console.log('listening on *:' + port); -}); - diff --git a/example/socketsio-auth0-sample/package.json b/example/socketsio-auth0-sample/package.json deleted file mode 100644 index 79381ce..0000000 --- a/example/socketsio-auth0-sample/package.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "name": "socket-auth0-chat-example", - "version": "1.0.0", - "description": "Auth0 + Socket.io seed", - "repository": { - "type": "git", - "url": "git://github.com/auth0/socketio-jwt.git" - }, - "author": "Auth0", - "license": "MIT", - "dependencies": { - "dotenv": "^2.0.0", - "express": "^4.13.4", - "pug": "^2.0.0-beta2", - "socket.io": "^1.4.6", - "socketio-jwt": "^4.3.4" - }, - "bugs": { - "url": "https://github.com/auth0/socketio-jwt/issues" - }, - "homepage": "https://github.com/auth0/socketio-jwt#readme", - "devDependencies": {}, - "scripts": { - "start": "node index.js", - "test": "echo \"Error: no test specified\" && exit 1" - } - -} diff --git a/example/socketsio-auth0-sample/public/stylesheets/style.css b/example/socketsio-auth0-sample/public/stylesheets/style.css deleted file mode 100644 index 2e749fe..0000000 --- a/example/socketsio-auth0-sample/public/stylesheets/style.css +++ /dev/null @@ -1,10 +0,0 @@ -* { margin: 0; padding: 0; box-sizing: border-box; } -body { font: 13px Helvetica, Arial; } -#chatForm { background: #000; padding: 3px; position: fixed; bottom: 0; width: 100%; } -#chatForm input { border: 0; padding: 10px; width: 90%; margin-right: .5%; } -#chatForm button { width: 9%; background: rgb(130, 224, 255); border: none; padding: 10px; } -#messages { list-style-type: none; margin: 0; padding: 0; } -#messages li { padding: 5px 10px; } -#messages li:nth-child(odd) { background: #eee; } -#login { width: 100%; padding: 10px } -#login button { width: 10%; padding: 8px; border: none; background: rgb(130, 255, 130);} diff --git a/example/socketsio-auth0-sample/views/index.pug b/example/socketsio-auth0-sample/views/index.pug deleted file mode 100644 index 3175adc..0000000 --- a/example/socketsio-auth0-sample/views/index.pug +++ /dev/null @@ -1,78 +0,0 @@ -extends layout - -block content - script(src="https://cdn.auth0.com/js/lock/10.0/lock.min.js") - script(src="/socket.io/socket.io.js") - script(src="http://code.jquery.com/jquery-1.12.4.js") - - - div#login - button.btn Login - div#chat - ul#messages - form(id="chatForm" action="") - input(id="m" autocomplete="off") - button.btn Send - - script. - var userProfile; - var userToken; - var lock = new Auth0Lock('#{env.AUTH0_CLIENT_ID}', '#{env.AUTH0_DOMAIN}'); - var id_token = localStorage.getItem('id_token'); - $('#chat').hide(); - $('#login button').click(function (e) { - e.preventDefault(); - lock.show(); - }); - - lock.on('authenticated', function(authResult) { - lock.getProfile(authResult.idToken, function(error, profile) { - if (error) { - // Handle error - return; - } - console.log('connected and authenticated'); - localStorage.setItem('id_token', authResult.idToken); - localStorage.setItem('profile', JSON.stringify(profile)); - userProfile = profile; - id_token = authResult.idToken; - openChat(); - }); - }); - - if (id_token) { - lock.getProfile(id_token, function (err, profile) { - if (err) { - return alert('There was an error getting the profile: ' + err.message); - } - userProfile = profile; - openChat(); - }); - } - - function openChat() { - var socket = io(); - socket - .on('connect', function (msg) { - console.log("connected"); - socket.emit('authenticate', {token: id_token}); // send the jwt - }) - .on('authenticated', function () { - //Do - $('#login').hide(); - $('#chat').show(); - $('form').submit(function (event) { - socket.emit('chat message', $('#m').val()); - $('#m').val(''); - return false; - }); - }) - .on('unauthorized', function(msg){ - console.log("unauthorized: " + JSON.stringify(msg.data)); - throw new Error(msg.data.type); - }) - .on('chat message', function (msg) { - console.log("msg"); - $('#messages').append($('
  • ').text(msg)); - }); - }; diff --git a/example/socketsio-auth0-sample/views/layout.pug b/example/socketsio-auth0-sample/views/layout.pug deleted file mode 100644 index 5941a37..0000000 --- a/example/socketsio-auth0-sample/views/layout.pug +++ /dev/null @@ -1,7 +0,0 @@ -doctype html -html - head - - link(rel='stylesheet', href='/stylesheets/style.css') - body - block content diff --git a/lib/index.js b/lib/index.js index 4aa18ad..0eb6f79 100644 --- a/lib/index.js +++ b/lib/index.js @@ -35,7 +35,7 @@ function noQsMethod(options) { message: (Object.prototype.toString.call(err) === '[object Object]' && err.message) ? err.message : err }); var callback_timeout; - // If callback explicitely set to false, start timeout to disconnect socket + // If callback explicitely set to false, start timeout to disconnect socket if (options.callback === false || typeof options.callback === "number") { if (typeof options.callback === "number") { if (options.callback < 0) { @@ -57,10 +57,15 @@ function noQsMethod(options) { } }; - if(!data || typeof data.token !== "string") { + var token = options.cookie ? socket.request.cookies[options.cookie] : (data ? data.token : undefined); + + if(!token || typeof token !== "string") { return onError({message: 'invalid token datatype'}, 'invalid_token'); } + // Store encoded JWT + socket[options.encodedPropertyName] = data.token; + var onJwtVerificationReady = function(err, decoded) { if (err) { @@ -96,16 +101,16 @@ function noQsMethod(options) { return onError(err, 'invalid_secret'); } - jwt.verify(data.token, secret, options, onJwtVerificationReady); + jwt.verify(token, secret, options, onJwtVerificationReady); }; - getSecret(socket.request, options.secret, data.token, onSecretReady); + getSecret(socket.request, options.secret, token, onSecretReady); }); }; } function authorize(options, onConnection) { - options = xtend({ decodedPropertyName: 'decoded_token' }, options); + options = xtend({ decodedPropertyName: 'decoded_token', encodedPropertyName: 'encoded_token' }, options); if (!options.handshake) { return noQsMethod(options); @@ -167,6 +172,9 @@ function authorize(options, onConnection) { return auth.fail(error, socket, accept); } + // Store encoded JWT + data[options.encodedPropertyName] = token; + var onJwtVerificationReady = function(err, decoded) { if (err) { diff --git a/package.json b/package.json index bd0589a..3626b9c 100644 --- a/package.json +++ b/package.json @@ -31,9 +31,11 @@ "mocha": "~3.2.0", "request": "~2.81.0", "serve-static": "^1.12.1", + "jsonwebtoken": "^8.3.0", + "xtend": "~2.1.2", "server-destroy": "~1.0.1", "should": "~11.2.1", "socket.io": "^1.7.3", "socket.io-client": "^1.7.3" } -} +} \ No newline at end of file