Substitute

Category: Ciphers

Status: Registered and callable in the CyberChef 11.3.0 compatibility inventory.

Input / output: string → string

Background: https://wikipedia.org/wiki/Substitution_cipher

What it does

A substitution cipher allowing you to specify bytes to replace with other byte values. This can be used to create Caesar ciphers but is more powerful as any byte value can be substituted, not just letters, and the substitution values need not be in order. Enter the bytes you want to replace in the Plaintext field and the bytes to replace them with in the Ciphertext field. Non-printable bytes can be specified using string escape notation. For example, a line feed character can be written as either \n or \x0a. Byte ranges can be specified using a hyphen. For example, the sequence 0123456789 can be written as 0-9. Note that blackslash characters are used to escape special characters, so will need to be escaped themselves if you want to use them on their own (e.g.``\``).

Note

Status here means the operation name is implemented and callable. It does not by itself promise byte-for-byte parity for every upstream option. See Compatibility and current status for the verified scope and known boundaries.

Arguments and options

Arguments are positional. Keep their order when using bake() or Pipeline.then().

Index	Name	UI type	PyChef default	Accepted values / format
`0`	Plaintext	`binaryString`	`'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`	`'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`
`1`	Ciphertext	`binaryString`	`'XYZABCDEFGHIJKLMNOPQRSTUVW'`	`'XYZABCDEFGHIJKLMNOPQRSTUVW'`
`2`	Ignore case	`boolean`	`False`	`True` or `False`

Recipe template

Important

This is a call template built from the documented defaults. Replace placeholder values such as empty keys, paths, patterns, or lookup data before running it.

from pychef import bake

input_value = "example"
args = ['ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'XYZABCDEFGHIJKLMNOPQRSTUVW', False]
result = bake(input_value, [{"op": 'Substitute', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = ['ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'XYZABCDEFGHIJKLMNOPQRSTUVW', False]
transform = Pipeline().then('Substitute', *args)
result = transform("example")

Direct call

pychef.ops.run_operation runs any registered operation as a plain function, under the active ExecutionPolicy (safe defaults, no network):

from pychef.ops import run_operation

args = ['ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'XYZABCDEFGHIJKLMNOPQRSTUVW', False]
result = run_operation('Substitute', "example", args=args)

Common operations also have typed helpers in Direct operations.

Low-level operation module

Warning

The module below is an internal implementation detail. It applies no execution policy, resource limits, or error sanitization; prefer bake(), Pipeline, or pychef.ops for application code.

The registered entry point lives in pychef.operations.by_operation.substitute. Direct calls receive the input value and a positional argument tuple:

from pychef.operations.by_operation.substitute import run

result = run("example", tuple(['ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'XYZABCDEFGHIJKLMNOPQRSTUVW', False]))

pychef.operations.by_operation.substitute.run(value, args)

Run this operation using its shared internal implementation.

Parameters:

value (str | bytes)
args (Sequence[Any])

Return type:

str | bytes