parsekey.h

   1 /*
   2  * parsekey.h - Routines to parse an OpenPGP key.
   3  *
   4  * Jonathan McDowell <noodles@earth.li>
   5  *
   6  * Copyright 2002 Project Purple
   7  *
   8  * $Id: parsekey.h,v 1.4 2003/06/04 20:57:12 noodles Exp $
   9  */
  10
  11 #ifndef __PARSEKEY_H__
  12 #define __PARSEKEY_H__
  13
  14 #include "keystructs.h"
  15
  16 /**
  17  *      add_key - Takes a key and adds it to the keyserver.
  18  *      @key: The public key to add.
  19  *
  20  *      This function takes a public key and adds it to the keyserver.
  21  *      It first of all sees if we already have the key locally. If we do then
  22  *      we retrieve it and merge the two keys. We then store the resulting key
  23  *      (or just the original we received if we don't already have it). We then
  24  *      send out the appropriate updates to our keyserver peers.
  25  */
  26 int add_key(struct openpgp_publickey *key);
  27
  28 /**
  29  *      parse_keys - Process a stream of packets for public keys + sigs.
  30  *      @packets: The packet list to parse.
  31  *      @keys: The returned list of public keys.
  32  *
  33  *      This function takes an list of OpenPGP packets and attempts to parse it
  34  *      into a list of public keys with signatures and subkeys.
  35  *
  36  *      Returns a count of how many keys we parsed.
  37  */
  38 int parse_keys(struct openpgp_packet_list *packets,
  39                 struct openpgp_publickey **keys);
  40
  41 /**
  42  *      debug_packet - Print debug info about a packet
  43  *      @packet: The packet to display.
  44  *
  45  *      This function takes an OpenPGP packet and displays some information
  46  *      about it to stdout. Useful for debugging purposes or curiousity about
  47  *      an OpenPGP packet stream.
  48  */
  49 int debug_packet(struct openpgp_packet *packet);
  50
  51 /**
  52  *      read_openpgp_stream - Reads a stream of OpenPGP packets.
  53  *      @getchar_func: The function to get the next character from the stream.
  54  *      @ctx: A pointer to the context structure for getchar_func.
  55  *      @packets: The outputted list of packets.
  56  *
  57  *      This function uses getchar_func to read characters from an OpenPGP
  58  *      packet stream and reads the packets into a linked list of packets
  59  *      ready for parsing as a public key or whatever.
  60  */
  61 int read_openpgp_stream(int (*getchar_func)(void *ctx, size_t count,
  62                                 unsigned char *c),
  63                                 void *ctx,
  64                                 struct openpgp_packet_list **packets);
  65
  66 /**
  67  *      write_openpgp_stream - Reads a stream of OpenPGP packets.
  68  *      @putchar_func: The function to put the next character to the stream.
  69  *      @ctx: A pointer to the context structure for putchar_func.
  70  *      @packets: The list of packets.
  71  *
  72  *      This function uses putchar_func to write characters to an OpenPGP
  73  *      packet stream from a linked list of packets.
  74  */
  75 int write_openpgp_stream(int (*putchar_func)(void *ctx, size_t count,
  76                                                 unsigned char *c),
  77                                 void *ctx,
  78                                 struct openpgp_packet_list *packets);
  79
  80 /**
  81  *      flatten_publickey - Convert a publickey to an OpenPGP packet list.
  82  *      @key: The public key.
  83  *      @packets: The outputted packet list.
  84  *      @list_end: The end of the packet list.
  85  *
  86  *      This function converts public key structure to a linked list of OpenPGP
  87  *      packets ready for outputing or storage. If we're not appending to an
  88  *      existing list then both packets & list_end will be pointers to NULLs,
  89  *      other wise packets should point to the start of the list and list_end
  90  *      to the end so we can append to the end.
  91  */
  92 int flatten_publickey(struct openpgp_publickey *key,
  93                         struct openpgp_packet_list **packets,
  94                         struct openpgp_packet_list **list_end);
  95
  96 #endif /* __PARSEKEY_H__ */