# shieldfy

> Shieldfy Nodejs Runtime Agent

Latest version **0.0.3** (published 2019-09-01) · SCL license · 0 weekly downloads

## Install

```sh
npm install shieldfy
pnpm add shieldfy
yarn add shieldfy
bun add shieldfy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-09-01 |
| First published | 2019-07-03 |
| Weekly downloads | 0 |
| License | SCL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 32.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | amr_reda, netcode |

## Links

- npm: https://www.npmjs.com/package/shieldfy
- npm.io page: https://npm.io/package/shieldfy

## Dependencies (4)

- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [shimmer](https://npm.io/package/shimmer.md) ^1.2.1
- [is-serverless](https://npm.io/package/is-serverless.md) ^1.0.0
- [require-in-the-middle](https://npm.io/package/require-in-the-middle.md) ^4.0.0

## Recent versions

- 0.0.3 (latest) — 2019-09-01
- 0.0.2 — 2019-08-06
- 0.0.1 — 2019-07-03

## README

# Shieldfy NodeJs Runtime Agent [BETA]

This is the official Runtime Agent for Shieldfy (shieldfy.io) https://shieldfy.io

Shieldfy is a strong application protection platform that helps businesses to secure their applications online.

## Installation

1. You will first need to register on [shieldfy.io](https://shieldfy.io/) to get your APP Key.
2. install nodejs sdk package through NPM (recommanded)
    ```
    npm install shieldfy
    ```

## Usage

### open `index.js` or (main file) and type the following **on top of the file**

```js
const shieldfy = require('shieldfy')("<yourAppKey>");

//If you are using expressJs include our middleware before yours
app.use(shieldfy.expressMiddleware());
```

## Configurations

### OR you can pass config to the initialize

```js
const shieldfy = require('shieldfy')({
    appKey : "<yourAppKey>",
    debug : false,
    action: "block"
    interval : 10000
});

//If you are using expressJs include our middleware before yours
app.use(shieldfy.expressMiddleware());
```
- interval => the number of mille seconds which SDK should check our API every this interval of time for new vulenrable package.
- action => 
    - "block"
       - This is default mode in which if there exist attack on your application SDK will stop the attack and block it then report to the shieldfy dashboard.
    - "listen"
       - In this mode the SDK will not bloack any attack but it will still report this attacks to shieldfy dashboard. 


### NOTE: You should require Shieldfy in the main file at first before any other package or module in order to SDK work correctly.

    

## Testing

* Run the command into your terminal into root directory of this package
    ```bash
        npm test
    ```

## Contributing

Thank you for considering contributing to this project!
Bug reports, feature requests, and pull requests are very welcome.


## Security Vulnerabilities

If you discover a security vulnerability within this project, please send an e-mail to `security@shieldfy.com`.

---
_Source: https://npm.io/package/shieldfy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._