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

88

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 
— ムスタファ
ソース

回答:

213

解決策は驚くほど簡単です。十分に文書化されていないだけです。次のような小さなアダプターを使用して、Express Sessionミドルウェアを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);
— エペリ
ソース
16
あなたの解決策を手伝ってくれませんか？私はこのデータだけ{クッキーを取得する： { path: '/', _expires: null, originalMaxAge: null, httpOnly: true, secure: true } }しかし、私は私のルートでセッションを印刷する場合、私は私が設定したすべてのセッション変数（ユーザ名、ID、等。）を取得
— ボビー・シャーク
7
これは完全にドキュメントに追加されるはずです。現在のように、認証ドキュメントは非常に軽量です。
— 2015
4
これは「機能」しますが、ExpressセッションIDは、socket.ioセッションIDと同じではありません。
— Alexander Mills 2015年
4
この解決策は素晴らしいものでした！...その時点で、socket.on（）内からセッションにデータを保存する必要があるまで、その方法は1つしかないことがわかります。それを両方の方法で機能させる方法はありますか？
— iDVB 2015
4
これは2、3の変更でうまくいきました。しかし、socket.ioからセッションに書き込むことができませんでした。私はすべてのニーズを満たし、実装するためにこの回答とほぼ同じ努力をするNPMパッケージを見つけました。npmjs.com/package/express-socket.io-session
— ベーコンブラッド
6

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

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で確認できます。そして、あなたはそれであなたがやりたいことを何でもすることができます。

— pootzko
ソース
4

express-socket.io-session

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

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

— Rahil051
ソース
2

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);
— アリ
ソース
私のために働いた。私のユーザーをsocket.request.userで見つけました
— Milazi
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-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);
    });
};
— ペンタトニック
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.