git.distorted.org.uk Git - u/mdw/putty/blob - storage.h

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