Protobuf Decode

Category: Serialise

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

Input / output: ArrayBuffer → JSON

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

What it does

Decodes any Protobuf encoded data to a JSON representation of the data using the field number as the field key. If a .proto schema is defined, the encoded data will be decoded with reference to the schema. Only one message instance will be decoded. Show Unknown Fields When a schema is used, this option shows fields that are present in the input data but not defined in the schema. Show Types Show the type of a field next to its name. For undefined fields, the wiretype and example types are shown instead.

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`	Schema (.proto text)	`text`	`''`	`''`
`1`	Show Unknown Fields	`boolean`	`False`	`True` or `False`
`2`	Show Types	`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 = b"example"
args = ['', False, False]
result = bake(input_value, [{"op": 'Protobuf Decode', "args": args}])
print(result)

Pipeline example

from pychef import Pipeline

args = ['', False, False]
transform = Pipeline().then('Protobuf Decode', *args)
result = transform(b"example")

Dedicated operation module

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

from pychef.operations.by_operation.protobuf_decode import run

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

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

Run this operation using its shared internal implementation.

Parameters:

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

Return type:

str | bytes