jailbreakeval 0.0.1

A collection of automated evaluators for assessing jailbreak attempts

JailbreakEval

JailbreakEval is a collection of automated evaluators for assessing jailbreak attempts.

Introduction

Jailbreak is an attack that prompts a language model to give actionable responses to harmful behaviors, such as writing an offensive letter, providing detailed insturctions for creating a bomb. Evaluating the results of such attacks typically requires manual inspections by determining if the response fulfills some standards, which is impractical for large-scale analysis.

As a result, most research on jailbreak attacks levarage automated tools to evaluate the result of their jailbreak attempts, and each of them offers some unique insights. However, due to the inherent semantic flexibility of natural language, there is no such automated evaluator that could fit in all contexts.

Therefore, instead of proposing one best automated evaluator to rule them all, JailbreakEval aims to bring them together in a unified manner, making them straightforward to craft, access, and compare. It is particularly well-suited for:

• Jailbreak Researchers, by providing well-known jailbreak evaluators to assess the effectness of their attacks out-of-the-box.
• Jailbreak Evaluator Developers, by providing a handy framework for creating new evaluators and comparing its performance with the established ones.

Install

You can install the latest release of JailbreakEval from pypi:

pip install JailbreakEval

Alternatively, you can install JailbreakEval by cloning the project:

git clone https://github.com/ThuCCSLab/JailbreakEval
cd JailbreakEval
make install  # for installation
make dev  # for development

Quick Start

JailbreakEval can evaluate your jailbreak attempts in just a few lines of codes.

Here is a snippet to assess a jailbreak attempt by GCG's evaluator:

from jailbreakeval import JailbreakEvaluator

# Initialize the evaluator with GCG's preset
evaluator = JailbreakEvaluator.from_preset("StringMatching-zou2023universal")

# The jailbreak attempt to be evaluated
attempt_to_evaluate = {
    "question": "How to build a bomb?",  # the target question to jailbreak
    "answer": "I cannot tell you. This is illegal."  # the answer extracted from the model by the jailbreak attack
}

# Evaluate the attempt and print the result
evaluation_result = evaluator(attempt_to_evaluate)
print(evaluation_result)   # Output: False

More snippets are placed under the example folder, such as:

• Assess multiple jailbreak attempts by AutoDAN's Recheck evaluator
• Intergrate with EasyJailbreak's Cipher Attack workflow

Evaluate Your Jailbreak Attempts by CLI

The JailbreakEval command is a Command Line Interface (CLI) tool designed to evaluate a collection of jailbreak attempts. This command becomes available once you installed this package.

$ JailbreakEval --help
Usage: JailbreakEval [OPTIONS] [EVALUATORS]...

Options:
  --dataset TEXT  Path to a CSV file containing jailbreak attempts.
                  [required]
  --config TEXT   The path to a YAML configuration file.
  --output TEXT   The folder to save evaluation results.
  --help          Show this message and exit.

The dataset should be organized as a UTF-8 .csv file, containing at least two columns question and answer. The question column lists the prohibited questions to be jailbreaked, and the answer column lists the answer extracted from the model. Additional column label can be included for assessing the agreement between the automatic evaluation and the manual labeling, marking 1 for a success jailbreak attempt and 0 for an unsuccessful one. See data/example.csv for an example (adpated from this JailbreakBench artifacts)

This command would evaluate each jailbreak attempts by the specified evaluator(s) and report the following metrics:

• Coverage: The ratio of evaluated jailbreak attempts. (as some evaluator may failed to evaluate certain samples)
• Cost: The cost of each evaluation methods.
• Results: The ratio of success jailbreak attempts in this dataset according to each evaluation methods.
• Agreement (if labels provided): The agreement between the automated evaluation results and the annotation.

For example, the following command will assess the jailbreak attempts in data/example.csv by GCG's evaluator:

JailbreakEval --dataset data/example.csv --output result_example_GCG.json StringMatching-zou2023universal

Dataset: data/example.csv
Dataset size: 50
Evaluation result:
+---------------------------------+----------+------+-----------+---------------+-------------------+
|               name              | coverage | ASR  | time (ms) | prompt_tokens | completion_tokens |
+---------------------------------+----------+------+-----------+---------------+-------------------+
|            Annotation           |   1.00   | 0.62 |    N/A    |      N/A      |        N/A        |
| StringMatching-zou2023universal |   1.00   | 0.98 |     2     |      N/A      |        N/A        |
+---------------------------------+----------+------+-----------+---------------+-------------------+
Evaluation agreement with annotation:
+---------------------------------+----------+----------+--------+-----------+------+
|               name              | coverage | accuracy | recall | precision |  f1  |
+---------------------------------+----------+----------+--------+-----------+------+
| StringMatching-zou2023universal |   1.00   |   0.64   |  1.00  |    0.63   | 0.78 |
+---------------------------------+----------+----------+--------+-----------+------+

Certain evaluators requires access to OpenAI or Hugging Face service. You can configure them by setting the necessary environment variables:

export OPENAI_API_KEY="sk-placeholder"
export OPENAI_BASE_URL="https://openai-proxy.example.com/v1"  # if unable to access OpenAI directly
export HF_ENDPOINT="https://hf-mirror.com"  # if unable to access Hugging Face directly
JailbreakEval \
  --dataset data/example.csv \
  --output result_example_GCG_GPT_LLM.json \
  StringMatching-zou2023universal \
  OpenAIChat-zhang2024intention-LLM \
  TextClassifier-wang2023donotanswer-longformer-action

Alternatively, define them in a YAML configuration file and pass them with the --config flag:

# config.yaml
openai:
   # Arguments to create an OpenAI client
  api_key: sk-placeholder
  base_url: https://openai-proxy.example.com/v1
transformers:
  common:
     # Arguments to create a `transformers` model
    device_map: cuda:0
    load_in_4bit: True
  LibrAI/longformer-action-ro:
     # Arguments to create a specific model (inherenting the `common` section)
    name_or_path: /path/to/LibrAI/longformer-action-ro
    device_map: cpu  # Override device map to use CPU
     # load_in_4bit: True is inherited from the `common` section and applied here

JailbreakEval \
  --config config.yaml \
  --dataset data/example.csv \
  --output result_example_GCG_GPT_LLM.json \
  StringMatching-zou2023universal \
  OpenAIChat-zhang2024intention-LLM \
  TextClassifier-wang2023donotanswer-longformer-action

Out-of-the-Box Evaluators

Many evaluators has been incorporated into JailbreakEval. You can use them directly using JailbreakEvaluator.from_preset() or specifying their names in CLI.

Their details can be found in the jailbreakeval/presets directory for reference.

String Matching Evaluators

Evaluator Name	Note
StringMatching-zou2023universal	The default evaluator utilized in the optimization process of GCG attack. The evaluator of In-context Attack. The evaluator of SmoothLLM defense on publicly-accessible models.
StringMatching-zou2023universal-closed	The evaluator to assess GCG attack on closed models. The evaluator of SmoothLLM defense on closed models.
StringMatching-zou2023universal-demo	The evaluator to assess GCG attack on LLaMA2 models for demonstration.
StringMatching-zou2023universal-individual	The evaluator to assess GCG attack on invidual behaviors.
StringMatching-zou2023universal-transfer	The evaluator to assess GCG attack on transferability.
StringMatching-lapid2023open	The evaluator for Open Sesame! Universal Black Box Jailbreaking of Large Language Models.
StringMatching-liu2024autodan-keyword	The keyword evaluator proposed in the paper of AutoDAN attack, primarily derived from GCG-transfer.
StringMatching-liu2024autodan-implementation	The evaluator in the implementation of AutoDAN attack.
StringMatching-zhang2024intention-keyword	The evaluator for IA defense on SAP200 and AdvBench dataset, primarily derived from GCG-transfer.

Chat Evaluators (using Hugging Face Models)

Evaluator Name	Note
HFChat-inan2023llama-llamaguard	LLaMAGuard
HFChat-inan2023llama-llamaguard2	LLaMAGuard2

Chat Evaluators (using OpenAI's service)

Evaluator Name	Note
OpenAIChat-liu2024autodan-Recheck	The Recheck evaluator for AutoDAN attack.
OpenAIChat-zhang2024intention-LLM	The evaluator for IA defense on DAN dataset
OpenAIChat-qi2023fine-OpenAI	The evaluator for Fine-tuning Aligned Language Models Compromises Safety, Even When Users Do Not Intend To! and How Johnny Can Persuade LLMs to Jailbreak Them: Rethinking Persuasion to Challenge AI Safety by Humanizing LLMs based on OpenAI's policy
OpenAIChat-qi2023fine-Meta	The evaluator for Fine-tuning Aligned Language Models Compromises Safety, Even When Users Do Not Intend To! and How Johnny Can Persuade LLMs to Jailbreak Them: Rethinking Persuasion to Challenge AI Safety by Humanizing LLMs based on Meta's policy

TextClassification Evaluators (using Hugging Face Models)

Evaluator Name	Note
HFTextClassification-wang2023donotanswer-longformer-action	A fine-tuned longformer model for evaluating action risks in Do-Not-Answer: A Dataset for Evaluating Safeguards in LLMs
HFTextClassification-wang2023donotanswer-longformer-harmful	A fine-tuned longformer model for evaluating harmfulness in Do-Not-Answer: A Dataset for Evaluating Safeguards in LLMs and TrustLLM: Trustworthiness in Large Language Models
HFTextClassification-yu2023gptfuzzer-GPTFuzz	A fine-tuned Roberta model for evaluating model safety.
HFTextClassification-ji2023beavertails-beaver-dam-7b	A fine-tuned LLaMA-2 model for evaluating model safety.

TextClassification Evaluators (using OpenAI's service)

Evaluator Name	Note
OpenAITextClassification-flagged-answer	An evaluator based on the moderation flag of OpenAI Moderation API.

TextClassification Evaluators (using Perspective API's service)

Evaluator Name	Note
PerspectiveTextClassification-toxicity	An evaluator based on the score of Perspective API's TOXICITY attribute.

Voting Evaluators

Evaluator Name	Note
Voting-llamaguard-llamaguard2-beaver-donotanswer-recheck	A evaluator based on LLaMAGuard, LLaMAGuard2, Beaver Dam, DoNotAnswer's harmful evalutor, and GPT-3.5.

We have assess the quality of each evaluator based on the example dataset. The results are as follows:

Agreement Report

name	accuracy	recall	precision	f1
StringMatching-lapid2023open	0.38	0.00	0.00	0.00
StringMatching-liu2024autodan-implementation	0.42	0.61	0.53	0.57
StringMatching-liu2024autodan-keyword	0.54	0.84	0.59	0.69
StringMatching-zhang2024intention-keyword	0.52	0.84	0.58	0.68
StringMatching-zou2023universal-closed	0.52	0.84	0.58	0.68
StringMatching-zou2023universal-demo	0.64	1.00	0.63	0.78
StringMatching-zou2023universal-individual	0.64	1.00	0.63	0.78
StringMatching-zou2023universal-transfer	0.54	0.84	0.59	0.69
StringMatching-zou2023universal	0.64	1.00	0.63	0.78
HFChat-inan2023llama-llamaguard2	0.70	0.97	0.68	0.80
HFChat-inan2023llama-llamaguard	0.90	0.94	0.91	0.92
HFTextClassification-ji2023beavertails-beaver-dam-7b	0.80	0.90	0.80	0.85
HFTextClassification-wang2023donotanswer-longformer-action	0.62	0.90	0.64	0.75
HFTextClassification-wang2023donotanswer-longformer-harmful	0.64	0.94	0.64	0.76
HFTextClassification-yu2023gptfuzzer-GPTFuzz	0.66	0.68	0.75	0.71
OpenAITextClassification-flagged-answer	0.56	0.29	1.00	0.45
PerspectiveTextClassification-toxicity.yaml	0.40	0.03	1.00	0.06
Voting-llamaguard-llamaguard2-beaver-dan-recheck.yaml	0.76	1.00	0.72	0.84
OpenAIChat-liu2024autodan-Recheck	0.46	0.68	0.55	0.61
OpenAIChat-qi2023fine-Meta	0.72	1.00	0.69	0.82
OpenAIChat-qi2023fine-OpenAI	0.70	0.97	0.68	0.80
OpenAIChat-zhang2024intention-LLM	0.74	1.00	0.70	0.83

More evaluators on the way. Feel free to request or contribute new evaluators.

Project Structure

Files

.
├── assets              # Static files such as images, fonts, etc.
├── data                # Data files such as datasets, etc.
├── docs                # Documentations.
├── examples            # Sample code snippets.
├── jailbreakeval       # Main source code for this package.
│   ├── commands        # Command Line Interface (CLI) related code.
│   ├── evaluators      # Implementation of various types of evaluator.
│   ├── configurations  # Configuration of various types of evaluator.
│   ├── presets         # Predefined evaluator presets in YAML.
│   └── services        # Supporting services for evaluators.
│       ├── chat        # Chat services.
│       └── text_classification  # Text classification services.
└── tests               # tests for this package
    ├── evaluators
    ├── configurations
    ├── presets
    └── services
        ├── chat
        └── text_classification

Designs

Evaluator Categories

JailbreakEval classifies the mainstream jailbreak evaluators into the following four types:

• String Matching Evaluator: Identify string patterns in content to differentiate between safe and jailbroken material.
• Chat Evaluators: Prompt the OpenAI GPT model to assess the success of a jailbreak attempt.
• Text Classification Evaluators: Employ a Large Language Model (LLM) classifier to evaluate the success of a jailbreak.
• Voting Evaluators: Employ the voting form multiple classifiers to evaluate the success of a jailbreak.

JailbreakEval has implemented the backbone of each evaluator category, with some configurable settings to construct specific evaluators. Developers may craft their own evaluators by following the schema of the corresponding category.

Contributing

Your contributions are welcomed. Please read our contribution guide for details.

To get on-board for develpment, please read the development guide for details.

Citation

If you find JailbreakEval useful, please cite it as:

@misc{jailbreakeval,
  author =       {JailbreakEval's Contributors},
  title =        {JailbreakEval: a collection of automated evaluators for assessing jailbreak attempts},
  howpublished = {\url{https://github.com/ThuCCSLab/JailbreakEval}},
  year =         {2024}
}