security-toolkit
Version:
A library for implementing multiples security measures in a nodejs application
152 lines (105 loc) • 6.26 kB
Markdown
<div align="center">
<img height="180" alt="SecToolkit's Logo" src="https://raw.githubusercontent.com/vmwavie/security-toolkit/main/.github/assets/security-toolkit.svg">
# Security Toolkit
Enjoying **Security Toolkit**? Give him a star to show your support 🌟
[](https://www.npmjs.com/package/security-toolkit)
[](https://www.npmjs.com/package/security-toolkit)
---
[Website](https://security-toolkit.xyz/)<span> • </span>[Documentation](https://security-toolkit.xyz/docs/intro)<span> • </span>[Npm](https://npmjs.com/package/security-toolkit)
</div>
> [!NOTE]
>
> [**Version 1**](https://github.com/vmwavie/security-toolkit) in testing phase 🧪
---
## Why does Security Toolkit exist?
💡 **Security Toolkit** is a package with the aim of solving your application's security problems, with all solutions concentrated in just one package.
</span><img width="16" height="16" alt="check" src="https://raw.githubusercontent.com/vmwavie/security-toolkit/main/.github/assets/check.svg"> Concentrates all solutions in just one package.<br />
</span><img width="16" height="16" alt="check" src="https://raw.githubusercontent.com/vmwavie/security-toolkit/main/.github/assets/check.svg"> Prevents future damage to your user base.<br />
</span><img width="16" height="16" alt="check" src="https://raw.githubusercontent.com/vmwavie/security-toolkit/main/.github/assets/check.svg"> Helps you find an intruder.<br />
</span><img width="16" height="16" alt="check" src="https://raw.githubusercontent.com/vmwavie/security-toolkit/main/.github/assets/check.svg"> Highly scalable on any architecture.<br />
---
## Quickstart
### <img width="16" height="16" alt="check" src="https://raw.githubusercontent.com/vmwavie/security-toolkit/main/.github/assets/check.svg"> Install
<table>
<tr>
<td width="225">
```bash
# Node.js
npm i -D security-toolkit
```
</td>
<td width="225">
```bash
# TypeScript (Node.js)
npm i -D security-toolkit
```
</td>
<td width="225">
```bash
# Bun
bun add -d security-toolkit
```
</td>
<td width="225">
```bash
# Deno (optional)
deno add npm:security-toolkit
```
</td>
</tr>
</table>
---
## Features
### <img width="16" height="16" alt="check" src="https://raw.githubusercontent.com/vmwavie/security-toolkit/main/.github/assets/check.svg"> Essentials
<table>
<tr>
<td width="280"><a href="https://security-toolkit.xyz/docs/documentation/authenticator/hotp">HOTP</a></td>
<td width="770">HMAC-Based One-Time Password (HOTP) implementation for secure authentication.</td>
</tr>
<tr>
<td width="280"><a href="https://security-toolkit.xyz/docs/documentation/authenticator/totp">TOTP</a></td>
<td width="770">Time-Based One-Time Password (TOTP) for enhanced two-factor authentication.</td>
</tr>
<tr>
<td width="280"><a href="https://security-toolkit.xyz/docs/documentation/checkers/validations">Validations</a></td>
<td width="770">Comprehensive validation tools, including email verification against extensive parameters and blacklists.</td>
</tr>
<tr>
<td width="280"><a href="https://security-toolkit.xyz/docs/documentation/loggers/device-data-logger">Device Logger</a></td>
<td width="770">Generate detailed logs of user devices, including geolocation, IP address, user agent, and other relevant information.</td>
</tr>
<tr>
<td width="280"><a href="https://security-toolkit.xyz/docs/documentation/loggers/trackers">Trackers</a></td>
<td width="770">IP tracking functionality using popular APIs in the market, such as ipinfo and others, for enhanced security monitoring.</td>
</tr>
<tr>
<td width="280"><a href="https://security-toolkit.xyz/docs/documentation/sanitization/fields-treatment">Field Treatment</a></td>
<td width="770">Implement backend masking and field encryption for secure data handling and storage.</td>
</tr>
<tr>
<td width="280"><a href="https://security-toolkit.xyz/docs/documentation/sanitization/fields-treatment">Input Sanitization</a></td>
<td width="770">Robust input sanitization to protect against malicious attacks such as SQL injection, XSS, and other common exploitation techniques, enhancing overall application security.</td>
</tr>
</table>
> _and much more_ 👇🏻
---
## Documentation and Examples
To see the detailed documentation, please visit the [**Documentation**](https://security-toolkit.xyz/docs/intro) section in the [**Security Toolkit**'s website](https://security-toolkit.xyz).
---
## Security Policy
[](https://github.com/vmwavie/security-toolkit/actions/workflows/cd_publish.yml?query=branch%3Amain)
Please check the [**SECURITY.md**](https://github.com/vmwavie/security-toolkit/blob/main/SECURITY.md).
---
## Contributing
See the [**Contributing Guide**](https://github.com/vmwavie/security-toolkit/blob/main/CONTRIBUTING.md) and please follow our [**Code of Conduct**](https://github.com/vmwavie/security-toolkit/blob/main/CODE_OF_CONDUCT.md) 🚀
---
## Acknowledgements
[](https://github.com/vmwavie/security-toolkit/graphs/contributors)
[](https://opencollective.com/security-toolkit/contributors.svg?button=false)
---
## License
**Security License** is under the [**MIT License**](https://github.com/vmwavie/security-toolkit/blob/main/LICENSE).<br />
Copyright © 2024-present [vmwavie](https://github.com/security-toolkit) and **Security Toolkit** [contributors](https://github.com/vmwavie/security-toolkit/graphs/contributors).
[node-version-url]: https://github.com/nodejs/node
[bun-version-url]: https://github.com/oven-sh/bun
[deno-version-url]: https://github.com/denoland/deno