Forgot to commit this:
[gnupg.git] / agent / cache.c
1 /* cache.c - keep a cache of passphrases
2  *      Copyright (C) 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <time.h>
27 #include <assert.h>
28
29 #include "agent.h"
30
31 struct secret_data_s {
32   int  totallen; /* this includes the padding */
33   int  datalen;  /* actual data length */
34   char data[1];
35 };
36
37 typedef struct cache_item_s *ITEM;
38 struct cache_item_s {
39   ITEM next;
40   time_t created;
41   time_t accessed;
42   int  ttl;  /* max. lifetime given in seonds */
43   int lockcount;
44   struct secret_data_s *pw;
45   char key[1];
46 };
47
48
49 static ITEM thecache;
50
51
52 static void
53 release_data (struct secret_data_s *data)
54 {
55    xfree (data);
56 }
57
58 static struct secret_data_s *
59 new_data (const void *data, size_t length)
60 {
61   struct secret_data_s *d;
62   int total;
63
64   /* we pad the data to 32 bytes so that it get more complicated
65      finding something out by watching allocation patterns.  This is
66      usally not possible but we better assume nothing about our
67      secure storage provider*/
68   total = length + 32 - (length % 32);
69
70   d = gcry_malloc_secure (sizeof d + total - 1);
71   if (d)
72     {
73       d->totallen = total;
74       d->datalen  = length;
75       memcpy (d->data, data, length);
76     }
77   return d;
78 }
79
80
81 /* check whether there are items to expire */
82 static void
83 housekeeping (void)
84 {
85   ITEM r, rprev;
86   time_t current = gnupg_get_time ();
87
88   /* first expire the actual data */
89   for (r=thecache; r; r = r->next)
90     {
91       if (!r->lockcount && r->pw && r->accessed + r->ttl < current)
92         {
93           if (DBG_CACHE)
94             log_debug ("  expired `%s' (%ds after last access)\n",
95                        r->key, r->ttl);
96           release_data (r->pw);
97           r->pw = NULL;
98           r->accessed = current;
99         }
100     }
101
102   /* second, make sure that we also remove them based on the created stamp so
103      that the user has to enter it from time to time.  We do this every hour */
104   for (r=thecache; r; r = r->next)
105     {
106       if (!r->lockcount && r->pw && r->created + 60*60 < current)
107         {
108           if (DBG_CACHE)
109             log_debug ("  expired `%s' (1h after creation)\n", r->key);
110           release_data (r->pw);
111           r->pw = NULL;
112           r->accessed = current;
113         }
114     }
115
116   /* third, make sure that we don't have too many items in the list.
117      Expire old and unused entries after 30 minutes */
118   for (rprev=NULL, r=thecache; r; )
119     {
120       if (!r->pw && r->accessed + 60*30 < current)
121         {
122           if (r->lockcount)
123             {
124               log_error ("can't remove unused cache entry `%s' due to"
125                          " lockcount=%d\n",
126                          r->key, r->lockcount);
127               r->accessed += 60*10; /* next error message in 10 minutes */
128               rprev = r;
129               r = r->next;
130             }
131           else
132             {
133               ITEM r2 = r->next;
134               if (DBG_CACHE)
135                 log_debug ("  removed `%s' (slot not used for 30m)\n", r->key);
136               xfree (r);
137               if (!rprev)
138                 thecache = r2;
139               else
140                 rprev->next = r2;
141               r = r2;
142             }
143         }
144       else
145         {
146           rprev = r;
147           r = r->next;
148         }
149     }
150 }
151
152
153
154 /* Store DATA of length DATALEN in the cache under KEY and mark it
155    with a maximum lifetime of TTL seconds.  If there is already data
156    under this key, it will be replaced.  Using a DATA of NULL deletes
157    the entry */
158 int
159 agent_put_cache (const char *key, const char *data, int ttl)
160 {
161   ITEM r;
162
163   if (DBG_CACHE)
164     log_debug ("agent_put_cache `%s'\n", key);
165   housekeeping ();
166
167   if (ttl < 1)
168     ttl = opt.def_cache_ttl;
169   if (!ttl)
170     return 0;
171
172   for (r=thecache; r; r = r->next)
173     {
174       if (!r->lockcount && !strcmp (r->key, key))
175         break;
176     }
177   if (r)
178     { /* replace */
179       if (r->pw)
180         {
181           release_data (r->pw);
182           r->pw = NULL;
183         }
184       if (data)
185         {
186           r->created = r->accessed = gnupg_get_time (); 
187           r->ttl = ttl;
188           r->pw = new_data (data, strlen (data)+1);
189           if (!r->pw)
190             log_error ("out of core while allocating new cache item\n");
191         }
192     }
193   else if (data)
194     { /* simply insert */
195       r = xtrycalloc (1, sizeof *r + strlen (key));
196       if (!r)
197         log_error ("out of core while allocating new cache control\n");
198       else
199         {
200           strcpy (r->key, key);
201           r->created = r->accessed = gnupg_get_time (); 
202           r->ttl = ttl;
203           r->pw = new_data (data, strlen (data)+1);
204           if (!r->pw)
205             {
206               log_error ("out of core while allocating new cache item\n");
207               xfree (r);
208             }
209           else
210             {
211               r->next = thecache;
212               thecache = r;
213             }
214         }
215     }
216   return 0;
217 }
218
219
220 /* Try to find an item in the cache */
221 const char *
222 agent_get_cache (const char *key, void **cache_id)
223 {
224   ITEM r;
225
226   if (DBG_CACHE)
227     log_debug ("agent_get_cache `%s'...\n", key);
228   housekeeping ();
229
230   /* first try to find one with no locks - this is an updated cache
231      entry: We might have entries with a lockcount and without a
232      lockcount. */
233   for (r=thecache; r; r = r->next)
234     {
235       if (!r->lockcount && r->pw && !strcmp (r->key, key))
236         {
237           /* put_cache does only put strings into the cache, so we
238              don't need the lengths */
239           r->accessed = gnupg_get_time ();
240           if (DBG_CACHE)
241             log_debug ("... hit\n");
242           r->lockcount++;
243           *cache_id = r;
244           return r->pw->data;
245         }
246     }
247   /* again, but this time get even one with a lockcount set */
248   for (r=thecache; r; r = r->next)
249     {
250       if (r->pw && !strcmp (r->key, key))
251         {
252           r->accessed = gnupg_get_time ();
253           if (DBG_CACHE)
254             log_debug ("... hit (locked)\n");
255           r->lockcount++;
256           *cache_id = r;
257           return r->pw->data;
258         }
259     }
260   if (DBG_CACHE)
261     log_debug ("... miss\n");
262
263   *cache_id = NULL;
264   return NULL;
265 }
266
267
268 void
269 agent_unlock_cache_entry (void **cache_id)
270 {
271   ITEM r;
272
273   for (r=thecache; r; r = r->next)
274     {
275       if (r == *cache_id)
276         {
277           if (!r->lockcount)
278             log_error ("trying to unlock non-locked cache entry `%s'\n",
279                        r->key);
280           else
281             r->lockcount--;
282           return;
283         }
284     }
285 }