4 #include <rpm/rpmtypes.h>
11 * Pseudo-tags used by the rpmdb and rpmgi iterator API's.
13 #define RPMDBI_PACKAGES 0 /* Installed package headers. */
14 #define RPMDBI_DEPENDS 1 /* Dependency resolution cache. */
15 #define RPMDBI_LABEL 2 /* Fingerprint search marker. */
16 #define RPMDBI_ADDED 3 /* Added package headers. */
17 #define RPMDBI_REMOVED 4 /* Removed package headers. */
18 #define RPMDBI_AVAILABLE 5 /* Available package headers. */
19 #define RPMDBI_HDLIST 6 /* (rpmgi) Header list. */
20 #define RPMDBI_ARGLIST 7 /* (rpmgi) Argument list. */
21 #define RPMDBI_FTSWALK 8 /* (rpmgi) File tree walk. */
24 * Header private tags.
25 * @note General use tags should start at 1000 (RPM's tag space starts there).
27 #define HEADER_IMAGE 61
28 #define HEADER_SIGNATURES 62
29 #define HEADER_IMMUTABLE 63
30 #define HEADER_REGIONS 64
31 #define HEADER_I18NTABLE 100
32 #define HEADER_SIGBASE 256
33 #define HEADER_TAGBASE 1000
36 * Tags identify data in package headers.
37 * @note tags should not have value 0!
39 /** @todo: Somehow supply type **/
40 typedef enum rpmTag_e {
42 RPMTAG_HEADERIMAGE = HEADER_IMAGE, /*!< Current image. */
43 RPMTAG_HEADERSIGNATURES = HEADER_SIGNATURES, /*!< Signatures. */
44 RPMTAG_HEADERIMMUTABLE = HEADER_IMMUTABLE, /*!< Original image. */
45 RPMTAG_HEADERREGIONS = HEADER_REGIONS, /*!< Regions. */
47 RPMTAG_HEADERI18NTABLE = HEADER_I18NTABLE, /* s[] !< I18N string locales. */
49 /* Retrofit (and uniqify) signature tags for use by rpmTagGetName() and rpmQuery. */
50 /* the md5 sum was broken *twice* on big endian machines */
51 /* XXX 2nd underscore prevents tagTable generation */
52 RPMTAG_SIG_BASE = HEADER_SIGBASE,
53 RPMTAG_SIGSIZE = RPMTAG_SIG_BASE+1, /* i */
54 RPMTAG_SIGLEMD5_1 = RPMTAG_SIG_BASE+2, /* internal - obsolete */
55 RPMTAG_SIGPGP = RPMTAG_SIG_BASE+3, /* x */
56 RPMTAG_SIGLEMD5_2 = RPMTAG_SIG_BASE+4, /* x internal - obsolete */
57 RPMTAG_SIGMD5 = RPMTAG_SIG_BASE+5, /* x */
58 #define RPMTAG_PKGID RPMTAG_SIGMD5 /* x */
59 RPMTAG_SIGGPG = RPMTAG_SIG_BASE+6, /* x */
60 RPMTAG_SIGPGP5 = RPMTAG_SIG_BASE+7, /* internal - obsolete */
62 RPMTAG_BADSHA1_1 = RPMTAG_SIG_BASE+8, /* internal - obsolete */
63 RPMTAG_BADSHA1_2 = RPMTAG_SIG_BASE+9, /* internal - obsolete */
64 RPMTAG_PUBKEYS = RPMTAG_SIG_BASE+10, /* s[] */
65 RPMTAG_DSAHEADER = RPMTAG_SIG_BASE+11, /* x */
66 RPMTAG_RSAHEADER = RPMTAG_SIG_BASE+12, /* x */
67 RPMTAG_SHA1HEADER = RPMTAG_SIG_BASE+13, /* s */
68 #define RPMTAG_HDRID RPMTAG_SHA1HEADER /* s */
70 RPMTAG_NAME = 1000, /* s */
71 #define RPMTAG_N RPMTAG_NAME /* s */
72 RPMTAG_VERSION = 1001, /* s */
73 #define RPMTAG_V RPMTAG_VERSION /* s */
74 RPMTAG_RELEASE = 1002, /* s */
75 #define RPMTAG_R RPMTAG_RELEASE /* s */
76 RPMTAG_EPOCH = 1003, /* i */
77 #define RPMTAG_E RPMTAG_EPOCH /* i */
78 RPMTAG_SUMMARY = 1004, /* s{} */
79 RPMTAG_DESCRIPTION = 1005, /* s{} */
80 RPMTAG_BUILDTIME = 1006, /* i */
81 RPMTAG_BUILDHOST = 1007, /* s */
82 RPMTAG_INSTALLTIME = 1008, /* i */
83 RPMTAG_SIZE = 1009, /* i */
84 RPMTAG_DISTRIBUTION = 1010, /* s */
85 RPMTAG_VENDOR = 1011, /* s */
86 RPMTAG_GIF = 1012, /* x */
87 RPMTAG_XPM = 1013, /* x */
88 RPMTAG_LICENSE = 1014, /* s */
89 RPMTAG_PACKAGER = 1015, /* s */
90 RPMTAG_GROUP = 1016, /* s{} */
91 RPMTAG_CHANGELOG = 1017, /* s[] internal */
92 RPMTAG_SOURCE = 1018, /* s[] */
93 RPMTAG_PATCH = 1019, /* s[] */
94 RPMTAG_URL = 1020, /* s */
95 RPMTAG_OS = 1021, /* s legacy used int */
96 RPMTAG_ARCH = 1022, /* s legacy used int */
97 RPMTAG_PREIN = 1023, /* s */
98 RPMTAG_POSTIN = 1024, /* s */
99 RPMTAG_PREUN = 1025, /* s */
100 RPMTAG_POSTUN = 1026, /* s */
101 RPMTAG_OLDFILENAMES = 1027, /* s[] obsolete */
102 RPMTAG_FILESIZES = 1028, /* i[] */
103 RPMTAG_FILESTATES = 1029, /* c[] */
104 RPMTAG_FILEMODES = 1030, /* h[] */
105 RPMTAG_FILEUIDS = 1031, /* i[] internal */
106 RPMTAG_FILEGIDS = 1032, /* i[] internal */
107 RPMTAG_FILERDEVS = 1033, /* h[] */
108 RPMTAG_FILEMTIMES = 1034, /* i[] */
109 RPMTAG_FILEDIGESTS = 1035, /* s[] */
110 #define RPMTAG_FILEMD5S RPMTAG_FILEDIGESTS /* s[] */
111 RPMTAG_FILELINKTOS = 1036, /* s[] */
112 RPMTAG_FILEFLAGS = 1037, /* i[] */
113 RPMTAG_ROOT = 1038, /* internal - obsolete */
114 RPMTAG_FILEUSERNAME = 1039, /* s[] */
115 RPMTAG_FILEGROUPNAME = 1040, /* s[] */
116 RPMTAG_EXCLUDE = 1041, /* internal - obsolete */
117 RPMTAG_EXCLUSIVE = 1042, /* internal - obsolete */
118 RPMTAG_ICON = 1043, /* x */
119 RPMTAG_SOURCERPM = 1044, /* s */
120 RPMTAG_FILEVERIFYFLAGS = 1045, /* i[] */
121 RPMTAG_ARCHIVESIZE = 1046, /* i */
122 RPMTAG_PROVIDENAME = 1047, /* s[] */
123 #define RPMTAG_PROVIDES RPMTAG_PROVIDENAME /* s[] */
124 #define RPMTAG_P RPMTAG_PROVIDENAME /* s[] */
125 RPMTAG_REQUIREFLAGS = 1048, /* i[] */
126 RPMTAG_REQUIRENAME = 1049, /* s[] */
127 #define RPMTAG_REQUIRES RPMTAG_REQUIRENAME /* s[] */
128 RPMTAG_REQUIREVERSION = 1050, /* s[] */
129 RPMTAG_NOSOURCE = 1051, /* i internal */
130 RPMTAG_NOPATCH = 1052, /* i internal */
131 RPMTAG_CONFLICTFLAGS = 1053, /* i[] */
132 RPMTAG_CONFLICTNAME = 1054, /* s[] */
133 #define RPMTAG_CONFLICTS RPMTAG_CONFLICTNAME /* s[] */
134 #define RPMTAG_C RPMTAG_CONFLICTNAME /* s[] */
135 RPMTAG_CONFLICTVERSION = 1055, /* s[] */
136 RPMTAG_DEFAULTPREFIX = 1056, /* s internal - deprecated */
137 RPMTAG_BUILDROOT = 1057, /* s internal */
138 RPMTAG_INSTALLPREFIX = 1058, /* s internal - deprecated */
139 RPMTAG_EXCLUDEARCH = 1059, /* s[] */
140 RPMTAG_EXCLUDEOS = 1060, /* s[] */
141 RPMTAG_EXCLUSIVEARCH = 1061, /* s[] */
142 RPMTAG_EXCLUSIVEOS = 1062, /* s[] */
143 RPMTAG_AUTOREQPROV = 1063, /* s internal */
144 RPMTAG_RPMVERSION = 1064, /* s */
145 RPMTAG_TRIGGERSCRIPTS = 1065, /* s[] */
146 RPMTAG_TRIGGERNAME = 1066, /* s[] */
147 RPMTAG_TRIGGERVERSION = 1067, /* s[] */
148 RPMTAG_TRIGGERFLAGS = 1068, /* i[] */
149 RPMTAG_TRIGGERINDEX = 1069, /* i[] */
150 RPMTAG_VERIFYSCRIPT = 1079, /* s */
151 RPMTAG_CHANGELOGTIME = 1080, /* i[] */
152 RPMTAG_CHANGELOGNAME = 1081, /* s[] */
153 RPMTAG_CHANGELOGTEXT = 1082, /* s[] */
154 RPMTAG_BROKENMD5 = 1083, /* internal - obsolete */
155 RPMTAG_PREREQ = 1084, /* internal */
156 RPMTAG_PREINPROG = 1085, /* s */
157 RPMTAG_POSTINPROG = 1086, /* s */
158 RPMTAG_PREUNPROG = 1087, /* s */
159 RPMTAG_POSTUNPROG = 1088, /* s */
160 RPMTAG_BUILDARCHS = 1089, /* s[] */
161 RPMTAG_OBSOLETENAME = 1090, /* s[] */
162 #define RPMTAG_OBSOLETES RPMTAG_OBSOLETENAME /* s[] */
163 #define RPMTAG_O RPMTAG_OBSOLETENAME /* s[] */
164 RPMTAG_VERIFYSCRIPTPROG = 1091, /* s */
165 RPMTAG_TRIGGERSCRIPTPROG = 1092, /* s[] */
166 RPMTAG_DOCDIR = 1093, /* internal */
167 RPMTAG_COOKIE = 1094, /* s */
168 RPMTAG_FILEDEVICES = 1095, /* i[] */
169 RPMTAG_FILEINODES = 1096, /* i[] */
170 RPMTAG_FILELANGS = 1097, /* s[] */
171 RPMTAG_PREFIXES = 1098, /* s[] */
172 RPMTAG_INSTPREFIXES = 1099, /* s[] */
173 RPMTAG_TRIGGERIN = 1100, /* internal */
174 RPMTAG_TRIGGERUN = 1101, /* internal */
175 RPMTAG_TRIGGERPOSTUN = 1102, /* internal */
176 RPMTAG_AUTOREQ = 1103, /* internal */
177 RPMTAG_AUTOPROV = 1104, /* internal */
178 RPMTAG_CAPABILITY = 1105, /* i legacy - obsolete */
179 RPMTAG_SOURCEPACKAGE = 1106, /* i legacy - obsolete */
180 RPMTAG_OLDORIGFILENAMES = 1107, /* internal - obsolete */
181 RPMTAG_BUILDPREREQ = 1108, /* internal */
182 RPMTAG_BUILDREQUIRES = 1109, /* internal */
183 RPMTAG_BUILDCONFLICTS = 1110, /* internal */
184 RPMTAG_BUILDMACROS = 1111, /* internal - unused */
185 RPMTAG_PROVIDEFLAGS = 1112, /* i[] */
186 RPMTAG_PROVIDEVERSION = 1113, /* s[] */
187 RPMTAG_OBSOLETEFLAGS = 1114, /* i[] */
188 RPMTAG_OBSOLETEVERSION = 1115, /* s[] */
189 RPMTAG_DIRINDEXES = 1116, /* i[] */
190 RPMTAG_BASENAMES = 1117, /* s[] */
191 RPMTAG_DIRNAMES = 1118, /* s[] */
192 RPMTAG_ORIGDIRINDEXES = 1119, /* i[] relocation */
193 RPMTAG_ORIGBASENAMES = 1120, /* s[] relocation */
194 RPMTAG_ORIGDIRNAMES = 1121, /* s[] relocation */
195 RPMTAG_OPTFLAGS = 1122, /* s */
196 RPMTAG_DISTURL = 1123, /* s */
197 RPMTAG_PAYLOADFORMAT = 1124, /* s */
198 RPMTAG_PAYLOADCOMPRESSOR = 1125, /* s */
199 RPMTAG_PAYLOADFLAGS = 1126, /* s */
200 RPMTAG_INSTALLCOLOR = 1127, /* i transaction color when installed */
201 RPMTAG_INSTALLTID = 1128, /* i */
202 RPMTAG_REMOVETID = 1129, /* i */
203 RPMTAG_SHA1RHN = 1130, /* internal - obsolete */
204 RPMTAG_RHNPLATFORM = 1131, /* s deprecated */
205 RPMTAG_PLATFORM = 1132, /* s */
206 RPMTAG_PATCHESNAME = 1133, /* s[] deprecated placeholder (SuSE) */
207 RPMTAG_PATCHESFLAGS = 1134, /* i[] deprecated placeholder (SuSE) */
208 RPMTAG_PATCHESVERSION = 1135, /* s[] deprecated placeholder (SuSE) */
209 RPMTAG_CACHECTIME = 1136, /* i */
210 RPMTAG_CACHEPKGPATH = 1137, /* s */
211 RPMTAG_CACHEPKGSIZE = 1138, /* i */
212 RPMTAG_CACHEPKGMTIME = 1139, /* i */
213 RPMTAG_FILECOLORS = 1140, /* i[] */
214 RPMTAG_FILECLASS = 1141, /* i[] */
215 RPMTAG_CLASSDICT = 1142, /* s[] */
216 RPMTAG_FILEDEPENDSX = 1143, /* i[] */
217 RPMTAG_FILEDEPENDSN = 1144, /* i[] */
218 RPMTAG_DEPENDSDICT = 1145, /* i[] */
219 RPMTAG_SOURCEPKGID = 1146, /* x */
220 RPMTAG_FILECONTEXTS = 1147, /* s[] - obsolete */
221 RPMTAG_FSCONTEXTS = 1148, /* s[] extension */
222 RPMTAG_RECONTEXTS = 1149, /* s[] extension */
223 RPMTAG_POLICIES = 1150, /* s[] selinux *.te policy file. */
224 RPMTAG_PRETRANS = 1151, /* s */
225 RPMTAG_POSTTRANS = 1152, /* s */
226 RPMTAG_PRETRANSPROG = 1153, /* s */
227 RPMTAG_POSTTRANSPROG = 1154, /* s */
228 RPMTAG_DISTTAG = 1155, /* s */
229 RPMTAG_SUGGESTSNAME = 1156, /* s[] extension */
230 #define RPMTAG_SUGGESTS RPMTAG_SUGGESTSNAME /* s[] */
231 RPMTAG_SUGGESTSVERSION = 1157, /* s[] extension */
232 RPMTAG_SUGGESTSFLAGS = 1158, /* i[] extension */
233 RPMTAG_ENHANCESNAME = 1159, /* s[] extension placeholder */
234 #define RPMTAG_ENHANCES RPMTAG_ENHANCESNAME /* s[] */
235 RPMTAG_ENHANCESVERSION = 1160, /* s[] extension placeholder */
236 RPMTAG_ENHANCESFLAGS = 1161, /* i[] extension placeholder */
237 RPMTAG_PRIORITY = 1162, /* i[] extension placeholder */
238 RPMTAG_CVSID = 1163, /* s */
239 #define RPMTAG_SVNID RPMTAG_CVSID /* s */
240 RPMTAG_BLINKPKGID = 1164, /* s[] */
241 RPMTAG_BLINKHDRID = 1165, /* s[] */
242 RPMTAG_BLINKNEVRA = 1166, /* s[] */
243 RPMTAG_FLINKPKGID = 1167, /* s[] */
244 RPMTAG_FLINKHDRID = 1168, /* s[] */
245 RPMTAG_FLINKNEVRA = 1169, /* s[] */
246 RPMTAG_PACKAGEORIGIN = 1170, /* s */
247 RPMTAG_TRIGGERPREIN = 1171, /* internal */
248 RPMTAG_BUILDSUGGESTS = 1172, /* internal */
249 RPMTAG_BUILDENHANCES = 1173, /* internal */
250 RPMTAG_SCRIPTSTATES = 1174, /* i[] scriptlet exit codes */
251 RPMTAG_SCRIPTMETRICS = 1175, /* i[] scriptlet execution times */
252 RPMTAG_BUILDCPUCLOCK = 1176, /* i */
253 RPMTAG_FILEDIGESTALGO = 1177, /* i file checksum algorithm */
254 RPMTAG_VARIANTS = 1178, /* s[] */
255 RPMTAG_XMAJOR = 1179, /* i */
256 RPMTAG_XMINOR = 1180, /* i */
257 RPMTAG_REPOTAG = 1181, /* s */
258 RPMTAG_KEYWORDS = 1182, /* s[] */
259 RPMTAG_BUILDPLATFORMS = 1183, /* s[] */
260 RPMTAG_PACKAGECOLOR = 1184, /* i */
261 RPMTAG_PACKAGEPREFCOLOR = 1185, /* i (unimplemented) */
262 RPMTAG_XATTRSDICT = 1186, /* s[] (unimplemented) */
263 RPMTAG_FILEXATTRSX = 1187, /* i[] (unimplemented) */
264 RPMTAG_DEPATTRSDICT = 1188, /* s[] (unimplemented) */
265 RPMTAG_CONFLICTATTRSX = 1189, /* i[] (unimplemented) */
266 RPMTAG_OBSOLETEATTRSX = 1190, /* i[] (unimplemented) */
267 RPMTAG_PROVIDEATTRSX = 1191, /* i[] (unimplemented) */
268 RPMTAG_REQUIREATTRSX = 1192, /* i[] (unimplemented) */
269 RPMTAG_BUILDPROVIDES = 1193, /* internal */
270 RPMTAG_BUILDOBSOLETES = 1194, /* internal */
271 RPMTAG_FILENAMES = 5000, /* s[] extension */
272 RPMTAG_FILEPROVIDE = 5001, /* s[] extension */
273 RPMTAG_FILEREQUIRE = 5002, /* s[] extension */
274 RPMTAG_FSNAMES = 5003, /* s[] extension */
275 RPMTAG_FSSIZES = 5004, /* i[] extension */
276 RPMTAG_TRIGGERCONDS = 5005, /* s[] extension */
277 RPMTAG_TRIGGERTYPE = 5006, /* s[] extension */
279 RPMTAG_FIRSTFREE_TAG /*!< internal */
282 #define RPMTAG_EXTERNAL_TAG 1000000
283 #define RPMTAG_NOT_FOUND -1
285 /** \ingroup signature
286 * Tags found in signature header from package.
288 typedef enum rpmSigTag_e {
289 RPMSIGTAG_SIZE = 1000, /*!< internal Header+Payload size in bytes. */
290 RPMSIGTAG_LEMD5_1 = 1001, /*!< internal Broken MD5, take 1 @deprecated legacy. */
291 RPMSIGTAG_PGP = 1002, /*!< internal PGP 2.6.3 signature. */
292 RPMSIGTAG_LEMD5_2 = 1003, /*!< internal Broken MD5, take 2 @deprecated legacy. */
293 RPMSIGTAG_MD5 = 1004, /*!< internal MD5 signature. */
294 RPMSIGTAG_GPG = 1005, /*!< internal GnuPG signature. */
295 RPMSIGTAG_PGP5 = 1006, /*!< internal PGP5 signature @deprecated legacy. */
296 RPMSIGTAG_PAYLOADSIZE = 1007,/*!< internal uncompressed payload size in bytes. */
297 RPMSIGTAG_BADSHA1_1 = RPMTAG_BADSHA1_1, /*!< internal Broken SHA1, take 1. */
298 RPMSIGTAG_BADSHA1_2 = RPMTAG_BADSHA1_2, /*!< internal Broken SHA1, take 2. */
299 RPMSIGTAG_SHA1 = RPMTAG_SHA1HEADER, /*!< internal sha1 header digest. */
300 RPMSIGTAG_DSA = RPMTAG_DSAHEADER, /*!< internal DSA header signature. */
301 RPMSIGTAG_RSA = RPMTAG_RSAHEADER /*!< internal RSA header signature. */
306 * The basic types of data in tags from headers.
308 typedef enum rpmTagType_e {
309 #define RPM_MIN_TYPE 0
318 RPM_STRING_ARRAY_TYPE = 8,
319 RPM_I18NSTRING_TYPE = 9,
320 #define RPM_MAX_TYPE 9
321 #define RPM_FORCEFREE_TYPE 0xff
322 #define RPM_MASK_TYPE 0x0000ffff
326 * New rpm data types under consideration/development.
327 * These data types may (or may not) be added to rpm at some point. In order
328 * to avoid incompatibility with legacy versions of rpm, these data (sub-)types
329 * are introduced into the header by overloading RPM_BIN_TYPE, with the binary
330 * value of the tag a 16 byte image of what should/will be in the header index,
331 * followed by per-tag private data.
333 typedef enum rpmSubTagType_e {
334 RPM_REGION_TYPE = -10,
335 RPM_BIN_ARRAY_TYPE = -11,
336 /*!<@todo Implement, kinda like RPM_STRING_ARRAY_TYPE for known (but variable)
337 length binary data. */
339 /*!<@todo Implement, intent is to to carry a (???,tagNum,valNum) cross
340 reference to retrieve data from other tags. */
344 * * Identify how to return the header data type.
346 typedef enum rpmTagReturnType_e {
347 RPM_ANY_RETURN_TYPE = 0,
348 RPM_SCALAR_RETURN_TYPE = 0x00010000,
349 RPM_ARRAY_RETURN_TYPE = 0x00020000,
350 RPM_MAPPING_RETURN_TYPE = 0x00040000,
351 RPM_MASK_RETURN_TYPE = 0xffff0000
355 * Return tag name from value.
356 * @param tag tag value
357 * @return tag name, "(unknown)" on not found
359 const char * rpmTagGetName(rpmTag tag);
362 * Return tag data type from value.
363 * @param tag tag value
364 * @return tag data type, RPM_NULL_TYPE on not found.
366 rpmTagType rpmTagGetType(rpmTag tag);
369 * Return tag value from name.
370 * @param tagstr name of tag
371 * @return tag value, -1 on not found
373 rpmTag rpmTagGetValue(const char * tagstr);
376 * Return known rpm tag names, sorted by name.
377 * @retval tagnames tag container of string array type
378 * @param fullname return short or full name
379 * @return number of tag names, 0 on error
381 int rpmTagGetNames(rpmtd tagnames, int fullname);
387 #endif /* _RPMTAG_H */