Python API reference

This section is generated from public Python docstrings and signatures. For task-oriented explanations, start with Recipes, Pipelines, CTF and binary tools, or Packets, PCAP, and PCAPNG.

• Top-level package
• Recipes and execution
  • Recipe
  • Chef
  • bake()
• Pipelines
  • Pipeline
  • PipelineTrace
• CTF helpers
  • aes_decrypt()
  • aes_encrypt()
  • aes_gcm_decrypt()
  • aes_gcm_encrypt()
  • chunks()
  • cyclic()
  • cyclic_find()
  • decode_bytes()
  • digest()
  • digests()
  • encode_bytes()
  • flat()
  • hexdump()
  • md5()
  • p8()
  • p16()
  • p16be()
  • p16le()
  • p32()
  • p32be()
  • p32le()
  • p64()
  • p64be()
  • p64le()
  • pack()
  • rol()
  • ror()
  • sha1()
  • sha256()
  • sha512()
  • swap_endian()
  • u8()
  • u16()
  • u16be()
  • u16le()
  • u32()
  • u32be()
  • u32le()
  • u64()
  • u64be()
  • u64le()
  • unpack()
  • xor_bytes()
• Packet and capture parsers
  • json_safe()
  • packet_json()
  • parse_arp_packet()
  • parse_capture()
  • parse_dns_message()
  • parse_ethernet_frame()
  • parse_icmp_message()
  • parse_ipv4_packet()
  • parse_ipv6_packet()
  • parse_packet()
  • parse_pcap()
  • parse_pcapng()
  • parse_tcp_segment()
  • parse_udp_datagram()
  • read_capture()
• Operation registry
  • Operation
  • OperationRegistry
  • operation()
  • implementation()
• Compatibility report
  • CompatibilityReport
  • compatibility_report()
• Public types
  • to_bytes()
  • to_text()
  • RecipeStep
  • BakeResult
• Exceptions
  • PyChefError
  • UnknownOperationError
  • OperationError
  • RecipeError