Source code for pyrit.prompt_converter.leetspeak_converter
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.
import random
from pyrit.models import PromptDataType
from pyrit.prompt_converter import PromptConverter, ConverterResult
[docs]
class LeetspeakConverter(PromptConverter):
"""Converts a string to a leetspeak version"""
[docs]
def __init__(self, deterministic: bool = False, custom_substitutions: dict = None) -> None:
"""
Initialize the converter with optional deterministic mode and custom substitutions.
Args:
deterministic (bool): If True, use the first substitution for each character.
If False, randomly choose a substitution for each character.
custom_substitutions (dict, Optional): A dictionary of custom substitutions to override the defaults.
"""
default_substitutions = {
"a": ["4", "@", "/\\", "@", "^", "/-\\"],
"b": ["8", "6", "13", "|3", "/3", "!3"],
"c": ["(", "[", "<", "{"],
"e": ["3"],
"g": ["9"],
"i": ["1", "!"],
"l": ["1", "|"],
"o": ["0"],
"s": ["5", "$"],
"t": ["7"],
"z": ["2"],
}
# Use custom substitutions if provided, otherwise default to the standard ones
self._leet_substitutions = custom_substitutions if custom_substitutions else default_substitutions
self._deterministic = deterministic
[docs]
async def convert_async(self, *, prompt: str, input_type: PromptDataType = "text") -> ConverterResult:
"""
Convert the given prompt to leetspeak.
Args:
prompt (str): The text to convert.
input_type (PromptDataType): The type of input data.
Returns:
ConverterResult: A ConverterResult containing the leetspeak version of the prompt.
"""
if not self.input_supported(input_type):
raise ValueError("Input type not supported")
converted_prompt = []
for char in prompt:
lower_char = char.lower()
if lower_char in self._leet_substitutions:
if self._deterministic:
# Use the first substitution for deterministic mode
converted_prompt.append(self._leet_substitutions[lower_char][0])
else:
# Randomly select a substitution for each character
converted_prompt.append(random.choice(self._leet_substitutions[lower_char]))
else:
# If character not in substitutions, keep it as is
converted_prompt.append(char)
return ConverterResult(output_text="".join(converted_prompt), output_type="text")
