keystructs.h

   1 /**
   2  * @file keystructs.h
   3  * @brief Structures for OpenPGP keys
   4  *
   5  * Copyright 2002 Jonathan McDowell <noodles@earth.li>
   6  *
   7  * This program is free software: you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the Free
   9  * Software Foundation; version 2 of the License.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14  * more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with
  17  * this program; if not, write to the Free Software Foundation, Inc., 51
  18  * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef __KEYSTRUCTS_H__
  22 #define __KEYSTRUCTS_H__
  23
  24 #include <inttypes.h>
  25 #include <stdbool.h>
  26 #include <stdlib.h>
  27
  28 #include "ll.h"
  29
  30 /* v3 MD5 fingerprint is 16 characters, v4 SHA-1 fingerprint is 20 */
  31 #define MAX_FINGERPRINT_LEN 20
  32
  33 /**
  34  * @brief Stores an OpenPGP packet.
  35  *
  36  * This structure holds any form of OpenPGP packet with minimum common
  37  * details decoded out.
  38  */
  39 struct openpgp_packet {
  40         /** The packet tag (i.e. type). */
  41         unsigned int tag;
  42         /** Indicates if this is a new format packet. */
  43         bool newformat;
  44         /** The length of the packet. */
  45         size_t length;
  46         /** The actual packet data. */
  47         unsigned char *data;
  48 };
  49
  50 /**
  51  * @brief A linked list of OpenPGP packets.
  52  *
  53  * This structure is used to hold a linked list of packets, for example
  54  * all the signatures of a public key's UID.
  55  */
  56 struct openpgp_packet_list {
  57         /** The actual packet structure. */
  58         struct openpgp_packet *packet;
  59         /** A pointer to the next packet in the list. */
  60         struct openpgp_packet_list *next;
  61 };
  62
  63 /**
  64  * @brief A packet with signatures.
  65  *
  66  * This structure holds an OpenPGP packet along with signatures that are
  67  * over this packet. It also links to the next signed packet. It's usually
  68  * used to hold a UID or subkey with their associated signatures.
  69  */
  70 struct openpgp_signedpacket_list {
  71         /** The OpenPGP packet that's signed. */
  72         struct openpgp_packet *packet;
  73         /** A linked list of sigs for the packet. */
  74         struct openpgp_packet_list *sigs;
  75         /** Pointer to the last sig in the sigs linked list */
  76         struct openpgp_packet_list *last_sig;
  77         /** A pointer to the next packet with signatures. */
  78         struct openpgp_signedpacket_list *next;
  79 };
  80
  81 /**
  82  * @brief An OpenPGP public key complete with sigs.
  83  */
  84 struct openpgp_publickey {
  85         /** The OpenPGP packet for the public key. */
  86         struct openpgp_packet                   *publickey;
  87         /** True if the key is revoked. */
  88         bool                                     revoked;
  89         /** Any signatures directly on the @a publickey packet. */
  90         struct openpgp_packet_list              *sigs;
  91         /** Pointer to the end of the @a sigs list */
  92         struct openpgp_packet_list              *last_sig;
  93         /** The list of UIDs with signatures for this key. */
  94         struct openpgp_signedpacket_list        *uids;
  95         /** Pointer to the end of the @a uids list */
  96         struct openpgp_signedpacket_list        *last_uid;
  97         /** The list of subkeys with signatures for this key. */
  98         struct openpgp_signedpacket_list        *subkeys;
  99         /** Pointer to the end of the @a subkey list */
 100         struct openpgp_signedpacket_list        *last_subkey;
 101         /** The next public key. */
 102         struct openpgp_publickey                *next;
 103 };
 104
 105 /**
 106  * @brief Holds an SKS key hash (md5 over sorted packet list)
 107  */
 108 struct skshash {
 109         /** The 128 bit MD5 hash of the sorted packet list from the key */
 110         uint8_t hash[16];
 111 };
 112
 113 #endif /* __KEYSTRUCTS_H__ */