summaryrefslogtreecommitdiff
path: root/src/cli-args.h.bak
blob: 83ef522baff2bcd55ba18597e9c9a6131afa5917 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/*   -*- buffer-read-only: t -*- vi: set ro:
 *
 *  DO NOT EDIT THIS FILE   (cli-args.h)
 *
 *  It has been AutoGen-ed
 *  From the definitions    cli-args.def
 *  and the template file   options
 *
 * Generated from AutoOpts 41:1:16 templates.
 *
 *  AutoOpts is a copyrighted work.  This header file is not encumbered
 *  by AutoOpts licensing, but is provided under the licensing terms chosen
 *  by the gnutls-cli author or copyright holder.  AutoOpts is
 *  licensed under the terms of the LGPL.  The redistributable library
 *  (``libopts'') is licensed under the terms of either the LGPL or, at the
 *  users discretion, the BSD license.  See the AutoOpts and/or libopts sources
 *  for details.
 *
 * The gnutls-cli program is copyrighted and licensed
 * under the following terms:
 *
 *  Copyright (C) 2000-@YEAR@ Free Software Foundation, and others, all rights reserved.
 *  This is free software. It is licensed for use, modification and
 *  redistribution under the terms of the GNU General Public License,
 *  version 3 or later <http://gnu.org/licenses/gpl.html>
 *
 *  gnutls-cli 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  gnutls-cli is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *  See the 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, see <http://www.gnu.org/licenses/>.
 */
/**
 *  This file contains the programmatic interface to the Automated
 *  Options generated for the gnutls-cli program.
 *  These macros are documented in the AutoGen info file in the
 *  "AutoOpts" chapter.  Please refer to that doc for usage help.
 */
#ifndef AUTOOPTS_CLI_ARGS_H_GUARD
#define AUTOOPTS_CLI_ARGS_H_GUARD 1
#include "config.h"
#include <autoopts/options.h>

/**
 *  Ensure that the library used for compiling this generated header is at
 *  least as new as the version current when the header template was released
 *  (not counting patch version increments).  Also ensure that the oldest
 *  tolerable version is at least as old as what was current when the header
 *  template was released.
 */
#define AO_TEMPLATE_VERSION 167937
#if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
 || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
# error option template version mismatches autoopts/options.h header
  Choke Me.
#endif

/**
 *  Enumeration of each option type for gnutls-cli
 */
typedef enum {
    INDEX_OPT_DEBUG                   =  0,
    INDEX_OPT_VERBOSE                 =  1,
    INDEX_OPT_TOFU                    =  2,
    INDEX_OPT_STRICT_TOFU             =  3,
    INDEX_OPT_DANE                    =  4,
    INDEX_OPT_LOCAL_DNS               =  5,
    INDEX_OPT_CA_VERIFICATION         =  6,
    INDEX_OPT_OCSP                    =  7,
    INDEX_OPT_RESUME                  =  8,
    INDEX_OPT_REHANDSHAKE             =  9,
    INDEX_OPT_SNI_HOSTNAME            = 10,
    INDEX_OPT_STARTTLS                = 11,
    INDEX_OPT_APP_PROTO               = 12,
    INDEX_OPT_STARTTLS_PROTO          = 13,
    INDEX_OPT_UDP                     = 14,
    INDEX_OPT_MTU                     = 15,
    INDEX_OPT_CRLF                    = 16,
    INDEX_OPT_FASTOPEN                = 17,
    INDEX_OPT_X509FMTDER              = 18,
    INDEX_OPT_PRINT_CERT              = 19,
    INDEX_OPT_SAVE_CERT               = 20,
    INDEX_OPT_SAVE_OCSP               = 21,
    INDEX_OPT_DH_BITS                 = 22,
    INDEX_OPT_PRIORITY                = 23,
    INDEX_OPT_X509CAFILE              = 24,
    INDEX_OPT_X509CRLFILE             = 25,
    INDEX_OPT_X509KEYFILE             = 26,
    INDEX_OPT_X509CERTFILE            = 27,
    INDEX_OPT_SRPUSERNAME             = 28,
    INDEX_OPT_SRPPASSWD               = 29,
    INDEX_OPT_PSKUSERNAME             = 30,
    INDEX_OPT_PSKKEY                  = 31,
    INDEX_OPT_PORT                    = 32,
    INDEX_OPT_INSECURE                = 33,
    INDEX_OPT_VERIFY_ALLOW_BROKEN     = 34,
    INDEX_OPT_RANGES                  = 35,
    INDEX_OPT_BENCHMARK_CIPHERS       = 36,
    INDEX_OPT_BENCHMARK_TLS_KX        = 37,
    INDEX_OPT_BENCHMARK_TLS_CIPHERS   = 38,
    INDEX_OPT_LIST                    = 39,
    INDEX_OPT_PRIORITY_LIST           = 40,
    INDEX_OPT_NOTICKET                = 41,
    INDEX_OPT_SRTP_PROFILES           = 42,
    INDEX_OPT_ALPN                    = 43,
    INDEX_OPT_HEARTBEAT               = 44,
    INDEX_OPT_RECORDSIZE              = 45,
    INDEX_OPT_DISABLE_SNI             = 46,
    INDEX_OPT_DISABLE_EXTENSIONS      = 47,
    INDEX_OPT_INLINE_COMMANDS         = 48,
    INDEX_OPT_INLINE_COMMANDS_PREFIX  = 49,
    INDEX_OPT_PROVIDER                = 50,
    INDEX_OPT_FIPS140_MODE            = 51,
    INDEX_OPT_VERSION                 = 52,
    INDEX_OPT_HELP                    = 53,
    INDEX_OPT_MORE_HELP               = 54
} teOptIndex;
/** count of all options for gnutls-cli */
#define OPTION_CT    55
/** gnutls-cli version */
#define GNUTLS_CLI_VERSION       "@VERSION@"
/** Full gnutls-cli version text */
#define GNUTLS_CLI_FULL_VERSION  "gnutls-cli @VERSION@"

/**
 *  Interface defines for all options.  Replace "n" with the UPPER_CASED
 *  option name (as in the teOptIndex enumeration above).
 *  e.g. HAVE_OPT(DEBUG)
 */
#define         DESC(n) (gnutls_cliOptions.pOptDesc[INDEX_OPT_## n])
/** 'true' if an option has been specified in any way */
#define     HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
/** The string argument to an option. The argument type must be \"string\". */
#define      OPT_ARG(n) (DESC(n).optArg.argString)
/** Mask the option state revealing how an option was specified.
 *  It will be one and only one of \a OPTST_SET, \a OPTST_PRESET,
 * \a OPTST_DEFINED, \a OPTST_RESET or zero.
 */
#define    STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
/** Count of option's occurrances *on the command line*. */
#define    COUNT_OPT(n) (DESC(n).optOccCt)
/** mask of \a OPTST_SET and \a OPTST_DEFINED. */
#define    ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
/** 'true' if \a HAVE_OPT would yield 'false'. */
#define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
/** 'true' if OPTST_DISABLED bit not set. */
#define  ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
/** number of stacked option arguments.
 *  Valid only for stacked option arguments. */
#define  STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
/** stacked argument vector.
 *  Valid only for stacked option arguments. */
#define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
/** Reset an option. */
#define    CLEAR_OPT(n) STMTS( \
                DESC(n).fOptState &= OPTST_PERSISTENT_MASK;   \
                if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
                    DESC(n).fOptState |= OPTST_DISABLED; \
                DESC(n).optCookie = NULL )
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**
 *  Enumeration of gnutls-cli exit codes
 */
typedef enum {
    GNUTLS_CLI_EXIT_SUCCESS         = 0,
    GNUTLS_CLI_EXIT_FAILURE         = 1,
    GNUTLS_CLI_EXIT_USAGE_ERROR     = 64,
    GNUTLS_CLI_EXIT_LIBOPTS_FAILURE = 70
}   gnutls_cli_exit_code_t;
/**
 *  Interface defines for specific options.
 * @{
 */
#define VALUE_OPT_DEBUG          'd'

#define OPT_VALUE_DEBUG          (DESC(DEBUG).optArg.argInt)
#define VALUE_OPT_VERBOSE        'V'
#define VALUE_OPT_TOFU           0x1001
#define VALUE_OPT_STRICT_TOFU    0x1002
#define VALUE_OPT_DANE           0x1003
#define VALUE_OPT_LOCAL_DNS      0x1004
#define VALUE_OPT_CA_VERIFICATION 0x1005
#define VALUE_OPT_OCSP           0x1006
#define VALUE_OPT_RESUME         'r'
#define VALUE_OPT_REHANDSHAKE    'e'
#define VALUE_OPT_SNI_HOSTNAME   0x1007
#define VALUE_OPT_STARTTLS       's'
#define VALUE_OPT_APP_PROTO      0x1008
#define VALUE_OPT_STARTTLS_PROTO 0x1009
#define VALUE_OPT_UDP            'u'
#define VALUE_OPT_MTU            0x100A

#define OPT_VALUE_MTU            (DESC(MTU).optArg.argInt)
#define VALUE_OPT_CRLF           0x100B
#define VALUE_OPT_FASTOPEN       0x100C
#define VALUE_OPT_X509FMTDER     0x100D
#define VALUE_OPT_PRINT_CERT     0x100E
#define VALUE_OPT_SAVE_CERT      0x100F
#define VALUE_OPT_SAVE_OCSP      0x1010
#define VALUE_OPT_DH_BITS        0x1011

#define OPT_VALUE_DH_BITS        (DESC(DH_BITS).optArg.argInt)
#define VALUE_OPT_PRIORITY       0x1012
#define VALUE_OPT_X509CAFILE     0x1013
#define VALUE_OPT_X509CRLFILE    0x1014
#define VALUE_OPT_X509KEYFILE    0x1015
#define VALUE_OPT_X509CERTFILE   0x1016
#define VALUE_OPT_SRPUSERNAME    0x1017
#define VALUE_OPT_SRPPASSWD      0x1018
#define VALUE_OPT_PSKUSERNAME    0x1019
#define VALUE_OPT_PSKKEY         0x101A
#define VALUE_OPT_PORT           'p'
#define VALUE_OPT_INSECURE       0x101B
#define VALUE_OPT_VERIFY_ALLOW_BROKEN 0x101C
#define VALUE_OPT_RANGES         0x101D
#define VALUE_OPT_BENCHMARK_CIPHERS 0x101E
#define VALUE_OPT_BENCHMARK_TLS_KX 0x101F
#define VALUE_OPT_BENCHMARK_TLS_CIPHERS 0x1020
#define VALUE_OPT_LIST           'l'
#define VALUE_OPT_PRIORITY_LIST  0x1021
#define VALUE_OPT_NOTICKET       0x1022
#define VALUE_OPT_SRTP_PROFILES  0x1023
#define VALUE_OPT_ALPN           0x1024
#define VALUE_OPT_HEARTBEAT      'b'
#define VALUE_OPT_RECORDSIZE     0x1025

#define OPT_VALUE_RECORDSIZE     (DESC(RECORDSIZE).optArg.argInt)
#define VALUE_OPT_DISABLE_SNI    0x1026
#define VALUE_OPT_DISABLE_EXTENSIONS 0x1027
#define VALUE_OPT_INLINE_COMMANDS 0x1028
#define VALUE_OPT_INLINE_COMMANDS_PREFIX 0x1029
#define VALUE_OPT_PROVIDER       0x102A
#define VALUE_OPT_FIPS140_MODE   0x102B
/** option flag (value) for help-value option */
#define VALUE_OPT_HELP          'h'
/** option flag (value) for more-help-value option */
#define VALUE_OPT_MORE_HELP     '!'
/** option flag (value) for version-value option */
#define VALUE_OPT_VERSION       'v'
/*
 *  Interface defines not associated with particular options
 */
#define ERRSKIP_OPTERR  STMTS(gnutls_cliOptions.fOptSet &= ~OPTPROC_ERRSTOP)
#define ERRSTOP_OPTERR  STMTS(gnutls_cliOptions.fOptSet |= OPTPROC_ERRSTOP)
#define RESTART_OPT(n)  STMTS( \
                gnutls_cliOptions.curOptIdx = (n); \
                gnutls_cliOptions.pzCurOpt  = NULL )
#define START_OPT       RESTART_OPT(1)
#define USAGE(c)        (*gnutls_cliOptions.pUsageProc)(&gnutls_cliOptions, c)

#ifdef  __cplusplus
extern "C" {
#endif
/*
 *  global exported definitions
 */
#include <gettext.h>


/* * * * * *
 *
 *  Declare the gnutls-cli option descriptor.
 */
extern tOptions gnutls_cliOptions;

#if defined(ENABLE_NLS)
# ifndef _
#   include <stdio.h>
#   ifndef HAVE_GETTEXT
      extern char * gettext(char const *);
#   else
#     include <libintl.h>
#   endif

# ifndef ATTRIBUTE_FORMAT_ARG
#   define ATTRIBUTE_FORMAT_ARG(_a)
# endif

static inline char* aoGetsText(char const* pz) ATTRIBUTE_FORMAT_ARG(1);
static inline char* aoGetsText(char const* pz) {
    if (pz == NULL) return NULL;
    return (char*)gettext(pz);
}
#   define _(s)  aoGetsText(s)
# endif /* _() */

# define OPT_NO_XLAT_CFG_NAMES  STMTS(gnutls_cliOptions.fOptSet |= \
                                    OPTPROC_NXLAT_OPT_CFG;)
# define OPT_NO_XLAT_OPT_NAMES  STMTS(gnutls_cliOptions.fOptSet |= \
                                    OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)

# define OPT_XLAT_CFG_NAMES     STMTS(gnutls_cliOptions.fOptSet &= \
                                  ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
# define OPT_XLAT_OPT_NAMES     STMTS(gnutls_cliOptions.fOptSet &= \
                                  ~OPTPROC_NXLAT_OPT;)

#else   /* ENABLE_NLS */
# define OPT_NO_XLAT_CFG_NAMES
# define OPT_NO_XLAT_OPT_NAMES

# define OPT_XLAT_CFG_NAMES
# define OPT_XLAT_OPT_NAMES

# ifndef _
#   define _(_s)  _s
# endif
#endif  /* ENABLE_NLS */

#ifdef  __cplusplus
}
#endif
#endif /* AUTOOPTS_CLI_ARGS_H_GUARD */

/* cli-args.h ends here */