web-dev-qa-db-ja.com

Socket.IO 1.xおよびExpress 4.xとセッションを共有する方法

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.jssessionexpresssocket.io
79
Mustafa

解決策は驚くほど簡単です。あまりよく文書化されていません。以下のような小さなアダプターを使用して、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);
190
Epeli

ちょうど1か月半前に私は同じ問題に対処し、その後、GitHubでホストされる完全に機能する デモアプリ と一緒にこのトピックについて広範な ブログ投稿 を書きました。ソリューションは express-session 、 cookie-parser および connect-redis に依存してすべてを結び付けます。 RESTとSocketsコンテキストの両方からセッションにアクセスして変更することができ、非常に便利です。

2つの重要な部分はミドルウェアのセットアップです。

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で表示でき、あなたはそれを使って何でもできます。

5
pootzko

express-socket.io-session

あなたの問題に対する既成のソリューションです。通常、socket.ioの終わりに作成されたセッションは、express.jsで作成されたセッションとは異なるsidを持ちます。

その事実を知る前に、解決策を見つけるために作業していたときに、少し奇妙なものを見つけました。 express.jsインスタンスから作成されたセッションはsocket.io側でアクセスできましたが、反対の場合は同じことができませんでした。そしてすぐに、sidを管理して問題を解決する必要があることを知りました。しかし、そのような問題に取り組むために書かれたパッケージはすでにありました。十分に文書化されており、仕事は完了しています。それが役に立てば幸い

3
Rahil051

Bradley Lederholzの答えを使用して、これは私がそれを自分のために働かせた方法です。詳細については、Bradley Lederholzの回答を参照してください。

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);
2
Ali

ちょっと解決しましたが、完璧ではありません。署名付きCookieなどはサポートしていません。 express-session の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
Mustafa

さて、元の受け入れられた答えは私にとっても機能しません。 @ Rahil051と同じように、 express-socket.io-session モジュールを使用しましたが、それでも動作します。このモジュールはcookie-parserを使用して、エクスプレスセッションミドルウェアに入る前にセッションIDを解析します。 @ 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);
    });
};
0
Pentatonic