{"id":15364199,"url":"https://github.com/posquit0/node-identif","last_synced_at":"2025-04-15T07:31:11.746Z","repository":{"id":57271185,"uuid":"89081789","full_name":"posquit0/node-identif","owner":"posquit0","description":":key: Helper class to verify one's identity via personal channels(SMS, Phone, E-Mail and more!)","archived":false,"fork":false,"pushed_at":"2020-05-30T04:09:43.000Z","size":108,"stargazers_count":26,"open_issues_count":12,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-12T06:42:01.529Z","etag":null,"topics":["2fa","authentication","email","email-verification","identification","identify","identity","phone","sms","sms-verification","verification"],"latest_commit_sha":null,"homepage":"","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/posquit0.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-04-22T16:00:01.000Z","updated_at":"2023-09-08T17:24:01.000Z","dependencies_parsed_at":"2022-09-01T00:22:04.151Z","dependency_job_id":null,"html_url":"https://github.com/posquit0/node-identif","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posquit0%2Fnode-identif","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posquit0%2Fnode-identif/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posquit0%2Fnode-identif/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/posquit0%2Fnode-identif/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/posquit0","download_url":"https://codeload.github.com/posquit0/node-identif/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249026734,"owners_count":21200499,"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","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":["2fa","authentication","email","email-verification","identification","identify","identity","phone","sms","sms-verification","verification"],"created_at":"2024-10-01T13:10:34.324Z","updated_at":"2025-04-15T07:31:09.456Z","avatar_url":"https://github.com/posquit0.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/posquit0/node-identif\" title=\"Identif.js\"\u003e\n    \u003cimg alt=\"Identif.js\" src=\"http://www.discoveringidentity.com/resources/WindowsLiveWriter_IdentityTrend9IdentityAnalytics_A52A_image3.png\" width=\"240px\" /\u003e\n  \u003c/a\u003e\n  \u003cbr /\u003e\n  \u003ch1\u003eIdentif\u003c/h1\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  A Helper to verify one's identity via personal channels\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://circleci.com/gh/posquit0/node-identif\"\u003e\n    \u003cimg alt=\"CircleCI\" src=\"https://circleci.com/gh/posquit0/node-identif.svg?style=shield\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://coveralls.io/github/posquit0/node-identif\"\u003e\n    \u003cimg src=\"https://coveralls.io/repos/github/posquit0/node-identif/badge.svg\" alt='Coverage Status' /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://badge.fury.io/js/identif\"\u003e\n    \u003cimg alt=\"npm version\" src=\"https://badge.fury.io/js/identif.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/identif\"\u003e\n    \u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dt/identif.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://david-dm.org/posquit0/node-identif\"\u003e\n    \u003cimg alt=\"npm\" src=\"https://img.shields.io/david/posquit0/node-identif.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/mit-license.php\"\u003e\n    \u003cimg alt=\"MIT Licence\" src=\"https://badges.frapsoft.com/os/mit/mit.svg?v=103\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/ellerbrock/open-source-badge/\"\u003e\n    \u003cimg alt=\"Open Source Love\" src=\"https://badges.frapsoft.com/os/v1/open-source.svg?v=103\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n**Identif** is an abstract helper class to easily implement the identity verification logic via personal channels like SMS, Phone, E-Mail, and more.\n\n- It was written for use on [**CARPLAT**](https://carplat.co.kr) which is the platform service for the car rental.\n\n\n## Installation\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/posquit0/node-identif.svg)](https://greenkeeper.io/)\n\n```bash\n# NPM\n$ npm install --save identif\n# Yarn\n$ yarn add identif\n```\n\n### Dependencies\n\n- [**Redis**](https://redis.io): if you use `RedisStore`, the connection to redis server is required.\n\n\n## Usage\n\n```node\nconst { Identif, RedisStore } = require('identif');\n\n// Create an instance of Identif with RedisStore\nconst identif = new Identif({\n  store: new RedisStore({\n    redis: { host: 'my.redis.com', port: 6379 },\n    ttl: 3 * 60\n  })\n});\n\n// Request the verification\nconst { requestId, code, createdAt } = await identif.request();\n/*\nOutput\n{\n  requestId: 'e89c3600-6ac7-469e-8d7e-e6e7847b346d',\n  code: '1274',\n  createdAt: '2017-04-23T14:47:24.173Z'\n}\n*/\n\n// Respond to the client including `requestId`, `createdAt`\n// Send `code` via a personal secure channel like SMS, E-Mail\n\n// Verify the request\nconst data = await identif.verify(requestId, code);\nif (!data) {\n  // Failed to verify one's identity\n} else {\n  // Verifed one's identity\n}\n```\n\n\n## API\n\n### Identif([options])\n\n#### Methods\n\n* `request([extra])`\n* `verify(requestId, code)`\n\n### MemoryStore()\n\n#### Methods\n\n* `get(key)`\n* `set(key, data)`\n\n### RedisStore([options])\n\n#### Methods\n\n* `get(key)`\n* `set(key, data)`\n\n\n## Contributing\n\nThis project follows the [**Contributor Covenant**](http://contributor-covenant.org/version/1/4/) Code of Conduct.\n\n#### Bug Reports \u0026 Feature Requests\n\nPlease use the [issue tracker](https://github.com/posquit0/node-identif/issues) to report any bugs or ask feature requests.\n\n\n## Self Promotion\n\nLike node-identif? Follow the repository on [GitHub](https://github.com/posquit0/node-identif). And if you're feeling especially charitable, follow [posquit0](https://posquit0.com) on [GitHub](https://github.com/posquit0).\n\n\n## Contact\n\nIf you have any questions, feel free to join me at [`#posquit0` on Freenode](irc://irc.freenode.net/posquit0) and ask away. Click [here](https://kiwiirc.com/client/irc.freenode.net/posquit0) to connect.\n\n\n## License\n\nProvided under the terms of the [MIT License](https://github.com/posquit0/node-identif/blob/master/LICENSE).\n\nCopyright © 2017-2018, [Byungjin Park](http://www.posquit0.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposquit0%2Fnode-identif","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fposquit0%2Fnode-identif","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fposquit0%2Fnode-identif/lists"}