src/certtool-args.h

   1 /*   -*- buffer-read-only: t -*- vi: set ro:
   2  *
   3  *  DO NOT EDIT THIS FILE   (certtool-args.h)
   4  *
   5  *  It has been AutoGen-ed  August  4, 2012 at 12:13:08 PM by AutoGen 5.16
   6  *  From the definitions    certtool-args.def
   7  *  and the template file   options
   8  *
   9  * Generated from AutoOpts 36:4:11 templates.
  10  *
  11  *  AutoOpts is a copyrighted work.  This header file is not encumbered
  12  *  by AutoOpts licensing, but is provided under the licensing terms chosen
  13  *  by the certtool author or copyright holder.  AutoOpts is
  14  *  licensed under the terms of the LGPL.  The redistributable library
  15  *  (``libopts'') is licensed under the terms of either the LGPL or, at the
  16  *  users discretion, the BSD license.  See the AutoOpts and/or libopts sources
  17  *  for details.
  18  *
  19  * The certtool program is copyrighted and licensed
  20  * under the following terms:
  21  *
  22  *  Copyright (C) 2000-2012 Free Software Foundation, all rights reserved.
  23  *  This is free software. It is licensed for use, modification and
  24  *  redistribution under the terms of the
  25  *  GNU General Public License, version 3 or later
  26  *      <http://gnu.org/licenses/gpl.html>
  27  *
  28  *  certtool is free software: you can redistribute it and/or modify it
  29  *  under the terms of the GNU General Public License as published by the
  30  *  Free Software Foundation, either version 3 of the License, or
  31  *  (at your option) any later version.
  32  *
  33  *  certtool is distributed in the hope that it will be useful, but
  34  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  35  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  36  *  See the GNU General Public License for more details.
  37  *
  38  *  You should have received a copy of the GNU General Public License along
  39  *  with this program.  If not, see <http://www.gnu.org/licenses/>.
  40  */
  41 /*
  42  *  This file contains the programmatic interface to the Automated
  43  *  Options generated for the certtool program.
  44  *  These macros are documented in the AutoGen info file in the
  45  *  "AutoOpts" chapter.  Please refer to that doc for usage help.
  46  */
  47 #ifndef AUTOOPTS_CERTTOOL_ARGS_H_GUARD
  48 #define AUTOOPTS_CERTTOOL_ARGS_H_GUARD 1
  49 #include "config.h"
  50 #include <autoopts/options.h>
  51
  52 /*
  53  *  Ensure that the library used for compiling this generated header is at
  54  *  least as new as the version current when the header template was released
  55  *  (not counting patch version increments).  Also ensure that the oldest
  56  *  tolerable version is at least as old as what was current when the header
  57  *  template was released.
  58  */
  59 #define AO_TEMPLATE_VERSION 147460
  60 #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
  61  || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
  62 # error option template version mismatches autoopts/options.h header
  63   Choke Me.
  64 #endif
  65
  66 /*
  67  *  Enumeration of each option:
  68  */
  69 typedef enum {
  70     INDEX_OPT_DEBUG                 =  0,
  71     INDEX_OPT_INFILE                =  1,
  72     INDEX_OPT_OUTFILE               =  2,
  73     INDEX_OPT_GENERATE_SELF_SIGNED  =  3,
  74     INDEX_OPT_GENERATE_CERTIFICATE  =  4,
  75     INDEX_OPT_GENERATE_PROXY        =  5,
  76     INDEX_OPT_GENERATE_CRL          =  6,
  77     INDEX_OPT_UPDATE_CERTIFICATE    =  7,
  78     INDEX_OPT_GENERATE_PRIVKEY      =  8,
  79     INDEX_OPT_GENERATE_REQUEST      =  9,
  80     INDEX_OPT_VERIFY_CHAIN          = 10,
  81     INDEX_OPT_VERIFY                = 11,
  82     INDEX_OPT_VERIFY_CRL            = 12,
  83     INDEX_OPT_GENERATE_DH_PARAMS    = 13,
  84     INDEX_OPT_GET_DH_PARAMS         = 14,
  85     INDEX_OPT_DH_INFO               = 15,
  86     INDEX_OPT_LOAD_PRIVKEY          = 16,
  87     INDEX_OPT_LOAD_PUBKEY           = 17,
  88     INDEX_OPT_LOAD_REQUEST          = 18,
  89     INDEX_OPT_LOAD_CERTIFICATE      = 19,
  90     INDEX_OPT_LOAD_CA_PRIVKEY       = 20,
  91     INDEX_OPT_LOAD_CA_CERTIFICATE   = 21,
  92     INDEX_OPT_PASSWORD              = 22,
  93     INDEX_OPT_NULL_PASSWORD         = 23,
  94     INDEX_OPT_CERTIFICATE_INFO      = 24,
  95     INDEX_OPT_CERTIFICATE_PUBKEY    = 25,
  96     INDEX_OPT_PGP_CERTIFICATE_INFO  = 26,
  97     INDEX_OPT_PGP_RING_INFO         = 27,
  98     INDEX_OPT_CRL_INFO              = 28,
  99     INDEX_OPT_CRQ_INFO              = 29,
 100     INDEX_OPT_NO_CRQ_EXTENSIONS     = 30,
 101     INDEX_OPT_P12_INFO              = 31,
 102     INDEX_OPT_P7_INFO               = 32,
 103     INDEX_OPT_SMIME_TO_P7           = 33,
 104     INDEX_OPT_KEY_INFO              = 34,
 105     INDEX_OPT_PGP_KEY_INFO          = 35,
 106     INDEX_OPT_PUBKEY_INFO           = 36,
 107     INDEX_OPT_V1                    = 37,
 108     INDEX_OPT_TO_P12                = 38,
 109     INDEX_OPT_TO_P8                 = 39,
 110     INDEX_OPT_PKCS8                 = 40,
 111     INDEX_OPT_RSA                   = 41,
 112     INDEX_OPT_DSA                   = 42,
 113     INDEX_OPT_ECC                   = 43,
 114     INDEX_OPT_HASH                  = 44,
 115     INDEX_OPT_INDER                 = 45,
 116     INDEX_OPT_INRAW                 = 46,
 117     INDEX_OPT_OUTDER                = 47,
 118     INDEX_OPT_OUTRAW                = 48,
 119     INDEX_OPT_BITS                  = 49,
 120     INDEX_OPT_SEC_PARAM             = 50,
 121     INDEX_OPT_DISABLE_QUICK_RANDOM  = 51,
 122     INDEX_OPT_TEMPLATE              = 52,
 123     INDEX_OPT_PKCS_CIPHER           = 53,
 124     INDEX_OPT_VERSION               = 54,
 125     INDEX_OPT_HELP                  = 55,
 126     INDEX_OPT_MORE_HELP             = 56
 127 } teOptIndex;
 128
 129 #define OPTION_CT    57
 130 #define CERTTOOL_VERSION       "@VERSION@"
 131 #define CERTTOOL_FULL_VERSION  "certtool @VERSION@"
 132
 133 /*
 134  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
 135  *  option name (as in the teOptIndex enumeration above).
 136  *  e.g. HAVE_OPT(DEBUG)
 137  */
 138 #define         DESC(n) (certtoolOptions.pOptDesc[INDEX_OPT_## n])
 139 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
 140 #define      OPT_ARG(n) (DESC(n).optArg.argString)
 141 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
 142 #define    COUNT_OPT(n) (DESC(n).optOccCt)
 143 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
 144 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
 145 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 146 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 147 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 148 #define    CLEAR_OPT(n) STMTS( \
 149                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 150                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 151                     DESC(n).fOptState |= OPTST_DISABLED; \
 152                 DESC(n).optCookie = NULL )
 153
 154 /* * * * * *
 155  *
 156  *  Enumeration of certtool exit codes
 157  */
 158 typedef enum {
 159     CERTTOOL_EXIT_SUCCESS = 0,
 160     CERTTOOL_EXIT_FAILURE = 1,
 161     CERTTOOL_EXIT_LIBOPTS_FAILURE = 70
 162 } certtool_exit_code_t;
 163 /* * * * * *
 164  *
 165  *  Interface defines for specific options.
 166  */
 167 #define VALUE_OPT_DEBUG          'd'
 168
 169 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 170 #define VALUE_OPT_INFILE         1
 171 #define VALUE_OPT_OUTFILE        2
 172 #define VALUE_OPT_GENERATE_SELF_SIGNED 's'
 173 #define VALUE_OPT_GENERATE_CERTIFICATE 'c'
 174 #define VALUE_OPT_GENERATE_PROXY 5
 175 #define VALUE_OPT_GENERATE_CRL   6
 176 #define VALUE_OPT_UPDATE_CERTIFICATE 'u'
 177 #define VALUE_OPT_GENERATE_PRIVKEY 'p'
 178 #define VALUE_OPT_GENERATE_REQUEST 'q'
 179 #define VALUE_OPT_VERIFY_CHAIN   'e'
 180 #define VALUE_OPT_VERIFY         11
 181 #define VALUE_OPT_VERIFY_CRL     12
 182 #define VALUE_OPT_GENERATE_DH_PARAMS 13
 183 #define VALUE_OPT_GET_DH_PARAMS  14
 184 #define VALUE_OPT_DH_INFO        15
 185 #define VALUE_OPT_LOAD_PRIVKEY   16
 186 #define VALUE_OPT_LOAD_PUBKEY    17
 187 #define VALUE_OPT_LOAD_REQUEST   18
 188 #define VALUE_OPT_LOAD_CERTIFICATE 19
 189 #define VALUE_OPT_LOAD_CA_PRIVKEY 20
 190 #define VALUE_OPT_LOAD_CA_CERTIFICATE 21
 191 #define VALUE_OPT_PASSWORD       22
 192 #define VALUE_OPT_NULL_PASSWORD  23
 193 #define VALUE_OPT_CERTIFICATE_INFO 'i'
 194 #define VALUE_OPT_CERTIFICATE_PUBKEY 25
 195 #define VALUE_OPT_PGP_CERTIFICATE_INFO 26
 196 #define VALUE_OPT_PGP_RING_INFO  27
 197 #define VALUE_OPT_CRL_INFO       'l'
 198 #define VALUE_OPT_CRQ_INFO       29
 199 #define VALUE_OPT_NO_CRQ_EXTENSIONS 30
 200 #define VALUE_OPT_P12_INFO       31
 201 #define VALUE_OPT_P7_INFO        32
 202 #define VALUE_OPT_SMIME_TO_P7    129
 203 #define VALUE_OPT_KEY_INFO       'k'
 204 #define VALUE_OPT_PGP_KEY_INFO   131
 205 #define VALUE_OPT_PUBKEY_INFO    132
 206 #define VALUE_OPT_V1             133
 207 #define VALUE_OPT_TO_P12         134
 208 #define VALUE_OPT_TO_P8          135
 209 #define VALUE_OPT_PKCS8          '8'
 210 #define VALUE_OPT_RSA            137
 211 #define VALUE_OPT_DSA            138
 212 #define VALUE_OPT_ECC            139
 213 #define VALUE_OPT_HASH           140
 214 #define VALUE_OPT_INDER          141
 215 #define VALUE_OPT_INRAW          142
 216 #define VALUE_OPT_OUTDER         143
 217 #define VALUE_OPT_OUTRAW         144
 218 #define VALUE_OPT_BITS           145
 219
 220 #define OPT_VALUE_BITS           (DESC(BITS).optArg.argInt)
 221 #define VALUE_OPT_SEC_PARAM      146
 222 #define VALUE_OPT_DISABLE_QUICK_RANDOM 147
 223 #define VALUE_OPT_TEMPLATE       148
 224 #define VALUE_OPT_PKCS_CIPHER    149
 225 #define VALUE_OPT_HELP          'h'
 226 #define VALUE_OPT_MORE_HELP     '!'
 227 #define VALUE_OPT_VERSION       'v'
 228 /*
 229  *  Interface defines not associated with particular options
 230  */
 231 #define ERRSKIP_OPTERR  STMTS(certtoolOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 232 #define ERRSTOP_OPTERR  STMTS(certtoolOptions.fOptSet |= OPTPROC_ERRSTOP)
 233 #define RESTART_OPT(n)  STMTS( \
 234                 certtoolOptions.curOptIdx = (n); \
 235                 certtoolOptions.pzCurOpt  = NULL)
 236 #define START_OPT       RESTART_OPT(1)
 237 #define USAGE(c)        (*certtoolOptions.pUsageProc)(&certtoolOptions, c)
 238 /* extracted from opthead.tlib near line 484 */
 239
 240 #ifdef  __cplusplus
 241 extern "C" {
 242 #endif
 243 /*
 244  *  global exported definitions
 245  */
 246 #include <gettext.h>
 247
 248
 249 /* * * * * *
 250  *
 251  *  Declare the certtool option descriptor.
 252  */
 253 extern tOptions certtoolOptions;
 254
 255 #if defined(ENABLE_NLS)
 256 # ifndef _
 257 #   include <stdio.h>
 258 static inline char* aoGetsText(char const* pz) {
 259     if (pz == NULL) return NULL;
 260     return (char*)gettext(pz);
 261 }
 262 #   define _(s)  aoGetsText(s)
 263 # endif /* _() */
 264
 265 # define OPT_NO_XLAT_CFG_NAMES  STMTS(certtoolOptions.fOptSet |= \
 266                                     OPTPROC_NXLAT_OPT_CFG;)
 267 # define OPT_NO_XLAT_OPT_NAMES  STMTS(certtoolOptions.fOptSet |= \
 268                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 269
 270 # define OPT_XLAT_CFG_NAMES     STMTS(certtoolOptions.fOptSet &= \
 271                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 272 # define OPT_XLAT_OPT_NAMES     STMTS(certtoolOptions.fOptSet &= \
 273                                   ~OPTPROC_NXLAT_OPT;)
 274
 275 #else   /* ENABLE_NLS */
 276 # define OPT_NO_XLAT_CFG_NAMES
 277 # define OPT_NO_XLAT_OPT_NAMES
 278
 279 # define OPT_XLAT_CFG_NAMES
 280 # define OPT_XLAT_OPT_NAMES
 281
 282 # ifndef _
 283 #   define _(_s)  _s
 284 # endif
 285 #endif  /* ENABLE_NLS */
 286
 287 #ifdef  __cplusplus
 288 }
 289 #endif
 290 #endif /* AUTOOPTS_CERTTOOL_ARGS_H_GUARD */
 291 /* certtool-args.h ends here */