{"id":32589190,"url":"https://github.com/deepexi/egg-authorization","last_synced_at":"2026-07-04T03:31:44.047Z","repository":{"id":57220308,"uuid":"205158144","full_name":"deepexi/egg-authorization","owner":"deepexi","description":"egg-authorization","archived":false,"fork":false,"pushed_at":"2020-07-13T22:35:38.000Z","size":25,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-12-13T05:08:44.486Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/deepexi.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","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":"2019-08-29T12:24:23.000Z","updated_at":"2019-09-25T08:55:07.000Z","dependencies_parsed_at":"2022-08-29T00:11:33.875Z","dependency_job_id":null,"html_url":"https://github.com/deepexi/egg-authorization","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/deepexi/egg-authorization","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepexi%2Fegg-authorization","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepexi%2Fegg-authorization/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepexi%2Fegg-authorization/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepexi%2Fegg-authorization/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepexi","download_url":"https://codeload.github.com/deepexi/egg-authorization/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepexi%2Fegg-authorization/sbom","scorecard":{"id":332005,"data":{"date":"2025-08-11","repo":{"name":"github.com/deepexi/egg-authorization","commit":"126619359733e5f96d13bf45799de1a5d4611611"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/9 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":"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":"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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"}}]},"last_synced_at":"2025-08-18T03:51:35.212Z","repository_id":57220308,"created_at":"2025-08-18T03:51:35.212Z","updated_at":"2025-08-18T03:51:35.212Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35109209,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-04T02:00:05.987Z","response_time":113,"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":[],"created_at":"2025-10-30T00:53:37.633Z","updated_at":"2026-07-04T03:31:44.041Z","avatar_url":"https://github.com/deepexi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# egg-authorization\n\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![Test coverage][codecov-image]][codecov-url]\n![npm](https://img.shields.io/npm/dw/@jackyhweng/egg-jwt)\n\n[npm-image]: https://img.shields.io/npm/v/egg-authorization.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/egg-authorization\n[travis-image]: https://img.shields.io/travis/deepexi/egg-authorization.svg?style=flat-square\n[travis-url]: https://travis-ci.org/deepexi/egg-authorization\n[codecov-image]: https://img.shields.io/codecov/c/gh/deepexi/egg-authorization.svg?style=flat-square\n[codecov-url]: https://codecov.io/gh/deepexi/egg-authorization\n[download-image]: https://img.shields.io/npm/dw/egg-authorization\n[download-url]: https://www.npmjs.com/package/egg-authorization\n\n\n\nEgg's authorization(JSON Web Token Authentication Plug)\n\n## Install\n\n```bash\n$ npm i egg-authorization --save\n\n```\n\n\n## Usage\n\n```js\n// {app_root}/config/plugin.js\nexports.auth = {\n  enable: true,\n  package: \"egg-authorization\"\n};\n```\n\n## Configuration\n\n```js\n// {app_root}/config/config.default.js\n'use strict';\n\nexports.auth = {\n  enable: true,\n  // 是使用什么认证\n  type: 'jwt',\n  // jwt配置\n  jwt: {\n    common: {\n      // 是否开启解析\n      enableParse: true,\n      // 是否开启验签\n      enableSignature: false,\n      // 是否开启错误处理\n      enableOnError: true,\n    },\n    generate: {\n      // 生成秘钥\n      secret: '123456',\n      // 有效时间\n      exp: 3600,\n    },\n    parse: {\n      // 需要解析 token 的位置\n      tokenPos: 'headers.authorization',\n      // 解析秘钥\n      secret: '123456',\n    },\n    // 用户自定义错误\n    onerror: {\n      // 解析错误的时候策略 \n      // ignore 忽略错误 \n      // exception 抛异常\n      // returnFormat 返回自定义的格式\n      strategy: 'returnFormat',\n      // 返回数据的格式，目前支持json 和 html\n      returnType: 'json',\n      json(ctx) {\n        ctx.body = { msg: 'Unauthorized' };\n        ctx.status = 401;\n      },\n      html(ctx) {\n        ctx.body = '\u003ch3\u003eUnauthorized\u003c/h3\u003e';\n        ctx.status = 410;\n      },\n    },\n  },\n\n};\n\n```\n\nsee [config/config.default.js](config/config.default.js) for more detail.\n\n## Example\n\n```javascript\n// app/router.js\n\"use strict\";\n\nmodule.exports = app =\u003e {\n  app.get('/login',app.controller.login.index);\n};\n```\n\n\n```js\n'use strict';\n\nmodule.exports = app =\u003e {\n  class LoginController extends app.Controller {\n    * index() {\n      console.log('login userInfo body : ', this.ctx.query.user);\n      this.ctx.body = this.ctx.query.user;\n    }\n  }\n  return LoginController;\n};\n\n\n```\n\nyou can use this way to get the token context \n\n```js\n\n// app/controller/test.js\n(\"use strict\");\n\nmodule.exports = app =\u003e {\n  class SuccessController extends app.Controller {\n    index() {\n        // get the token \n        const authorization = this.ctx.headers.authorization;\n        const data = this.ctx.auth.decode(authorization);\n        console.log(data);\n        this.ctx.body = data;\n    }\n  }\n  return SuccessController;\n};\n```\n\n\n## Questions \u0026 Suggestions\n\nPlease open an issue [here](https://github.com/eggjs/egg/issues).\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepexi%2Fegg-authorization","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepexi%2Fegg-authorization","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepexi%2Fegg-authorization/lists"}