Module sequoia_openpgp::types

Primitive types.

This module provides types used in OpenPGP, like enumerations describing algorithms.

Common Operations

• Rounding the creation time of signatures: See the Timestamp::round_down method.
• Checking key usage flags: See the KeyFlags data structure.
• Setting key validity ranges: See the Timestamp and Duration data structures.

Data structures

CompressionLevel

Allows adjusting the amount of effort spent on compressing encoded data. This structure additionally has several helper methods for commonly used compression strategies.

Features

Describes particular features supported by the given OpenPGP implementation.

KeyFlags

Holds imformation about a key in particular how the given key can be used.

RevocationKey

Describes a key that has been designated to issue revocation signatures.

KeyServerPreferences

Describes preferences regarding to key servers.

Timestamp and Duration

In OpenPGP time is represented as the number of seconds since the UNIX epoch stored as an u32. These two data structures allow manipulating OpenPGP time ensuring that adding or subtracting durations will never overflow or underflow without notice.

Structs

• Bitfield
  A variable-sized set of boolean flags.
• CompressionLevel
  Compression level.
• Duration
  A duration representable by OpenPGP.
• Features
  Describes the features supported by an OpenPGP implementation.
• KeyFlags
  Describes how a key may be used, and stores additional information.
• KeyServerPreferences
  Describes preferences regarding key servers.
• RevocationKey
  Designates a key as a valid third-party revoker.
• Timestamp
  A timestamp representable by OpenPGP.

Enums

• AEADAlgorithm
  The AEAD algorithms as defined in Section 9.6 of RFC 4880bis.
• CompressionAlgorithm
  The OpenPGP compression algorithms as defined in Section 9.3 of RFC 4880.
• Curve
  Elliptic curves used in OpenPGP.
• DataFormat
  Describes the format of the body of a literal data packet.
• HashAlgorithm
  The OpenPGP hash algorithms as defined in Section 9.4 of RFC 4880.
• PublicKeyAlgorithm
  The OpenPGP public key algorithms as defined in Section 9.1 of RFC 4880, and Section 5 of RFC 6637.
• ReasonForRevocation
  Describes the reason for a revocation.
• RevocationStatus
  The revocation status.
• RevocationType
  Describes whether a ReasonForRevocation should be consider hard or soft.
• SignatureType
  Signature type as defined in Section 5.2.1 of RFC 4880.
• SymmetricAlgorithm
  The symmetric-key algorithms as defined in Section 9.2 of RFC 4880.