fix: RFC6265 default cookie name

koajs · Apr 23, 2020 · d34fc8e · d34fc8e
1 parent 17b3280
commit d34fc8e
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 60 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules
 coverage
 *.log
+package-lock.json
diff --git a/Readme.md b/Readme.md
@@ -48,7 +48,7 @@ const app = new Koa();
 app.keys = ['some secret hurr'];
 
 const CONFIG = {
-  key: 'koa:sess', /** (string) cookie key (default is koa:sess) */
+  key: 'koa.sess', /** (string) cookie key (default is koa.sess) */
   /** (number || 'session') maxAge in ms (default is 1 days) */
   /** 'session' will result in a cookie that expires when session/browser is closed */
   /** Warning: If a session cookie is stolen, this cookie will never expire */
@@ -84,7 +84,7 @@ console.log('listening on port 3000');
 ### Options
 
   The cookie name is controlled by the `key` option, which defaults
-  to "koa:sess". All other options are passed to `ctx.cookies.get()` and
+  to "koa.sess". All other options are passed to `ctx.cookies.get()` and
   `ctx.cookies.set()` allowing you to control security, domain, path,
   and signing among other settings.
 

diff --git a/index.js b/index.js
@@ -13,7 +13,7 @@ const _CONTEXT_SESSION = Symbol('context#_contextSession');
 /**
  * Initialize session middleware with `opts`:
  *
- * - `key` session cookie name ["koa:sess"]
+ * - `key` session cookie name ["koa.sess"]
  * - all other options are passed as cookie options
  *
  * @param {Object} [opts]
@@ -60,7 +60,7 @@ module.exports = function(opts, app) {
 function formatOpts(opts) {
   opts = opts || {};
   // key
-  opts.key = opts.key || 'koa:sess';
+  opts.key = opts.key || 'koa.sess';
 
   // back-compat maxage
   if (!('maxAge' in opts)) opts.maxAge = opts.maxage;

diff --git a/test/contextstore.test.js b/test/contextstore.test.js
@@ -87,7 +87,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, (err, res) => {
           if (err) return done(err);
           cookie = res.header['set-cookie'].join(';');
@@ -107,7 +107,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, (err, res) => {
           if (err) return done(err);
           cookie = res.header['set-cookie'].join(';');
@@ -200,7 +200,7 @@ describe('Koa Session External Context Store', () => {
         request(app.listen())
         .get('/')
         .set('Cookie', cookie)
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, done);
       });
     });
@@ -218,7 +218,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, done);
       });
     });
@@ -253,7 +253,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, done);
       });
     });
@@ -285,7 +285,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect({ foo: 'bar' })
         .expect(200, done);
       });
@@ -302,7 +302,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect('1')
         .expect(200, done);
       });
@@ -319,7 +319,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect('true')
         .expect(200, done);
       });
@@ -336,7 +336,7 @@ describe('Koa Session External Context Store', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect('hello')
         .expect(200, done);
       });
@@ -371,7 +371,7 @@ describe('Koa Session External Context Store', () => {
 
       request(app.listen())
       .get('/')
-      .expect('Set-Cookie', /koa:sess/)
+      .expect('Set-Cookie', /koa\.sess/)
       .expect(401, done);
     });
   });
@@ -415,7 +415,7 @@ describe('Koa Session External Context Store', () => {
 
         request(server)
         .post('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .end(err => {
           if (err) return done(err);
         })
@@ -441,7 +441,7 @@ describe('Koa Session External Context Store', () => {
 
         request(server)
         .post('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .end((err, res) => {
           if (err) return done(err);
           const cookie = res.headers['set-cookie'].join(';');
@@ -463,7 +463,7 @@ describe('Koa Session External Context Store', () => {
 
         request(server)
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect('hi 1')
         .end((err, res) => {
           if (err) return done(err);
@@ -473,7 +473,7 @@ describe('Koa Session External Context Store', () => {
           request(server)
           .get('/')
           .set('cookie', cookie)
-          .expect('Set-Cookie', /koa:sess/)
+          .expect('Set-Cookie', /koa\.sess/)
           .expect('hi 2')
           .end((err, res) => {
             if (err) return done(err);
@@ -483,7 +483,7 @@ describe('Koa Session External Context Store', () => {
             request(server)
             .get('/')
             .set('cookie', cookie)
-            .expect('Set-Cookie', /koa:sess/)
+            .expect('Set-Cookie', /koa\.sess/)
             .expect('hi 3')
             .end((err, res) => {
               if (err) return done(err);
@@ -510,7 +510,7 @@ describe('Koa Session External Context Store', () => {
 
         request(server)
         .post('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .end((err, res) => {
           if (err) return done(err);
           const cookie = res.headers['set-cookie'].join(';');
@@ -539,7 +539,7 @@ describe('Koa Session External Context Store', () => {
 
         request(server)
         .post('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .end((err, res) => {
           if (err) return done(err);
           const cookie = res.headers['set-cookie'].join(';');
@@ -570,7 +570,7 @@ describe('Koa Session External Context Store', () => {
 
         request(server)
         .post('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .end((err, res) => {
           if (err) return done(err);
           const cookie = res.headers['set-cookie'].join(';');
@@ -655,7 +655,7 @@ describe('Koa Session External Context Store', () => {
 
       request(app.listen())
       .get('/')
-      .set('cookie', 'koa:sess=invalid-key')
+      .set('cookie', 'koa.sess=invalid-key')
       .expect('true')
       .expect(200, done);
     });
@@ -693,7 +693,7 @@ describe('Koa Session External Context Store', () => {
         should.not.exist(err);
         const data = res.body;
         const cookies = res.headers['set-cookie'].join(';');
-        cookies.should.containEql('koa:sess=');
+        cookies.should.containEql('koa.sess=');
 
         request(app.callback())
         .get('/')

diff --git a/test/cookie.test.js b/test/cookie.test.js
@@ -153,7 +153,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, (err, res) => {
           if (err) return done(err);
           cookie = res.header['set-cookie'].join(';');
@@ -245,7 +245,7 @@ describe('Koa Session Cookie', () => {
         request(app.listen())
         .get('/')
         .set('Cookie', cookie)
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(res => {
           const cookie = res.headers['set-cookie'];
           // samesite is not set
@@ -270,8 +270,8 @@ describe('Koa Session Cookie', () => {
 
       request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=; path=\/; expires=Thu, 01 Jan 1970 00:00:00 GMT/)
-        .expect('Set-Cookie', /koa:sess.sig=(.*); path=\/; expires=Thu, 01 Jan 1970 00:00:00 GMT/)
+        .expect('Set-Cookie', /koa\.sess=; path=\/; expires=Thu, 01 Jan 1970 00:00:00 GMT/)
+        .expect('Set-Cookie', /koa\.sess.sig=(.*); path=\/; expires=Thu, 01 Jan 1970 00:00:00 GMT/)
         .expect('true')
         .expect(200, done);
     });
@@ -291,7 +291,7 @@ describe('Koa Session Cookie', () => {
 
       request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=; path=\/; expires=Thu, 01 Jan 1970 00:00:00 GMT/)
+        .expect('Set-Cookie', /koa\.sess=; path=\/; expires=Thu, 01 Jan 1970 00:00:00 GMT/)
         .expect('true')
         .expect(200, done);
     });
@@ -309,7 +309,7 @@ describe('Koa Session Cookie', () => {
 
       request(app.listen())
       .get('/')
-      .expect('Set-Cookie', /koa:sess=;/)
+      .expect('Set-Cookie', /koa\.sess=;/)
       .expect('true')
       .expect(200, done);
     });
@@ -326,7 +326,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .set('cookie', 'koa:sess=invalid-session;')
+        .set('cookie', 'koa.sess=invalid-session;')
         .expect('true')
         .expect(200, done);
       });
@@ -347,8 +347,8 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .set('cookie', 'koa:sess=invalid-session;')
-        .expect('Set-Cookie', /koa:sess=;/)
+        .set('cookie', 'koa.sess=invalid-session;')
+        .expect('Set-Cookie', /koa\.sess=;/)
         .expect(500, done);
       });
     });
@@ -390,7 +390,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect({ foo: 'bar' })
         .expect(200, done);
       });
@@ -407,7 +407,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect('1')
         .expect(200, done);
       });
@@ -424,7 +424,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect('true')
         .expect(200, done);
       });
@@ -441,7 +441,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess=.+;/)
+        .expect('Set-Cookie', /koa\.sess=.+;/)
         .expect('hello')
         .expect(200, done);
       });
@@ -460,7 +460,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, done);
       });
     });
@@ -495,7 +495,7 @@ describe('Koa Session Cookie', () => {
 
         request(app.listen())
         .get('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .expect(200, done);
       });
     });
@@ -543,7 +543,7 @@ describe('Koa Session Cookie', () => {
 
       request(app.listen())
       .get('/')
-      .expect('Set-Cookie', /koa:sess/)
+      .expect('Set-Cookie', /koa\.sess/)
       .expect(401, done);
     });
   });
@@ -566,7 +566,7 @@ describe('Koa Session Cookie', () => {
 
         request(server)
         .post('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .end((err, res) => {
           if (err) return done(err);
           const cookie = res.headers['set-cookie'].join(';');
@@ -597,7 +597,7 @@ describe('Koa Session Cookie', () => {
 
         request(server)
         .post('/')
-        .expect('Set-Cookie', /koa:sess/)
+        .expect('Set-Cookie', /koa\.sess/)
         .end((err, res) => {
           if (err) return done(err);
           const cookie = res.headers['set-cookie'].join(';');
@@ -691,7 +691,7 @@ describe('Koa Session Cookie', () => {
       .expect(200, (err, res) => {
         should.not.exist(err);
         const cookies = res.headers['set-cookie'].join(';');
-        cookies.should.containEql('koa:sess=');
+        cookies.should.containEql('koa.sess=');
 
         request(app.callback())
         .get('/')
@@ -770,7 +770,7 @@ describe('Koa Session Cookie', () => {
         should.not.exist(err);
         const data = res.body;
         const cookies = res.headers['set-cookie'].join(';');
-        cookies.should.containEql('koa:sess=');
+        cookies.should.containEql('koa.sess=');
 
         request(app.callback())
         .get('/')