src/cache.h

   1 /*
   2     Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012
   3     Ben Kibbey <bjk@luxsci.net>
   4
   5     This file is part of pwmd.
   6
   7     Pwmd is free software: you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation, either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     Pwmd is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with Pwmd.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20 #ifndef CACHE_H
  21 #define CACHE_H
  22
  23 #include <pthread.h>
  24 #include <gpg-error.h>
  25 #include <time.h>
  26
  27 struct cache_data_s {
  28     void *pubkey;       /* needed for SAVE */
  29     void *sigkey;       /* needed for SAVE */
  30     void *doc;          /* AES-128 encrypted */
  31     size_t doclen;
  32     unsigned char *crc; /* Checksum of the data file. */
  33 };
  34
  35 typedef struct {
  36     unsigned char filename[16]; /* MD5 hash. */
  37     unsigned char grip[41];     /* key grip for this file */
  38     int timeout;                /* cache_timer_thread(). */
  39     int reset;                  /* To reset .timeout. */
  40     int defer_clear;            /* Another thread wants to clear the cache
  41                                    entry for this file. Prevent resetting the
  42                                    timer until this flag is cleared. */
  43     pthread_mutex_t *mutex;     /* Data file mutex. */
  44     struct cache_data_s *data;
  45     unsigned refcount;
  46 } file_cache_t;
  47
  48 unsigned char *cache_iv;
  49 unsigned char *cache_key;
  50 size_t cache_blocksize;
  51 size_t cache_keysize;
  52
  53 void cache_adjust_timeout();
  54 gpg_error_t cache_set_timeout(const unsigned char *md5filename, int timeout);
  55 gpg_error_t cache_iscached(const char *filename, int *defer);
  56 gpg_error_t cache_clear(const unsigned char *md5filename);
  57 int cache_add_file(const unsigned char *md5file, const unsigned char *grip,
  58         struct cache_data_s *, int timeout);
  59 void cache_deinit();
  60 gpg_error_t cache_init();
  61 unsigned cache_file_count();
  62 struct cache_data_s *cache_get_data(const unsigned char *md5file);
  63 gpg_error_t cache_set_data(const unsigned char *md5file, struct cache_data_s *,
  64         const unsigned char *grip);
  65 gpg_error_t cache_is_shadowed(const char *grip);
  66 gpg_error_t cache_lock_mutex(void *ctx, const unsigned char *md5file,
  67         long mutex_timeout, int add, int timeout);
  68 gpg_error_t cache_unlock_mutex(const unsigned char *md5file, int remove);
  69 void cache_lock();
  70 void cache_unlock();
  71 void free_cache_data_once(struct cache_data_s *data);
  72 gpg_error_t cache_defer_clear(const unsigned char *md5file);
  73
  74 #endif