Skip to content
This repository was archived by the owner on Mar 22, 2022. It is now read-only.

Socket.io authentication tests and login logout event #324

Merged
merged 4 commits into from
Oct 24, 2016
Merged

Socket.io authentication tests and login logout event #324

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b74d66
Socket.io authentication tests and login logout event
daffl Oct 23, 2016
7a1ca49
Improving socket tests and adding Primus
daffl Oct 24, 2016
0aec228
Some cleanup
daffl Oct 24, 2016
82fb2d8
Better error verification tests
daffl Oct 24, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -51,6 +51,7 @@
"debug": "^2.2.0",
"feathers-commons": "^0.7.5",
"feathers-errors": "^2.4.0",
"feathers-socket-commons": "^2.3.1",
"jsonwebtoken": "^7.1.9",
"lodash.merge": "^4.6.0",
"lodash.omit": "^4.5.0",
8 changes: 7 additions & 1 deletion src/base.js
View file
Original file line number Diff line number Diff line change
@@ -4,6 +4,8 @@ import middlewares from './middleware/authentication';

const debug = Debug('feathers-authentication:authentication:base');

// A basic Authentication class that allows to create and verify JWTs
// and also run through a token authentication chain
export default class Authentication {
constructor(app, options) {
this.options = options;
@@ -16,6 +18,7 @@ export default class Authentication {
this._middleware.isInitial = true;
}

// Register one or more handlers for the JWT verification chain
use(... middleware) {
// Reset the default middleware chain
if(this._middleware.isInitial) {
@@ -31,6 +34,7 @@ export default class Authentication {
return this;
}

// Run the JWT verification chain against data
authenticate(data) {
let promise = Promise.resolve(data);

@@ -46,6 +50,8 @@ export default class Authentication {
return promise;
}

// Returns a { token } object either from a string,
// an HTTP request object or another object with a `.token` property
getJWT(data) {
const { header } = this.options;

@@ -70,7 +76,7 @@ export default class Authentication {
debug('Token found in header', token);
}

return Promise.resolve({ token, req });
return Promise.resolve({ token });
}
else if (typeof data === 'object' && data.token) {
return Promise.resolve({ token: data.token });
9 changes: 3 additions & 6 deletions src/index.js
View file
Original file line number Diff line number Diff line change
@@ -7,7 +7,6 @@ import { socketioHandler, primusHandler } from './middleware/socket';
import getOptions from './options';
import Authentication from './base';
import service from './service';
// import tokenAuth from './token-auth';

const debug = Debug('feathers-authentication:index');

@@ -32,14 +31,12 @@ export default function init(config = {}) {
options.cookie.secure = false;
}

debug('Initializing base Authentication class');
app.authentication = new Authentication(app, options);
debug('Setting up Authentication class and Express middleware');

debug('registering Express authentication middleware');
app.authentication = new Authentication(app, options);
app.authenticate = app.authentication.authenticate.bind(app.authenticate);
app.use(express.getJWT(options));

app.configure(service(options));
// app.configure(tokenAuth(options));

app.setup = function() {
let result = _super.apply(this, arguments);
2 changes: 1 addition & 1 deletion src/middleware/authentication/populate-user.js
View file
Original file line number Diff line number Diff line change
@@ -3,6 +3,7 @@ import Debug from 'debug';
const debug = Debug('feathers-authentication:token:populate-user');

export default function(options) {
const app = this;
const { user } = options;

if (!user.service) {
@@ -14,7 +15,6 @@ export default function(options) {
}

return function populateUser(data) {
const app = this;
const service = typeof user.service === 'string' ? app.service(user.service) : user.service;
const { payloadField } = user;

2 changes: 1 addition & 1 deletion src/middleware/authentication/verify-key.js
View file
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ const debug = Debug('feathers-authentication:token:verifyKey');

export default function(options) {
return function verifyKey(data) {
if (data && data.token) {
if (data && data[options.keyfield]) {
const app = this;
const key = data[options.keyfield];

80 changes: 46 additions & 34 deletions src/middleware/socket/handler.js
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
import Debug from 'debug';
// import errors from 'feathers-errors';
import errors from 'feathers-errors';
import { normalizeError } from 'feathers-socket-commons/lib/utils';

const debug = Debug('feathers-authentication:sockets:handler');

export function normalizeError(e) {
let result = {};

Object.getOwnPropertyNames(e).forEach(key => result[key] = e[key]);

if(process.env.NODE_ENV === 'production') {
delete result.stack;
function handleSocketCallback(promise, callback) {
if(typeof callback === 'function') {
promise.then(data => callback(null, data))
.catch(error => {
debug(`Socket authentication error`, error);
callback(normalizeError(error));
});
}

delete result.hook;

return result;
return promise;
}

export default function setupSocketHandler(app, options, {
@@ -23,41 +22,54 @@ export default function setupSocketHandler(app, options, {

const service = app.service(options.service);

if(!service) {
throw new Error(`Could not find authentication service '${options.service}'`);
}

return function(socket) {
const authenticate = (data, callback = () => {}) => {
service.create(data, { provider })
.then( ({ token }) => {
const authenticate = function (data, callback = () => {}) {
const promise = service.create(data, { provider })
.then(jwt => app.authentication.authenticate(jwt))
.then(result => {
if(!result.authenticated) {
throw new errors.NotAuthenticated('Authentication was not successful');
}

const { token } = result;
const connection = feathersParams(socket);

debug(`Successfully authenticated socket with token`, token);

feathersParams(socket).token = token;
// Add the token to the connection so that it shows up as `params.token`
connection.token = token;

app.emit('login', result, {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you filter this? Is there an app.filter() method?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, these events are already being emitted in the service, here: https://github.com/feathersjs/feathers-authentication/blob/socketio-auth/src/service.js#L17

Would it be better to only emit at only one of these?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can probably take the ones in the service out since it doesn't have information about the connection and the provider. There is also no need to filter those. They only happen on the server on the app object, they are not service events.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, on line 75 in this same file it says socket.on(disconnect, logout); Should disconnect be a string?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so to emit the logout message to a single user, would we do this:

app.on('logout', (data, {socket}) => {
  socket.emit('logout', data);
});

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@daffl so you don't want to use app.service('authentication').on('login') and app.service('authentication').on('logout')? Is that because they don't have the provider context?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ekryski Yeah. Those events with the provider context seemed the best way to e.g. support keeping connection.user up to date when it changes during connection (which I'm working on right now).
@marshallswain I wouldn't say those events should be propagated to the outside. I was more thinking using them for things like

app.on('logout', (data, {socket}) => {
  const user = data.user;

  app.service('users').patch(user._id, {
    online: false
  });
});

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only ask because it's what is wanted for bitcentive. Will that send to only the authenticating or logging out connection if I do that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@daffl sounds good. Hopefully, because it's not on a service people won't be confused about it being dispatched outside of the server. I agree with you, I don't think they should be available to a client.

Copy link
Member

@ekryski ekryski Oct 24, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marshallswain we had talked about that but it's redundant. The client will get an ack for the authenticate event it sends to the server, and same for logout so we don't really need to emit those events to the client as well.

provider, socket, connection
});

return { token };
})
.then(data => callback(null, data))
.catch(error => {
debug(`Socket authentication error`, error);
callback(normalizeError(error));
});

handleSocketCallback(promise, callback);
};
const logout = (callback = () => {}) => {
const params = feathersParams(socket);
const { token } = params;
const logout = function (callback = () => {}) {
const connection = feathersParams(socket);
const { token } = connection;

if(token) {
debug('Authenticated socket disconnected', token);
debug('Logging out socket with token', token);

delete params.token;
delete connection.token;

service.remove(token)
.then(data => callback(null, data))
.catch(error => {
debug(`Error logging out socket`, error);
callback(error);
const promise = service.remove(token, { provider })
.then(jwt => app.authentication.authenticate(jwt))
.then(result => {
debug(`Successfully logged out socket with token`, token);

app.emit('logout', result, {
provider, socket, connection
});

return result;
});

handleSocketCallback(promise, callback);
}
};

2 changes: 1 addition & 1 deletion src/middleware/socket/index.js
View file
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ export function primusHandler(app, options = {}) {
const providerSettings = {
provider: 'primus',
emit: 'send',
disconnect: 'disconnection',
disconnect: 'end',
feathersParams(socket) {
return socket.request.feathers;
}
6 changes: 1 addition & 5 deletions src/service.js
View file
Original file line number Diff line number Diff line change
@@ -21,10 +21,6 @@ class Service {
}

remove(id, params) {
if (params.provider && !params.authentication) {
return Promise.reject(new Error(`External ${params.provider} requests need to run through an authentication provider`));
}

const token = id !== null ? id : params.token;

this.emit('logout', { token });
@@ -48,4 +44,4 @@ export default function init(options){
};
}

init.Service = Service;
init.Service = Service;
2 changes: 0 additions & 2 deletions test/base.test.js
View file
Original file line number Diff line number Diff line change
@@ -95,7 +95,6 @@ describe('Feathers Authentication Base Class', () => {
};

return auth.getJWT(mockRequest).then(data => {
expect(data.req).to.equal(mockRequest);
expect(data.token).to.equal('sometoken');
});
});
@@ -108,7 +107,6 @@ describe('Feathers Authentication Base Class', () => {
};

return auth.getJWT(mockRequest).then(data => {
expect(data.req).to.equal(mockRequest);
expect(data.token).to.equal('sometoken');
});
});
6 changes: 6 additions & 0 deletions test/fixtures/server.js
View file
Original file line number Diff line number Diff line change
@@ -45,6 +45,12 @@ export default function(settings, useSocketio = true) {
userId: 0,
authentication: 'test-auth'
};
} else if(hook.data.login === 'testing-fail') {
hook.params.authentication = 'test-auth';

hook.data.payload = {
authentication: 'test-auth'
};
}
}
});
Loading