2 * decodekey.c - Routines to further decode an OpenPGP key.
4 * Copyright 2002-2008 Jonathan McDowell <noodles@earth.li>
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; version 2 of the License.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 #include "decodekey.h"
29 #include "keystructs.h"
35 * parse_subpackets - Parse the subpackets of a Type 4 signature.
36 * @data: The subpacket data.
37 * @keyid: A pointer to where we should return the keyid.
38 * @creationtime: A pointer to where we should return the creation time.
40 * This function parses the subkey data of a Type 4 signature and fills
41 * in the supplied variables. It also returns the length of the data
42 * processed. If the value of any piece of data is not desired a NULL
43 * can be passed instead of a pointer to a storage area for that value.
45 int parse_subpackets(unsigned char *data, uint64_t *keyid, time_t *creation)
51 log_assert(data != NULL);
53 length = (data[0] << 8) + data[1] + 2;
56 while (offset < length) {
57 packetlen = data[offset++];
58 if (packetlen > 191 && packetlen < 255) {
59 packetlen = ((packetlen - 192) << 8) +
61 } else if (packetlen == 255) {
62 packetlen = data[offset++];
64 packetlen |= data[offset++];
66 packetlen |= data[offset++];
68 packetlen |= data[offset++];
70 switch (data[offset] & 0x7F) {
71 case OPENPGP_SIGSUB_CREATION:
73 * Signature creation time.
75 if (creation != NULL) {
76 *creation = data[offset + packetlen - 4];
78 *creation = data[offset + packetlen - 3];
80 *creation = data[offset + packetlen - 2];
82 *creation = data[offset + packetlen - 1];
86 * Signature expiration time. Might want to output this?
89 case OPENPGP_SIGSUB_ISSUER:
91 *keyid = data[offset+packetlen - 8];
93 *keyid += data[offset+packetlen - 7];
95 *keyid += data[offset+packetlen - 6];
97 *keyid += data[offset+packetlen - 5];
99 *keyid += data[offset+packetlen - 4];
101 *keyid += data[offset+packetlen - 3];
103 *keyid += data[offset+packetlen - 2];
105 *keyid += data[offset+packetlen - 1];
108 case OPENPGP_SIGSUB_EXPIRY:
109 case OPENPGP_SIGSUB_EXPORTABLE:
110 case OPENPGP_SIGSUB_TRUSTSIG:
111 case OPENPGP_SIGSUB_REGEX:
112 case OPENPGP_SIGSUB_REVOCABLE:
113 case OPENPGP_SIGSUB_CAPABILITIES:
114 case OPENPGP_SIGSUB_KEYEXPIRY:
115 case OPENPGP_SIGSUB_ARR:
116 case OPENPGP_SIGSUB_PREFSYM:
117 case OPENPGP_SIGSUB_REVOCATION_KEY:
118 case OPENPGP_SIGSUB_ISSUER_UID:
119 case OPENPGP_SIGSUB_URL:
120 case OPENPGP_SIGSUB_ISSUER_FINGER:
121 case OPENPGP_SIGSUB_NOTATION:
122 case OPENPGP_SIGSUB_PREFHASH:
123 case OPENPGP_SIGSUB_PREFCOMPRESS:
124 case OPENPGP_SIGSUB_KEYSERVER:
125 case OPENPGP_SIGSUB_PREFKEYSERVER:
126 case OPENPGP_SIGSUB_PRIMARYUID:
127 case OPENPGP_SIGSUB_POLICYURI:
128 case OPENPGP_SIGSUB_KEYFLAGS:
129 case OPENPGP_SIGSUB_SIGNER_UID:
130 case OPENPGP_SIGSUB_REVOKE_REASON:
131 case OPENPGP_SIGSUB_FEATURES:
132 case OPENPGP_SIGSUB_SIGNATURE_TARGET:
133 case OPENPGP_SIGSUB_EMBEDDED_SIG:
135 * Various subpacket types we know about, but don't
136 * currently handle. Some are candidates for being
137 * supported if we add signature checking support.
142 * We don't care about unrecognized packets unless bit
143 * 7 is set in which case we log a major error.
145 if (data[offset] & 0x80) {
146 logthing(LOGTHING_CRITICAL,
147 "Critical subpacket type not parsed: 0x%X",
159 * keysigs - Return the sigs on a given OpenPGP signature list.
160 * @curll: The current linked list. Can be NULL to create a new list.
161 * @sigs: The signature list we want the sigs on.
163 * Returns a linked list of stats_key elements containing the sigs on the
164 * supplied OpenPGP packet list.
166 struct ll *keysigs(struct ll *curll,
167 struct openpgp_packet_list *sigs)
171 while (sigs != NULL) {
172 keyid = sig_keyid(sigs->packet);
174 curll = lladd(curll, createandaddtohash(keyid));
181 * sig_info - Get info on a given OpenPGP signature packet
182 * @packet: The signature packet
183 * @keyid: A pointer for where to return the signature keyid
184 * @creation: A pointer for where to return the signature creation time
186 * Gets any info about a signature packet; parses the subpackets for a v4
187 * key or pulls the data directly from v2/3. NULL can be passed for any
188 * values which aren't cared about.
190 void sig_info(struct openpgp_packet *packet, uint64_t *keyid, time_t *creation)
194 if (packet != NULL) {
195 switch (packet->data[0]) {
199 *keyid = packet->data[7];
201 *keyid += packet->data[8];
203 *keyid += packet->data[9];
205 *keyid += packet->data[10];
207 *keyid += packet->data[11];
209 *keyid += packet->data[12];
211 *keyid += packet->data[13];
213 *keyid += packet->data[14];
215 if (creation != NULL) {
216 *creation = packet->data[3];
218 *creation = packet->data[4];
220 *creation = packet->data[5];
222 *creation = packet->data[6];
226 length = parse_subpackets(&packet->data[4],
228 parse_subpackets(&packet->data[length + 4],
231 * Don't bother to look at the unsigned packets.
243 * sig_keyid - Return the keyid for a given OpenPGP signature packet.
244 * @packet: The signature packet.
246 * Returns the keyid for the supplied signature packet.
248 uint64_t sig_keyid(struct openpgp_packet *packet)
252 sig_info(packet, &keyid, NULL);
259 * TODO: Abstract out; all our linked lists should be generic and then we can
262 int spsize(struct openpgp_signedpacket_list *list)
265 struct openpgp_signedpacket_list *cur;
267 for (cur = list; cur != NULL; cur = cur->next, size++) ;
273 * keyuids - Takes a key and returns an array of its UIDs
274 * @key: The key to get the uids of.
275 * @primary: A pointer to store the primary UID in.
277 * keyuids takes a public key structure and builds an array of the UIDs
278 * on the key. It also attempts to work out the primary UID and returns a
279 * separate pointer to that particular element of the array.
281 char **keyuids(struct openpgp_publickey *key, char **primary)
283 struct openpgp_signedpacket_list *curuid = NULL;
288 if (primary != NULL) {
292 if (key != NULL && key->uids != NULL) {
293 uids = malloc((spsize(key->uids) + 1) * sizeof (char *));
296 while (curuid != NULL) {
298 if (curuid->packet->tag == OPENPGP_PACKET_UID) {
299 snprintf(buf, 1023, "%.*s",
300 (int) curuid->packet->length,
301 curuid->packet->data);
302 uids[count++] = strdup(buf);
304 curuid = curuid -> next;
309 * TODO: Parse subpackets for real primary ID (v4 keys)
311 if (primary != NULL) {
320 * keysubkeys - Takes a key and returns an array of its subkey keyids.
321 * @key: The key to get the subkeys of.
323 * keysubkeys takes a public key structure and returns an array of the
324 * subkey keyids for that key.
326 struct openpgp_fingerprint *keysubkeys(struct openpgp_publickey *key)
328 struct openpgp_signedpacket_list *cursubkey = NULL;
329 struct openpgp_fingerprint *subkeys = NULL;
332 if (key != NULL && key->subkeys != NULL) {
333 subkeys = malloc((spsize(key->subkeys) + 1) *
334 sizeof (struct openpgp_fingerprint));
335 cursubkey = key->subkeys;
336 while (cursubkey != NULL) {
337 get_fingerprint(cursubkey->packet, &subkeys[count++]);
338 cursubkey = cursubkey -> next;
340 subkeys[count].length = 0;