rpm  4.16.0
rpmpgp.h
Go to the documentation of this file.
1 #ifndef H_RPMPGP
2 #define H_RPMPGP
3 
17 #include <string.h>
18 #include <stdio.h>
19 #include <stdlib.h>
20 #include <rpm/rpmtypes.h>
21 #include <rpm/rpmstring.h>
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
29 typedef struct DIGEST_CTX_s * DIGEST_CTX;
30 typedef struct rpmDigestBundle_s * rpmDigestBundle;
31 
34 typedef struct pgpDig_s * pgpDig;
35 
38 typedef struct pgpDigParams_s * pgpDigParams;
39 
40 typedef uint8_t pgpKeyID_t[8];
41 typedef uint8_t pgpTime_t[4];
42 
50 typedef enum pgpTag_e {
63  PGPTAG_TRUST = 12,
69  PGPTAG_MDC = 19,
74 } pgpTag;
75 
110 typedef struct pgpPktPubkey_s {
111  uint8_t version;
113  uint8_t algo;
114 } pgpPktPubkey;
115 
116 
123 typedef enum pgpSigType_e {
141 } pgpSigType;
142 
167 typedef enum pgpPubkeyAlgo_e {
178 } pgpPubkeyAlgo;
179 
204 typedef enum pgpSymkeyAlgo_e {
217 } pgpSymkeyAlgo;
218 
234 typedef enum pgpCompressAlgo_e {
240 
264 typedef enum pgpHashAlgo_e {
275 } pgpHashAlgo;
276 
283 typedef enum pgpCurveId_e {
291 } pgpCurveId;
292 
314 typedef struct pgpPktSigV3_s {
315  uint8_t version;
316  uint8_t hashlen;
317  uint8_t sigtype;
320  uint8_t pubkey_algo;
321  uint8_t hash_algo;
322  uint8_t signhash16[2];
323 } * pgpPktSigV3;
324 
346 typedef struct pgpPktSigV4_s {
347  uint8_t version;
348  uint8_t sigtype;
349  uint8_t pubkey_algo;
350  uint8_t hash_algo;
351  uint8_t hashlen[2];
352 } * pgpPktSigV4;
353 
420 typedef enum pgpSubType_e {
459 } pgpSubType;
460 
481 typedef union pgpPktSig_u {
484 } * pgpPktSig;
485 
514 typedef struct pgpPktSymkey_s {
515  uint8_t version;
516  uint8_t symkey_algo;
517  uint8_t s2k[1];
518 } pgpPktSymkey;
519 
549 typedef struct pgpPktOnepass_s {
550  uint8_t version;
551  uint8_t sigtype;
552  uint8_t hash_algo;
553  uint8_t pubkey_algo;
555  uint8_t nested;
556 } * pgpPktOnepass;
557 
630 typedef struct pgpPktKeyV3_s {
631  uint8_t version;
633  uint8_t valid[2];
634  uint8_t pubkey_algo;
635 } * pgpPktKeyV3;
636 
673 typedef struct pgpPktKeyV4_s {
674  uint8_t version;
676  uint8_t pubkey_algo;
677 } * pgpPktKeyV4;
678 
743 typedef union pgpPktKey_u {
746 } pgpPktKey;
747 
772 typedef struct pgpPktCdata_s {
773  uint8_t compressalgo;
774  uint8_t data[1];
775 } pgpPktCdata;
776 
811 typedef struct pgpPktEdata_s {
812  uint8_t data[1];
813 } pgpPktEdata;
814 
862 typedef struct pgpPktLdata_s {
863  uint8_t format;
864  uint8_t filenamelen;
865  uint8_t filename[1];
866 } pgpPktLdata;
867 
881 typedef struct pgpPktTrust_s {
882  uint8_t flag;
883 } pgpPktTrust;
884 
895 typedef struct pgpPktUid_s {
896  uint8_t userid[1];
897 } pgpPktUid;
898 
901 union pgpPktPre_u {
913 };
914 
917 typedef enum pgpArmor_e {
925 #define PGPARMOR_ERROR PGPARMOR_ERR_NO_BEGIN_PGP
934 } pgpArmor;
935 
938 typedef enum pgpArmorKey_e {
944 } pgpArmorKey;
945 
946 typedef enum pgpValType_e {
957 } pgpValType;
958 
964 };
965 
967 
974 const char * pgpValString(pgpValType type, uint8_t val);
975 
982 static inline
983 unsigned int pgpGrab(const uint8_t *s, size_t nbytes)
984 {
985  size_t i = 0;
986  size_t nb = (nbytes <= sizeof(i) ? nbytes : sizeof(i));
987  while (nb--)
988  i = (i << 8) | *s++;
989  return i;
990 }
991 
998 char * pgpHexStr(const uint8_t *p, size_t plen);
999 
1008 int pgpPubkeyFingerprint(const uint8_t * pkt, size_t pktlen,
1009  uint8_t **fp, size_t *fplen);
1010 
1018 int pgpPubkeyKeyID(const uint8_t * pkt, size_t pktlen, pgpKeyID_t keyid);
1019 
1028 int pgpPrtParams(const uint8_t *pkts, size_t pktlen, unsigned int pkttype,
1029  pgpDigParams * ret);
1030 
1040 int pgpPrtParamsSubkeys(const uint8_t *pkts, size_t pktlen,
1041  pgpDigParams mainkey, pgpDigParams **subkeys,
1042  int *subkeysCount);
1051 int pgpPrtPkts(const uint8_t *pkts, size_t pktlen, pgpDig dig, int printing);
1052 
1060 pgpArmor pgpReadPkts(const char * fn, uint8_t ** pkt, size_t * pktlen);
1061 
1069 pgpArmor pgpParsePkts(const char *armor, uint8_t ** pkt, size_t * pktlen);
1070 
1083 int pgpPubKeyCertLen(const uint8_t *pkts, size_t pktslen, size_t *certlen);
1084 
1092 char * pgpArmorWrap(int atype, const unsigned char * s, size_t ns);
1093 
1098 pgpDig pgpNewDig(void);
1099 
1104 void pgpCleanDig(pgpDig dig);
1105 
1111 pgpDig pgpFreeDig(pgpDig dig);
1112 
1119 pgpDigParams pgpDigGetParams(pgpDig dig, unsigned int pkttype);
1120 
1128 
1135 unsigned int pgpDigParamsAlgo(pgpDigParams digp, unsigned int algotype);
1136 
1143 
1152 
1161 rpmRC pgpVerifySig(pgpDig dig, DIGEST_CTX hashctx);
1162 
1168 char *pgpIdentItem(pgpDigParams digp);
1169 
1177 int rpmInitCrypto(void);
1178 
1182 int rpmFreeCrypto(void);
1183 
1190 
1196 size_t rpmDigestLength(int hashalgo);
1197 
1205 DIGEST_CTX rpmDigestInit(int hashalgo, rpmDigestFlags flags);
1206 
1214 int rpmDigestUpdate(DIGEST_CTX ctx, const void * data, size_t len);
1215 
1227 int rpmDigestFinal(DIGEST_CTX ctx,
1228  void ** datap,
1229  size_t * lenp, int asAscii);
1230 
1236 
1243 
1252 int rpmDigestBundleAdd(rpmDigestBundle bundle, int algo,
1253  rpmDigestFlags flags);
1254 
1263 int rpmDigestBundleAddID(rpmDigestBundle bundle, int algo, int id,
1264  rpmDigestFlags flags);
1265 
1273 int rpmDigestBundleUpdate(rpmDigestBundle bundle, const void *data, size_t len);
1274 
1285 int rpmDigestBundleFinal(rpmDigestBundle bundle, int id,
1286  void ** datap, size_t * lenp, int asAscii);
1287 
1295 
1296 #ifdef __cplusplus
1297 }
1298 #endif
1299 
1300 #endif /* H_RPMPGP */
uint8_t userid[1]
Definition: rpmpgp.h:896
struct pgpPktSigV3_s v3
Definition: rpmpgp.h:482
5.5.1.
Definition: rpmpgp.h:630
uint8_t hash_algo
Definition: rpmpgp.h:350
struct pgpPktLdata_s pgpPktLdata
5.8.
5.7.
Definition: rpmpgp.h:811
pgpArmor pgpParsePkts(const char *armor, uint8_t **pkt, size_t *pktlen)
Parse armored OpenPGP packets from memory.
enum pgpPubkeyAlgo_e pgpPubkeyAlgo
9.1.
pgpDig pgpNewDig(void)
Create a container for parsed OpenPGP packet(s).
uint8_t hash_algo
Definition: rpmpgp.h:552
struct pgpPktSigV4_s * pgpPktSigV4
5.2.3.
struct pgpPktTrust_s pgpPktTrust
5.10.
struct pgpPktPubkey_s pgpPktPubkey
5.1.
pgpPktCdata cdata
Definition: rpmpgp.h:907
uint8_t pubkey_algo
Definition: rpmpgp.h:676
5.6.
Definition: rpmpgp.h:772
struct pgpPktKeyV3_s * pgpPktKeyV3
5.5.1.
pgpValType_e
Definition: rpmpgp.h:946
enum pgpSymkeyAlgo_e pgpSymkeyAlgo
9.2.
5.11.
Definition: rpmpgp.h:895
pgpPktOnepass onepass
Definition: rpmpgp.h:905
struct pgpPktCdata_s pgpPktCdata
5.6.
pgpTime_t time
Definition: rpmpgp.h:675
int pgpDigParamsCmp(pgpDigParams p1, pgpDigParams p2)
Compare OpenPGP packet parameters param p1 1st parameter container param p2 2nd parameter container r...
pgpTag_e
4.3.
Definition: rpmpgp.h:50
pgpArmor pgpReadPkts(const char *fn, uint8_t **pkt, size_t *pktlen)
Parse armored OpenPGP packets from a file.
uint8_t version
Definition: rpmpgp.h:315
uint8_t version
Definition: rpmpgp.h:631
rpmDigestBundle rpmDigestBundleFree(rpmDigestBundle bundle)
Free a digest bundle and all contained digest contexts.
pgpCurveId_e
ECC Curves.
Definition: rpmpgp.h:283
uint8_t signhash16[2]
Definition: rpmpgp.h:322
pgpPubkeyAlgo_e
9.1.
Definition: rpmpgp.h:167
uint8_t version
Definition: rpmpgp.h:550
struct pgpPktKeyV4_s * pgpPktKeyV4
The version 4 format is similar to the version 3 format except for the absence of a validity period...
int rpmDigestFinal(DIGEST_CTX ctx, void **datap, size_t *lenp, int asAscii)
Return digest and destroy context.
struct DIGEST_CTX_s * DIGEST_CTX
Definition: rpmpgp.h:29
5.2.3.
Definition: rpmpgp.h:346
enum pgpCurveId_e pgpCurveId
ECC Curves.
enum pgpCompressAlgo_e pgpCompressAlgo
9.3.
DIGEST_CTX rpmDigestBundleDupCtx(rpmDigestBundle bundle, int id)
Duplicate a digest context from a bundle.
DIGEST_CTX rpmDigestInit(int hashalgo, rpmDigestFlags flags)
Initialize digest.
uint8_t version
Definition: rpmpgp.h:111
pgpPktSig sig
Definition: rpmpgp.h:903
enum pgpArmorKey_e pgpArmorKey
uint8_t version
Definition: rpmpgp.h:347
uint8_t valid[2]
Definition: rpmpgp.h:633
pgpArmorKey_e
Definition: rpmpgp.h:938
uint8_t pubkey_algo
Definition: rpmpgp.h:553
pgpDig pgpFreeDig(pgpDig dig)
Destroy a container for parsed OpenPGP packet(s).
uint8_t flag
Definition: rpmpgp.h:882
struct pgpDig_s * pgpDig
Definition: rpmpgp.h:34
rpmRC pgpVerifySignature(pgpDigParams key, pgpDigParams sig, DIGEST_CTX hashctx)
Verify a PGP signature.
5.2.2.
Definition: rpmpgp.h:314
int pgpPubkeyKeyID(const uint8_t *pkt, size_t pktlen, pgpKeyID_t keyid)
Calculate OpenPGP public key Key ID.
5.5.3.
Definition: rpmpgp.h:743
uint8_t pgpKeyID_t[8]
Definition: rpmpgp.h:40
uint8_t s2k[1]
Definition: rpmpgp.h:517
int rpmDigestBundleFinal(rpmDigestBundle bundle, int id, void **datap, size_t *lenp, int asAscii)
Return digest from a bundle and destroy context, see rpmDigestFinal().
static unsigned int pgpGrab(const uint8_t *s, size_t nbytes)
Return (native-endian) integer from big-endian representation.
Definition: rpmpgp.h:983
struct rpmDigestBundle_s * rpmDigestBundle
Definition: rpmpgp.h:30
uint8_t pubkey_algo
Definition: rpmpgp.h:349
uint8_t data[1]
Definition: rpmpgp.h:774
rpmFlags rpmDigestFlags
Definition: rpmpgp.h:966
uint32_t rpmFlags
Definition: rpmtypes.h:42
pgpArmor_e
Definition: rpmpgp.h:917
pgpPktPubkey pubkey
Definition: rpmpgp.h:902
enum pgpHashAlgo_e pgpHashAlgo
9.4.
enum pgpValType_e pgpValType
struct pgpPktEdata_s pgpPktEdata
5.7.
uint8_t version
Definition: rpmpgp.h:515
uint8_t symkey_algo
Definition: rpmpgp.h:516
uint8_t data[1]
Definition: rpmpgp.h:812
int rpmDigestUpdate(DIGEST_CTX ctx, const void *data, size_t len)
Update context with next plain text buffer.
DIGEST_CTX rpmDigestDup(DIGEST_CTX octx)
Duplicate a digest context.
uint8_t format
Definition: rpmpgp.h:863
uint8_t sigtype
Definition: rpmpgp.h:348
uint8_t hash_algo
Definition: rpmpgp.h:321
char * pgpHexStr(const uint8_t *p, size_t plen)
Return hex formatted representation of bytes.
pgpPktKey key
Definition: rpmpgp.h:906
pgpDigParams pgpDigParamsFree(pgpDigParams digp)
Destroy parsed OpenPGP packet parameter(s).
rpmDigestFlags_e
Bit(s) to control digest operation.
Definition: rpmpgp.h:962
pgpDigParams pgpDigGetParams(pgpDig dig, unsigned int pkttype)
Retrieve parameters for parsed OpenPGP packet(s).
union pgpPktKey_u pgpPktKey
5.5.3.
rpmRC pgpVerifySig(pgpDig dig, DIGEST_CTX hashctx)
Verify a PGP signature.
int rpmDigestBundleUpdate(rpmDigestBundle bundle, const void *data, size_t len)
Update contexts within bundle with next plain text buffer.
rpmDigestBundle rpmDigestBundleNew(void)
Create a new digest bundle.
int pgpPubkeyFingerprint(const uint8_t *pkt, size_t pktlen, uint8_t **fp, size_t *fplen)
Calculate OpenPGP public key fingerprint.
enum pgpSubType_e pgpSubType
5.2.3.1.
uint8_t algo
Definition: rpmpgp.h:113
pgpTime_t time
Definition: rpmpgp.h:632
pgpSubType_e
5.2.3.1.
Definition: rpmpgp.h:420
pgpPktLdata ldata
Definition: rpmpgp.h:910
char * pgpArmorWrap(int atype, const unsigned char *s, size_t ns)
Wrap a OpenPGP packets in ascii armor for transport.
uint8_t nested
Definition: rpmpgp.h:555
struct pgpPktUid_s pgpPktUid
5.11.
uint8_t compressalgo
Definition: rpmpgp.h:773
pgpHashAlgo_e
9.4.
Definition: rpmpgp.h:264
uint8_t filename[1]
Definition: rpmpgp.h:865
pgpTime_t time
Definition: rpmpgp.h:318
uint8_t hashlen[2]
Definition: rpmpgp.h:351
struct pgpPktSigV3_s * pgpPktSigV3
5.2.2.
pgpKeyID_t signid
Definition: rpmpgp.h:319
pgpPktUid uid
Definition: rpmpgp.h:912
enum pgpTag_e pgpTag
4.3.
uint8_t pgpTime_t[4]
Definition: rpmpgp.h:41
unsigned int pgpDigParamsAlgo(pgpDigParams digp, unsigned int algotype)
Retrieve OpenPGP algorithm parameters param digp parameter container param algotype PGPVAL_HASHALGO /...
uint8_t version
Definition: rpmpgp.h:674
uint8_t pubkey_algo
Definition: rpmpgp.h:634
int rpmDigestBundleAddID(rpmDigestBundle bundle, int algo, int id, rpmDigestFlags flags)
Add a new type of digest to a bundle.
int rpmInitCrypto(void)
Perform cryptography initialization.
char * pgpIdentItem(pgpDigParams digp)
Return a string identification of a PGP signature/pubkey.
pgpPktEdata edata
Definition: rpmpgp.h:908
pgpSigType_e
5.2.1.
Definition: rpmpgp.h:123
struct pgpPktKeyV4_s v4
Definition: rpmpgp.h:745
uint8_t hashlen
Definition: rpmpgp.h:316
pgpPktTrust tdata
Definition: rpmpgp.h:911
uint8_t pubkey_algo
Definition: rpmpgp.h:320
5.2.
Definition: rpmpgp.h:481
struct pgpPktSigV4_s v4
Definition: rpmpgp.h:483
pgpKeyID_t keyid
Definition: rpmpgp.h:112
struct pgpDigParams_s * pgpDigParams
Definition: rpmpgp.h:38
int rpmFreeCrypto(void)
Shutdown cryptography.
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 mo...
struct pgpPktSymkey_s pgpPktSymkey
5.3.
pgpSymkeyAlgo_e
9.2.
Definition: rpmpgp.h:204
int pgpPrtParamsSubkeys(const uint8_t *pkts, size_t pktlen, pgpDigParams mainkey, pgpDigParams **subkeys, int *subkeysCount)
Parse subkey parameters from OpenPGP packet(s).
struct pgpPktKeyV3_s v3
Definition: rpmpgp.h:744
const char * pgpValString(pgpValType type, uint8_t val)
Return string representation of am OpenPGP value.
enum pgpSigType_e pgpSigType
5.2.1.
5.8.
Definition: rpmpgp.h:862
int pgpPrtParams(const uint8_t *pkts, size_t pktlen, unsigned int pkttype, pgpDigParams *ret)
Parse a OpenPGP packet(s).
union pgpPktSig_u * pgpPktSig
5.2.
uint8_t sigtype
Definition: rpmpgp.h:317
int rpmDigestBundleAdd(rpmDigestBundle bundle, int algo, rpmDigestFlags flags)
Add a new type of digest to a bundle.
void pgpCleanDig(pgpDig dig)
Release (malloc&#39;d) data from container.
pgpCompressAlgo_e
9.3.
Definition: rpmpgp.h:234
int pgpPrtPkts(const uint8_t *pkts, size_t pktlen, pgpDig dig, int printing)
Print/parse a OpenPGP packet(s).
The version 4 format is similar to the version 3 format except for the absence of a validity period...
Definition: rpmpgp.h:673
5.10.
Definition: rpmpgp.h:881
uint8_t sigtype
Definition: rpmpgp.h:551
pgpKeyID_t signid
Definition: rpmpgp.h:554
enum pgpArmor_e pgpArmor
uint8_t filenamelen
Definition: rpmpgp.h:864
enum rpmRC_e rpmRC
Package read return codes.
size_t rpmDigestLength(int hashalgo)
Obtain digest length in bytes.
pgpPktSymkey symkey
Definition: rpmpgp.h:904
struct pgpPktOnepass_s * pgpPktOnepass
5.4.