rpm 4.19.0
The RPM Package Manager
|
OpenPGP constants and structures from RFC-2440. More...
Files | |
file | rpmpgp.h |
Classes | |
struct | pgpPktPubkey_s |
struct | pgpPktSigV3_s |
struct | pgpPktSigV4_s |
union | pgpPktSig_u |
struct | pgpPktOnepass_s |
struct | pgpPktKeyV3_s |
struct | pgpPktKeyV4_s |
union | pgpPktKey_u |
struct | pgpPktCdata_s |
struct | pgpPktEdata_s |
struct | pgpPktLdata_s |
struct | pgpPktTrust_s |
struct | pgpPktUid_s |
union | pgpPktPre_u |
Macros | |
#define | PGP_KEYID_LEN 8 |
Typedefs | |
typedef struct pgpDigParams_s * | pgpDigParams |
typedef enum pgpTag_e | pgpTag |
typedef struct pgpPktPubkey_s | pgpPktPubkey |
typedef enum pgpSigType_e | pgpSigType |
typedef enum pgpPubkeyAlgo_e | pgpPubkeyAlgo |
typedef enum pgpSymkeyAlgo_e | pgpSymkeyAlgo |
typedef enum pgpCompressAlgo_e | pgpCompressAlgo |
typedef enum pgpHashAlgo_e | pgpHashAlgo |
typedef enum pgpCurveId_e | pgpCurveId |
typedef struct pgpPktSigV3_s * | pgpPktSigV3 |
typedef struct pgpPktSigV4_s * | pgpPktSigV4 |
typedef enum pgpSubType_e | pgpSubType |
typedef union pgpPktSig_u * | pgpPktSig |
typedef struct pgpPktOnepass_s * | pgpPktOnepass |
typedef struct pgpPktKeyV3_s * | pgpPktKeyV3 |
typedef struct pgpPktKeyV4_s * | pgpPktKeyV4 |
typedef union pgpPktKey_u | pgpPktKey |
typedef struct pgpPktCdata_s | pgpPktCdata |
typedef struct pgpPktEdata_s | pgpPktEdata |
typedef struct pgpPktLdata_s | pgpPktLdata |
typedef struct pgpPktTrust_s | pgpPktTrust |
typedef struct pgpPktUid_s | pgpPktUid |
typedef enum pgpArmor_e | pgpArmor |
typedef enum pgpArmorKey_e | pgpArmorKey |
Functions | |
const char * | pgpValString (pgpValType type, uint8_t val) |
int | pgpPubkeyFingerprint (const uint8_t *pkt, size_t pktlen, uint8_t **fp, size_t *fplen) |
int | pgpPubkeyKeyID (const uint8_t *pkt, size_t pktlen, pgpKeyID_t keyid) |
int | pgpPrtParams (const uint8_t *pkts, size_t pktlen, unsigned int pkttype, pgpDigParams *ret) |
int | pgpPrtParams2 (const uint8_t *pkts, size_t pktlen, unsigned int pkttype, pgpDigParams *ret, char **lints) |
int | pgpPrtParamsSubkeys (const uint8_t *pkts, size_t pktlen, pgpDigParams mainkey, pgpDigParams **subkeys, int *subkeysCount) |
pgpArmor | pgpReadPkts (const char *fn, uint8_t **pkt, size_t *pktlen) |
pgpArmor | pgpParsePkts (const char *armor, uint8_t **pkt, size_t *pktlen) |
int | pgpPubKeyCertLen (const uint8_t *pkts, size_t pktslen, size_t *certlen) |
rpmRC | pgpPubKeyLint (const uint8_t *pkts, size_t pktslen, char **explanation) |
char * | pgpArmorWrap (int atype, const unsigned char *s, size_t ns) |
int | pgpDigParamsCmp (pgpDigParams p1, pgpDigParams p2) |
unsigned int | pgpDigParamsAlgo (pgpDigParams digp, unsigned int algotype) |
const uint8_t * | pgpDigParamsSignID (pgpDigParams digp) |
const char * | pgpDigParamsUserID (pgpDigParams digp) |
int | pgpDigParamsVersion (pgpDigParams digp) |
uint32_t | pgpDigParamsCreationTime (pgpDigParams digp) |
pgpDigParams | pgpDigParamsFree (pgpDigParams digp) |
rpmRC | pgpVerifySignature (pgpDigParams key, pgpDigParams sig, DIGEST_CTX hashctx) |
rpmRC | pgpVerifySignature2 (pgpDigParams key, pgpDigParams sig, DIGEST_CTX hashctx, char **lints) |
int | pgpSignatureType (pgpDigParams sig) |
char * | pgpIdentItem (pgpDigParams digp) |
OpenPGP constants and structures from RFC-2440.
#define PGP_KEYID_LEN 8 |
The length (in bytes) of a binary (not hex encoded) key ID.
typedef enum pgpCompressAlgo_e pgpCompressAlgo |
9.3. Compression Algorithms
ID Algorithm -- --------- 0 - Uncompressed 1 - ZIP (RFC 1951) 2 - ZLIB (RFC 1950) 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement uncompressed data. Implementations SHOULD implement ZIP. Implementations MAY implement ZLIB.
typedef enum pgpCurveId_e pgpCurveId |
ECC Curves
The following curve ids are private to rpm. PGP uses oids to identify a curve.
typedef enum pgpHashAlgo_e pgpHashAlgo |
9.4. Hash Algorithms
ID Algorithm Text Name -- --------- ---- ---- 1 - MD5 "MD5" 2 - SHA-1 "SHA1" 3 - RIPE-MD/160 "RIPEMD160" 4 - Reserved for double-width SHA (experimental) 5 - MD2 "MD2" 6 - Reserved for TIGER/192 "TIGER192" 7 - Reserved for HAVAL (5 pass, 160-bit) "HAVAL-5-160" 8 - SHA-256 "SHA256" 9 - SHA-384 "SHA384" 10 - SHA-512 "SHA512" 11 - SHA-224 "SHA224" 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement SHA-1. Implementations SHOULD implement MD5.
typedef struct pgpPktCdata_s pgpPktCdata |
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 literal data packets.
The body of this packet consists of:
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 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 ZLIB-style blocks.
typedef struct pgpPktEdata_s pgpPktEdata |
5.7. Symmetrically Encrypted Data Packet (Tag 9)
The Symmetrically Encrypted Data packet contains data encrypted with a symmetric-key algorithm. When it has been decrypted, it will typically contain other packets (often literal data packets or compressed data packets).
The body of this packet consists of:
The symmetric cipher used may be specified in an Public-Key or Symmetric-Key Encrypted Session Key packet that precedes the Symmetrically Encrypted Data Packet. In that case, the cipher algorithm octet is prefixed to the session key before it is encrypted. If no packets of these types precede the encrypted data, the IDEA algorithm is used with the session key calculated as the MD5 hash of the passphrase.
The data is encrypted in CFB mode, with a CFB shift size equal to the cipher's block size. The Initial Vector (IV) is specified as all zeros. Instead of using an IV, OpenPGP prefixes a 10-octet string to the data before it is encrypted. The first eight octets are random, and the 9th and 10th octets are copies of the 7th and 8th octets, respectively. After encrypting the first 10 octets, the CFB state is resynchronized if the cipher block size is 8 octets or less. The last 8 octets of ciphertext are passed through the cipher and the block boundary is reset.
The repetition of 16 bits in the 80 bits of random data prefixed to the message allows the receiver to immediately check whether the session key is incorrect.
typedef union pgpPktKey_u pgpPktKey |
5.5.3. Secret Key Packet Formats
The Secret Key and Secret Subkey packets contain all the data of the Public Key and Public Subkey packets, with additional algorithm- specific secret key data appended, in encrypted form.
The packet contains:
Two-octet checksum of the plaintext of the algorithm-specific portion (sum of all octets, mod 65536).
Algorithm Specific Fields for RSA secret keys:
Algorithm Specific Fields for DSA secret keys:
Algorithm Specific Fields for Elgamal secret keys:
Secret MPI values can be encrypted using a passphrase. If a string- to-key specifier is given, that describes the algorithm for converting the passphrase to a key, else a simple MD5 hash of the passphrase is used. Implementations SHOULD use a string-to-key specifier; the simple hash is for backward compatibility. The cipher for encrypting the MPIs is specified in the secret key packet.
Encryption/decryption of the secret data is done in CFB mode using the key created from the passphrase and the Initial Vector from the packet. A different mode is used with V3 keys (which are only RSA) than with other key formats. With V3 keys, the MPI bit count prefix (i.e., the first two octets) is not encrypted. Only the MPI non- prefix data is encrypted. Furthermore, the CFB state is resynchronized at the beginning of each new MPI value, so that the CFB block boundary is aligned with the start of the MPI data.
With V4 keys, a simpler method is used. All secret MPI values are encrypted in CFB mode, including the MPI bitcount prefix.
The 16-bit checksum that follows the algorithm-specific portion is the algebraic sum, mod 65536, of the plaintext of all the algorithm- specific octets (including MPI prefix and data). With V3 keys, the checksum is stored in the clear. With V4 keys, the checksum is encrypted like the algorithm-specific data. This value is used to check that the passphrase was correct.
typedef struct pgpPktKeyV3_s * pgpPktKeyV3 |
5.5.1. Key Packet Variants
5.5.1.1. Public Key Packet (Tag 6)
A Public Key packet starts a series of packets that forms an OpenPGP key (sometimes called an OpenPGP certificate).
5.5.1.2. Public Subkey Packet (Tag 14)
A Public Subkey packet (tag 14) has exactly the same format as a Public Key packet, but denotes a subkey. One or more subkeys may be associated with a top-level key. By convention, the top-level key provides signature services, and the subkeys provide encryption services.
Note: in PGP 2.6.x, tag 14 was intended to indicate a comment packet. This tag was selected for reuse because no previous version of PGP ever emitted comment packets but they did properly ignore them. Public Subkey packets are ignored by PGP 2.6.x and do not cause it to fail, providing a limited degree of backward compatibility.
5.5.1.3. Secret Key Packet (Tag 5)
A Secret Key packet contains all the information that is found in a Public Key packet, including the public key material, but also includes the secret key material after all the public key fields.
5.5.1.4. Secret Subkey Packet (Tag 7)
A Secret Subkey packet (tag 7) is the subkey analog of the Secret Key packet, and has exactly the same format.
5.5.2. Public Key Packet Formats
There are two versions of key-material packets. Version 3 packets were first generated by PGP 2.6. Version 2 packets are identical in format to Version 3 packets, but are generated by PGP 2.5 or before. V2 packets are deprecated and they MUST NOT be generated. PGP 5.0 introduced version 4 packets, with new fields and semantics. PGP 2.6.x will not accept key-material packets with versions greater than 3.
OpenPGP implementations SHOULD create keys with version 4 format. An implementation MAY generate a V3 key to ensure interoperability with old software; note, however, that V4 keys correct some security deficiencies in V3 keys. These deficiencies are described below. An implementation MUST NOT create a V3 key with a public key algorithm other than RSA.
A version 3 public key or public subkey packet contains:
V3 keys SHOULD only be used for backward compatibility because of three weaknesses in them. First, it is relatively easy to construct a V3 key that has the same key ID as any other key because the key ID is simply the low 64 bits of the public modulus. Secondly, because the fingerprint of a V3 key hashes the key material, but not its length, which increases the opportunity for fingerprint collisions. Third, there are minor weaknesses in the MD5 hash algorithm that make developers prefer other algorithms. See below for a fuller discussion of key IDs and fingerprints.
typedef struct pgpPktKeyV4_s * pgpPktKeyV4 |
The version 4 format is similar to the version 3 format except for the absence of a validity period. This has been moved to the signature packet. In addition, fingerprints of version 4 keys are calculated differently from version 3 keys, as described in section "Enhanced Key Formats."
A version 4 packet contains:
A series of multi-precision integers comprising the key material. This algorithm-specific portion is:
Algorithm Specific Fields for RSA public keys:
Algorithm Specific Fields for DSA public keys:
Algorithm Specific Fields for Elgamal public keys:
Algorithm Specific Fields for EdDSA public keys:
typedef struct pgpPktLdata_s pgpPktLdata |
5.8. Marker Packet (Obsolete Literal Packet) (Tag 10)
An experimental version of PGP used this packet as the Literal packet, but no released version of PGP generated Literal packets with this tag. With PGP 5.x, this packet has been re-assigned and is reserved for use as the Marker packet.
The body of this packet consists of:
Such a packet MUST be ignored when received. It may be placed at the beginning of a message that uses features not available in PGP 2.6.x in order to cause that version to report that newer software is necessary to process the message.
5.9. Literal Data Packet (Tag 11)
A Literal Data packet contains the body of a message; data that is not to be further interpreted.
The body of this packet consists of:
If it is a 'b' (0x62), then the literal packet contains binary data. If it is a 't' (0x74), then it contains text data, and thus may need line ends converted to local form, or other text-mode changes. RFC 1991 also defined a value of 'l' as a 'local' mode for machine-local conversions. This use is now deprecated.
If the special name "_CONSOLE" is used, the message is considered to be "for your eyes only". This advises that the message data is unusually sensitive, and the receiving program should process it more carefully, perhaps avoiding storing the received data to disk, for example.
Text data is stored with <CR><LF> text endings (i.e. network-normal line endings). These should be converted to native line endings by the receiving software.
typedef struct pgpPktOnepass_s * pgpPktOnepass |
5.4. One-Pass Signature Packets (Tag 4)
The One-Pass Signature packet precedes the signed data and contains enough information to allow the receiver to begin calculating any hashes needed to verify the signature. It allows the Signature Packet to be placed at the end of the message, so that the signer can compute the entire signed message in one pass.
A One-Pass Signature does not interoperate with PGP 2.6.x or earlier.
The body of this packet consists of:
Note that if a message contains more than one one-pass signature, then the signature packets bracket the message; that is, the first signature packet after the message corresponds to the last one-pass packet and the final signature packet corresponds to the first one- pass packet.
typedef struct pgpPktPubkey_s pgpPktPubkey |
5.1. Public-Key Encrypted Session Key Packets (Tag 1)
A Public-Key Encrypted Session Key packet holds the session key used to encrypt a message. Zero or more Encrypted Session Key packets (either Public-Key or Symmetric-Key) may precede a Symmetrically Encrypted Data Packet, which holds an encrypted message. The message is encrypted with the session key, and the session key is itself encrypted and stored in the Encrypted Session Key packet(s). The Symmetrically Encrypted Data Packet is preceded by one Public-Key Encrypted Session Key packet for each OpenPGP key to which the message is encrypted. The recipient of the message finds a session key that is encrypted to their public key, decrypts the session key, and then uses the session key to decrypt the message.
The body of this packet consists of:
Algorithm Specific Fields for RSA encryption
Algorithm Specific Fields for Elgamal encryption:
typedef union pgpPktSig_u * pgpPktSig |
5.2. Signature Packet (Tag 2)
A signature packet describes a binding between some public key and some data. The most common signatures are a signature of a file or a block of text, and a signature that is a certification of a user ID.
Two versions of signature packets are defined. Version 3 provides basic signature information, while version 4 provides an expandable format with subpackets that can specify more information about the signature. PGP 2.6.x only accepts version 3 signatures.
Implementations MUST accept V3 signatures. Implementations SHOULD generate V4 signatures. Implementations MAY generate a V3 signature that can be verified by PGP 2.6.x.
Note that if an implementation is creating an encrypted and signed message that is encrypted to a V3 key, it is reasonable to create a V3 signature.
typedef struct pgpPktSigV3_s * pgpPktSigV3 |
5.2.2. Version 3 Signature Packet Format
The body of a version 3 Signature Packet contains:
Algorithm Specific Fields for RSA signatures:
Algorithm Specific Fields for DSA and EdDSA signatures:
typedef struct pgpPktSigV4_s * pgpPktSigV4 |
5.2.3. Version 4 Signature Packet Format
The body of a version 4 Signature Packet contains:
typedef struct pgpPktTrust_s pgpPktTrust |
5.10. Trust Packet (Tag 12)
The Trust packet is used only within keyrings and is not normally exported. Trust packets contain data that record the user's specifications of which key holders are trustworthy introducers, along with other information that implementing software uses for trust information.
Trust packets SHOULD NOT be emitted to output streams that are transferred to other users, and they SHOULD be ignored on any input other than local keyring files.
typedef struct pgpPktUid_s pgpPktUid |
5.11. User ID Packet (Tag 13)
A User ID packet consists of data that is intended to represent the name and email address of the key holder. By convention, it includes an RFC 822 mail name, but there are no restrictions on its content. The packet length in the header specifies the length of the user id. If it is text, it is encoded in UTF-8.
typedef enum pgpPubkeyAlgo_e pgpPubkeyAlgo |
9.1. Public Key Algorithms
ID Algorithm -- --------- 1 - RSA (Encrypt or Sign) 2 - RSA Encrypt-Only 3 - RSA Sign-Only 16 - Elgamal (Encrypt-Only), see [ELGAMAL] 17 - DSA (Digital Signature Standard) 18 - Reserved for Elliptic Curve 19 - Reserved for ECDSA 20 - Elgamal (Encrypt or Sign) 21 - Reserved for Diffie-Hellman (X9.42, as defined for IETF-S/MIME) 22 - EdDSA 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement DSA for signatures, and Elgamal for encryption. Implementations SHOULD implement RSA keys. Implementations MAY implement any other algorithm.
typedef enum pgpSigType_e pgpSigType |
5.2.1. Signature Types
There are a number of possible meanings for a signature, which are specified in a signature type octet in any given signature.
typedef enum pgpSubType_e pgpSubType |
5.2.3.1. Signature Subpacket Specification
The subpacket fields consist of zero or more signature subpackets. Each set of subpackets is preceded by a two-octet scalar count of the length of the set of subpackets.
Each subpacket consists of a subpacket header and a body. The header consists of:
The length includes the type octet but not this length. Its format is similar to the "new" format packet header lengths, but cannot have partial body lengths. That is:
if the 1st octet < 192, then lengthOfLength = 1 subpacketLen = 1st_octet if the 1st octet >= 192 and < 255, then lengthOfLength = 2 subpacketLen = ((1st_octet - 192) << 8) + (2nd_octet) + 192 if the 1st octet = 255, then lengthOfLength = 5 subpacket length = [four-octet scalar starting at 2nd_octet]
The value of the subpacket type octet may be:
2 = signature creation time 3 = signature expiration time 4 = exportable certification 5 = trust signature 6 = regular expression 7 = revocable 9 = key expiration time 10 = placeholder for backward compatibility 11 = preferred symmetric algorithms 12 = revocation key 16 = issuer key ID 20 = notation data 21 = preferred hash algorithms 22 = preferred compression algorithms 23 = key server preferences 24 = preferred key server 25 = primary user id 26 = policy URL 27 = key flags 28 = signer's user id 29 = reason for revocation 100 to 110 = internal or user-defined
An implementation SHOULD ignore any subpacket of a type that it does not recognize.
Bit 7 of the subpacket type is the "critical" bit. If set, it denotes that the subpacket is one that is critical for the evaluator of the signature to recognize. If a subpacket is encountered that is marked critical but is unknown to the evaluating software, the evaluator SHOULD consider the signature to be in error.
typedef enum pgpSymkeyAlgo_e pgpSymkeyAlgo |
9.2. Symmetric Key Algorithms
ID Algorithm -- --------- 0 - Plaintext or unencrypted data 1 - IDEA [IDEA] 2 - Triple-DES (DES-EDE, as per spec - 168 bit key derived from 192) 3 - CAST5 (128 bit key, as per RFC 2144) 4 - Blowfish (128 bit key, 16 rounds) [BLOWFISH] 5 - SAFER-SK128 (13 rounds) [SAFER] 6 - Reserved for DES/SK 7 - Reserved for AES with 128-bit key 8 - Reserved for AES with 192-bit key 9 - Reserved for AES with 256-bit key 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement Triple-DES. Implementations SHOULD implement IDEA and CAST5. Implementations MAY implement any other algorithm.
4.3. Packet Tags
The packet tag denotes what type of packet the body holds. Note that old format headers can only have tags less than 16, whereas new format headers can have tags as great as 63.
enum pgpArmor_e |
enum pgpArmorKey_e |
enum pgpCompressAlgo_e |
9.3. Compression Algorithms
ID Algorithm -- --------- 0 - Uncompressed 1 - ZIP (RFC 1951) 2 - ZLIB (RFC 1950) 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement uncompressed data. Implementations SHOULD implement ZIP. Implementations MAY implement ZLIB.
Enumerator | |
---|---|
PGPCOMPRESSALGO_NONE | Uncompressed |
PGPCOMPRESSALGO_ZIP | ZIP |
PGPCOMPRESSALGO_ZLIB | ZLIB |
PGPCOMPRESSALGO_BZIP2 | BZIP2 |
enum pgpCurveId_e |
ECC Curves
The following curve ids are private to rpm. PGP uses oids to identify a curve.
enum pgpHashAlgo_e |
9.4. Hash Algorithms
ID Algorithm Text Name -- --------- ---- ---- 1 - MD5 "MD5" 2 - SHA-1 "SHA1" 3 - RIPE-MD/160 "RIPEMD160" 4 - Reserved for double-width SHA (experimental) 5 - MD2 "MD2" 6 - Reserved for TIGER/192 "TIGER192" 7 - Reserved for HAVAL (5 pass, 160-bit) "HAVAL-5-160" 8 - SHA-256 "SHA256" 9 - SHA-384 "SHA384" 10 - SHA-512 "SHA512" 11 - SHA-224 "SHA224" 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement SHA-1. Implementations SHOULD implement MD5.
enum pgpPubkeyAlgo_e |
9.1. Public Key Algorithms
ID Algorithm -- --------- 1 - RSA (Encrypt or Sign) 2 - RSA Encrypt-Only 3 - RSA Sign-Only 16 - Elgamal (Encrypt-Only), see [ELGAMAL] 17 - DSA (Digital Signature Standard) 18 - Reserved for Elliptic Curve 19 - Reserved for ECDSA 20 - Elgamal (Encrypt or Sign) 21 - Reserved for Diffie-Hellman (X9.42, as defined for IETF-S/MIME) 22 - EdDSA 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement DSA for signatures, and Elgamal for encryption. Implementations SHOULD implement RSA keys. Implementations MAY implement any other algorithm.
enum pgpSigType_e |
5.2.1. Signature Types
There are a number of possible meanings for a signature, which are specified in a signature type octet in any given signature.
enum pgpSubType_e |
5.2.3.1. Signature Subpacket Specification
The subpacket fields consist of zero or more signature subpackets. Each set of subpackets is preceded by a two-octet scalar count of the length of the set of subpackets.
Each subpacket consists of a subpacket header and a body. The header consists of:
The length includes the type octet but not this length. Its format is similar to the "new" format packet header lengths, but cannot have partial body lengths. That is:
if the 1st octet < 192, then lengthOfLength = 1 subpacketLen = 1st_octet if the 1st octet >= 192 and < 255, then lengthOfLength = 2 subpacketLen = ((1st_octet - 192) << 8) + (2nd_octet) + 192 if the 1st octet = 255, then lengthOfLength = 5 subpacket length = [four-octet scalar starting at 2nd_octet]
The value of the subpacket type octet may be:
2 = signature creation time 3 = signature expiration time 4 = exportable certification 5 = trust signature 6 = regular expression 7 = revocable 9 = key expiration time 10 = placeholder for backward compatibility 11 = preferred symmetric algorithms 12 = revocation key 16 = issuer key ID 20 = notation data 21 = preferred hash algorithms 22 = preferred compression algorithms 23 = key server preferences 24 = preferred key server 25 = primary user id 26 = policy URL 27 = key flags 28 = signer's user id 29 = reason for revocation 100 to 110 = internal or user-defined
An implementation SHOULD ignore any subpacket of a type that it does not recognize.
Bit 7 of the subpacket type is the "critical" bit. If set, it denotes that the subpacket is one that is critical for the evaluator of the signature to recognize. If a subpacket is encountered that is marked critical but is unknown to the evaluating software, the evaluator SHOULD consider the signature to be in error.
enum pgpSymkeyAlgo_e |
9.2. Symmetric Key Algorithms
ID Algorithm -- --------- 0 - Plaintext or unencrypted data 1 - IDEA [IDEA] 2 - Triple-DES (DES-EDE, as per spec - 168 bit key derived from 192) 3 - CAST5 (128 bit key, as per RFC 2144) 4 - Blowfish (128 bit key, 16 rounds) [BLOWFISH] 5 - SAFER-SK128 (13 rounds) [SAFER] 6 - Reserved for DES/SK 7 - Reserved for AES with 128-bit key 8 - Reserved for AES with 192-bit key 9 - Reserved for AES with 256-bit key 100 to 110 - Private/Experimental algorithm.
Implementations MUST implement Triple-DES. Implementations SHOULD implement IDEA and CAST5. Implementations MAY implement any other algorithm.
enum pgpTag_e |
4.3. Packet Tags
The packet tag denotes what type of packet the body holds. Note that old format headers can only have tags less than 16, whereas new format headers can have tags as great as 63.
char * pgpArmorWrap | ( | int | atype, |
const unsigned char * | s, | ||
size_t | ns | ||
) |
Wrap a OpenPGP packets in ascii armor for transport.
atype | type of armor |
s | binary pkt data |
ns | binary pkt data length |
unsigned int pgpDigParamsAlgo | ( | pgpDigParams | digp, |
unsigned int | algotype | ||
) |
Retrieve OpenPGP algorithm parameters param digp parameter container param algotype PGPVAL_HASHALGO / PGPVAL_PUBKEYALGO return algorithm value, 0 on error
int pgpDigParamsCmp | ( | pgpDigParams | p1, |
pgpDigParams | p2 | ||
) |
Compare OpenPGP packet parameters param p1 1st parameter container param p2 2nd parameter container return 1 if the parameters differ, 0 otherwise
uint32_t pgpDigParamsCreationTime | ( | pgpDigParams | digp | ) |
Retrieve the object's creation time.
param digp parameter container return seconds since the UNIX Epoch.
pgpDigParams pgpDigParamsFree | ( | pgpDigParams | digp | ) |
Destroy parsed OpenPGP packet parameter(s).
digp | parameter container |
const uint8_t * pgpDigParamsSignID | ( | pgpDigParams | digp | ) |
Returns the issuer or the object's Key ID.
If the object is a signature, then this returns the Key ID stored in the first Issuer subpacket as a hex string. (This is not authenticated.)
If the object is a certificate or a subkey, then this returns the key's Key ID.
The caller must not free the returned buffer.
param digp parameter container return an array of PGP_KEYID_LEN bytes. If the issuer is unknown, this returns an array with all zeros.
const char * pgpDigParamsUserID | ( | pgpDigParams | digp | ) |
Retrieve the primary User ID, if any.
Returns the primary User ID, if any.
If the object is a signature, then this returns NULL.
If the object is a certificate or a subkey, then this returns the certificate's primary User ID, if any.
This interface does not provide a way for the caller to recognize any embedded NUL characters.
The caller must not free the returned buffer.
param digp parameter container return a string or NULL, if there is no primary User ID.
int pgpDigParamsVersion | ( | pgpDigParams | digp | ) |
Retrieve the object's version.
Returns the object's version.
If the object is a signature, then this returns the version of the signature packet.
If the object is a certificate, then this returns the version of the primary key packet.
If the object is a subkey, then this returns the version of the subkey's key packet.
param digp parameter container return the object's version
char * pgpIdentItem | ( | pgpDigParams | digp | ) |
Return a string identification of a PGP signature/pubkey.
digp | signature/pubkey container |
pgpArmor pgpParsePkts | ( | const char * | armor, |
uint8_t ** | pkt, | ||
size_t * | pktlen | ||
) |
Parse armored OpenPGP packets from memory.
armor | armored OpenPGP packet string | |
[out] | pkt | dearmored OpenPGP packet(s) (malloced) |
[out] | pktlen | dearmored OpenPGP packet(s) length in bytes |
int pgpPrtParams | ( | const uint8_t * | pkts, |
size_t | pktlen, | ||
unsigned int | pkttype, | ||
pgpDigParams * | ret | ||
) |
Parse a OpenPGP packet(s).
pkts | OpenPGP packet(s) | |
pktlen | OpenPGP packet(s) length (no. of bytes) | |
pkttype | Expected packet type (signature/key) or 0 for any | |
[out] | ret | signature/pubkey packet parameters on success (alloced) |
int pgpPrtParams2 | ( | const uint8_t * | pkts, |
size_t | pktlen, | ||
unsigned int | pkttype, | ||
pgpDigParams * | ret, | ||
char ** | lints | ||
) |
Parse a OpenPGP packet(s).
pkts | OpenPGP packet(s) | |
pktlen | OpenPGP packet(s) length (no. of bytes) | |
pkttype | Expected packet type (signature/key) or 0 for any | |
[out] | ret | signature/pubkey packet parameters on success (alloced) |
[out] | lints | error messages and lints |
int pgpPrtParamsSubkeys | ( | const uint8_t * | pkts, |
size_t | pktlen, | ||
pgpDigParams | mainkey, | ||
pgpDigParams ** | subkeys, | ||
int * | subkeysCount | ||
) |
Parse subkey parameters from OpenPGP packet(s).
pkts | OpenPGP packet(s) |
pktlen | OpenPGP packet(s) length (no. of bytes) |
mainkey | parameters of main key |
subkeys | array of subkey parameters (alloced) |
subkeysCount | count of subkeys |
int pgpPubKeyCertLen | ( | const uint8_t * | pkts, |
size_t | pktslen, | ||
size_t * | certlen | ||
) |
Return a length of the first public key certificate in a buffer given by pkts that contains one or more certificates. A public key certificate consits of packets like Public key packet, User ID packet and so on. In a buffer every certificate starts with Public key packet and it ends with the start of the next certificate or with the end of the buffer.
pkts | pointer to a buffer with certificates |
pktslen | length of the buffer with certificates |
certlen | length of the first certificate in the buffer |
int pgpPubkeyFingerprint | ( | const uint8_t * | pkt, |
size_t | pktlen, | ||
uint8_t ** | fp, | ||
size_t * | fplen | ||
) |
Calculate OpenPGP public key fingerprint.
pkt | OpenPGP packet (i.e. PGPTAG_PUBLIC_KEY) | |
pktlen | OpenPGP packet length (no. of bytes) | |
[out] | fp | public key fingerprint |
[out] | fplen | public key fingerprint length |
int pgpPubkeyKeyID | ( | const uint8_t * | pkt, |
size_t | pktlen, | ||
pgpKeyID_t | keyid | ||
) |
Calculate OpenPGP public key Key ID
pkt | OpenPGP packet (i.e. PGPTAG_PUBLIC_KEY) | |
pktlen | OpenPGP packet length (no. of bytes) | |
[out] | keyid | public key Key ID |
rpmRC pgpPubKeyLint | ( | const uint8_t * | pkts, |
size_t | pktslen, | ||
char ** | explanation | ||
) |
Lints the certificate.
There are four cases:
The packets do not describe a certificate: returns an error and sets *explanation to NULL.
The packets describe a certificate and the certificate is completely unusable: returns an error and sets *explanation to a human readable explanation.
The packets describe a certificate and some components are not usable: returns success, and sets *explanation to a human readable explanation.
The packets describe a certificate and there are no lints: returns success, and sets *explanation to NULL.
pkts | OpenPGP pointer to a buffer with certificates | |
pktslen | length of the buffer with certificates | |
[out] | explanation | An optional lint to display to the user. |
pgpArmor pgpReadPkts | ( | const char * | fn, |
uint8_t ** | pkt, | ||
size_t * | pktlen | ||
) |
Parse armored OpenPGP packets from a file.
fn | file name | |
[out] | pkt | dearmored OpenPGP packet(s) (malloced) |
[out] | pktlen | dearmored OpenPGP packet(s) length in bytes |
int pgpSignatureType | ( | pgpDigParams | sig | ) |
Return the type of a PGP signature. If sig
is NULL, or is not a signature, returns -1.
sig | signature |
const char * pgpValString | ( | pgpValType | type, |
uint8_t | val | ||
) |
Return string representation of am OpenPGP value.
type | type of value |
val | byte value to lookup |
rpmRC pgpVerifySignature | ( | pgpDigParams | key, |
pgpDigParams | sig, | ||
DIGEST_CTX | hashctx | ||
) |
Verify a PGP signature.
key | public key |
sig | signature |
hashctx | digest context |
rpmRC pgpVerifySignature2 | ( | pgpDigParams | key, |
pgpDigParams | sig, | ||
DIGEST_CTX | hashctx, | ||
char ** | lints | ||
) |
Verify a PGP signature and return a error message or lint.
key | public key |
sig | signature |
hashctx | digest context |
lints | error messages and lints |