Package Exports

socketio-jwt-auth

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (socketio-jwt-auth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SocketIO JWT Auth

Socket.io authentication middleware using Json Web Token

Work with socket.io >= 1.0

Install

npm install socketio-jwt-auth

Usage

Register middleware to socket io

socketio-jwt-auth has only one method authenticate(options, verify).

options is an object literal contain two options secret and algorithm.

verify is a function with two args payload and done:

payload is the decoded JWT payload
done is a error first callback with three args: done(err, user, message)

var io = require('socket.io')();
var jwtAuth = require('socketio-jwt-auth');

// using middleware
io.use(jwtAuth.authenticate({
  secret: 'Your Secret',    // required, used to verify the token's signature
  algorithm: 'HS256'        // optional, default to be HS256
}, function(payload, done) {
  // done is a callback, you can use it as follow
  User.findOne({id: payload.sub}, function(err, user) {
    if (err) {
      // return error
      return done(err);
    }
    if (!user) {
      // return fail with an error message
      return done(null, false, 'user not exist');
    }
    // return success with a user info
    return done(null, user);
  });
}));

Access user info

io.on('connection', function(socket) {
  console.log('Authentication passed!');
  // now you can access user info through socket.request.user
  // socket.request.user.logged_in will be set to true
  socket.emit('success', {
    message: 'success logged in!',
    user: socket.request.user
  });
});

io.listen(9000);

Client Side

<script>
  // You should add auth_token to query while connecting
  // Replace THE_JWT_TOKEN with the valid one
  var socket = io('http://localhost:9000', {query: 'auth_token=THE_JWT_TOKEN'});
  // Authentication failed
  socket.on('error', function(err) {
    throw new Error(err);
  });
  // Authentication passed
  socket.on('success', function(data) {
    console.log(message);
    console.log('user info: ' + user);
  })
</script>

Tests

npm install
npm test

License

The MIT License