# check-my-headers

> Fast and simple way to check any HTTP Headers

Latest version **0.1.2** (published 2022-04-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install check-my-headers
pnpm add check-my-headers
yarn add check-my-headers
bun add check-my-headers
```

Provides the command `check-my-headers`.

## 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.1.2 |
| Published | 2022-04-04 |
| First published | 2020-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 168.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 47 |
| Author | Ulises Gascón |
| Maintainers | ulisesgascon |
| Keywords | http, headers, security |

## Links

- npm: https://www.npmjs.com/package/check-my-headers
- Repository: https://github.com/UlisesGascon/check-my-headers
- Homepage: https://github.com/UlisesGascon/check-my-headers#readme
- Issues: https://github.com/UlisesGascon/check-my-headers/issues
- npm.io page: https://npm.io/package/check-my-headers

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [request](https://npm.io/package/request.md) 2.88.2
- [request-promise](https://npm.io/package/request-promise.md) 4.2.6

## Recent versions

- 0.1.2 (latest) — 2022-04-04
- 0.1.1 — 2020-02-23
- 0.1.0 — 2020-02-14
- 0.0.1 — 2020-02-10

## README

<p align="center"><h1 align="center">
  check-my-headers
</h1>

<p align="center">
  Fast and simple way to check any HTTP Headers
</p>

<p align="center">
  <a href="https://www.npmjs.org/package/check-my-headers"><img src="https://badgen.net/npm/v/check-my-headers" alt="npm version"/></a>
  <a href="https://www.npmjs.org/package/check-my-headers"><img src="https://badgen.net/npm/license/check-my-headers" alt="license"/></a>
  <a href="https://www.npmjs.org/package/check-my-headers"><img src="https://badgen.net/npm/dt/check-my-headers" alt="downloads"/></a>
  <a href="https://snyk.io/test/github/ulisesgascon/check-my-headers"><img src="https://snyk.io/test/github/ulisesgascon/check-my-headers/badge.svg" alt="Known Vulnerabilities"/></a>
</p>


<p align="center">
  <img src="./.github/screen.png" alt="Screenshot of npm module called is check my headers that in a aast and simple way check any HTTP Headers" />
</p>

<p align="center">
  Thanks <a href="https://github.com/lirantal">Liran Tal</a> and the amazing <a href="https://snyk.io">Snyk team</a> for your support 😊
</p>

</p>


# About

Fast and simple way to check any HTTP Headers

# Usage

## Command line

Using Node.js's `npx` to run a one-off scan of a website:

```bash
npx check-my-headers https://example.com 
```

The CLI will gracefully handle cases where the URL to scan is missing or wrong:

```bash
$ npx check-my-headers
👋  Welcome to check-my-headers@0.1.0
😬  Missing argument URL!
👉  Example: check-my-headers https://github.com/ulisesgascon/check-my-headers
```

## Module

Using `check-my-headers` in your project.

```js
const checkMyHeaders = require('check-my-headers')

checkMyHeaders("http://example.com")
.then(({ messages, headers, status }) => {
    console.log(`Status code: ${status}`)
    console.log(`Messages:`)
    console.log(messages)
    console.log("Current headers:")
    console.log(headers)
})
```

Output:
```
Status code: 200
Messages:
[
  { msg: 'Remove field: server', type: 'error' },
  { msg: 'Missing field: content-security-policy', type: 'error' },
  { msg: 'Missing field: referrer-policy', type: 'error' },
  { msg: 'Missing field: strict-transport-security', type: 'error' },
  { msg: 'Missing field: x-xss-protection', type: 'error' },
  { msg: 'Missing field: x-content-type-options', type: 'error' },
  { msg: 'Missing field: access-control-allow-origin', type: 'warn' },
  { msg: 'Missing field: access-control-allow-methods', type: 'warn' },
  { msg: 'Missing field: access-control-allow-headers', type: 'warn' },
  { msg: 'Missing field: link', type: 'warn' },
  { msg: 'Deprecated field: expires', type: 'warn' },
  { msg: 'Extra field: etag', type: 'info' },
  { msg: 'Extra field: last-modified', type: 'info' },
  { msg: 'Extra field: vary', type: 'info' },
  { msg: 'Extra field: x-cache', type: 'info' },
  { msg: 'Extra field: connection', type: 'info' }
]
Current headers:
{
  age: '534610',
  'cache-control': 'max-age=604800',
  'content-type': 'text/html; charset=UTF-8',
  date: 'Wed, 12 Feb 2020 19:37:45 GMT',
  etag: '"3147526947+ident"',
  expires: 'Wed, 19 Feb 2020 19:37:45 GMT',
  'last-modified': 'Thu, 17 Oct 2019 07:18:26 GMT',
  server: 'ECS (nyb/1D2A)',
  vary: 'Accept-Encoding',
  'x-cache': 'HIT',
  'content-length': '1256',
  connection: 'close'
}
```

## Docker

Use Docker Hub:

```bash
# Pull the image from Docker Hub:
docker pull ulisesgascon/check-my-headers:latest

# Run container:
docker run --rm -e SCAN_URL="https://www.github.com/" ulisesgascon/check-my-headers:latest
```

`SCAN_URL` is an environment variable and its value must be replaced with the desired URL during Docker run. Docker container will exit once the scan has been completed.

To build and run the container locally:

```bash
# Clone Repo:
git clone https://github.com/ulisesgascon/check-my-headers.git

# Change to repo's cloned directory:
cd check-my-headers

# Build Image locally:
docker build --no-cache -t ulisesgascon/check-my-headers:latest .

# Run container:
docker run --rm -e SCAN_URL="https://www.github.com/" ulisesgascon/check-my-headers:latest
```


# Install

You can install globally via:

```bash
npm install -g check-my-headers
```


# Test

You can run them:

```bash
npm run test:coverage
```

# Contributing

Please consult [CONTRIBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.

# Author

**check-my-headers** © [Ulises Gascón](https://github.com/ulisesgascon), Released under the [MIT](./LICENSE) License.

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