lib/opencdk/keydb.h

   1 /* keydb.h - Key database routines
   2  * Copyright (C) 2002-2012 Free Software Foundation, Inc.
   3  *
   4  * Author: Timo Schulz
   5  *
   6  * This file is part of OpenCDK.
   7  *
   8  * The OpenCDK library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>
  20  *
  21  */
  22
  23 /* Internal key index structure. */
  24 struct key_idx_s
  25 {
  26   off_t offset;
  27   u32 keyid[2];
  28   byte fpr[KEY_FPR_LEN];
  29 };
  30 typedef struct key_idx_s *key_idx_t;
  31
  32 /* Internal key cache to associate a key with an file offset. */
  33 struct key_table_s
  34 {
  35   struct key_table_s *next;
  36   off_t offset;
  37 };
  38 typedef struct key_table_s *key_table_t;
  39
  40 typedef struct cdk_keydb_search_s
  41 {
  42   off_t off;                    /* last file offset */
  43   union
  44   {
  45     char *pattern;              /* A search is performed by pattern. */
  46     u32 keyid[2];               /* A search by keyid. */
  47     byte fpr[KEY_FPR_LEN];      /* A search by fingerprint. */
  48   } u;
  49   int type;
  50   struct key_table_s *cache;
  51   size_t ncache;
  52   unsigned int no_cache:1;      /* disable the index cache. */
  53
  54   cdk_stream_t idx;
  55   char *idx_name;               /* name of the index file or NULL. */
  56
  57 } cdk_keydb_search_s;
  58
  59 /* Internal key database handle. */
  60 struct cdk_keydb_hd_s
  61 {
  62   int type;                     /* type of the key db handle. */
  63   int fp_ref;                   /* 1=means it is a reference and shall not be closed. */
  64   cdk_stream_t fp;
  65   char *name;                   /* name of the underlying file or NULL. */
  66   unsigned int secret:1;        /* contain secret keys. */
  67   unsigned int isopen:1;        /* the underlying stream is opened. */
  68
  69   /* structure to store some stats about the keydb. */
  70   struct
  71   {
  72     size_t new_keys;            /* amount of new keys that were imported. */
  73   } stats;
  74 };