chiark - git - mdw - catacomb/blob - key-error.h

   1 /* -*-c-*-
   2  *
   3  * $Id$
   4  *
   5  * Key management error codes
   6  *
   7  * (c) 2004 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of Catacomb.
  13  *
  14  * Catacomb is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU Library General Public License as
  16  * published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * Catacomb is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Library General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Library General Public
  25  * License along with Catacomb; if not, write to the Free
  26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27  * MA 02111-1307, USA.
  28  */
  29
  30 #ifndef CATACOMB_KEY_ERROR_H
  31 #define CATACOMB_KEY_ERROR_H
  32
  33 #ifdef __cplusplus
  34   extern "C" {
  35 #endif
  36
  37 /*----- Error codes -------------------------------------------------------*/
  38
  39 #define KEY_ERRORS(_)                                                   \
  40   _(OK,           0, "No error")                                        \
  41   _(BADTAG,      -1, "Bad tag string")                                  \
  42   _(BADTYPE,     -2, "Bad type string")                                 \
  43   _(BADCOMMENT,  -3, "Bad comment string")                              \
  44   _(DUPID,       -4, "Key id already exists")                           \
  45   _(DUPTAG,      -5, "Key tag already exists")                          \
  46   _(READONLY,    -6, "Key file is read-only")                           \
  47   _(WILLEXPIRE,  -7, "Key will eventually expire")                      \
  48   _(EXPIRED,     -8, "Key has expired")                                 \
  49   _(BADFLAGS,    -9, "Bad key flags string")                            \
  50   _(BADPASS,    -10, "Failed to unlock key")                            \
  51   _(WRONGTYPE,  -11, "Unexpected key encoding type")                    \
  52   _(NOTFOUND,   -12, "Key not found")                                   \
  53   _(BADATTR,    -13, "Bad attribute name")                              \
  54   _(MALFORMED,  -14, "Malformed key data")                              \
  55   _(IO,         -15, "I/O error")                                       \
  56
  57 enum {
  58 #define ENTRY(tag, num, str) KERR_##tag = num,
  59   KEY_ERRORS(ENTRY)
  60 #undef ENTRY
  61   KERR__dummy
  62 };
  63
  64 /*----- Functions provided ------------------------------------------------*/
  65
  66 /* --- @key_strerror@ --- *
  67  *
  68  * Arguments:   @int err@ = error code from @key_new@
  69  *
  70  * Returns:     Pointer to error string.
  71  *
  72  * Use:         Translates a @KERR@ error code into a human-readable string.
  73  */
  74
  75 extern const char *key_strerror(int /*err*/);
  76
  77 /*----- That's all, folks -------------------------------------------------*/
  78
  79 #ifdef __cplusplus
  80   }
  81 #endif
  82
  83 #endif