View Source OpenPGP.CompressedDataPacket (OpenPGP v0.6.2)

Represents structured data for Compressed Data Packet.

Example:

iex> alias OpenPGP.CompressedDataPacket
iex> deflated = <<120, 156, 243, 72, 205, 201, 201, 215, 81, 8,
...>     207, 47, 202, 73, 81, 84, 84, 4, 0, 40, 213, 4, 172>>
iex> CompressedDataPacket.decode(<<2, deflated::binary>>)
{
  %CompressedDataPacket{
    algo: {2, "ZLIB [RFC1950]"},
    data_deflated: deflated,
    data_inflated: "Hello, World!!!"},
  <<>>
}

NOTE: As of 0.5.x Compressed Data Packet supports only:

ZIP-style blocks (ID: 1)
ZLIB-style blocks (ID: 2)

RFC4880

5.6. Compressed Data Packet (Tag 8)

The Compressed Data packet contains compressed data. Typically, this packet is found as the contents of an encrypted packet, or following a Signature or One-Pass Signature packet, and contains a literal data packet.

The body of this packet consists of:

One octet that gives the algorithm used to compress the packet.
Compressed data, which makes up the remainder of the packet.

A Compressed Data Packet's body contains an block that compresses some set of packets. See section "Packet Composition" for details on how messages are formed.

ZIP-compressed packets are compressed with raw RFC 1951 [RFC1951] DEFLATE blocks. Note that PGP V2.6 uses 13 bits of compression. If an implementation uses more bits of compression, PGP V2.6 cannot decompress it.

ZLIB-compressed packets are compressed with RFC 1950 [RFC1950] ZLIB- style blocks.

BZip2-compressed packets are compressed using the BZip2 [BZ2] algorithm.

Summary

Types

t()

Functions

decode(arg)

Decode Compressed Data Packet given input binary. Return structured packet and remaining binary (empty binary).

Types

t()

@type t() :: %OpenPGP.CompressedDataPacket{
  algo: OpenPGP.Util.compression_algo_tuple(),
  data_deflated: bitstring(),
  data_inflated: binary()
}

Functions

decode(arg)

@spec decode(binary()) :: {t(), <<_::0>>}

Decode Compressed Data Packet given input binary. Return structured packet and remaining binary (empty binary).