SM4 Encrypt

Category: Ciphers

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

Input / output: string → string

Background: https://wikipedia.org/wiki/SM4_(cipher)

What it does

SM4 is a 128-bit block cipher, currently established as a national standard (GB/T 32907-2016) of China. Multiple block cipher modes are supported. When using CBC or ECB mode, the PKCS#7 padding scheme is used.

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`	Key	`toggleString`	`{'string': '', 'option': 'Hex'}`	`''`
`1`	IV	`toggleString`	`{'string': '', 'option': 'Hex'}`	`''`
`2`	Mode	`option`	`'CBC'`	`'CBC'`, `'CFB'`, `'OFB'`, `'CTR'`, `'ECB'`, `'CBC/NoPadding'`, `'ECB/NoPadding'`
`3`	Input	`option`	`'Raw'`	`'Raw'`, `'Hex'`
`4`	Output	`option`	`'Hex'`	`'Hex'`, `'Raw'`

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 = [{'string': '', 'option': 'Hex'}, {'string': '', 'option': 'Hex'}, 'CBC', 'Raw', 'Hex']
result = bake(input_value, [{"op": 'SM4 Encrypt', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = [{'string': '', 'option': 'Hex'}, {'string': '', 'option': 'Hex'}, 'CBC', 'Raw', 'Hex']
transform = Pipeline().then('SM4 Encrypt', *args)
result = transform("example")

Dedicated operation module

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

from pychef.operations.by_operation.sm4_encrypt import run

result = run("example", tuple([{'string': '', 'option': 'Hex'}, {'string': '', 'option': 'Hex'}, 'CBC', 'Raw', 'Hex']))

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

Run this operation using its shared internal implementation.

Parameters:

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

Return type:

str | bytes