{"id":31667568,"url":"https://github.com/dongss/koa-socketio-session","last_synced_at":"2025-10-08T00:13:17.713Z","repository":{"id":50756119,"uuid":"113261099","full_name":"Dongss/koa-socketio-session","owner":"Dongss","description":"A socket.io middleware to share session from Koa app.","archived":false,"fork":false,"pushed_at":"2023-02-03T00:39:11.000Z","size":1468,"stargazers_count":8,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-13T03:09:55.042Z","etag":null,"topics":["koa","middleware","session","socketio"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dongss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-06T03:00:12.000Z","updated_at":"2022-11-11T02:31:16.000Z","dependencies_parsed_at":"2023-01-31T20:31:14.501Z","dependency_job_id":null,"html_url":"https://github.com/Dongss/koa-socketio-session","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Dongss/koa-socketio-session","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dongss%2Fkoa-socketio-session","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dongss%2Fkoa-socketio-session/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dongss%2Fkoa-socketio-session/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dongss%2Fkoa-socketio-session/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dongss","download_url":"https://codeload.github.com/Dongss/koa-socketio-session/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dongss%2Fkoa-socketio-session/sbom","scorecard":{"id":41757,"data":{"date":"2025-08-11","repo":{"name":"github.com/Dongss/koa-socketio-session","commit":"ed82a4706011e3ca9c5a9b90c89942774f131301"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/8 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"86 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-p9w8-2mpq-49h9","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-675m-85rw-j3w4","Warn: Project is vulnerable to: GHSA-593f-38f6-jp5m","Warn: Project is vulnerable to: GHSA-x2rg-q646-7m2v","Warn: Project is vulnerable to: GHSA-jgmv-j7ww-jx2x","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-2m96-9w4j-wgv7","Warn: Project is vulnerable to: GHSA-h726-x36v-rx45","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc","Warn: Project is vulnerable to: GHSA-xgh6-85xh-479p","Warn: Project is vulnerable to: GHSA-6fx8-h7jm-663j","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj","Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T21:44:06.309Z","repository_id":50756119,"created_at":"2025-08-14T21:44:06.309Z","updated_at":"2025-08-14T21:44:06.309Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278867267,"owners_count":26059743,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["koa","middleware","session","socketio"],"created_at":"2025-10-08T00:13:15.949Z","updated_at":"2025-10-08T00:13:17.708Z","avatar_url":"https://github.com/Dongss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# koa-socketio-session\n\n[![Build Status](https://travis-ci.org/Dongss/koa-socketio-session.svg?branch=master)](https://travis-ci.org/Dongss/koa-socketio-session)\n[![Coverage Status](https://coveralls.io/repos/github/Dongss/koa-socketio-session/badge.svg?branch=master)](https://coveralls.io/github/Dongss/koa-socketio-session?branch=master)\n[![Dependency Status](https://dependencyci.com/github/Dongss/koa-socketio-session/badge)](https://dependencyci.com/github/Dongss/koa-socketio-session)\n\n\nA [socket.io](https://socket.io/docs/) middleware to share session from Koa app.\n\nGet koa app session by: `let mySession = socket.session;`\n\n## Require\n\n* Koa2\n* Node 7.6 or greater for async/await support\n\n## Supported Koa session middlewares\n\n* [koa-session](https://github.com/koajs/session)\n* [koa-generic-session](https://github.com/koajs/generic-session)\n* [koa-session2](https://github.com/Secbone/koa-session2)\n\n## Install\n\n`npm install koa-socketio-session --save`\n\n## Usage\n\n### koa-session\n\n[koa-session](https://github.com/koajs/session)\n\nNotice:\n\nIf you are using koa-session \u003e= 6.0.0, you must pass `key` option. [koa-session 6.x issue](https://github.com/koajs/session#notice)\n\n`const koaSocketioSession = require('koa-socketio-session').HandleKoaSession;`\n\nkoaSocketioSession(app, opt)\n\n* opt, see [koa-session options](https://github.com/koajs/session#options), `store` is required in opt\n\n[example](https://github.com/Dongss/koa-socketio-session/tree/master/examples/koa-session.example.js)\n\n```\nconst Koa = require('koa');\nconst session = require('koa-session');\nconst koaSocketioSession = require('koa-socketio-session').HandleKoaSession;\nconst app = new Koa();\n\n// session store\nclass Store {\n    async get(sid) {\n        // ...\n    }\n\n    async set(sid =  this.getID(24), session, maxAge) {\n        // ...\n    }\n\n    destroy(sid) {\n        // ...\n    }\n}\n\napp.keys = ['koa2', 'socketio', 'koa-session'];\n\nconst sessionOpt = {\n    store: new Store(),\n    key: '4lKSd^Qma*3',\n};\napp.use(session(sessionOpt, app));\n\nconst server = app.listen(3000, () =\u003e {\n    console.log('server listen on 3000');\n});\n\nconst io = require('socket.io')(server, {\n    path: '/websocket',\n    cookie: true\n});\n\nio.use(koaSocketioSession(app, sessionOpt));\n\nio.use((socket, next) =\u003e {\n    let s = socket.session;\n    if (!s || !s.logined) {\n        return next(new Error('unauthorized'));\n    }\n    return next();\n});\n\nio.on('connection', (socket) =\u003e {\n    let s = socket.session;\n    console.log(s);\n    socket.use((p, next) =\u003e {\n        let s = socket.session;\n        if (!s || !s.logined) {\n            return next(new Error('unauthorized'));\n        }\n        return next();\n    });\n});\n\n```\n\n### koa-generic-session\n\n[koa-generic-session](https://github.com/koajs/generic-session)\n\n`const koaSocketioSession = require('koa-socketio-session').HandleKoaGenericSession;`\n\nkoaSocketioSession(app, opt)\n\n* opt, see [koa-generic-session options](https://github.com/koajs/generic-session#options), `store` is required in opt\n\n[example](https://github.com/Dongss/koa-socketio-session/tree/master/examples/koa-generic-session.example.js)\n\n```\nconst Koa = require('koa');\nconst session = require('koa-generic-session');\n// const Store = require('koa-generic-session/lib/memory_store');\nconst redisStore = require('koa-redis');\nconst koaSocketioSession = require('koa-socketio-session').HandleKoaGenericSession;\n\nconst app = new Koa();\n\napp.keys = ['koa2', 'socketio', 'koa-generic-session'];\n\nconst sessionOpt = {\n    store: new redisStore(),\n    key: '4lKSd^Qma*3',\n};\n\napp.use(session(sessionOpt));\n\nconst server = app.listen(3000, () =\u003e {\n    console.log('server listen on 3000');\n});\n\nconst io = require('socket.io')(server, {\n    path: '/websocket',\n    cookie: true\n});\n\nio.use(koaSocketioSession(app, sessionOpt));\n\nio.use((socket, next) =\u003e {\n    let s = socket.session;\n    if (!s || !s.logined) {\n        return next(new Error('unauthorized'));\n    }\n    return next();\n});\n\nio.on('connection', (socket) =\u003e {\n    let s = socket.session;\n    console.log(s);\n    socket.use((p, next) =\u003e {\n        let s = socket.session;\n        if (!s || !s.logined) {\n            return next(new Error('unauthorized'));\n        }\n        return next();\n    });\n});\n\n```\n\n### koa-session2\n\n[koa-session2](https://github.com/Secbone/koa-session2)\n\n`const koaSocketioSession = require('koa-socketio-session').HandleKoaSession2;`\n\nkoaSocketioSession(app, store, key)\n\n* opt, see [koa-session2 options](https://github.com/Secbone/koa-session2#options), `store` is required in opt\n\n[example](https://github.com/Dongss/koa-socketio-session/tree/master/examples/koa-session2.example.js)\n\n```\nconst Koa = require('koa');\nconst session = require('koa-session2');\nconst koaSocketioSession = require('koa-socketio-session').HandleKoaSession2;\nconst app = new Koa();\n\n// session store\nclass Store {\n    constructor() {\n    }\n\n    async get(sid) {\n        // ...\n    }\n\n    async set(session, { sid =  this.getID(24), maxAge } = {}) {\n        // ...\n    }\n\n    destroy(sid) {\n        // ...\n    }\n}\n\napp.keys = ['koa2', 'socketio', 'koa-session2'];\n\nconst sessionOpt = {\n    store: new Store(),\n    key: '4lKSd^Qma*3',\n};\napp.use(session(sessionOpt));\n\nconst server = app.listen(3000, () =\u003e {\n    console.log('server listen on 3000');\n});\n\nconst io = require('socket.io')(server, {\n    path: '/websocket',\n    cookie: true\n});\n\nio.use(koaSocketioSession(app, sessionOpt));\n\nio.use((socket, next) =\u003e {\n    let s = socket.session;\n    if (!s || !s.logined) {\n        return next(new Error('unauthorized'));\n    }\n    return next();\n});\n\nio.on('connection', (socket) =\u003e {\n    let s = socket.session;\n    console.log(s);\n    socket.use((p, next) =\u003e {\n        let s = socket.session;\n        if (!s || !s.logined) {\n            return next(new Error('unauthorized'));\n        }\n        return next();\n    });\n});\n```\n\n## Test\n\n`npm test`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdongss%2Fkoa-socketio-session","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdongss%2Fkoa-socketio-session","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdongss%2Fkoa-socketio-session/lists"}