README.md

socketio-auth

Socket io jwt authentication middleware.
Including verifing middleware for socket.io and signing middleware for express.

Server side

Socket io verifing middleware

const fakeDB = {
  leet: { password: '1337' },
};

/**
 * Validation example
 * @param {*} userdata Decoded data from token
 */
const validation = (userdata) => {
  const { username, password } = userdata;
  return (
    username
    && password
    && fakeDB[username].password === password
  );
};

const { socketAuth } = authentication({
  secret: 'YourSecretOrPublicKey',
  verifyOptions: {
    // JWT verify options. see link below
  },
}, validation);

// Socket io authentication using the socketAuth middleware
io.use(socketAuth)
  .on('connection', (socket) => {
    socket.emit('connected', socket.authData);
  });

• Verifing options

Token signing middleware

Express example

const { tokenHandler } = authentication({
  secret: 'test',
  signOptions: {
    // JWT signing options. see link below
  },
});
app.use(bodyParser.urlencoded({ extended: false }));
app.use(bodyParser.json());
app.use('/api/token', tokenHandler);

• Sign options

Client side

Request token from api

const data = {
  username: 'leet',
  password: '1337',
};
const res = await fetch(`/api/token`, {
  method: 'POST',
  body: JSON.stringify(data),
  headers: {
    'Content-Type': 'application/json',
  },
});
const { token } = await res.json();

Connect with token

// Fetch the token like explained above
const token = await fetchToken();
// Connect using the query option token
const socket = client.connect({ query: { token }});

Then store the token in memory for reconnects