session/index.js at master · ExpressoJava/session · GitHub

History

669 lines (540 loc) · 15.5 KB

Raw

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

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

/*!

* express-session

* MIT Licensed

'use strict';

/**

* Module dependencies.

* @private

var Buffer = require('safe-buffer').Buffer

var cookie = require('cookie');

var crypto = require('crypto')

var debug = require('debug')('express-session');

var deprecate = require('depd')('express-session');

var onHeaders = require('on-headers')

var parseUrl = require('parseurl');

var signature = require('cookie-signature')

var uid = require('uid-safe').sync

var Cookie = require('./session/cookie')

var MemoryStore = require('./session/memory')

var Session = require('./session/session')

var Store = require('./session/store')

// environment

var env = process.env.NODE_ENV;

/**

* Expose the middleware.

exports = module.exports = session;

/**

* Expose constructors.

exports.Store = Store;

exports.Cookie = Cookie;

exports.Session = Session;

exports.MemoryStore = MemoryStore;

/**

* Warning message for `MemoryStore` usage in production.

* @private

var warning = 'Warning: connect.session() MemoryStore is not\n'

+ 'designed for a production environment, as it will leak\n'

+ 'memory, and will not scale past a single process.';

/**

* Node.js 0.8+ async implementation.

* @private

/* istanbul ignore next */

var defer = typeof setImmediate === 'function'

? setImmediate

: function(fn){ process.nextTick(fn.bind.apply(fn, arguments)) }

/**

* Setup session store with the given `options`.

* @param {Object} [options]

* @param {Object} [options.cookie] Options for cookie

* @param {Function} [options.genid]

* @param {String} [options.name=connect.sid] Session ID cookie name

* @param {Boolean} [options.proxy]

* @param {Boolean} [options.resave] Resave unmodified sessions back to the store

* @param {Boolean} [options.rolling] Enable/disable rolling session expiration

* @param {Boolean} [options.saveUninitialized] Save uninitialized sessions to the store

* @param {String|Array} [options.secret] Secret for signing session ID

* @param {Object} [options.store=MemoryStore] Session store

* @param {String} [options.unset]

* @return {Function} middleware

* @public

function session(options) {

var opts = options || {}

// get the cookie options

var cookieOptions = opts.cookie || {}

// get the session id generate function

var generateId = opts.genid || generateSessionId

// get the session cookie name

var name = opts.name || opts.key || 'connect.sid'

// get the session store

var store = opts.store || new MemoryStore()

// get the trust proxy setting

var trustProxy = opts.proxy

// get the resave session option

var resaveSession = opts.resave;

// get the rolling session option

var rollingSessions = Boolean(opts.rolling)

// get the save uninitialized session option

var saveUninitializedSession = opts.saveUninitialized

// get the cookie signing secret

var secret = opts.secret

if (typeof generateId !== 'function') {

throw new TypeError('genid option must be a function');

}

if (resaveSession === undefined) {

deprecate('undefined resave option; provide resave option');

resaveSession = true;

}

if (saveUninitializedSession === undefined) {

deprecate('undefined saveUninitialized option; provide saveUninitialized option');

saveUninitializedSession = true;

}

if (opts.unset && opts.unset !== 'destroy' && opts.unset !== 'keep') {

throw new TypeError('unset option must be "destroy" or "keep"');

}

// TODO: switch to "destroy" on next major

var unsetDestroy = opts.unset === 'destroy'

if (Array.isArray(secret) && secret.length === 0) {

throw new TypeError('secret option array must contain one or more strings');

}

if (secret && !Array.isArray(secret)) {

secret = [secret];

}

if (!secret) {

deprecate('req.secret; provide secret option');

}

// notify user that this store is not

// meant for a production environment

/* istanbul ignore next: not tested */

if ('production' == env && store instanceof MemoryStore) {

console.warn(warning);

}

// generates the new session

store.generate = function(req){

req.sessionID = generateId(req);

req.session = new Session(req);

req.session.cookie = new Cookie(cookieOptions);

if (cookieOptions.secure === 'auto') {

req.session.cookie.secure = issecure(req, trustProxy);

}

};

var storeImplementsTouch = typeof store.touch === 'function';

// register event listeners for the store to track readiness

var storeReady = true

store.on('disconnect', function ondisconnect() {

storeReady = false

})

store.on('connect', function onconnect() {

storeReady = true

})

return function session(req, res, next) {

// self-awareness

if (req.session) {

next()

return

}

// Handle connection as if there is no session if

// the store has temporarily disconnected etc

if (!storeReady) {

debug('store is disconnected')

next()

return

}

// pathname mismatch

var originalPath = parseUrl.original(req).pathname || '/'

if (originalPath.indexOf(cookieOptions.path || '/') !== 0) return next();

// ensure a secret is available or bail

if (!secret && !req.secret) {

next(new Error('secret option required for sessions'));

return;

}

// backwards compatibility for signed cookies

// req.secret is passed from the cookie parser middleware

var secrets = secret || [req.secret];

var originalHash;

var originalId;

var savedHash;

var touched = false

// expose store

req.sessionStore = store;

// get the session ID from the cookie

var cookieId = req.sessionID = getcookie(req, name, secrets);

// set-cookie

onHeaders(res, function(){

if (!req.session) {

debug('no session');

return;

}

if (!shouldSetCookie(req)) {

return;

}

// only send secure cookies via https

if (req.session.cookie.secure && !issecure(req, trustProxy)) {

debug('not secured');

return;

}

if (!touched) {

// touch session

req.session.touch()

touched = true

}

// set cookie

setcookie(res, name, req.sessionID, secrets[0], req.session.cookie.data);

});

// proxy end() to commit the session

var _end = res.end;

var _write = res.write;

var ended = false;

res.end = function end(chunk, encoding) {

if (ended) {

return false;

}

ended = true;

var ret;

var sync = true;

function writeend() {

if (sync) {

ret = _end.call(res, chunk, encoding);

sync = false;

return;

}

_end.call(res);

}

function writetop() {

if (!sync) {

return ret;

}

if (chunk == null) {

ret = true;

return ret;

}

var contentLength = Number(res.getHeader('Content-Length'));

if (!isNaN(contentLength) && contentLength > 0) {

// measure chunk

chunk = !Buffer.isBuffer(chunk)

? Buffer.from(chunk, encoding)

: chunk;

encoding = undefined;

if (chunk.length !== 0) {

debug('split response');

ret = _write.call(res, chunk.slice(0, chunk.length - 1));

chunk = chunk.slice(chunk.length - 1, chunk.length);

return ret;

}

ret = _write.call(res, chunk, encoding);

sync = false;

return ret;

}

if (shouldDestroy(req)) {

// destroy session

debug('destroying');

store.destroy(req.sessionID, function ondestroy(err) {

if (err) {

defer(next, err);

}

debug('destroyed');

writeend();

});

return writetop();

}

// no session to save

if (!req.session) {

debug('no session');

return _end.call(res, chunk, encoding);

}

if (!touched) {

// touch session

req.session.touch()

touched = true

}

if (shouldSave(req)) {

req.session.save(function onsave(err) {

if (err) {

defer(next, err);

}

writeend();

});

return writetop();

} else if (storeImplementsTouch && shouldTouch(req)) {

// store implements touch method

debug('touching');

store.touch(req.sessionID, req.session, function ontouch(err) {

if (err) {

defer(next, err);

}

debug('touched');

writeend();

});

return writetop();

}

return _end.call(res, chunk, encoding);

};

// generate the session

function generate() {

store.generate(req);

originalId = req.sessionID;

originalHash = hash(req.session);

wrapmethods(req.session);

}

// wrap session methods

function wrapmethods(sess) {

var _reload = sess.reload

var _save = sess.save;

function reload(callback) {

debug('reloading %s', this.id)

_reload.call(this, function () {

wrapmethods(req.session)

callback.apply(this, arguments)

})

}

function save() {

debug('saving %s', this.id);

savedHash = hash(this);

_save.apply(this, arguments);

}

Object.defineProperty(sess, 'reload', {

configurable: true,

enumerable: false,

value: reload,

writable: true

})

Object.defineProperty(sess, 'save', {

configurable: true,

enumerable: false,

value: save,

writable: true

});

}

// check if session has been modified

function isModified(sess) {

return originalId !== sess.id || originalHash !== hash(sess);

}

// check if session has been saved

function isSaved(sess) {

return originalId === sess.id && savedHash === hash(sess);

}

// determine if session should be destroyed

function shouldDestroy(req) {

return req.sessionID && unsetDestroy && req.session == null;

}

// determine if session should be saved to store

function shouldSave(req) {

// cannot set cookie without a session ID

if (typeof req.sessionID !== 'string') {

debug('session ignored because of bogus req.sessionID %o', req.sessionID);

return false;

}

return !saveUninitializedSession && cookieId !== req.sessionID

? isModified(req.session)

: !isSaved(req.session)

}

// determine if session should be touched

function shouldTouch(req) {

// cannot set cookie without a session ID

if (typeof req.sessionID !== 'string') {

debug('session ignored because of bogus req.sessionID %o', req.sessionID);

return false;

}

return cookieId === req.sessionID && !shouldSave(req);

}

// determine if cookie should be set on response

function shouldSetCookie(req) {

// cannot set cookie without a session ID

if (typeof req.sessionID !== 'string') {

return false;

}

return cookieId != req.sessionID

? saveUninitializedSession || isModified(req.session)

: rollingSessions || req.session.cookie.expires != null && isModified(req.session);

}

// generate a session if the browser doesn't send a sessionID

if (!req.sessionID) {

debug('no SID sent, generating session');

generate();

next();

return;

}

// generate the session object

debug('fetching %s', req.sessionID);

store.get(req.sessionID, function(err, sess){

// error handling

if (err) {

debug('error %j', err);

if (err.code !== 'ENOENT') {

next(err);

return;

}

generate();

// no session

} else if (!sess) {

debug('no session found');

generate();

// populate req.session

} else {

debug('session found');

store.createSession(req, sess);

originalId = req.sessionID;

originalHash = hash(sess);

if (!resaveSession) {

savedHash = originalHash

}

wrapmethods(req.session);

}

next();

});

};

/**

* Generate a session ID for a new session.

* @return {String}

* @private

function generateSessionId(sess) {

return uid(24);

}

/**

* Get the session ID cookie from request.

* @return {string}

* @private

function getcookie(req, name, secrets) {

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 = unsigncookie(raw.slice(2), secrets);

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 = unsigncookie(raw.slice(2), secrets);

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;

}

/**

* Hash the given `sess` object omitting changes to `.cookie`.

* @param {Object} sess

* @return {String}

* @private

function hash(sess) {

// serialize

var str = JSON.stringify(sess, function (key, val) {

// ignore sess.cookie property

if (this === sess && key === 'cookie') {

return

}

return val

})

// hash

return crypto

.createHash('sha1')

.update(str, 'utf8')

.digest('hex')

}

/**

* Determine if request is secure.

* @param {Object} req

* @param {Boolean} [trustProxy]

* @return {Boolean}

* @private

function issecure(req, trustProxy) {

// socket is https server

if (req.connection && req.connection.encrypted) {

return true;

}

// do not trust proxy

if (trustProxy === false) {

return false;

}

// no explicit trust; try req.secure from express

if (trustProxy !== true) {

return req.secure === true

}

// read the proto from x-forwarded-proto header

var header = req.headers['x-forwarded-proto'] || '';

var index = header.indexOf(',');

var proto = index !== -1

? header.substr(0, index).toLowerCase().trim()

: header.toLowerCase().trim()

return proto === 'https';

}

/**

* Set cookie on response.

* @private

function setcookie(res, name, val, secret, options) {

var signed = 's:' + signature.sign(val, secret);

var data = cookie.serialize(name, signed, options);

debug('set-cookie %s', data);

var prev = res.getHeader('Set-Cookie') || []

var header = Array.isArray(prev) ? prev.concat(data) : [prev, data];

res.setHeader('Set-Cookie', header)

}

/**

* Verify and decode the given `val` with `secrets`.

* @param {String} val

* @param {Array} secrets

* @returns {String|Boolean}

* @private

function unsigncookie(val, secrets) {

for (var i = 0; i < secrets.length; i++) {

var result = signature.unsign(val, secrets[i]);

if (result !== false) {

return result;

}

return false;

}

session/index.js at master · ExpressoJava/session · GitHub

Expand file tree

Breadcrumbs

index.js

Latest commit

History

Breadcrumbs

index.js

File metadata and controls