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  November 21, 2012 at 09:00:25 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_VERBOSE               =  1,
  72     INDEX_OPT_INFILE                =  2,
  73     INDEX_OPT_OUTFILE               =  3,
  74     INDEX_OPT_GENERATE_SELF_SIGNED  =  4,
  75     INDEX_OPT_GENERATE_CERTIFICATE  =  5,
  76     INDEX_OPT_GENERATE_PROXY        =  6,
  77     INDEX_OPT_GENERATE_CRL          =  7,
  78     INDEX_OPT_UPDATE_CERTIFICATE    =  8,
  79     INDEX_OPT_GENERATE_PRIVKEY      =  9,
  80     INDEX_OPT_GENERATE_REQUEST      = 10,
  81     INDEX_OPT_VERIFY_CHAIN          = 11,
  82     INDEX_OPT_VERIFY                = 12,
  83     INDEX_OPT_VERIFY_CRL            = 13,
  84     INDEX_OPT_GENERATE_DH_PARAMS    = 14,
  85     INDEX_OPT_GET_DH_PARAMS         = 15,
  86     INDEX_OPT_DH_INFO               = 16,
  87     INDEX_OPT_LOAD_PRIVKEY          = 17,
  88     INDEX_OPT_LOAD_PUBKEY           = 18,
  89     INDEX_OPT_LOAD_REQUEST          = 19,
  90     INDEX_OPT_LOAD_CERTIFICATE      = 20,
  91     INDEX_OPT_LOAD_CA_PRIVKEY       = 21,
  92     INDEX_OPT_LOAD_CA_CERTIFICATE   = 22,
  93     INDEX_OPT_PASSWORD              = 23,
  94     INDEX_OPT_HEX_NUMBERS           = 24,
  95     INDEX_OPT_NULL_PASSWORD         = 25,
  96     INDEX_OPT_CERTIFICATE_INFO      = 26,
  97     INDEX_OPT_CERTIFICATE_PUBKEY    = 27,
  98     INDEX_OPT_PGP_CERTIFICATE_INFO  = 28,
  99     INDEX_OPT_PGP_RING_INFO         = 29,
 100     INDEX_OPT_CRL_INFO              = 30,
 101     INDEX_OPT_CRQ_INFO              = 31,
 102     INDEX_OPT_NO_CRQ_EXTENSIONS     = 32,
 103     INDEX_OPT_P12_INFO              = 33,
 104     INDEX_OPT_P7_INFO               = 34,
 105     INDEX_OPT_SMIME_TO_P7           = 35,
 106     INDEX_OPT_KEY_INFO              = 36,
 107     INDEX_OPT_PGP_KEY_INFO          = 37,
 108     INDEX_OPT_PUBKEY_INFO           = 38,
 109     INDEX_OPT_V1                    = 39,
 110     INDEX_OPT_TO_P12                = 40,
 111     INDEX_OPT_TO_P8                 = 41,
 112     INDEX_OPT_PKCS8                 = 42,
 113     INDEX_OPT_RSA                   = 43,
 114     INDEX_OPT_DSA                   = 44,
 115     INDEX_OPT_ECC                   = 45,
 116     INDEX_OPT_ECDSA                 = 46,
 117     INDEX_OPT_HASH                  = 47,
 118     INDEX_OPT_INDER                 = 48,
 119     INDEX_OPT_INRAW                 = 49,
 120     INDEX_OPT_OUTDER                = 50,
 121     INDEX_OPT_OUTRAW                = 51,
 122     INDEX_OPT_BITS                  = 52,
 123     INDEX_OPT_SEC_PARAM             = 53,
 124     INDEX_OPT_DISABLE_QUICK_RANDOM  = 54,
 125     INDEX_OPT_TEMPLATE              = 55,
 126     INDEX_OPT_PKCS_CIPHER           = 56,
 127     INDEX_OPT_VERSION               = 57,
 128     INDEX_OPT_HELP                  = 58,
 129     INDEX_OPT_MORE_HELP             = 59
 130 } teOptIndex;
 131
 132 #define OPTION_CT    60
 133 #define CERTTOOL_VERSION       "@VERSION@"
 134 #define CERTTOOL_FULL_VERSION  "certtool @VERSION@"
 135
 136 /*
 137  *  Interface defines for all options.  Replace "n" with the UPPER_CASED
 138  *  option name (as in the teOptIndex enumeration above).
 139  *  e.g. HAVE_OPT(DEBUG)
 140  */
 141 #define         DESC(n) (certtoolOptions.pOptDesc[INDEX_OPT_## n])
 142 #define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
 143 #define      OPT_ARG(n) (DESC(n).optArg.argString)
 144 #define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
 145 #define    COUNT_OPT(n) (DESC(n).optOccCt)
 146 #define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
 147 #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
 148 #define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
 149 #define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
 150 #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
 151 #define    CLEAR_OPT(n) STMTS( \
 152                 DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
 153                 if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
 154                     DESC(n).fOptState |= OPTST_DISABLED; \
 155                 DESC(n).optCookie = NULL )
 156
 157 /* * * * * *
 158  *
 159  *  Enumeration of certtool exit codes
 160  */
 161 typedef enum {
 162     CERTTOOL_EXIT_SUCCESS = 0,
 163     CERTTOOL_EXIT_FAILURE = 1,
 164     CERTTOOL_EXIT_LIBOPTS_FAILURE = 70
 165 } certtool_exit_code_t;
 166 /* * * * * *
 167  *
 168  *  Interface defines for specific options.
 169  */
 170 #define VALUE_OPT_DEBUG          'd'
 171
 172 #define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
 173 #define VALUE_OPT_VERBOSE        'V'
 174 #define VALUE_OPT_INFILE         2
 175 #define VALUE_OPT_OUTFILE        3
 176 #define VALUE_OPT_GENERATE_SELF_SIGNED 's'
 177 #define VALUE_OPT_GENERATE_CERTIFICATE 'c'
 178 #define VALUE_OPT_GENERATE_PROXY 6
 179 #define VALUE_OPT_GENERATE_CRL   7
 180 #define VALUE_OPT_UPDATE_CERTIFICATE 'u'
 181 #define VALUE_OPT_GENERATE_PRIVKEY 'p'
 182 #define VALUE_OPT_GENERATE_REQUEST 'q'
 183 #define VALUE_OPT_VERIFY_CHAIN   'e'
 184 #define VALUE_OPT_VERIFY         12
 185 #define VALUE_OPT_VERIFY_CRL     13
 186 #define VALUE_OPT_GENERATE_DH_PARAMS 14
 187 #define VALUE_OPT_GET_DH_PARAMS  15
 188 #define VALUE_OPT_DH_INFO        16
 189 #define VALUE_OPT_LOAD_PRIVKEY   17
 190 #define VALUE_OPT_LOAD_PUBKEY    18
 191 #define VALUE_OPT_LOAD_REQUEST   19
 192 #define VALUE_OPT_LOAD_CERTIFICATE 20
 193 #define VALUE_OPT_LOAD_CA_PRIVKEY 21
 194 #define VALUE_OPT_LOAD_CA_CERTIFICATE 22
 195 #define VALUE_OPT_PASSWORD       23
 196 #define VALUE_OPT_HEX_NUMBERS    24
 197 #define VALUE_OPT_NULL_PASSWORD  25
 198 #define VALUE_OPT_CERTIFICATE_INFO 'i'
 199 #define VALUE_OPT_CERTIFICATE_PUBKEY 27
 200 #define VALUE_OPT_PGP_CERTIFICATE_INFO 28
 201 #define VALUE_OPT_PGP_RING_INFO  29
 202 #define VALUE_OPT_CRL_INFO       'l'
 203 #define VALUE_OPT_CRQ_INFO       31
 204 #define VALUE_OPT_NO_CRQ_EXTENSIONS 32
 205 #define VALUE_OPT_P12_INFO       129
 206 #define VALUE_OPT_P7_INFO        130
 207 #define VALUE_OPT_SMIME_TO_P7    131
 208 #define VALUE_OPT_KEY_INFO       'k'
 209 #define VALUE_OPT_PGP_KEY_INFO   133
 210 #define VALUE_OPT_PUBKEY_INFO    134
 211 #define VALUE_OPT_V1             135
 212 #define VALUE_OPT_TO_P12         136
 213 #define VALUE_OPT_TO_P8          137
 214 #define VALUE_OPT_PKCS8          '8'
 215 #define VALUE_OPT_RSA            139
 216 #define VALUE_OPT_DSA            140
 217 #define VALUE_OPT_ECC            141
 218 #define VALUE_OPT_ECDSA          142
 219 #define VALUE_OPT_HASH           143
 220 #define VALUE_OPT_INDER          144
 221 #define VALUE_OPT_INRAW          145
 222 #define VALUE_OPT_OUTDER         146
 223 #define VALUE_OPT_OUTRAW         147
 224 #define VALUE_OPT_BITS           148
 225
 226 #define OPT_VALUE_BITS           (DESC(BITS).optArg.argInt)
 227 #define VALUE_OPT_SEC_PARAM      149
 228 #define VALUE_OPT_DISABLE_QUICK_RANDOM 150
 229 #define VALUE_OPT_TEMPLATE       151
 230 #define VALUE_OPT_PKCS_CIPHER    152
 231 #define VALUE_OPT_HELP          'h'
 232 #define VALUE_OPT_MORE_HELP     '!'
 233 #define VALUE_OPT_VERSION       'v'
 234 /*
 235  *  Interface defines not associated with particular options
 236  */
 237 #define ERRSKIP_OPTERR  STMTS(certtoolOptions.fOptSet &= ~OPTPROC_ERRSTOP)
 238 #define ERRSTOP_OPTERR  STMTS(certtoolOptions.fOptSet |= OPTPROC_ERRSTOP)
 239 #define RESTART_OPT(n)  STMTS( \
 240                 certtoolOptions.curOptIdx = (n); \
 241                 certtoolOptions.pzCurOpt  = NULL)
 242 #define START_OPT       RESTART_OPT(1)
 243 #define USAGE(c)        (*certtoolOptions.pUsageProc)(&certtoolOptions, c)
 244 /* extracted from opthead.tlib near line 484 */
 245
 246 #ifdef  __cplusplus
 247 extern "C" {
 248 #endif
 249 /*
 250  *  global exported definitions
 251  */
 252 #include <gettext.h>
 253
 254
 255 /* * * * * *
 256  *
 257  *  Declare the certtool option descriptor.
 258  */
 259 extern tOptions certtoolOptions;
 260
 261 #if defined(ENABLE_NLS)
 262 # ifndef _
 263 #   include <stdio.h>
 264 static inline char* aoGetsText(char const* pz) {
 265     if (pz == NULL) return NULL;
 266     return (char*)gettext(pz);
 267 }
 268 #   define _(s)  aoGetsText(s)
 269 # endif /* _() */
 270
 271 # define OPT_NO_XLAT_CFG_NAMES  STMTS(certtoolOptions.fOptSet |= \
 272                                     OPTPROC_NXLAT_OPT_CFG;)
 273 # define OPT_NO_XLAT_OPT_NAMES  STMTS(certtoolOptions.fOptSet |= \
 274                                     OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
 275
 276 # define OPT_XLAT_CFG_NAMES     STMTS(certtoolOptions.fOptSet &= \
 277                                   ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
 278 # define OPT_XLAT_OPT_NAMES     STMTS(certtoolOptions.fOptSet &= \
 279                                   ~OPTPROC_NXLAT_OPT;)
 280
 281 #else   /* ENABLE_NLS */
 282 # define OPT_NO_XLAT_CFG_NAMES
 283 # define OPT_NO_XLAT_OPT_NAMES
 284
 285 # define OPT_XLAT_CFG_NAMES
 286 # define OPT_XLAT_OPT_NAMES
 287
 288 # ifndef _
 289 #   define _(_s)  _s
 290 # endif
 291 #endif  /* ENABLE_NLS */
 292
 293 #ifdef  __cplusplus
 294 }
 295 #endif
 296 #endif /* AUTOOPTS_CERTTOOL_ARGS_H_GUARD */
 297 /* certtool-args.h ends here */