putty/STORAGE.H

   1 /*\r
   2  * storage.h: interface defining functions for storage and recovery\r
   3  * of PuTTY's persistent data.\r
   4  */\r
   5 \r
   6 #ifndef PUTTY_STORAGE_H\r
   7 #define PUTTY_STORAGE_H\r
   8 \r
   9 /* ----------------------------------------------------------------------\r
  10  * Functions to save and restore PuTTY sessions. Note that this is\r
  11  * only the low-level code to do the reading and writing. The\r
  12  * higher-level code that translates a Config structure into a set\r
  13  * of (key,value) pairs is elsewhere, since it doesn't (mostly)\r
  14  * change between platforms.\r
  15  */\r
  16 \r
  17 /*\r
  18  * Write a saved session. The caller is expected to call\r
  19  * open_setting_w() to get a `void *' handle, then pass that to a\r
  20  * number of calls to write_setting_s() and write_setting_i(), and\r
  21  * then close it using close_settings_w(). At the end of this call\r
  22  * sequence the settings should have been written to the PuTTY\r
  23  * persistent storage area.\r
  24  *\r
  25  * A given key will be written at most once while saving a session.\r
  26  * Keys may be up to 255 characters long.  String values have no length\r
  27  * limit.\r
  28  * \r
  29  * Any returned error message must be freed after use.\r
  30  */\r
  31 void *open_settings_w(const char *sessionname, char **errmsg);\r
  32 void write_setting_s(void *handle, const char *key, const char *value);\r
  33 void write_setting_i(void *handle, const char *key, int value);\r
  34 void write_setting_filename(void *handle, const char *key, Filename value);\r
  35 void write_setting_fontspec(void *handle, const char *key, FontSpec font);\r
  36 void close_settings_w(void *handle);\r
  37 \r
  38 /*\r
  39  * Read a saved session. The caller is expected to call\r
  40  * open_setting_r() to get a `void *' handle, then pass that to a\r
  41  * number of calls to read_setting_s() and read_setting_i(), and\r
  42  * then close it using close_settings_r().\r
  43  * \r
  44  * read_setting_s() writes into the provided buffer and returns a\r
  45  * pointer to the same buffer.\r
  46  * \r
  47  * If a particular string setting is not present in the session,\r
  48  * read_setting_s() can return NULL, in which case the caller\r
  49  * should invent a sensible default. If an integer setting is not\r
  50  * present, read_setting_i() returns its provided default.\r
  51  * \r
  52  * read_setting_filename() and read_setting_fontspec() each read into\r
  53  * the provided buffer, and return zero if they failed to.\r
  54  */\r
  55 void *open_settings_r(const char *sessionname);\r
  56 char *read_setting_s(void *handle, const char *key, char *buffer, int buflen);\r
  57 int read_setting_i(void *handle, const char *key, int defvalue);\r
  58 int read_setting_filename(void *handle, const char *key, Filename *value);\r
  59 int read_setting_fontspec(void *handle, const char *key, FontSpec *font);\r
  60 void close_settings_r(void *handle);\r
  61 \r
  62 /*\r
  63  * Delete a whole saved session.\r
  64  */\r
  65 void del_settings(const char *sessionname);\r
  66 \r
  67 /*\r
  68  * Enumerate all saved sessions.\r
  69  */\r
  70 void *enum_settings_start(void);\r
  71 char *enum_settings_next(void *handle, char *buffer, int buflen);\r
  72 void enum_settings_finish(void *handle);\r
  73 \r
  74 /* ----------------------------------------------------------------------\r
  75  * Functions to access PuTTY's host key database.\r
  76  */\r
  77 \r
  78 /*\r
  79  * See if a host key matches the database entry. Return values can\r
  80  * be 0 (entry matches database), 1 (entry is absent in database),\r
  81  * or 2 (entry exists in database and is different).\r
  82  */\r
  83 int verify_host_key(const char *hostname, int port,\r
  84                     const char *keytype, const char *key);\r
  85 \r
  86 /*\r
  87  * Write a host key into the database, overwriting any previous\r
  88  * entry that might have been there.\r
  89  */\r
  90 void store_host_key(const char *hostname, int port,\r
  91                     const char *keytype, const char *key);\r
  92 \r
  93 /* ----------------------------------------------------------------------\r
  94  * Functions to access PuTTY's random number seed file.\r
  95  */\r
  96 \r
  97 typedef void (*noise_consumer_t) (void *data, int len);\r
  98 \r
  99 /*\r
 100  * Read PuTTY's random seed file and pass its contents to a noise\r
 101  * consumer function.\r
 102  */\r
 103 void read_random_seed(noise_consumer_t consumer);\r
 104 \r
 105 /*\r
 106  * Write PuTTY's random seed file from a given chunk of noise.\r
 107  */\r
 108 void write_random_seed(void *data, int len);\r
 109 \r
 110 /* ----------------------------------------------------------------------\r
 111  * Cleanup function: remove all of PuTTY's persistent state.\r
 112  */\r
 113 void cleanup_all(void);\r
 114 \r
 115 #endif\r