![](\"https://raw.githubusercontent.com/aftabmk/Cookie/master/image/cookie.jpg\")
\r\n \r\n
This package is used to create dynamic cookie value and authenticate the created cookie to prevent external tampering.This is simple and plain way to create advanced binaary based cookie with no effort.It primarly targeted for beginner coders.
\r\n\r\n## Installing\r\n\r\nUsing npm:\r\n\r\n```bash\r\n$ npm i @aftabmk/cookie\r\n```\r\n\r\nUsing bower:\r\n\r\n```bash\r\n$ bower install @aftabmk/cookie\r\n```\r\n\r\nUsing yarn:\r\n\r\n```bash\r\n$ yarn add @aftabmk/cookie\r\n```\r\n\r\nUsing pnpm:\r\n\r\n```bash\r\n$ pnpm add @aftabmk/cookie\r\n```\r\n\r\n## Documentation\r\n\r\n## Functions\r\n*setCookie*\r\n```ts\r\nconst cookie : setCookie(String,String,Number,Number)\r\n```\r\n*filterCookie*\r\n```ts\r\nconst bool : filterCookie(String,Number,String)\r\n```\r\n\r\n# Example\r\n# setCookie inputs\r\n*Name*\r\n```js\r\nconst cookie = setCookie('kizhissery','-',7,5)\r\n/*{\r\n cookie:'kizhissery-101010000.........\r\n here input is Kizhissery\r\n}*/\r\n```\r\n*Symbol*\r\n```js\r\nconst cookie = setCookie('kizhissery','=',7,20)\r\n/*{\r\n cookie:'kizhissery-101010000.........\r\n here input is Kizhissery\r\n}*/\r\n```\r\n*Key*\r\n```js\r\nconst cookie = setCookie('aftab','-',7,20)\r\n/*{\r\n cookie:'kizhissery-101010000.........\r\n here secret key is 7, it can be any +ve integer Only, decimal and -ve integer will not function\r\n}*/\r\n```\r\n*Repeat*\r\n```js\r\nconst cookie = setCookie('aftab','-',7,5)\r\n/*{\r\n cookie:'kizhissery-101010000.........\r\n here length of cookie detemined length here it is 5\r\n cookie:'kizhissery-101010000.........*4\r\n here length of cookie detemined length here it is 20, if you need bigger cookie value , should be more than 5 and less than 20 for optimal result\r\n}*/\r\n```\r\n*result*\r\n```js\r\nconst cookie = setCookie(name,symbol,key,length)\r\n/*{\r\n cookie:'kizhissery-101010000.........\r\n here length of cookie detemined length here it is 5\r\n cookie:'kizhissery-101010000.........*4\r\n here length of cookie detemined length here it is 20, if you need bigger cookie value , should be more than 5 and less than 20 for optimal result\r\n}*/\r\n```\r\n# filterCookie inputs\r\n\r\n*result*\r\n```js\r\nconst filter = filterCookie(name,key,cookie)\r\n/*{\r\n cookie is the the derived value of the above function \"setCookie\" which is passed to filter function.\r\n Note the name and key of setCookie must match the inputs of filterCookie.\r\n}*/\r\n```\r\n\r\n# Starter Code\r\n*example 1*\r\n```js\r\nconst { setCookie , filterCookie } = require('@aftabmk/cookie')\r\n\r\nconst cookie = setCookie('aftab','=',30,5)\r\nconst filter = filterCookie('aftab',30,cookie)\r\n\r\nconsole.log({cookie},{filter})\r\n```\r\n*example 2*\r\n```js\r\n// imports\r\nconst express = require(\"express\");\r\nconst cookieParser = require('cookie-parser')\r\nconst { setCookie , filterCookie } = require('@aftabmk/cookie');\r\n//setting up express\r\napp.use(ex.json())\r\napp.use(ex.urlencoded({ extended: true }))\r\n//auth\r\nfunction Auth(req, res, next)\r\n{\r\n if(!req.headers.cookie) return res.status(403).send('403 access forbidden')\r\n if(filterCookie('user',77,req.headers.cookie))\r\n // name was set to user and key to 77 at setCookie function\r\n // filterCookie return true\r\n // so it will lead to next() , if authentication fails it will send 403 to unauthorised api/json scrapper\r\n // for true return /api route and access the data from those route\r\n {\r\n next();return\r\n }\r\n else\r\n {\r\n res.status(401).send([{'status':401,'description':'Invalid certificate'}]);\r\n }\r\n}\r\n// the user in front end redirect to setCookie end point to initialise setCookie function to set cookie inside cookie-parser option\r\napp.get(`/setCookie`, async (req, res) => \r\n{ try \r\n { \r\n return res.status(202)\r\n .cookieParser( setCookie('user','=',77,20) , cookieOptions)\r\n // here name is user , symbol is '=' , secret key = 77 and length = 20\r\n // cookieOption { sameSite: 'strict', path: '/', expires: new Date(Date.now() + 900000), httpOnly: true }\r\n // IMPORTANT htmlonly to true\r\n .send('User cookie is set') \r\n } \r\n catch (err) \r\n { \r\n return res.status(500).json({ err: err.toString() }) \r\n } })\r\n\r\n// Express router import whereapi are stored hence we introduce Auth middleware , to prevent unwanted scrapers\r\napp.use('/api',Auth,api)\r\n\r\n\r\napp.listen(port, () => { console.log(`running on port http://localhost:5000`) })\r\n```","readmeFilename":"README.md"}