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 * @len: The amount of data available to read.
38 * @parselen: The amount of data that was actually parsed.
39 * @keyid: A pointer to where we should return the keyid.
40 * @creationtime: A pointer to where we should return the creation time.
42 * This function parses the subkey data of a Type 4 signature and fills
43 * in the supplied variables. It also returns the length of the data
44 * processed. If the value of any piece of data is not desired a NULL
45 * can be passed instead of a pointer to a storage area for that value.
47 onak_status_t parse_subpackets(unsigned char *data, size_t len,
48 size_t *parselen, uint64_t *keyid, time_t *creation)
54 log_assert(data != NULL);
56 /* Make sure we actually have the 2 byte length field */
58 return ONAK_E_INVALID_PKT;
61 length = (data[0] << 8) + data[1] + 2;
63 /* If the length is off the end of the data available, it's bogus */
65 return ONAK_E_INVALID_PKT;
71 while (offset < length) {
72 packetlen = data[offset++];
73 if (packetlen > 191 && packetlen < 255) {
74 packetlen = ((packetlen - 192) << 8) +
76 } else if (packetlen == 255) {
77 packetlen = data[offset++];
79 packetlen |= data[offset++];
81 packetlen |= data[offset++];
83 packetlen |= data[offset++];
85 switch (data[offset] & 0x7F) {
86 case OPENPGP_SIGSUB_CREATION:
88 * Signature creation time.
90 if (creation != NULL) {
91 *creation = data[offset + packetlen - 4];
93 *creation = data[offset + packetlen - 3];
95 *creation = data[offset + packetlen - 2];
97 *creation = data[offset + packetlen - 1];
101 * Signature expiration time. Might want to output this?
104 case OPENPGP_SIGSUB_ISSUER:
106 *keyid = data[offset+packetlen - 8];
108 *keyid += data[offset+packetlen - 7];
110 *keyid += data[offset+packetlen - 6];
112 *keyid += data[offset+packetlen - 5];
114 *keyid += data[offset+packetlen - 4];
116 *keyid += data[offset+packetlen - 3];
118 *keyid += data[offset+packetlen - 2];
120 *keyid += data[offset+packetlen - 1];
123 case OPENPGP_SIGSUB_EXPIRY:
124 case OPENPGP_SIGSUB_EXPORTABLE:
125 case OPENPGP_SIGSUB_TRUSTSIG:
126 case OPENPGP_SIGSUB_REGEX:
127 case OPENPGP_SIGSUB_REVOCABLE:
128 case OPENPGP_SIGSUB_CAPABILITIES:
129 case OPENPGP_SIGSUB_KEYEXPIRY:
130 case OPENPGP_SIGSUB_ARR:
131 case OPENPGP_SIGSUB_PREFSYM:
132 case OPENPGP_SIGSUB_REVOCATION_KEY:
133 case OPENPGP_SIGSUB_ISSUER_UID:
134 case OPENPGP_SIGSUB_URL:
135 case OPENPGP_SIGSUB_ISSUER_FINGER:
136 case OPENPGP_SIGSUB_NOTATION:
137 case OPENPGP_SIGSUB_PREFHASH:
138 case OPENPGP_SIGSUB_PREFCOMPRESS:
139 case OPENPGP_SIGSUB_KEYSERVER:
140 case OPENPGP_SIGSUB_PREFKEYSERVER:
141 case OPENPGP_SIGSUB_PRIMARYUID:
142 case OPENPGP_SIGSUB_POLICYURI:
143 case OPENPGP_SIGSUB_KEYFLAGS:
144 case OPENPGP_SIGSUB_SIGNER_UID:
145 case OPENPGP_SIGSUB_REVOKE_REASON:
146 case OPENPGP_SIGSUB_FEATURES:
147 case OPENPGP_SIGSUB_SIGNATURE_TARGET:
148 case OPENPGP_SIGSUB_EMBEDDED_SIG:
150 * Various subpacket types we know about, but don't
151 * currently handle. Some are candidates for being
152 * supported if we add signature checking support.
157 * We don't care about unrecognized packets unless bit
158 * 7 is set in which case we log a major error.
160 if (data[offset] & 0x80) {
161 logthing(LOGTHING_CRITICAL,
162 "Critical subpacket type not parsed: 0x%X",
174 * keysigs - Return the sigs on a given OpenPGP signature list.
175 * @curll: The current linked list. Can be NULL to create a new list.
176 * @sigs: The signature list we want the sigs on.
178 * Returns a linked list of stats_key elements containing the sigs on the
179 * supplied OpenPGP packet list.
181 struct ll *keysigs(struct ll *curll,
182 struct openpgp_packet_list *sigs)
186 while (sigs != NULL) {
187 keyid = sig_keyid(sigs->packet);
189 curll = lladd(curll, createandaddtohash(keyid));
196 * sig_info - Get info on a given OpenPGP signature packet
197 * @packet: The signature packet
198 * @keyid: A pointer for where to return the signature keyid
199 * @creation: A pointer for where to return the signature creation time
201 * Gets any info about a signature packet; parses the subpackets for a v4
202 * key or pulls the data directly from v2/3. NULL can be passed for any
203 * values which aren't cared about.
205 onak_status_t sig_info(struct openpgp_packet *packet, uint64_t *keyid,
211 if (packet != NULL) {
212 switch (packet->data[0]) {
216 *keyid = packet->data[7];
218 *keyid += packet->data[8];
220 *keyid += packet->data[9];
222 *keyid += packet->data[10];
224 *keyid += packet->data[11];
226 *keyid += packet->data[12];
228 *keyid += packet->data[13];
230 *keyid += packet->data[14];
232 if (creation != NULL) {
233 *creation = packet->data[3];
235 *creation = packet->data[4];
237 *creation = packet->data[5];
239 *creation = packet->data[6];
243 res = parse_subpackets(&packet->data[4],
245 &length, keyid, creation);
246 if (res != ONAK_E_OK) {
249 res = parse_subpackets(&packet->data[length + 4],
250 packet->length - (4 + length),
251 &length, keyid, creation);
252 if (res != ONAK_E_OK) {
265 * sig_keyid - Return the keyid for a given OpenPGP signature packet.
266 * @packet: The signature packet.
268 * Returns the keyid for the supplied signature packet.
270 uint64_t sig_keyid(struct openpgp_packet *packet)
274 sig_info(packet, &keyid, NULL);
281 * TODO: Abstract out; all our linked lists should be generic and then we can
284 int spsize(struct openpgp_signedpacket_list *list)
287 struct openpgp_signedpacket_list *cur;
289 for (cur = list; cur != NULL; cur = cur->next, size++) ;
295 * keyuids - Takes a key and returns an array of its UIDs
296 * @key: The key to get the uids of.
297 * @primary: A pointer to store the primary UID in.
299 * keyuids takes a public key structure and builds an array of the UIDs
300 * on the key. It also attempts to work out the primary UID and returns a
301 * separate pointer to that particular element of the array.
303 char **keyuids(struct openpgp_publickey *key, char **primary)
305 struct openpgp_signedpacket_list *curuid = NULL;
310 if (primary != NULL) {
314 if (key != NULL && key->uids != NULL) {
315 uids = malloc((spsize(key->uids) + 1) * sizeof (char *));
318 while (curuid != NULL) {
320 if (curuid->packet->tag == OPENPGP_PACKET_UID) {
321 snprintf(buf, 1023, "%.*s",
322 (int) curuid->packet->length,
323 curuid->packet->data);
324 uids[count++] = strdup(buf);
326 curuid = curuid -> next;
331 * TODO: Parse subpackets for real primary ID (v4 keys)
333 if (primary != NULL) {
342 * keysubkeys - Takes a key and returns an array of its subkey keyids.
343 * @key: The key to get the subkeys of.
345 * keysubkeys takes a public key structure and returns an array of the
346 * subkey keyids for that key.
348 struct openpgp_fingerprint *keysubkeys(struct openpgp_publickey *key)
350 struct openpgp_signedpacket_list *cursubkey = NULL;
351 struct openpgp_fingerprint *subkeys = NULL;
354 if (key != NULL && key->subkeys != NULL) {
355 subkeys = malloc((spsize(key->subkeys) + 1) *
356 sizeof (struct openpgp_fingerprint));
357 cursubkey = key->subkeys;
358 while (cursubkey != NULL) {
359 get_fingerprint(cursubkey->packet, &subkeys[count++]);
360 cursubkey = cursubkey -> next;
362 subkeys[count].length = 0;