index.js
5.17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/*!
* cookie-session
* Copyright(c) 2013 Jonathan Ong
* Copyright(c) 2014-2015 Douglas Christopher Wilson
* MIT Licensed
*/
'use strict'
/**
* Module dependencies.
* @private
*/
var debug = require('debug')('cookie-session');
var Cookies = require('cookies');
var onHeaders = require('on-headers');
/**
* Module exports.
* @public
*/
module.exports = cookieSession
/**
* Create a new cookie session middleware.
*
* @param {object} [options]
* @param {boolean} [options.httpOnly=true]
* @param {array} [options.keys]
* @param {string} [options.name=express:sess] Name of the cookie to use
* @param {boolean} [options.overwrite=true]
* @param {string} [options.secret]
* @param {boolean} [options.signed=true]
* @return {function} middleware
* @public
*/
function cookieSession(options) {
var opts = options || {}
// name - previously "opts.key"
var name = opts.name || opts.key || 'express:sess';
// secrets
var keys = opts.keys;
if (!keys && opts.secret) keys = [opts.secret];
// defaults
if (null == opts.overwrite) opts.overwrite = true;
if (null == opts.httpOnly) opts.httpOnly = true;
if (null == opts.signed) opts.signed = true;
if (!keys && opts.signed) throw new Error('.keys required.');
debug('session options %j', opts);
return function _cookieSession(req, res, next) {
var cookies = req.sessionCookies = new Cookies(req, res, {
keys: keys
});
var sess, json;
// to pass to Session()
req.sessionOptions = Object.create(opts)
req.sessionKey = name
req.__defineGetter__('session', function(){
// already retrieved
if (sess) return sess;
// unset
if (false === sess) return null;
json = cookies.get(name, req.sessionOptions)
if (json) {
debug('parse %s', json);
try {
sess = new Session(req, decode(json));
} catch (err) {
// backwards compatibility:
// create a new session if parsing fails.
// new Buffer(string, 'base64') does not seem to crash
// when `string` is not base64-encoded.
// but `JSON.parse(string)` will crash.
if (!(err instanceof SyntaxError)) throw err;
sess = new Session(req);
}
} else {
debug('new session');
sess = new Session(req);
}
return sess;
});
req.__defineSetter__('session', function(val){
if (null == val) return sess = false;
if ('object' == typeof val) return sess = new Session(req, val);
throw new Error('req.session can only be set as null or an object.');
});
onHeaders(res, function setHeaders() {
if (sess === undefined) {
// not accessed
return;
}
try {
if (sess === false) {
// remove
cookies.set(name, '', req.sessionOptions)
} else if (!json && !sess.length) {
// do nothing if new and not populated
} else if (sess.changed(json)) {
// save
sess.save();
}
} catch (e) {
debug('error saving session %s', e.message);
}
});
next();
}
};
/**
* Session model.
*
* @param {Context} ctx
* @param {Object} obj
* @private
*/
function Session(ctx, obj) {
this._ctx = ctx
Object.defineProperty(this, 'isNew', {
value: !obj
})
if (obj) {
for (var key in obj) {
this[key] = obj[key]
}
}
}
/**
* JSON representation of the session.
*
* @return {Object}
* @public
*/
Session.prototype.inspect =
Session.prototype.toJSON = function toJSON() {
var keys = Object.keys(this)
var obj = {}
for (var i = 0; i < keys.length; i++) {
var key = keys[i]
if (key[0] !== '_') {
obj[key] = this[key]
}
}
return obj
}
/**
* Check if the session has changed relative to the `prev`
* JSON value from the request.
*
* @param {String} [prev]
* @return {Boolean}
* @private
*/
Session.prototype.changed = function(prev){
if (!prev) return true;
this._json = encode(this);
return this._json != prev;
};
/**
* Return how many values there are in the session object.
* Used to see if it's "populated".
*
* @return {Number}
* @public
*/
Session.prototype.__defineGetter__('length', function(){
return Object.keys(this.toJSON()).length;
});
/**
* populated flag, which is just a boolean alias of .length.
*
* @return {Boolean}
* @public
*/
Session.prototype.__defineGetter__('populated', function(){
return !!this.length;
});
/**
* Save session changes by performing a Set-Cookie.
*
* @private
*/
Session.prototype.save = function(){
var ctx = this._ctx;
var json = this._json || encode(this);
var opts = ctx.sessionOptions;
var name = ctx.sessionKey;
debug('save %s', json);
ctx.sessionCookies.set(name, json, opts);
};
/**
* Decode the base64 cookie value to an object.
*
* @param {String} string
* @return {Object}
* @private
*/
function decode(string) {
var body = new Buffer(string, 'base64').toString('utf8');
return JSON.parse(body);
}
/**
* Encode an object into a base64-encoded JSON string.
*
* @param {Object} body
* @return {String}
* @private
*/
function encode(body) {
var str = JSON.stringify(body)
return new Buffer(str).toString('base64')
}