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 a Config structure into a set
  13  * of (key,value) pairs is elsewhere, since it doesn't (mostly)
  14  * 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 void *open_settings_w(const char *sessionname);
  30 void write_setting_s(void *handle, const char *key, const char *value);
  31 void write_setting_i(void *handle, const char *key, int value);
  32 void write_setting_filename(void *handle, const char *key, Filename value);
  33 void write_setting_fontspec(void *handle, const char *key, FontSpec font);
  34 void close_settings_w(void *handle);
  35
  36 /*
  37  * Read a saved session. The caller is expected to call
  38  * open_setting_r() to get a `void *' handle, then pass that to a
  39  * number of calls to read_setting_s() and read_setting_i(), and
  40  * then close it using close_settings_r().
  41  *
  42  * read_setting_s() writes into the provided buffer and returns a
  43  * pointer to the same buffer.
  44  *
  45  * If a particular string setting is not present in the session,
  46  * read_setting_s() can return NULL, in which case the caller
  47  * should invent a sensible default. If an integer setting is not
  48  * present, read_setting_i() returns its provided default.
  49  *
  50  * read_setting_filename() and read_setting_fontspec() each read into
  51  * the provided buffer, and return zero if they failed to.
  52  */
  53 void *open_settings_r(const char *sessionname);
  54 char *read_setting_s(void *handle, const char *key, char *buffer, int buflen);
  55 int read_setting_i(void *handle, const char *key, int defvalue);
  56 int read_setting_filename(void *handle, const char *key, Filename *value);
  57 int read_setting_fontspec(void *handle, const char *key, FontSpec *font);
  58 void close_settings_r(void *handle);
  59
  60 /*
  61  * Delete a whole saved session.
  62  */
  63 void del_settings(const char *sessionname);
  64
  65 /*
  66  * Enumerate all saved sessions.
  67  */
  68 void *enum_settings_start(void);
  69 char *enum_settings_next(void *handle, char *buffer, int buflen);
  70 void enum_settings_finish(void *handle);
  71
  72 /* ----------------------------------------------------------------------
  73  * Functions to access PuTTY's host key database.
  74  */
  75
  76 /*
  77  * See if a host key matches the database entry. Return values can
  78  * be 0 (entry matches database), 1 (entry is absent in database),
  79  * or 2 (entry exists in database and is different).
  80  */
  81 int verify_host_key(const char *hostname, int port,
  82                     const char *keytype, const char *key);
  83
  84 /*
  85  * Write a host key into the database, overwriting any previous
  86  * entry that might have been there.
  87  */
  88 void store_host_key(const char *hostname, int port,
  89                     const char *keytype, const char *key);
  90
  91 /* ----------------------------------------------------------------------
  92  * Functions to access PuTTY's random number seed file.
  93  */
  94
  95 typedef void (*noise_consumer_t) (void *data, int len);
  96
  97 /*
  98  * Read PuTTY's random seed file and pass its contents to a noise
  99  * consumer function.
 100  */
 101 void read_random_seed(noise_consumer_t consumer);
 102
 103 /*
 104  * Write PuTTY's random seed file from a given chunk of noise.
 105  */
 106 void write_random_seed(void *data, int len);
 107
 108 /* ----------------------------------------------------------------------
 109  * Cleanup function: remove all of PuTTY's persistent state.
 110  */
 111 void cleanup_all(void);
 112
 113 #endif