https://github.com/k4m4/cloudflare-detect

Detect whether a site is running behind Cloudflare.
https://github.com/k4m4/cloudflare-detect

cloudflare detection nodejs waf

Last synced: about 2 months ago
JSON representation

Detect whether a site is running behind Cloudflare.

• Host: GitHub
• URL: https://github.com/k4m4/cloudflare-detect
• Owner: k4m4
• License: mit
• Created: 2018-02-22T16:08:17.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T09:52:51.000Z (7 months ago)
• Last Synced: 2024-10-30T06:33:22.621Z (2 months ago)
• Topics: cloudflare, detection, nodejs, waf
• Language: JavaScript
• Homepage:
• Size: 255 KB
• Stars: 23
• Watchers: 4
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • License: license

Awesome Lists containing this project

• awesome-cloudflare - Detector - Detect whether a site is running behind Cloudflare. (DNS)
• awesome-cloudflare - Detector - Detect whether a site is running behind Cloudflare. (DNS)

README

        
# cloudflare-detect [![Last version](https://img.shields.io/github/tag/k4m4/cloudflare-detect.svg?style=flat-square)](https://www.npmjs.org/package/cloudflare-detect) [![NPM Status](https://img.shields.io/npm/dm/cloudflare-detect.svg?style=flat-square)](https://www.npmjs.org/package/cloudflare-detect) ![github actions status](https://github.com/k4m4/cloudflare-detect/actions/workflows/build_and_publish.yml/badge.svg)

Detect whether a site is running behind Cloudflare.

## Install

```shell

npm install --save cloudflare-detect

```

Note that versions > 2 of this package are ESM-only. Use 1.x for CommonJS support.

## Usage

```js

const cloudflareDetect = require('cloudflare-detect');

cloudflareDetect('nikolaskama.me').then(cf => {

	console.log(cf);

	//=> true

});

cloudflareDetect('google.com').then(cf => {

	console.log(cf);

	//=> false

});

```

## API

### cloudflareDetect(targets, [options])

Returns a `Promise` for a `boolean` which is `true` if any of the `targets` are running behind Cloudflare.

#### targets

Type: `string` `Array`

One or more targets to check. Can either be a full [URL](https://nodejs.org/api/url.html) like `https://hostname` or just `hostname`. When the protocol is missing from a target `http` is assumed.

#### options

##### timeout

Type: `number`

Timeout in milliseconds after which a request is considered failed. Default: `5000`.

## Credits

- [cloudflare-ip](https://github.com/danneu/cloudflare-ip) - a lot of the code for verifying that the host's IP address is within Cloudflare's range has been adapted from this repo (which doesn't seem to be maintained anymore) by [danneu](https://github.com/danneu).

- [is-reachable](https://github.com/sindresorhus/is-reachable) - some of the IP verification & DNS lookup code, as well as the format of the readme file, has been adapted from this repo by [sindresorhus](https://github.com/sindresorhus).

## Contributors

- [Michael Bianco](https://github.com/iloveitaly)

## License

MIT © [Nikolaos Kamarinakis](https://nikolaskama.me/)