CyberChef

# CyberChef

[![](https://github.com/gchq/CyberChef/workflows/Master%20Build,%20Test%20&%20Deploy/badge.svg)](https://github.com/gchq/CyberChef/actions?query=workflow%3A%22Master+Build%2C+Test+%26+Deploy%22)
[![npm](https://img.shields.io/npm/v/cyberchef.svg)](https://www.npmjs.com/package/cyberchef)
[![](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/gchq/CyberChef/blob/master/LICENSE)
[![Gitter](https://badges.gitter.im/gchq/CyberChef.svg)](https://gitter.im/gchq/CyberChef?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)


#### *The Cyber Swiss Army Knife*

CyberChef is a simple, intuitive web app for carrying out all manner of "cyber" operations within a web browser. These operations include simple encoding like XOR and Base64, more complex encryption like AES, DES and Blowfish, creating binary and hexdumps, compression and decompression of data, calculating hashes and checksums, IPv6 and X.509 parsing, changing character encodings, and much more.

The tool is designed to enable both technical and non-technical analysts to manipulate data in complex ways without having to deal with complex tools or algorithms. It was conceived, designed, built and incrementally improved by an analyst in their 10% innovation time over several years.

## Contents

- [Official website](#official-website)
- [Running Locally](#running-locally)
  - [With Docker](#with-docker)
  - [From source](#from-source)
- [How it works](#how-it-works)
- [Features](#features)
- [Deep linking](#deep-linking)
- [Browser support](#browser-support)
- [Node.js support](#nodejs-support)
- [Security](#security)
- [Contributing](#contributing)
- [Licencing](#licencing)

## Official website

[CyberChef's official website can be found here][1] - have fun!

## Running Locally

You can run CyberChef with Docker (no toolchain required) or build it from source with Node.js.

### With Docker

**Prerequisites**

- [Docker](https://www.docker.com/products/docker-desktop/)
  - Docker Desktop must be open and running on your machine


#### Option 1: Build the Docker Image Yourself

1. Build the docker image
```bash
docker build --tag cyberchef --ulimit nofile=10000 .
```
2. Run the docker container
```bash
docker run -it -p 8080:8080 cyberchef
```
3. Navigate to `http://localhost:8080` in your browser

#### Option 2: Use the pre-built Docker Image

If you prefer to skip the build process, you can use the pre-built image

```bash
docker run -it -p 8080:8080 ghcr.io/gchq/cyberchef:latest
```

Just like before, navigate to `http://localhost:8080` in your browser.

This image is built and published through our [GitHub Workflows](.github/workflows/releases.yml).

### From source

If you want to develop CyberChef or run it without Docker, you can build it directly with Node.js.

**Prerequisites**

- [Node.js](https://nodejs.org/) `v24` (see [Node.js support](#nodejs-support))


> [!NOTE] 

> You can use [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versio