\n\n⚠️ **Warning: FunctionShield is no longer actively maintained and will unlikely be updated to have Node.js v12 support. [See #460](https://github.com/middyjs/middy/issues/460)** ⚠️\n\nHardens AWS Lambda execution environment:\n* By monitoring (or blocking) outbound network traffic to public internet, you can be certain that your data is never leaked (traffic to AWS services is not affected)\n* By disabling read/write operations on the /tmp/ directory, you make sure that files are not persisted across invocations. Storing data in `/tmp` is a bad practice as it may be leaked in subsequent invocations\n* By disabling the ability to launch child processes, you can make sure that no rogue processes are spawned without your knowledge by potentially malicious packages\n* By disabling the ability to read the function's (handler) source code through the file system, you can prevent handler source code leakage, which is oftentimes the first step in a serverless attack \n\nMore info:\n* https://www.puresec.io/function-shield\n* https://www.jeremydaly.com/serverless-security-with-functionshield/\n\n## Get a free token\n\nPlease visit: https://www.puresec.io/function-shield-token-form\n\n### Modes\n\n- `'block'` - Block and log to Cloudwatch Logs\n- `'alert'` - Allow and log to Cloudwatch Logs\n- `'allow'` - Allow\n\n### Options\n\n\n- `policy.outbound_connectivity` - `'block'/'alert'/'allow'` (default: `'block'`)\n- `policy.read_write_tmp` - `'block'/'alert'/'allow'` (default: `'block'`)\n- `policy.create_child_process` - `'block'/'alert'/'allow'` (default: `'block'`)\n- `policy.read_handler` - `'block'/'alert'/'allow'` (default: `'block'`)\n- `token` - By default looks for `FUNCTION_SHIELD_TOKEN` in `process.env` and `context`\n- `disable_analytics` - Periodically, during cold starts, FunctionShield sends basic analytics information to its backend. To disable analytics module set: `true`. (default: `false`)\n\n### Sample Usage\n\n```javascript\n'use strict';\n\nconst fs = require('fs');\nconst middy = require('middy');\nconst {ssm, functionShield} = require('middy/middlewares');\n\nasync function hello(event) {\n fs.openSync('/tmp/test', 'w');\n}\n\n\nconst handler = middy(hello)\n .use(ssm({\n cache: true,\n setToContext: true,\n names: {\n FUNCTION_SHIELD_TOKEN: 'function_shield_token'\n }\n }))\n .use(functionShield(\n {\n policy: {\n outbound_connectivity: 'alert'\n }\n }\n ));\n\nmodule.exports = {\n handler\n};\n```\n\n```\nSTART RequestId: f7b7305d-d785-11e8-baf1-9136b5c7aa75 Version: $LATEST\n[TOKEN VERIFICATION] license is OK\n{\"function_shield\":true,\"policy\":\"read_write_tmp\",\"details\":{\"path\":\"/tmp/test\"},\"mode\":\"block\"}\n2018-10-24 15:11:45.427 (+03:00) f7b7305d-d785-11e8-baf1-9136b5c7aa75 {\"errorMessage\":\"Unknown system error -999: Unknown system error -999, open '/tmp/test'\",\"errorType\":\"Error\",\"stackTrace\":[\"Object.fs.openSync (fs.js:646:18)\",\"Function.hello (/var/task/handler.js:8:6)\",\"runMiddlewares (/var/task/node_modules/middy/src/middy.js:180:42)\",\"runNext (/var/task/node_modules/middy/src/middy.js:85:14)\",\"before (/var/task/node_modules/middy/src/middlewares/functionShield.js:20:5)\",\"runNext (/var/task/node_modules/middy/src/middy.js:70:24)\",\"\",\"process._tickDomainCallback (internal/process/next_tick.js:228:7)\"]}\nEND RequestId: f7b7305d-d785-11e8-baf1-9136b5c7aa75\nREPORT RequestId: f7b7305d-d785-11e8-baf1-9136b5c7aa75 Duration: 458.65 ms Billed Duration: 500 ms Memory Size: 1024 MB Max Memory Used: 38 MB \n```\n\n## Middy documentation and examples\n\nFor more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).\n\n\n## Contributing\n\nEveryone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).\n\n\n## License\n\nLicensed under [MIT License](LICENSE). Copyright (c) 2017-2018 Luciano Mammino and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).\n\n\n \n\n","readmeFilename":"README.md"}
![\"Middy](\"https://raw.githubusercontent.com/middyjs/middy/master/img/middy-logo.png\"/){kind=logo}
\n![\"FOSSA](\"https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large\")
\n\n","readmeFilename":"README.md"}![\"npm](\"https://badge.fury.io/js/%40middy%2Ffunction-shield.svg\"){kind=icon}
\n ![\"Known](\"https://snyk.io/test/github/middyjs/middy/badge.svg\"){kind=icon}
\n ![\"Standard](\"https://img.shields.io/badge/code_style-standard-brightgreen.svg\"){kind=icon}
\n ![\"Greenkeeper](\"https://badges.greenkeeper.io/middyjs/middy.svg\")
\n ![\"Chat](\"https://badges.gitter.im/gitterHQ/gitter.svg\")
\n