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