2
1
mirror of https://github.com/Thream/socketio-jwt.git synced 2024-07-21 09:38:31 +02:00
socketio-jwt/README.md
2014-01-13 16:00:21 -03:00

1.3 KiB

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.

Installation

npm install socketio-jwt

Example usage

var io            = require("socket.io")(server);
var socketioJwt   = require("socketio-jwt");

// set authorization for socket.io
io.set('authorization', socketioJwt.authorize({
  secret: 'your secret or public key'
}));

For more validation options see auth0/jsonwebtoken.

Client side:

For now the only way to append the jwt token is using query string:

var socket = io.connect('http://localhost:9000', {
  'query': 'token=' + your_jwt
});

Take care as URLs has a lenght limitation on Internet Explorer. I opened a issue in engine-io-client to support headers.

Contribute

You are always welcome to open an issue or provide a pull-request!

Also check out the unit tests:

npm test

License

Licensed under the MIT-License. 2013 AUTH10 LLC.