Як поділитися сеансами з Socket.IO 1.x та Express 4.x?

89

Як я можу поділитися сеансом із Socket.io 1.0 та Express 4.x? Я використовую Redis Store, але я вважаю, що це не має значення. Я знаю, що мені потрібно використовувати проміжне програмне забезпечення для перегляду файлів cookie та отримання сеансу, але не знаю як. Я шукав, але не міг знайти жодної роботи

    var RedisStore = connectRedis(expressSession);
    var session = expressSession({
        store: new RedisStore({
            client: redisClient
        }),
        secret: mysecret,
        saveUninitialized: true,
        resave: true
    });
    app.use(session);

    io.use(function(socket, next) {
        var handshake = socket.handshake;
        if (handshake.headers.cookie) {
            var str = handshake.headers.cookie;
            next();
        } else {
            next(new Error('Missing Cookies'));
        }
    });
node.js  session  express  socket.io 
— Мустафа
джерело

Відповіді:

215

Рішення напрочуд просте. Це просто не дуже добре задокументовано. Можна використовувати проміжне програмне забезпечення Express Express як Socket.IO проміжне програмне забезпечення також з невеликим адаптером, як це:

sio.use(function(socket, next) {
    sessionMiddleware(socket.request, socket.request.res, next);
});

Ось повний приклад із express 4.x, Socket.IO 1.x та Redis:

var express = require("express");
var Server = require("http").Server;
var session = require("express-session");
var RedisStore = require("connect-redis")(session);

var app = express();
var server = Server(app);
var sio = require("socket.io")(server);

var sessionMiddleware = session({
    store: new RedisStore({}), // XXX redis server config
    secret: "keyboard cat",
});

sio.use(function(socket, next) {
    sessionMiddleware(socket.request, socket.request.res || {}, next);
});

app.use(sessionMiddleware);

app.get("/", function(req, res){
    req.session // Session object in a normal request
});

sio.sockets.on("connection", function(socket) {
  socket.request.session // Now it's available from Socket.IO sockets too! Win!
});


server.listen(8080);
— Епелі
джерело
17
Не могли б ви допомогти мені з вашим рішенням? Я отримую лише ці дані {cookie: { path: '/', _expires: null, originalMaxAge: null, httpOnly: true, secure: true } }Але якщо я надрукую сеанс у своїх маршрутах, я отримаю всі змінні сеансу, які я встановив (ім'я користувача, ідентифікатор тощо)
— Боббі Шарк,
7
Це повинно бути повністю додано до їхніх документів. Документація щодо автентифікації надзвичайно легка, як і зараз.
— Брет
4
це "працює" для мене, але мій ідентифікатор сеансу Express не такий, як ідентифікатор мого сеансу socket.io ... можливо, я все одно не хочу, щоб вони були однаковими?
— Олександр Міллс
4
Це рішення працювало ВЕЛИКО! ... поки мені не потрібно було зберігати дані до сеансу із сокета.on () на той момент, я виявляю, що це єдиний спосіб. Чи є спосіб змусити це працювати в обидві сторони?
— iDVB
4
Це чудово працювало з парою модифікацій. Але я не міг написати на сеанс із socket.io. Я знайшов пакет NPM, який відповідав усім моїм потребам і вимагає приблизно тих самих зусиль, що й ця відповідь, щоб реалізувати. npmjs.com/package/express-socket.io-session
— Бекон Бред
6

Буквально півтора місяці тому я мав справу з тією ж проблемою, а потім написав обширний допис у блозі на цю тему, який поєднується з повністю робочим демо-додатком, розміщеним на GitHub. Рішення покладається на модулі вузлів експрес-сесії , cookie-parser та connect-redis, щоб зв’язати все. Це дозволяє отримувати доступ та змінювати сеанси як з REST, так і з контексту Sockets, що є досить корисним.

Дві найважливіші частини - це налаштування проміжного програмного забезпечення: 

app.use(cookieParser(config.sessionSecret));
app.use(session({
    store: redisStore,
    key: config.sessionCookieKey,
    secret: config.sessionSecret,
    resave: true,
    saveUninitialized: true
}));

... та налаштування сервера SocketIO:

ioServer.use(function (socket, next) {
    var parseCookie = cookieParser(config.sessionSecret);
    var handshake = socket.request;

    parseCookie(handshake, null, function (err, data) {
        sessionService.get(handshake, function (err, session) {
            if (err)
                next(new Error(err.message));
            if (!session)
                next(new Error("Not authorized"));

            handshake.session = session;
            next();
        });
    });
});

Вони поєднуються з простим модулем sessionService, який я створив, який дозволяє виконувати деякі основні операції з сесіями, і цей код виглядає так:

var config = require('../config');

var redisClient = null;
var redisStore = null;

var self = module.exports = {
    initializeRedis: function (client, store) {
        redisClient = client;
        redisStore = store;
    },
    getSessionId: function (handshake) {
        return handshake.signedCookies[config.sessionCookieKey];
    },
    get: function (handshake, callback) {
        var sessionId = self.getSessionId(handshake);

        self.getSessionBySessionID(sessionId, function (err, session) {
            if (err) callback(err);
            if (callback != undefined)
                callback(null, session);
        });
    },
    getSessionBySessionID: function (sessionId, callback) {
        redisStore.load(sessionId, function (err, session) {
            if (err) callback(err);
            if (callback != undefined)
                callback(null, session);
        });
    },
    getUserName: function (handshake, callback) {
        self.get(handshake, function (err, session) {
            if (err) callback(err);
            if (session)
                callback(null, session.userName);
            else
                callback(null);
        });
    },
    updateSession: function (session, callback) {
        try {
            session.reload(function () {
                session.touch().save();
                callback(null, session);
            });
        }
        catch (err) {
            callback(err);
        }
    },
    setSessionProperty: function (session, propertyName, propertyValue, callback) {
        session[propertyName] = propertyValue;
        self.updateSession(session, callback);
    }
};

Оскільки в цілому більше коду, ніж цей (наприклад, ініціалізація модулів, робота з сокетами та виклики REST як на клієнтській, так і на серверній стороні), я не буду вставляти весь код сюди, ви можете переглянути його на GitHub і ви можете робити з ним все, що завгодно.

— поотцько
джерело
4

express-socket.io-session

- це готове рішення для вашої проблеми. Зазвичай сеанс, створений в кінці socket.io, має інший sid, ніж той, що створений у express.js

Перш ніж знати цей факт, коли я працював над цим, щоб знайти рішення, я виявив щось дещо дивне. Сеанси, створені з екземпляра express.js, були доступні в кінці socket.io, але те саме не було можливим для протилежного. І незабаром я зрозумів, що для вирішення цієї проблеми мені доведеться прокласти шлях через управління sid. Але вже було написано пакет для вирішення такої проблеми. Це добре задокументовано і виконує роботу. Сподіваюся, це допоможе

— Рахіл051
джерело
2

Використовуючи відповідь Бредлі Ледерхольца, ось як я змусив це спрацювати для себе. Будь ласка, зверніться до відповіді Бредлі Ледерхольца, щоб отримати додаткові пояснення.

var app = express();
var server  = require('http').createServer(app);
var io = require('socket.io');
var cookieParse = require('cookie-parser')();
var passport = require('passport');
var passportInit = passport.initialize();
var passportSession = passport.session();
var session = require('express-session');
var mongoStore = require('connect-mongo')(session);
var mongoose = require('mongoose');
var sessionMiddleware = session({
  secret: 'some secret',
  key: 'express.sid',
  resave: true,
  httpOnly: true,
  secure: true,
  ephemeral: true,
  saveUninitialized: true,
  cookie: {},
  store:new mongoStore({
  mongooseConnection: mongoose.connection,
  db: 'mydb'
  });
});

app.use(sessionMiddleware);
io = io(server);
io.use(function(socket, next){
  socket.client.request.originalUrl = socket.client.request.url;
  cookieParse(socket.client.request, socket.client.request.res, next);
});

io.use(function(socket, next){
  socket.client.request.originalUrl = socket.client.request.url;
  sessionMiddleware(socket.client.request,   socket.client.request.res, next);
});

io.use(function(socket, next){
  passportInit(socket.client.request, socket.client.request.res, next);
});

io.use(function(socket, next){
  passportSession(socket.client.request, socket.client.request.res, next);
});

io.on('connection', function(socket){
  ...
});

... 
server.listen(8000);
— Алі
джерело
Працював у мене. Знайшов мого користувача в socket.request.user
— Мілазі
0

Я це якось вирішив, але це не ідеально. Не підтримує підписані файли cookie тощо. Я використовував функцію getcookie експрес-сесії . Модифікована функція така:

    io.use(function(socket, next) {
        var cookie = require("cookie");
        var signature = require('cookie-signature');
        var debug = function() {};
        var deprecate = function() {};

        function getcookie(req, name, secret) {
            var header = req.headers.cookie;
            var raw;
            var val;

            // read from cookie header
            if (header) {
                var cookies = cookie.parse(header);

                raw = cookies[name];

                if (raw) {
                    if (raw.substr(0, 2) === 's:') {
                        val = signature.unsign(raw.slice(2), secret);

                        if (val === false) {
                            debug('cookie signature invalid');
                            val = undefined;
                        }
                    } else {
                        debug('cookie unsigned')
                    }
                }
            }

            // back-compat read from cookieParser() signedCookies data
            if (!val && req.signedCookies) {
                val = req.signedCookies[name];

                if (val) {
                    deprecate('cookie should be available in req.headers.cookie');
                }
            }

            // back-compat read from cookieParser() cookies data
            if (!val && req.cookies) {
                raw = req.cookies[name];

                if (raw) {
                    if (raw.substr(0, 2) === 's:') {
                        val = signature.unsign(raw.slice(2), secret);

                        if (val) {
                            deprecate('cookie should be available in req.headers.cookie');
                        }

                        if (val === false) {
                            debug('cookie signature invalid');
                            val = undefined;
                        }
                    } else {
                        debug('cookie unsigned')
                    }
                }
            }

            return val;
        }

        var handshake = socket.handshake;
        if (handshake.headers.cookie) {
            var req = {};
            req.headers = {};
            req.headers.cookie = handshake.headers.cookie;
            var sessionId = getcookie(req, "connect.sid", mysecret);
            console.log(sessionId);
            myStore.get(sessionId, function(err, sess) {
                console.log(err);
                console.log(sess);
                if (!sess) {
                    next(new Error("No session"));
                } else {
                    console.log(sess);
                    socket.session = sess;
                    next();
                }
            });
        } else {
            next(new Error("Not even a cookie found"));
        }
    });

    // Session backend config
    var RedisStore = connectRedis(expressSession);
    var myStore = new RedisStore({
        client: redisClient
    });
    var session = expressSession({
        store: myStore,
        secret: mysecret,
        saveUninitialized: true,
        resave: true
    });
    app.use(session);
— Мустафа
джерело
0

Тепер оригінальна прийнята відповідь також не працює для мене. Так само, як @ Rahil051, я використовував модуль express-socket.io-session , і він все ще працює. Цей модуль використовує синтаксичний аналізатор cookie для синтаксичного аналізу ідентифікатора сеансу перед введенням проміжного програмного забезпечення експрес-сесії. Думаю, це відповідає @pootzko, @Mustafa та @ Kosar.

Я використовую ці модулі:

"dependencies": 
{
  "debug": "^2.6.1",
  "express": "^4.14.1",
  "express-session": "^1.15.1",
  "express-socket.io-session": "^1.3.2
  "socket.io": "^1.7.3"
}

перевірте дані в socket.handshake:

const debug = require('debug')('ws');
const sharedsession = require('express-socket.io-session');

module.exports = (server, session) => {
    const io = require('socket.io').listen(server);
    let connections = [];

    io.use(sharedsession(session, {
        autoSave: true,
    }));

    io.use(function (socket, next) {
        debug('check handshake %s', JSON.stringify(socket.handshake, null, 2));
        debug('check headers %s', JSON.stringify(socket.request.headers));
        debug('check socket.id %s', JSON.stringify(socket.id));
        next();
    });

    io.sockets.on('connection', (socket) => {
        connections.push(socket);
    });
};
— Пентатонічний
джерело
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.