gsasl  1.10.0
About: GNU SASL is an implementation of the Simple Authentication and Security Layer (SASL). Development version.
  Fossies Dox: gsasl-1.10.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

gsasl_cmd.h
Go to the documentation of this file.
1 /** @file gsasl_cmd.h
2  * @brief The header file for the command line option parser
3  * generated by GNU Gengetopt version 2.22.6
4  * http://www.gnu.org/software/gengetopt.
5  * DO NOT modify this file, since it can be overwritten
6  * @author GNU Gengetopt by Lorenzo Bettini */
7 
8 #ifndef GSASL_CMD_H
9 #define GSASL_CMD_H
10 
11 /* If we use autoconf. */
12 #ifdef HAVE_CONFIG_H
13 #include "config.h"
14 #endif
15 
16 #include <stdio.h> /* for FILE */
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif /* __cplusplus */
21 
22 #ifndef CMDLINE_PARSER_PACKAGE
23 /** @brief the program name (used for printing errors) */
24 #define CMDLINE_PARSER_PACKAGE PACKAGE
25 #endif
26 
27 #ifndef CMDLINE_PARSER_PACKAGE_NAME
28 /** @brief the complete program name (used for help and version) */
29 #ifdef PACKAGE_NAME
30 #define CMDLINE_PARSER_PACKAGE_NAME PACKAGE_NAME
31 #else
32 #define CMDLINE_PARSER_PACKAGE_NAME PACKAGE
33 #endif
34 #endif
35 
36 #ifndef CMDLINE_PARSER_VERSION
37 /** @brief the program version */
38 #define CMDLINE_PARSER_VERSION VERSION
39 #endif
40 
41 /** @brief Where the command line options are stored */
43 {
44  const char *help_help; /**< @brief Print help and exit help description. */
45  const char *version_help; /**< @brief Print version and exit help description. */
46  int client_flag; /**< @brief Act as client. (default=on). */
47  const char *client_help; /**< @brief Act as client. help description. */
48  int server_flag; /**< @brief Act as server. (default=off). */
49  const char *server_help; /**< @brief Act as server. help description. */
50  int client_mechanisms_flag; /**< @brief Write name of supported client mechanisms separated by space to stdout. (default=off). */
51  const char *client_mechanisms_help; /**< @brief Write name of supported client mechanisms separated by space to stdout. help description. */
52  int server_mechanisms_flag; /**< @brief Write name of supported server mechanisms separated by space to stdout. (default=off). */
53  const char *server_mechanisms_help; /**< @brief Write name of supported server mechanisms separated by space to stdout. help description. */
54  int mkpasswd_flag; /**< @brief Derive password. Provide --mechanism as SCRAM-SHA-1 or SCRAM-SHA-256. The required inputs are password (through --password or read from terminal) and optional inputs are iteration count (through --iteration-count, or defaulting to 65536) and salt (through --salt, or generated randomly). The output is a string of the form \"{mech}count,salt,stored-key,server-key[,salted-password]\" where \"mech\" is the mechanism, \"count\" is the number of times password was hashed, \"salt\" is the provided/generated base64-encoded salt, \"stored-key\" and \"server-key\" are the two derived and base64-encoded server-side keys. When --verbose is provided, \"salted-password\" will be included as the hex-encoded PBKDF2-derived password. (default=off). */
55  const char *mkpasswd_help; /**< @brief Derive password. Provide --mechanism as SCRAM-SHA-1 or SCRAM-SHA-256. The required inputs are password (through --password or read from terminal) and optional inputs are iteration count (through --iteration-count, or defaulting to 65536) and salt (through --salt, or generated randomly). The output is a string of the form \"{mech}count,salt,stored-key,server-key[,salted-password]\" where \"mech\" is the mechanism, \"count\" is the number of times password was hashed, \"salt\" is the provided/generated base64-encoded salt, \"stored-key\" and \"server-key\" are the two derived and base64-encoded server-side keys. When --verbose is provided, \"salted-password\" will be included as the hex-encoded PBKDF2-derived password. help description. */
56  char * connect_arg; /**< @brief Connect to TCP server and negotiate on stream instead of stdin/stdout. PORT is the protocol service, or an integer denoting the port, and defaults to 143 (imap) if not specified. Also sets the --hostname default.. */
57  char * connect_orig; /**< @brief Connect to TCP server and negotiate on stream instead of stdin/stdout. PORT is the protocol service, or an integer denoting the port, and defaults to 143 (imap) if not specified. Also sets the --hostname default. original value given at command line. */
58  const char *connect_help; /**< @brief Connect to TCP server and negotiate on stream instead of stdin/stdout. PORT is the protocol service, or an integer denoting the port, and defaults to 143 (imap) if not specified. Also sets the --hostname default. help description. */
59  int application_data_flag; /**< @brief After authentication, read data from stdin and run it through the mechanism's security layer and print it base64 encoded to stdout. The default is to terminate after authentication. (default=on). */
60  const char *application_data_help; /**< @brief After authentication, read data from stdin and run it through the mechanism's security layer and print it base64 encoded to stdout. The default is to terminate after authentication. help description. */
61  int imap_flag; /**< @brief Use a IMAP-like logon procedure (client only). Also sets the --service default to 'imap'. (default=off). */
62  const char *imap_help; /**< @brief Use a IMAP-like logon procedure (client only). Also sets the --service default to 'imap'. help description. */
63  int smtp_flag; /**< @brief Use a SMTP-like logon procedure (client only). Also sets the --service default to 'smtp'. (default=off). */
64  const char *smtp_help; /**< @brief Use a SMTP-like logon procedure (client only). Also sets the --service default to 'smtp'. help description. */
65  char * mechanism_arg; /**< @brief Mechanism to use.. */
66  char * mechanism_orig; /**< @brief Mechanism to use. original value given at command line. */
67  const char *mechanism_help; /**< @brief Mechanism to use. help description. */
68  int no_client_first_flag; /**< @brief Disallow client to send data first (client only). (default=off). */
69  const char *no_client_first_help; /**< @brief Disallow client to send data first (client only). help description. */
70  char * anonymous_token_arg; /**< @brief Token for anonymous authentication, usually mail address (ANONYMOUS only).. */
71  char * anonymous_token_orig; /**< @brief Token for anonymous authentication, usually mail address (ANONYMOUS only). original value given at command line. */
72  const char *anonymous_token_help; /**< @brief Token for anonymous authentication, usually mail address (ANONYMOUS only). help description. */
73  char * authentication_id_arg; /**< @brief Identity of credential owner.. */
74  char * authentication_id_orig; /**< @brief Identity of credential owner. original value given at command line. */
75  const char *authentication_id_help; /**< @brief Identity of credential owner. help description. */
76  char * authorization_id_arg; /**< @brief Identity to request service for.. */
77  char * authorization_id_orig; /**< @brief Identity to request service for. original value given at command line. */
78  const char *authorization_id_help; /**< @brief Identity to request service for. help description. */
79  char * password_arg; /**< @brief Password for authentication (insecure for non-testing purposes).. */
80  char * password_orig; /**< @brief Password for authentication (insecure for non-testing purposes). original value given at command line. */
81  const char *password_help; /**< @brief Password for authentication (insecure for non-testing purposes). help description. */
82  char * realm_arg; /**< @brief Realm. Defaults to hostname.. */
83  char * realm_orig; /**< @brief Realm. Defaults to hostname. original value given at command line. */
84  const char *realm_help; /**< @brief Realm. Defaults to hostname. help description. */
85  char * passcode_arg; /**< @brief Passcode for authentication (SECURID only).. */
86  char * passcode_orig; /**< @brief Passcode for authentication (SECURID only). original value given at command line. */
87  const char *passcode_help; /**< @brief Passcode for authentication (SECURID only). help description. */
88  char * service_arg; /**< @brief Set the requested service name (should be a registered GSSAPI host based service name).. */
89  char * service_orig; /**< @brief Set the requested service name (should be a registered GSSAPI host based service name). original value given at command line. */
90  const char *service_help; /**< @brief Set the requested service name (should be a registered GSSAPI host based service name). help description. */
91  char * hostname_arg; /**< @brief Set the name of the server with the requested service.. */
92  char * hostname_orig; /**< @brief Set the name of the server with the requested service. original value given at command line. */
93  const char *hostname_help; /**< @brief Set the name of the server with the requested service. help description. */
94  char * service_name_arg; /**< @brief Set the generic server name in case of a replicated server (DIGEST-MD5 only).. */
95  char * service_name_orig; /**< @brief Set the generic server name in case of a replicated server (DIGEST-MD5 only). original value given at command line. */
96  const char *service_name_help; /**< @brief Set the generic server name in case of a replicated server (DIGEST-MD5 only). help description. */
97  int enable_cram_md5_validate_flag; /**< @brief Validate CRAM-MD5 challenge and response interactively. (default=off). */
98  const char *enable_cram_md5_validate_help; /**< @brief Validate CRAM-MD5 challenge and response interactively. help description. */
99  int disable_cleartext_validate_flag; /**< @brief Disable cleartext validate hook, forcing server to prompt for password. (default=off). */
100  const char *disable_cleartext_validate_help; /**< @brief Disable cleartext validate hook, forcing server to prompt for password. help description. */
101  char * quality_of_protection_arg; /**< @brief How application payload will be protected. 'qop-auth' means no protection, 'qop-int' means integrity protection, 'qop-conf' means integrity and confidentialiy protection. Currently only used by DIGEST-MD5, where the default is 'qop-int'.. */
102  char * quality_of_protection_orig; /**< @brief How application payload will be protected. 'qop-auth' means no protection, 'qop-int' means integrity protection, 'qop-conf' means integrity and confidentialiy protection. Currently only used by DIGEST-MD5, where the default is 'qop-int'. original value given at command line. */
103  const char *quality_of_protection_help; /**< @brief How application payload will be protected. 'qop-auth' means no protection, 'qop-int' means integrity protection, 'qop-conf' means integrity and confidentialiy protection. Currently only used by DIGEST-MD5, where the default is 'qop-int'. help description. */
104  int iteration_count_arg; /**< @brief Indicate PBKDF2 hash iteration count (SCRAM only). (default='65536'). */
105  char * iteration_count_orig; /**< @brief Indicate PBKDF2 hash iteration count (SCRAM only). original value given at command line. */
106  const char *iteration_count_help; /**< @brief Indicate PBKDF2 hash iteration count (SCRAM only). help description. */
107  char * salt_arg; /**< @brief Indicate PBKDF2 salt as base64-encoded string (SCRAM only).. */
108  char * salt_orig; /**< @brief Indicate PBKDF2 salt as base64-encoded string (SCRAM only). original value given at command line. */
109  const char *salt_help; /**< @brief Indicate PBKDF2 salt as base64-encoded string (SCRAM only). help description. */
110  int starttls_flag; /**< @brief Force use of STARTTLS. The default is to use STARTTLS when available. (default=off). */
111  const char *starttls_help; /**< @brief Force use of STARTTLS. The default is to use STARTTLS when available. help description. */
112  int no_starttls_flag; /**< @brief Unconditionally disable STARTTLS. (default=off). */
113  const char *no_starttls_help; /**< @brief Unconditionally disable STARTTLS. help description. */
114  int no_cb_flag; /**< @brief Don't use channel bindings from TLS. (default=off). */
115  const char *no_cb_help; /**< @brief Don't use channel bindings from TLS. help description. */
116  char * x509_ca_file_arg; /**< @brief File containing one or more X.509 Certificate Authorities certificates in PEM format, used to verify the certificate received from the server. If not specified, verification uses system trust settings. If FILE is the empty string, don't fail on X.509 server certificates verification errors.. */
117  char * x509_ca_file_orig; /**< @brief File containing one or more X.509 Certificate Authorities certificates in PEM format, used to verify the certificate received from the server. If not specified, verification uses system trust settings. If FILE is the empty string, don't fail on X.509 server certificates verification errors. original value given at command line. */
118  const char *x509_ca_file_help; /**< @brief File containing one or more X.509 Certificate Authorities certificates in PEM format, used to verify the certificate received from the server. If not specified, verification uses system trust settings. If FILE is the empty string, don't fail on X.509 server certificates verification errors. help description. */
119  char * x509_cert_file_arg; /**< @brief File containing client X.509 certificate in PEM format. Used together with --x509-key-file to specify the certificate/key pair.. */
120  char * x509_cert_file_orig; /**< @brief File containing client X.509 certificate in PEM format. Used together with --x509-key-file to specify the certificate/key pair. original value given at command line. */
121  const char *x509_cert_file_help; /**< @brief File containing client X.509 certificate in PEM format. Used together with --x509-key-file to specify the certificate/key pair. help description. */
122  char * x509_key_file_arg; /**< @brief Private key for the client X.509 certificate in PEM format. Used together with --x509-key-file to specify the certificate/key pair.. */
123  char * x509_key_file_orig; /**< @brief Private key for the client X.509 certificate in PEM format. Used together with --x509-key-file to specify the certificate/key pair. original value given at command line. */
124  const char *x509_key_file_help; /**< @brief Private key for the client X.509 certificate in PEM format. Used together with --x509-key-file to specify the certificate/key pair. help description. */
125  char * priority_arg; /**< @brief Cipher priority string.. */
126  char * priority_orig; /**< @brief Cipher priority string. original value given at command line. */
127  const char *priority_help; /**< @brief Cipher priority string. help description. */
128  int verbose_flag; /**< @brief Produce verbose output. (default=off). */
129  const char *verbose_help; /**< @brief Produce verbose output. help description. */
130  int quiet_flag; /**< @brief Don't produce any diagnostic output. (default=off). */
131  const char *quiet_help; /**< @brief Don't produce any diagnostic output. help description. */
132 
133  unsigned int help_given ; /**< @brief Whether help was given. */
134  unsigned int version_given ; /**< @brief Whether version was given. */
135  unsigned int client_given ; /**< @brief Whether client was given. */
136  unsigned int server_given ; /**< @brief Whether server was given. */
137  unsigned int client_mechanisms_given ; /**< @brief Whether client-mechanisms was given. */
138  unsigned int server_mechanisms_given ; /**< @brief Whether server-mechanisms was given. */
139  unsigned int mkpasswd_given ; /**< @brief Whether mkpasswd was given. */
140  unsigned int connect_given ; /**< @brief Whether connect was given. */
141  unsigned int application_data_given ; /**< @brief Whether application-data was given. */
142  unsigned int imap_given ; /**< @brief Whether imap was given. */
143  unsigned int smtp_given ; /**< @brief Whether smtp was given. */
144  unsigned int mechanism_given ; /**< @brief Whether mechanism was given. */
145  unsigned int no_client_first_given ; /**< @brief Whether no-client-first was given. */
146  unsigned int anonymous_token_given ; /**< @brief Whether anonymous-token was given. */
147  unsigned int authentication_id_given ; /**< @brief Whether authentication-id was given. */
148  unsigned int authorization_id_given ; /**< @brief Whether authorization-id was given. */
149  unsigned int password_given ; /**< @brief Whether password was given. */
150  unsigned int realm_given ; /**< @brief Whether realm was given. */
151  unsigned int passcode_given ; /**< @brief Whether passcode was given. */
152  unsigned int service_given ; /**< @brief Whether service was given. */
153  unsigned int hostname_given ; /**< @brief Whether hostname was given. */
154  unsigned int service_name_given ; /**< @brief Whether service-name was given. */
155  unsigned int enable_cram_md5_validate_given ; /**< @brief Whether enable-cram-md5-validate was given. */
156  unsigned int disable_cleartext_validate_given ; /**< @brief Whether disable-cleartext-validate was given. */
157  unsigned int quality_of_protection_given ; /**< @brief Whether quality-of-protection was given. */
158  unsigned int iteration_count_given ; /**< @brief Whether iteration-count was given. */
159  unsigned int salt_given ; /**< @brief Whether salt was given. */
160  unsigned int starttls_given ; /**< @brief Whether starttls was given. */
161  unsigned int no_starttls_given ; /**< @brief Whether no-starttls was given. */
162  unsigned int no_cb_given ; /**< @brief Whether no-cb was given. */
163  unsigned int x509_ca_file_given ; /**< @brief Whether x509-ca-file was given. */
164  unsigned int x509_cert_file_given ; /**< @brief Whether x509-cert-file was given. */
165  unsigned int x509_key_file_given ; /**< @brief Whether x509-key-file was given. */
166  unsigned int priority_given ; /**< @brief Whether priority was given. */
167  unsigned int verbose_given ; /**< @brief Whether verbose was given. */
168  unsigned int quiet_given ; /**< @brief Whether quiet was given. */
169 
170  char **inputs ; /**< @brief unamed options (options without names) */
171  unsigned inputs_num ; /**< @brief unamed options number */
172 } ;
173 
174 /** @brief The additional parameters to pass to parser functions */
176 {
177  int override; /**< @brief whether to override possibly already present options (default 0) */
178  int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
179  int check_required; /**< @brief whether to check that all required options were provided (default 1) */
180  int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
181  int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
182 } ;
183 
184 /** @brief the purpose string of the program */
185 extern const char *gengetopt_args_info_purpose;
186 /** @brief the usage string of the program */
187 extern const char *gengetopt_args_info_usage;
188 /** @brief the description string of the program */
189 extern const char *gengetopt_args_info_description;
190 /** @brief all the lines making the help output */
191 extern const char *gengetopt_args_info_help[];
192 
193 /**
194  * The command line parser
195  * @param argc the number of command line options
196  * @param argv the command line options
197  * @param args_info the structure where option information will be stored
198  * @return 0 if everything went fine, NON 0 if an error took place
199  */
200 int cmdline_parser (int argc, char **argv,
202 
203 /**
204  * The command line parser (version with additional parameters - deprecated)
205  * @param argc the number of command line options
206  * @param argv the command line options
207  * @param args_info the structure where option information will be stored
208  * @param override whether to override possibly already present options
209  * @param initialize whether to initialize the option structure my_args_info
210  * @param check_required whether to check that all required options were provided
211  * @return 0 if everything went fine, NON 0 if an error took place
212  * @deprecated use cmdline_parser_ext() instead
213  */
214 int cmdline_parser2 (int argc, char **argv,
216  int override, int initialize, int check_required);
217 
218 /**
219  * The command line parser (version with additional parameters)
220  * @param argc the number of command line options
221  * @param argv the command line options
222  * @param args_info the structure where option information will be stored
223  * @param params additional parameters for the parser
224  * @return 0 if everything went fine, NON 0 if an error took place
225  */
226 int cmdline_parser_ext (int argc, char **argv,
228  struct cmdline_parser_params *params);
229 
230 /**
231  * Save the contents of the option struct into an already open FILE stream.
232  * @param outfile the stream where to dump options
233  * @param args_info the option struct to dump
234  * @return 0 if everything went fine, NON 0 if an error took place
235  */
236 int cmdline_parser_dump(FILE *outfile,
238 
239 /**
240  * Save the contents of the option struct into a (text) file.
241  * This file can be read by the config file parser (if generated by gengetopt)
242  * @param filename the file where to save
243  * @param args_info the option struct to save
244  * @return 0 if everything went fine, NON 0 if an error took place
245  */
246 int cmdline_parser_file_save(const char *filename,
248 
249 /**
250  * Print the help
251  */
252 void cmdline_parser_print_help(void);
253 /**
254  * Print the version
255  */
257 
258 /**
259  * Initializes all the fields a cmdline_parser_params structure
260  * to their default values
261  * @param params the structure to initialize
262  */
264 
265 /**
266  * Allocates dynamically a cmdline_parser_params structure and initializes
267  * all its fields to their default values
268  * @return the created and initialized cmdline_parser_params structure
269  */
271 
272 /**
273  * Initializes the passed gengetopt_args_info structure's fields
274  * (also set default values for options that have a default)
275  * @param args_info the structure to initialize
276  */
278 /**
279  * Deallocates the string fields of the gengetopt_args_info structure
280  * (but does not deallocate the structure itself)
281  * @param args_info the structure to deallocate
282  */
284 
285 /**
286  * Checks that all the required options were specified
287  * @param args_info the structure to check
288  * @param prog_name the name of the program that will be used to print
289  * possible errors
290  * @return
291  */
293  const char *prog_name);
294 
295 
296 #ifdef __cplusplus
297 }
298 #endif /* __cplusplus */
299 #endif /* GSASL_CMD_H */
struct gengetopt_args_info args_info
Definition: gsasl.c:37
int cmdline_parser_dump(FILE *outfile, struct gengetopt_args_info *args_info)
Definition: gsasl_cmd.c:388
int cmdline_parser(int argc, char **argv, struct gengetopt_args_info *args_info)
Definition: gsasl_cmd.c:518
int cmdline_parser_file_save(const char *filename, struct gengetopt_args_info *args_info)
Definition: gsasl_cmd.c:477
const char * gengetopt_args_info_purpose
the purpose string of the program
Definition: gsasl_cmd.c:28
const char * gengetopt_args_info_help[]
all the lines making the help output
Definition: gsasl_cmd.c:36
int cmdline_parser2(int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required)
Definition: gsasl_cmd.c:540
int cmdline_parser_required(struct gengetopt_args_info *args_info, const char *prog_name)
Definition: gsasl_cmd.c:563
void cmdline_parser_print_version(void)
Definition: gsasl_cmd.c:246
const char * gengetopt_args_info_usage
the usage string of the program
Definition: gsasl_cmd.c:30
int cmdline_parser_ext(int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)
Definition: gsasl_cmd.c:524
void cmdline_parser_init(struct gengetopt_args_info *args_info)
Definition: gsasl_cmd.c:281
const char * gengetopt_args_info_description
the description string of the program
Definition: gsasl_cmd.c:34
void cmdline_parser_print_help(void)
Definition: gsasl_cmd.c:272
void cmdline_parser_free(struct gengetopt_args_info *args_info)
Definition: gsasl_cmd.c:497
void cmdline_parser_params_init(struct cmdline_parser_params *params)
Definition: gsasl_cmd.c:292
struct cmdline_parser_params * cmdline_parser_params_create(void)
Definition: gsasl_cmd.c:305
The additional parameters to pass to parser functions.
Definition: gsasl_cmd.h:176
int print_errors
whether getopt_long should print an error message for a bad option (default 1)
Definition: gsasl_cmd.h:181
int check_required
whether to check that all required options were provided (default 1)
Definition: gsasl_cmd.h:179
int check_ambiguity
whether to check for options already specified in the option structure gengetopt_args_info (default 0...
Definition: gsasl_cmd.h:180
int initialize
whether to initialize the option structure gengetopt_args_info (default 1)
Definition: gsasl_cmd.h:178
Where the command line options are stored.
Definition: gsasl_cmd.h:43
const char * no_client_first_help
Disallow client to send data first (client only). help description.
Definition: gsasl_cmd.h:69
unsigned int service_given
Whether service was given.
Definition: gsasl_cmd.h:152
char * hostname_orig
Set the name of the server with the requested service. original value given at command line.
Definition: gsasl_cmd.h:92
unsigned int server_mechanisms_given
Whether server-mechanisms was given.
Definition: gsasl_cmd.h:138
const char * imap_help
Use a IMAP-like logon procedure (client only). Also sets the –service default to 'imap'....
Definition: gsasl_cmd.h:62
int mkpasswd_flag
Derive password. Provide –mechanism as SCRAM-SHA-1 or SCRAM-SHA-256. The required inputs are password...
Definition: gsasl_cmd.h:54
char * salt_arg
Indicate PBKDF2 salt as base64-encoded string (SCRAM only)..
Definition: gsasl_cmd.h:107
unsigned int x509_key_file_given
Whether x509-key-file was given.
Definition: gsasl_cmd.h:165
char * priority_arg
Cipher priority string..
Definition: gsasl_cmd.h:125
int client_flag
Act as client. (default=on).
Definition: gsasl_cmd.h:46
unsigned int client_given
Whether client was given.
Definition: gsasl_cmd.h:135
unsigned int service_name_given
Whether service-name was given.
Definition: gsasl_cmd.h:154
const char * verbose_help
Produce verbose output. help description.
Definition: gsasl_cmd.h:129
char * passcode_orig
Passcode for authentication (SECURID only). original value given at command line.
Definition: gsasl_cmd.h:86
char * connect_arg
Connect to TCP server and negotiate on stream instead of stdin/stdout. PORT is the protocol service,...
Definition: gsasl_cmd.h:56
const char * x509_key_file_help
Private key for the client X.509 certificate in PEM format. Used together with –x509-key-file to spec...
Definition: gsasl_cmd.h:124
char * anonymous_token_arg
Token for anonymous authentication, usually mail address (ANONYMOUS only)..
Definition: gsasl_cmd.h:70
char * anonymous_token_orig
Token for anonymous authentication, usually mail address (ANONYMOUS only). original value given at co...
Definition: gsasl_cmd.h:71
char * service_arg
Set the requested service name (should be a registered GSSAPI host based service name)....
Definition: gsasl_cmd.h:88
int enable_cram_md5_validate_flag
Validate CRAM-MD5 challenge and response interactively. (default=off).
Definition: gsasl_cmd.h:97
int quiet_flag
Don't produce any diagnostic output. (default=off).
Definition: gsasl_cmd.h:130
unsigned int priority_given
Whether priority was given.
Definition: gsasl_cmd.h:166
char * password_arg
Password for authentication (insecure for non-testing purposes)..
Definition: gsasl_cmd.h:79
const char * service_name_help
Set the generic server name in case of a replicated server (DIGEST-MD5 only). help description.
Definition: gsasl_cmd.h:96
char * mechanism_orig
Mechanism to use. original value given at command line.
Definition: gsasl_cmd.h:66
unsigned inputs_num
unamed options number
Definition: gsasl_cmd.h:171
const char * smtp_help
Use a SMTP-like logon procedure (client only). Also sets the –service default to 'smtp'....
Definition: gsasl_cmd.h:64
const char * priority_help
Cipher priority string. help description.
Definition: gsasl_cmd.h:127
char * service_orig
Set the requested service name (should be a registered GSSAPI host based service name)....
Definition: gsasl_cmd.h:89
char * connect_orig
Connect to TCP server and negotiate on stream instead of stdin/stdout. PORT is the protocol service,...
Definition: gsasl_cmd.h:57
const char * quality_of_protection_help
How application payload will be protected. 'qop-auth' means no protection, 'qop-int' means integrity ...
Definition: gsasl_cmd.h:103
unsigned int imap_given
Whether imap was given.
Definition: gsasl_cmd.h:142
unsigned int x509_cert_file_given
Whether x509-cert-file was given.
Definition: gsasl_cmd.h:164
const char * realm_help
Realm. Defaults to hostname. help description.
Definition: gsasl_cmd.h:84
unsigned int no_cb_given
Whether no-cb was given.
Definition: gsasl_cmd.h:162
unsigned int authentication_id_given
Whether authentication-id was given.
Definition: gsasl_cmd.h:147
unsigned int iteration_count_given
Whether iteration-count was given.
Definition: gsasl_cmd.h:158
char * authorization_id_arg
Identity to request service for..
Definition: gsasl_cmd.h:76
unsigned int starttls_given
Whether starttls was given.
Definition: gsasl_cmd.h:160
char * priority_orig
Cipher priority string. original value given at command line.
Definition: gsasl_cmd.h:126
unsigned int disable_cleartext_validate_given
Whether disable-cleartext-validate was given.
Definition: gsasl_cmd.h:156
const char * authentication_id_help
Identity of credential owner. help description.
Definition: gsasl_cmd.h:75
unsigned int realm_given
Whether realm was given.
Definition: gsasl_cmd.h:150
const char * service_help
Set the requested service name (should be a registered GSSAPI host based service name)....
Definition: gsasl_cmd.h:90
int no_starttls_flag
Unconditionally disable STARTTLS. (default=off).
Definition: gsasl_cmd.h:112
unsigned int no_starttls_given
Whether no-starttls was given.
Definition: gsasl_cmd.h:161
unsigned int anonymous_token_given
Whether anonymous-token was given.
Definition: gsasl_cmd.h:146
unsigned int smtp_given
Whether smtp was given.
Definition: gsasl_cmd.h:143
const char * enable_cram_md5_validate_help
Validate CRAM-MD5 challenge and response interactively. help description.
Definition: gsasl_cmd.h:98
char * x509_ca_file_orig
File containing one or more X.509 Certificate Authorities certificates in PEM format,...
Definition: gsasl_cmd.h:117
int server_mechanisms_flag
Write name of supported server mechanisms separated by space to stdout. (default=off).
Definition: gsasl_cmd.h:52
char * realm_arg
Realm. Defaults to hostname..
Definition: gsasl_cmd.h:82
char * x509_key_file_orig
Private key for the client X.509 certificate in PEM format. Used together with –x509-key-file to spec...
Definition: gsasl_cmd.h:123
const char * server_mechanisms_help
Write name of supported server mechanisms separated by space to stdout. help description.
Definition: gsasl_cmd.h:53
const char * password_help
Password for authentication (insecure for non-testing purposes). help description.
Definition: gsasl_cmd.h:81
const char * authorization_id_help
Identity to request service for. help description.
Definition: gsasl_cmd.h:78
int server_flag
Act as server. (default=off).
Definition: gsasl_cmd.h:48
char * passcode_arg
Passcode for authentication (SECURID only)..
Definition: gsasl_cmd.h:85
char * hostname_arg
Set the name of the server with the requested service..
Definition: gsasl_cmd.h:91
int disable_cleartext_validate_flag
Disable cleartext validate hook, forcing server to prompt for password. (default=off).
Definition: gsasl_cmd.h:99
char * authorization_id_orig
Identity to request service for. original value given at command line.
Definition: gsasl_cmd.h:77
int imap_flag
Use a IMAP-like logon procedure (client only). Also sets the –service default to 'imap'....
Definition: gsasl_cmd.h:61
char * password_orig
Password for authentication (insecure for non-testing purposes). original value given at command line...
Definition: gsasl_cmd.h:80
const char * anonymous_token_help
Token for anonymous authentication, usually mail address (ANONYMOUS only). help description.
Definition: gsasl_cmd.h:72
int no_client_first_flag
Disallow client to send data first (client only). (default=off).
Definition: gsasl_cmd.h:68
char * realm_orig
Realm. Defaults to hostname. original value given at command line.
Definition: gsasl_cmd.h:83
char ** inputs
unamed options (options without names)
Definition: gsasl_cmd.h:170
unsigned int hostname_given
Whether hostname was given.
Definition: gsasl_cmd.h:153
char * service_name_orig
Set the generic server name in case of a replicated server (DIGEST-MD5 only). original value given at...
Definition: gsasl_cmd.h:95
unsigned int no_client_first_given
Whether no-client-first was given.
Definition: gsasl_cmd.h:145
const char * quiet_help
Don't produce any diagnostic output. help description.
Definition: gsasl_cmd.h:131
unsigned int mechanism_given
Whether mechanism was given.
Definition: gsasl_cmd.h:144
int application_data_flag
After authentication, read data from stdin and run it through the mechanism's security layer and prin...
Definition: gsasl_cmd.h:59
const char * application_data_help
After authentication, read data from stdin and run it through the mechanism's security layer and prin...
Definition: gsasl_cmd.h:60
int verbose_flag
Produce verbose output. (default=off).
Definition: gsasl_cmd.h:128
unsigned int enable_cram_md5_validate_given
Whether enable-cram-md5-validate was given.
Definition: gsasl_cmd.h:155
char * x509_ca_file_arg
File containing one or more X.509 Certificate Authorities certificates in PEM format,...
Definition: gsasl_cmd.h:116
unsigned int application_data_given
Whether application-data was given.
Definition: gsasl_cmd.h:141
const char * disable_cleartext_validate_help
Disable cleartext validate hook, forcing server to prompt for password. help description.
Definition: gsasl_cmd.h:100
const char * x509_cert_file_help
File containing client X.509 certificate in PEM format. Used together with –x509-key-file to specify ...
Definition: gsasl_cmd.h:121
int no_cb_flag
Don't use channel bindings from TLS. (default=off).
Definition: gsasl_cmd.h:114
unsigned int help_given
Whether help was given.
Definition: gsasl_cmd.h:133
const char * salt_help
Indicate PBKDF2 salt as base64-encoded string (SCRAM only). help description.
Definition: gsasl_cmd.h:109
unsigned int authorization_id_given
Whether authorization-id was given.
Definition: gsasl_cmd.h:148
int iteration_count_arg
Indicate PBKDF2 hash iteration count (SCRAM only). (default='65536').
Definition: gsasl_cmd.h:104
unsigned int connect_given
Whether connect was given.
Definition: gsasl_cmd.h:140
const char * x509_ca_file_help
File containing one or more X.509 Certificate Authorities certificates in PEM format,...
Definition: gsasl_cmd.h:118
char * x509_cert_file_orig
File containing client X.509 certificate in PEM format. Used together with –x509-key-file to specify ...
Definition: gsasl_cmd.h:120
unsigned int quiet_given
Whether quiet was given.
Definition: gsasl_cmd.h:168
int smtp_flag
Use a SMTP-like logon procedure (client only). Also sets the –service default to 'smtp'....
Definition: gsasl_cmd.h:63
int starttls_flag
Force use of STARTTLS. The default is to use STARTTLS when available. (default=off).
Definition: gsasl_cmd.h:110
const char * hostname_help
Set the name of the server with the requested service. help description.
Definition: gsasl_cmd.h:93
char * x509_cert_file_arg
File containing client X.509 certificate in PEM format. Used together with –x509-key-file to specify ...
Definition: gsasl_cmd.h:119
const char * passcode_help
Passcode for authentication (SECURID only). help description.
Definition: gsasl_cmd.h:87
char * mechanism_arg
Mechanism to use..
Definition: gsasl_cmd.h:65
const char * starttls_help
Force use of STARTTLS. The default is to use STARTTLS when available. help description.
Definition: gsasl_cmd.h:111
int client_mechanisms_flag
Write name of supported client mechanisms separated by space to stdout. (default=off).
Definition: gsasl_cmd.h:50
const char * client_help
Act as client. help description.
Definition: gsasl_cmd.h:47
char * service_name_arg
Set the generic server name in case of a replicated server (DIGEST-MD5 only)..
Definition: gsasl_cmd.h:94
unsigned int version_given
Whether version was given.
Definition: gsasl_cmd.h:134
const char * connect_help
Connect to TCP server and negotiate on stream instead of stdin/stdout. PORT is the protocol service,...
Definition: gsasl_cmd.h:58
unsigned int salt_given
Whether salt was given.
Definition: gsasl_cmd.h:159
char * x509_key_file_arg
Private key for the client X.509 certificate in PEM format. Used together with –x509-key-file to spec...
Definition: gsasl_cmd.h:122
unsigned int mkpasswd_given
Whether mkpasswd was given.
Definition: gsasl_cmd.h:139
char * quality_of_protection_arg
How application payload will be protected. 'qop-auth' means no protection, 'qop-int' means integrity ...
Definition: gsasl_cmd.h:101
const char * mkpasswd_help
Derive password. Provide –mechanism as SCRAM-SHA-1 or SCRAM-SHA-256. The required inputs are password...
Definition: gsasl_cmd.h:55
unsigned int quality_of_protection_given
Whether quality-of-protection was given.
Definition: gsasl_cmd.h:157
unsigned int passcode_given
Whether passcode was given.
Definition: gsasl_cmd.h:151
char * quality_of_protection_orig
How application payload will be protected. 'qop-auth' means no protection, 'qop-int' means integrity ...
Definition: gsasl_cmd.h:102
const char * version_help
Print version and exit help description.
Definition: gsasl_cmd.h:45
unsigned int verbose_given
Whether verbose was given.
Definition: gsasl_cmd.h:167
char * authentication_id_orig
Identity of credential owner. original value given at command line.
Definition: gsasl_cmd.h:74
const char * server_help
Act as server. help description.
Definition: gsasl_cmd.h:49
unsigned int client_mechanisms_given
Whether client-mechanisms was given.
Definition: gsasl_cmd.h:137
const char * client_mechanisms_help
Write name of supported client mechanisms separated by space to stdout. help description.
Definition: gsasl_cmd.h:51
unsigned int x509_ca_file_given
Whether x509-ca-file was given.
Definition: gsasl_cmd.h:163
char * authentication_id_arg
Identity of credential owner..
Definition: gsasl_cmd.h:73
const char * iteration_count_help
Indicate PBKDF2 hash iteration count (SCRAM only). help description.
Definition: gsasl_cmd.h:106
char * iteration_count_orig
Indicate PBKDF2 hash iteration count (SCRAM only). original value given at command line.
Definition: gsasl_cmd.h:105
char * salt_orig
Indicate PBKDF2 salt as base64-encoded string (SCRAM only). original value given at command line.
Definition: gsasl_cmd.h:108
unsigned int password_given
Whether password was given.
Definition: gsasl_cmd.h:149
const char * mechanism_help
Mechanism to use. help description.
Definition: gsasl_cmd.h:67
unsigned int server_given
Whether server was given.
Definition: gsasl_cmd.h:136
const char * no_starttls_help
Unconditionally disable STARTTLS. help description.
Definition: gsasl_cmd.h:113
const char * no_cb_help
Don't use channel bindings from TLS. help description.
Definition: gsasl_cmd.h:115
const char * help_help
Print help and exit help description.
Definition: gsasl_cmd.h:44