# @gradebook/trusted-request

> Express middleware to limit requests to trusted IPs

Latest version **0.2.1** (published 2024-01-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gradebook/trusted-request
pnpm add @gradebook/trusted-request
yarn add @gradebook/trusted-request
bun add @gradebook/trusted-request
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2024-01-02 |
| First published | 2020-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Vikas Potluri |
| Maintainers | vikaspotluri123, joshcos97 |

## Links

- npm: https://www.npmjs.com/package/@gradebook/trusted-request
- Repository: https://github.com/gradebook/utils
- Homepage: https://github.com/gradebook/utils/tree/master/packages/trusted-request#readme
- Issues: https://github.com/gradebook/utils/issues
- npm.io page: https://npm.io/package/@gradebook/trusted-request

## Recent versions

- 0.2.1 (latest) — 2024-01-02
- 0.1.0 — 2020-03-02

## README

# `@gradebook/trusted-request`

> Express middleware to limit requests to trusted IPs

## Usage

```js
import express from 'express';
import {allowTrustedIps} from '@gradebook/trusted-request';

const onlyTrustedIps = allowTrustedIps({
	trustProxy: true,
	trustedIps: ['127.0.0.1', '192.168.124.131'] // Only allow requests from loopback and (e.g.) the parent node
});

const app = express();

app.use('/api', apiRouter);
// trusted-request DOES NOT handle authentication or authorization
app.use('/admin', onlyTrustedIps, user.isAuthenticated, adminRouter);
```

## API Reference

```ts
import {allowTrustedIps, TrustedRequestError} from '@gradebook/trusted-request';
```

If a request is not trusted, `trustedRequest` will call `next(new TrustedRequestError)`.

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