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, see <https://www.gnu.org/licenses/>.
25 #include "decodekey.h"
28 #include "keystructs.h"
33 * parse_subpackets - Parse the subpackets of a Type 4 signature.
34 * @data: The subpacket data.
35 * @len: The amount of data available to read.
36 * @parselen: The amount of data that was actually parsed.
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 onak_status_t parse_subpackets(unsigned char *data, size_t len,
46 size_t *parselen, uint64_t *keyid, time_t *creation)
51 struct openpgp_fingerprint fp;
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 /* Check the supplied length is within the remaining data */
86 if (packetlen == 0 || (packetlen + offset) > length) {
87 return ONAK_E_INVALID_PKT;
89 switch (data[offset] & 0x7F) {
90 case OPENPGP_SIGSUB_CREATION:
92 * Signature creation time.
94 if (creation != NULL) {
95 *creation = data[offset + packetlen - 4];
97 *creation = data[offset + packetlen - 3];
99 *creation = data[offset + packetlen - 2];
101 *creation = data[offset + packetlen - 1];
105 * Signature expiration time. Might want to output this?
108 case OPENPGP_SIGSUB_ISSUER:
110 *keyid = data[offset+packetlen - 8];
112 *keyid += data[offset+packetlen - 7];
114 *keyid += data[offset+packetlen - 6];
116 *keyid += data[offset+packetlen - 5];
118 *keyid += data[offset+packetlen - 4];
120 *keyid += data[offset+packetlen - 3];
122 *keyid += data[offset+packetlen - 2];
124 *keyid += data[offset+packetlen - 1];
127 case OPENPGP_SIGSUB_ISSUER_FINGER:
128 if ((packetlen - 2) <= MAX_FINGERPRINT_LEN &&
130 fp.length = packetlen - 2;
131 for (i = 0; i < fp.length; i++) {
132 fp.fp[i] = data[offset + i + 2];
134 *keyid = fingerprint2keyid(&fp);
137 case OPENPGP_SIGSUB_EXPIRY:
138 case OPENPGP_SIGSUB_EXPORTABLE:
139 case OPENPGP_SIGSUB_TRUSTSIG:
140 case OPENPGP_SIGSUB_REGEX:
141 case OPENPGP_SIGSUB_REVOCABLE:
142 case OPENPGP_SIGSUB_CAPABILITIES:
143 case OPENPGP_SIGSUB_KEYEXPIRY:
144 case OPENPGP_SIGSUB_ARR:
145 case OPENPGP_SIGSUB_PREFSYM:
146 case OPENPGP_SIGSUB_REVOCATION_KEY:
147 case OPENPGP_SIGSUB_ISSUER_UID:
148 case OPENPGP_SIGSUB_URL:
149 case OPENPGP_SIGSUB_X_ISSUER_FINGER:
150 case OPENPGP_SIGSUB_NOTATION:
151 case OPENPGP_SIGSUB_PREFHASH:
152 case OPENPGP_SIGSUB_PREFCOMPRESS:
153 case OPENPGP_SIGSUB_KEYSERVER:
154 case OPENPGP_SIGSUB_PREFKEYSERVER:
155 case OPENPGP_SIGSUB_PRIMARYUID:
156 case OPENPGP_SIGSUB_POLICYURI:
157 case OPENPGP_SIGSUB_KEYFLAGS:
158 case OPENPGP_SIGSUB_SIGNER_UID:
159 case OPENPGP_SIGSUB_REVOKE_REASON:
160 case OPENPGP_SIGSUB_FEATURES:
161 case OPENPGP_SIGSUB_SIGNATURE_TARGET:
162 case OPENPGP_SIGSUB_EMBEDDED_SIG:
164 * Various subpacket types we know about, but don't
165 * currently handle. Some are candidates for being
166 * supported if we add signature checking support.
171 * We don't care about unrecognized packets unless bit
172 * 7 is set in which case we log a major error.
174 if (data[offset] & 0x80) {
175 return ONAK_E_UNSUPPORTED_FEATURE;
185 * sig_info - Get info on a given OpenPGP signature packet
186 * @packet: The signature packet
187 * @keyid: A pointer for where to return the signature keyid
188 * @creation: A pointer for where to return the signature creation time
190 * Gets any info about a signature packet; parses the subpackets for a v4
191 * key or pulls the data directly from v2/3. NULL can be passed for any
192 * values which aren't cared about.
194 onak_status_t sig_info(struct openpgp_packet *packet, uint64_t *keyid,
200 if (packet != NULL) {
201 switch (packet->data[0]) {
205 *keyid = packet->data[7];
207 *keyid += packet->data[8];
209 *keyid += packet->data[9];
211 *keyid += packet->data[10];
213 *keyid += packet->data[11];
215 *keyid += packet->data[12];
217 *keyid += packet->data[13];
219 *keyid += packet->data[14];
221 if (creation != NULL) {
222 *creation = packet->data[3];
224 *creation = packet->data[4];
226 *creation = packet->data[5];
228 *creation = packet->data[6];
233 res = parse_subpackets(&packet->data[4],
235 &length, keyid, creation);
236 if (res != ONAK_E_OK) {
239 res = parse_subpackets(&packet->data[length + 4],
240 packet->length - (4 + length),
241 &length, keyid, creation);
242 if (res != ONAK_E_OK) {
255 * sig_keyid - Return the keyid for a given OpenPGP signature packet.
256 * @packet: The signature packet.
258 * Returns the keyid for the supplied signature packet.
260 uint64_t sig_keyid(struct openpgp_packet *packet)
264 sig_info(packet, &keyid, NULL);
271 * TODO: Abstract out; all our linked lists should be generic and then we can
274 int spsize(struct openpgp_signedpacket_list *list)
277 struct openpgp_signedpacket_list *cur;
279 for (cur = list; cur != NULL; cur = cur->next, size++) ;
285 * keyuids - Takes a key and returns an array of its UIDs
286 * @key: The key to get the uids of.
287 * @primary: A pointer to store the primary UID in.
289 * keyuids takes a public key structure and builds an array of the UIDs
290 * on the key. It also attempts to work out the primary UID and returns a
291 * separate pointer to that particular element of the array.
293 char **keyuids(struct openpgp_publickey *key, char **primary)
295 struct openpgp_signedpacket_list *curuid = NULL;
300 if (primary != NULL) {
304 if (key != NULL && key->uids != NULL) {
305 uids = malloc((spsize(key->uids) + 1) * sizeof (char *));
308 while (curuid != NULL) {
310 if (curuid->packet->tag == OPENPGP_PACKET_UID) {
311 snprintf(buf, 1023, "%.*s",
312 (int) curuid->packet->length,
313 curuid->packet->data);
314 uids[count++] = strdup(buf);
316 curuid = curuid -> next;
321 * TODO: Parse subpackets for real primary ID (v4 keys)
323 if (primary != NULL) {
332 * keysubkeys - Takes a key and returns an array of its subkey keyids.
333 * @key: The key to get the subkeys of.
335 * keysubkeys takes a public key structure and returns an array of the
336 * subkey keyids for that key.
338 struct openpgp_fingerprint *keysubkeys(struct openpgp_publickey *key)
340 struct openpgp_signedpacket_list *cursubkey = NULL;
341 struct openpgp_fingerprint *subkeys = NULL;
344 if (key != NULL && key->subkeys != NULL) {
345 subkeys = malloc((spsize(key->subkeys) + 1) *
346 sizeof (struct openpgp_fingerprint));
347 cursubkey = key->subkeys;
348 while (cursubkey != NULL) {
349 get_fingerprint(cursubkey->packet, &subkeys[count++]);
350 cursubkey = cursubkey -> next;
352 subkeys[count].length = 0;