Revert last change, add comment about link() return values.
[gnupg.git] / kbx / keybox.h
index fcacc49..52bbe21 100644 (file)
@@ -1,11 +1,11 @@
 /* keybox.h - Keybox operations
- *     Copyright (C) 2001 Free Software Foundation, Inc.
+ *     Copyright (C) 2001, 2003 Free Software Foundation, Inc.
  *
  * This file is part of GnuPG.
  *
  * GnuPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
  * (at your option) any later version.
  *
  * GnuPG is distributed in the hope that it will be useful,
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef KEYBOX_H
 #define KEYBOX_H 1
 #ifdef __cplusplus
-extern "C" { 
+extern "C" {
 #if 0
  }
 #endif
@@ -29,7 +28,7 @@ extern "C" {
 
 #include "keybox-search-desc.h"
 
-#define KEYBOX_WITH_OPENPGP 1 
+#define KEYBOX_WITH_OPENPGP 1
 #define KEYBOX_WITH_X509 1
 
 
@@ -42,30 +41,25 @@ extern "C" {
 # include <ksba.h>
 #endif
 
+typedef struct keybox_handle *KEYBOX_HANDLE;
 
-typedef enum {
-  KEYBOX_No_Error = 0,
-  KEYBOX_General_Error = 1,
-  KEYBOX_Out_Of_Core = 2,
-  KEYBOX_Invalid_Value = 3,
-  KEYBOX_Timeout = 4,  
-  KEYBOX_Read_Error = 5,
-  KEYBOX_Write_Error = 6,
-  KEYBOX_File_Error = 7,
-  KEYBOX_Blob_Too_Short = 8,
-  KEYBOX_Blob_Too_Large = 9,
-  KEYBOX_Invalid_Handle = 10,
-  KEYBOX_File_Create_Error = 11,
-  KEYBOX_File_Open_Error = 12,
-  KEYBOX_File_Close_Error = 13,
-  KEYBOX_Nothing_Found = 14,
-  KEYBOX_Wrong_Blob_Type = 15,
-  KEYBOX_Missing_Value = 16,
-} KeyboxError;
 
+typedef enum
+  {
+    KEYBOX_FLAG_BLOB,       /* The blob flags. */
+    KEYBOX_FLAG_VALIDITY,   /* The validity of the entire key. */
+    KEYBOX_FLAG_OWNERTRUST, /* The assigned ownertrust. */
+    KEYBOX_FLAG_KEY,        /* The key flags; requires a key index. */
+    KEYBOX_FLAG_UID,        /* The user ID flags; requires an uid index. */
+    KEYBOX_FLAG_UID_VALIDITY,/* The validity of a specific uid, requires
+                               an uid index. */
+    KEYBOX_FLAG_CREATED_AT  /* The date the block was created. */
+  } keybox_flag_t;
 
+/* Flag values used with KEYBOX_FLAG_BLOB.  */
+#define KEYBOX_FLAG_BLOB_SECRET     1
+#define KEYBOX_FLAG_BLOB_EPHEMERAL  2
 
-typedef struct keybox_handle *KEYBOX_HANDLE;
 
 
 /*-- keybox-init.c --*/
@@ -75,26 +69,30 @@ int keybox_is_writable (void *token);
 KEYBOX_HANDLE keybox_new (void *token, int secret);
 void keybox_release (KEYBOX_HANDLE hd);
 const char *keybox_get_resource_name (KEYBOX_HANDLE hd);
+int keybox_set_ephemeral (KEYBOX_HANDLE hd, int yes);
 
 
 /*-- keybox-search.c --*/
-#ifdef KEYBOX_WITH_X509 
-int keybox_get_cert (KEYBOX_HANDLE hd, KsbaCert *ret_cert);
+#ifdef KEYBOX_WITH_X509
+int keybox_get_cert (KEYBOX_HANDLE hd, ksba_cert_t *ret_cert);
 #endif /*KEYBOX_WITH_X509*/
+int keybox_get_flags (KEYBOX_HANDLE hd, int what, int idx, unsigned int *value);
 
 int keybox_search_reset (KEYBOX_HANDLE hd);
 int keybox_search (KEYBOX_HANDLE hd, KEYBOX_SEARCH_DESC *desc, size_t ndesc);
 
 
 /*-- keybox-update.c --*/
-#ifdef KEYBOX_WITH_X509 
-int keybox_insert_cert (KEYBOX_HANDLE hd, KsbaCert cert,
+#ifdef KEYBOX_WITH_X509
+int keybox_insert_cert (KEYBOX_HANDLE hd, ksba_cert_t cert,
                         unsigned char *sha1_digest);
-int keybox_update_cert (KEYBOX_HANDLE hd, KsbaCert cert,
+int keybox_update_cert (KEYBOX_HANDLE hd, ksba_cert_t cert,
                         unsigned char *sha1_digest);
 #endif /*KEYBOX_WITH_X509*/
+int keybox_set_flags (KEYBOX_HANDLE hd, int what, int idx, unsigned int value);
 
 int keybox_delete (KEYBOX_HANDLE hd);
+int keybox_compress (KEYBOX_HANDLE hd);
 
 
 /*--  --*/
@@ -114,9 +112,6 @@ void keybox_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
                                void *(*new_realloc_func)(void *p, size_t n),
                                void (*new_free_func)(void*) );
 
-/*-- keybox-errors.c (built) --*/
-const char *keybox_strerror (KeyboxError err);
-
 
 #ifdef __cplusplus
 }