Jak udostępniać sesje z Socket.IO 1.x i Express 4.x?

89

Jak mogę udostępnić sesję z Socket.io 1.0 i Express 4.x? Korzystam ze sklepu Redis, ale uważam, że nie powinno to mieć znaczenia. Wiem, że do przeglądania plików cookie i pobierania sesji muszę używać oprogramowania pośredniczącego, ale nie wiem jak. Szukałem, ale nie mogłem znaleźć żadnej działającej

    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 
— Mustafa
źródło

Odpowiedzi:

215

Rozwiązanie jest zaskakująco proste. Po prostu nie jest to dobrze udokumentowane. Możliwe jest również użycie oprogramowania pośredniego sesji ekspresowej jako oprogramowania pośredniczącego Socket.IO z małym adapterem, takim jak ten:

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

Oto pełny przykład z Express 4.x, Socket.IO 1.x i 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);
— Epeli
źródło
17
Czy możesz mi pomóc w rozwiązaniu? Dostaję tylko te dane {cookie: { path: '/', _expires: null, originalMaxAge: null, httpOnly: true, secure: true } }Ale jeśli wydrukuję sesję na moich trasach, otrzymam wszystkie zmienne sesji, które ustawiłem (nazwa użytkownika, identyfikator itp.)
— Bobby Shark
7
Powinno to całkowicie zostać dodane do ich dokumentów. Dokumentacja uwierzytelniająca jest super lekka, tak jak obecnie.
— Bret
4
to „działa” dla mnie, ale mój identyfikator sesji Express nie jest taki sam jak mój identyfikator sesji socket.io ... może i tak naprawdę nie chcę, aby były takie same?
— Alexander Mills,
4
To rozwiązanie działało świetnie! ... dopóki nie musiałem zapisać danych w sesji z poziomu socket.on (), w tym momencie stwierdzam, że jest to jedyny sposób. Czy jest sposób, aby działał w obie strony?
— iDVB
4
To działało świetnie z kilkoma modyfikacjami. Ale nie mogłem napisać do sesji z socket.io. Znalazłem pakiet NPM, który spełnia wszystkie moje potrzeby, a jego wdrożenie zajmuje mniej więcej tyle samo wysiłku, co ta odpowiedź. npmjs.com/package/express-socket.io-session
— Bacon Brad
6

Zaledwie półtora miesiąca temu poradziłem sobie z tym samym problemem, a potem napisałem obszerny wpis na blogu na ten temat, który idzie w parze z w pełni działającą aplikacją demonstracyjną hostowaną na GitHubie. Rozwiązanie opiera się na modułach Express-session , cookie-parser i connect-redis , aby wszystko powiązać. Umożliwia dostęp do sesji i modyfikowanie ich z kontekstu REST i Sockets, co jest całkiem przydatne.

Dwie kluczowe części to konfiguracja oprogramowania pośredniego: 

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

... i konfiguracja serwera 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();
        });
    });
});

Są one połączone z prostym modułem sessionService, który stworzyłem, który pozwala na wykonywanie podstawowych operacji z sesjami, a kod wygląda następująco:

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);
    }
};

Ponieważ do tego wszystkiego jest więcej kodu (np. Inicjalizacja modułów, praca z gniazdami i wywołania REST po stronie klienta i serwera), nie będę wklejać całego kodu tutaj, możesz go zobaczyć na GitHub i możesz z nim robić, co chcesz.

— pootzko
źródło
4

express-socket.io-session

to gotowe rozwiązanie Twojego problemu. Zwykle sesja utworzona na końcu socket.io ma inny identyfikator sid niż te utworzone w express.js

Zanim dowiedziałem się o tym, kiedy pracowałem nad tym, aby znaleźć rozwiązanie, znalazłem coś dziwnego. Sesje utworzone z instancji express.js były dostępne na końcu socket.io, ale to samo nie było możliwe w przypadku przeciwnego. Wkrótce dowiedziałem się, że muszę przejść przez zarządzanie sid, aby rozwiązać ten problem. Ale był już napisany pakiet, aby rozwiązać ten problem. Jest dobrze udokumentowany i spełnia swoje zadanie. Mam nadzieję, że to pomoże

— Rahil051
źródło
2

Korzystając z odpowiedzi Bradleya Lederholza, w ten sposób sprawiłem, że zadziałało dla mnie. Więcej wyjaśnień można znaleźć w odpowiedzi Bradleya Lederholza.

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);
— Ali
źródło
Pracował dla mnie. Znalazłem mojego użytkownika w socket.request.user
— Milazi
0

Trochę to rozwiązałem, ale nie jest doskonały. Nie obsługuje podpisanych plików cookie itp. Użyłem funkcji getcookie sesji ekspresowej. Zmodyfikowana funkcja jest następująca:

    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);
— Mustafa
źródło
0

Teraz oryginalna zaakceptowana odpowiedź też nie działa dla mnie. Tak samo jak @ Rahil051, użyłem modułu express-socket.io-session i nadal działa. Ten moduł używa analizatora plików cookie do analizowania identyfikatora sesji przed wejściem do oprogramowania pośredniczącego sesji ekspresowej. Myślę, że to silmiar dla odpowiedzi @pootzko, @Mustafa i @ Kosar.

Używam tych modułów:

"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"
}

sprawdź dane w 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);
    });
};
— Pentatonic
źródło
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.