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)  

gengetopt_args_info Struct Reference

Where the command line options are stored. More...

#include <gsasl_cmd.h>

Data Fields

const char * help_help
 Print help and exit help description.
More...
 
const char * version_help
 Print version and exit help description.
More...
 
int client_flag
 Act as client. (default=on).
More...
 
const char * client_help
 Act as client. help description.
More...
 
int server_flag
 Act as server. (default=off).
More...
 
const char * server_help
 Act as server. help description.
More...
 
int client_mechanisms_flag
 Write name of supported client mechanisms separated by space to stdout. (default=off).
More...
 
const char * client_mechanisms_help
 Write name of supported client mechanisms separated by space to stdout. help description.
More...
 
int server_mechanisms_flag
 Write name of supported server mechanisms separated by space to stdout. (default=off).
More...
 
const char * server_mechanisms_help
 Write name of supported server mechanisms separated by space to stdout. help description.
More...
 
int mkpasswd_flag
 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).
More...
 
const char * mkpasswd_help
 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.
More...
 
char * connect_arg
 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..
More...
 
char * connect_orig
 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.
More...
 
const char * connect_help
 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.
More...
 
int application_data_flag
 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).
More...
 
const char * application_data_help
 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.
More...
 
int imap_flag
 Use a IMAP-like logon procedure (client only). Also sets the –service default to 'imap'. (default=off).
More...
 
const char * imap_help
 Use a IMAP-like logon procedure (client only). Also sets the –service default to 'imap'. help description.
More...
 
int smtp_flag
 Use a SMTP-like logon procedure (client only). Also sets the –service default to 'smtp'. (default=off).
More...
 
const char * smtp_help
 Use a SMTP-like logon procedure (client only). Also sets the –service default to 'smtp'. help description.
More...
 
char * mechanism_arg
 Mechanism to use..
More...
 
char * mechanism_orig
 Mechanism to use. original value given at command line.
More...
 
const char * mechanism_help
 Mechanism to use. help description.
More...
 
int no_client_first_flag
 Disallow client to send data first (client only). (default=off).
More...
 
const char * no_client_first_help
 Disallow client to send data first (client only). help description.
More...
 
char * anonymous_token_arg
 Token for anonymous authentication, usually mail address (ANONYMOUS only)..
More...
 
char * anonymous_token_orig
 Token for anonymous authentication, usually mail address (ANONYMOUS only). original value given at command line.
More...
 
const char * anonymous_token_help
 Token for anonymous authentication, usually mail address (ANONYMOUS only). help description.
More...
 
char * authentication_id_arg
 Identity of credential owner..
More...
 
char * authentication_id_orig
 Identity of credential owner. original value given at command line.
More...
 
const char * authentication_id_help
 Identity of credential owner. help description.
More...
 
char * authorization_id_arg
 Identity to request service for..
More...
 
char * authorization_id_orig
 Identity to request service for. original value given at command line.
More...
 
const char * authorization_id_help
 Identity to request service for. help description.
More...
 
char * password_arg
 Password for authentication (insecure for non-testing purposes)..
More...
 
char * password_orig
 Password for authentication (insecure for non-testing purposes). original value given at command line.
More...
 
const char * password_help
 Password for authentication (insecure for non-testing purposes). help description.
More...
 
char * realm_arg
 Realm. Defaults to hostname..
More...
 
char * realm_orig
 Realm. Defaults to hostname. original value given at command line.
More...
 
const char * realm_help
 Realm. Defaults to hostname. help description.
More...
 
char * passcode_arg
 Passcode for authentication (SECURID only)..
More...
 
char * passcode_orig
 Passcode for authentication (SECURID only). original value given at command line.
More...
 
const char * passcode_help
 Passcode for authentication (SECURID only). help description.
More...
 
char * service_arg
 Set the requested service name (should be a registered GSSAPI host based service name)..
More...
 
char * service_orig
 Set the requested service name (should be a registered GSSAPI host based service name). original value given at command line.
More...
 
const char * service_help
 Set the requested service name (should be a registered GSSAPI host based service name). help description.
More...
 
char * hostname_arg
 Set the name of the server with the requested service..
More...
 
char * hostname_orig
 Set the name of the server with the requested service. original value given at command line.
More...
 
const char * hostname_help
 Set the name of the server with the requested service. help description.
More...
 
char * service_name_arg
 Set the generic server name in case of a replicated server (DIGEST-MD5 only)..
More...
 
char * service_name_orig
 Set the generic server name in case of a replicated server (DIGEST-MD5 only). original value given at command line.
More...
 
const char * service_name_help
 Set the generic server name in case of a replicated server (DIGEST-MD5 only). help description.
More...
 
int enable_cram_md5_validate_flag
 Validate CRAM-MD5 challenge and response interactively. (default=off).
More...
 
const char * enable_cram_md5_validate_help
 Validate CRAM-MD5 challenge and response interactively. help description.
More...
 
int disable_cleartext_validate_flag
 Disable cleartext validate hook, forcing server to prompt for password. (default=off).
More...
 
const char * disable_cleartext_validate_help
 Disable cleartext validate hook, forcing server to prompt for password. help description.
More...
 
char * quality_of_protection_arg
 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'..
More...
 
char * quality_of_protection_orig
 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.
More...
 
const char * quality_of_protection_help
 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.
More...
 
int iteration_count_arg
 Indicate PBKDF2 hash iteration count (SCRAM only). (default='65536').
More...
 
char * iteration_count_orig
 Indicate PBKDF2 hash iteration count (SCRAM only). original value given at command line.
More...
 
const char * iteration_count_help
 Indicate PBKDF2 hash iteration count (SCRAM only). help description.
More...
 
char * salt_arg
 Indicate PBKDF2 salt as base64-encoded string (SCRAM only)..
More...
 
char * salt_orig
 Indicate PBKDF2 salt as base64-encoded string (SCRAM only). original value given at command line.
More...
 
const char * salt_help
 Indicate PBKDF2 salt as base64-encoded string (SCRAM only). help description.
More...
 
int starttls_flag
 Force use of STARTTLS. The default is to use STARTTLS when available. (default=off).
More...
 
const char * starttls_help
 Force use of STARTTLS. The default is to use STARTTLS when available. help description.
More...
 
int no_starttls_flag
 Unconditionally disable STARTTLS. (default=off).
More...
 
const char * no_starttls_help
 Unconditionally disable STARTTLS. help description.
More...
 
int no_cb_flag
 Don't use channel bindings from TLS. (default=off).
More...
 
const char * no_cb_help
 Don't use channel bindings from TLS. help description.
More...
 
char * x509_ca_file_arg
 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..
More...
 
char * x509_ca_file_orig
 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.
More...
 
const char * x509_ca_file_help
 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.
More...
 
char * x509_cert_file_arg
 File containing client X.509 certificate in PEM format. Used together with –x509-key-file to specify the certificate/key pair..
More...
 
char * x509_cert_file_orig
 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.
More...
 
const char * x509_cert_file_help
 File containing client X.509 certificate in PEM format. Used together with –x509-key-file to specify the certificate/key pair. help description.
More...
 
char * x509_key_file_arg
 Private key for the client X.509 certificate in PEM format. Used together with –x509-key-file to specify the certificate/key pair..
More...
 
char * x509_key_file_orig
 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.
More...
 
const char * x509_key_file_help
 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.
More...
 
char * priority_arg
 Cipher priority string..
More...
 
char * priority_orig
 Cipher priority string. original value given at command line.
More...
 
const char * priority_help
 Cipher priority string. help description.
More...
 
int verbose_flag
 Produce verbose output. (default=off).
More...
 
const char * verbose_help
 Produce verbose output. help description.
More...
 
int quiet_flag
 Don't produce any diagnostic output. (default=off).
More...
 
const char * quiet_help
 Don't produce any diagnostic output. help description.
More...
 
unsigned int help_given
 Whether help was given.
More...
 
unsigned int version_given
 Whether version was given.
More...
 
unsigned int client_given
 Whether client was given.
More...
 
unsigned int server_given
 Whether server was given.
More...
 
unsigned int client_mechanisms_given
 Whether client-mechanisms was given.
More...
 
unsigned int server_mechanisms_given
 Whether server-mechanisms was given.
More...
 
unsigned int mkpasswd_given
 Whether mkpasswd was given.
More...
 
unsigned int connect_given
 Whether connect was given.
More...
 
unsigned int application_data_given
 Whether application-data was given.
More...
 
unsigned int imap_given
 Whether imap was given.
More...
 
unsigned int smtp_given
 Whether smtp was given.
More...
 
unsigned int mechanism_given
 Whether mechanism was given.
More...
 
unsigned int no_client_first_given
 Whether no-client-first was given.
More...
 
unsigned int anonymous_token_given
 Whether anonymous-token was given.
More...
 
unsigned int authentication_id_given
 Whether authentication-id was given.
More...
 
unsigned int authorization_id_given
 Whether authorization-id was given.
More...
 
unsigned int password_given
 Whether password was given.
More...
 
unsigned int realm_given
 Whether realm was given.
More...
 
unsigned int passcode_given
 Whether passcode was given.
More...
 
unsigned int service_given
 Whether service was given.
More...
 
unsigned int hostname_given
 Whether hostname was given.
More...
 
unsigned int service_name_given
 Whether service-name was given.
More...
 
unsigned int enable_cram_md5_validate_given
 Whether enable-cram-md5-validate was given.
More...
 
unsigned int disable_cleartext_validate_given
 Whether disable-cleartext-validate was given.
More...
 
unsigned int quality_of_protection_given
 Whether quality-of-protection was given.
More...
 
unsigned int iteration_count_given
 Whether iteration-count was given.
More...
 
unsigned int salt_given
 Whether salt was given.
More...
 
unsigned int starttls_given
 Whether starttls was given.
More...
 
unsigned int no_starttls_given
 Whether no-starttls was given.
More...
 
unsigned int no_cb_given
 Whether no-cb was given.
More...
 
unsigned int x509_ca_file_given
 Whether x509-ca-file was given.
More...
 
unsigned int x509_cert_file_given
 Whether x509-cert-file was given.
More...
 
unsigned int x509_key_file_given
 Whether x509-key-file was given.
More...
 
unsigned int priority_given
 Whether priority was given.
More...
 
unsigned int verbose_given
 Whether verbose was given.
More...
 
unsigned int quiet_given
 Whether quiet was given.
More...
 
char ** inputs
 unamed options (options without names) More...
 
unsigned inputs_num
 unamed options number More...
 

Detailed Description

Where the command line options are stored.

Definition at line 42 of file gsasl_cmd.h.

Field Documentation

◆ anonymous_token_arg

char* gengetopt_args_info::anonymous_token_arg

Token for anonymous authentication, usually mail address (ANONYMOUS only)..

Definition at line 70 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), and cmdline_parser_release().

◆ anonymous_token_given

unsigned int gengetopt_args_info::anonymous_token_given

Whether anonymous-token was given.

Definition at line 146 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ anonymous_token_help

const char* gengetopt_args_info::anonymous_token_help

Token for anonymous authentication, usually mail address (ANONYMOUS only). help description.

Definition at line 72 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ anonymous_token_orig

char* gengetopt_args_info::anonymous_token_orig

Token for anonymous authentication, usually mail address (ANONYMOUS only). original value given at command line.

Definition at line 71 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ application_data_flag

int gengetopt_args_info::application_data_flag

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).

Definition at line 59 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and main().

◆ application_data_given

unsigned int gengetopt_args_info::application_data_given

Whether application-data was given.

Definition at line 141 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ application_data_help

const char* gengetopt_args_info::application_data_help

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.

Definition at line 60 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ authentication_id_arg

char* gengetopt_args_info::authentication_id_arg

Identity of credential owner..

Definition at line 73 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), and cmdline_parser_release().

◆ authentication_id_given

unsigned int gengetopt_args_info::authentication_id_given

Whether authentication-id was given.

Definition at line 147 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ authentication_id_help

const char* gengetopt_args_info::authentication_id_help

Identity of credential owner. help description.

Definition at line 75 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ authentication_id_orig

char* gengetopt_args_info::authentication_id_orig

Identity of credential owner. original value given at command line.

Definition at line 74 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ authorization_id_arg

char* gengetopt_args_info::authorization_id_arg

Identity to request service for..

Definition at line 76 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), and cmdline_parser_release().

◆ authorization_id_given

unsigned int gengetopt_args_info::authorization_id_given

Whether authorization-id was given.

Definition at line 148 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ authorization_id_help

const char* gengetopt_args_info::authorization_id_help

Identity to request service for. help description.

Definition at line 78 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ authorization_id_orig

char* gengetopt_args_info::authorization_id_orig

Identity to request service for. original value given at command line.

Definition at line 77 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ client_flag

int gengetopt_args_info::client_flag

Act as client. (default=on).

Definition at line 46 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and main().

◆ client_given

unsigned int gengetopt_args_info::client_given

Whether client was given.

Definition at line 135 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and main().

◆ client_help

const char* gengetopt_args_info::client_help

Act as client. help description.

Definition at line 47 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ client_mechanisms_flag

int gengetopt_args_info::client_mechanisms_flag

Write name of supported client mechanisms separated by space to stdout. (default=off).

Definition at line 50 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and main().

◆ client_mechanisms_given

unsigned int gengetopt_args_info::client_mechanisms_given

Whether client-mechanisms was given.

Definition at line 137 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ client_mechanisms_help

const char* gengetopt_args_info::client_mechanisms_help

Write name of supported client mechanisms separated by space to stdout. help description.

Definition at line 51 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ connect_arg

char* gengetopt_args_info::connect_arg

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..

Definition at line 56 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ connect_given

unsigned int gengetopt_args_info::connect_given

Whether connect was given.

Definition at line 140 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and main().

◆ connect_help

const char* gengetopt_args_info::connect_help

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.

Definition at line 58 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ connect_orig

char* gengetopt_args_info::connect_orig

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.

Definition at line 57 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ disable_cleartext_validate_flag

int gengetopt_args_info::disable_cleartext_validate_flag

Disable cleartext validate hook, forcing server to prompt for password. (default=off).

Definition at line 99 of file gsasl_cmd.h.

Referenced by clear_args(), and cmdline_parser_internal().

◆ disable_cleartext_validate_given

unsigned int gengetopt_args_info::disable_cleartext_validate_given

Whether disable-cleartext-validate was given.

Definition at line 156 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ disable_cleartext_validate_help

const char* gengetopt_args_info::disable_cleartext_validate_help

Disable cleartext validate hook, forcing server to prompt for password. help description.

Definition at line 100 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ enable_cram_md5_validate_flag

int gengetopt_args_info::enable_cram_md5_validate_flag

Validate CRAM-MD5 challenge and response interactively. (default=off).

Definition at line 97 of file gsasl_cmd.h.

Referenced by clear_args(), and cmdline_parser_internal().

◆ enable_cram_md5_validate_given

unsigned int gengetopt_args_info::enable_cram_md5_validate_given

Whether enable-cram-md5-validate was given.

Definition at line 155 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ enable_cram_md5_validate_help

const char* gengetopt_args_info::enable_cram_md5_validate_help

Validate CRAM-MD5 challenge and response interactively. help description.

Definition at line 98 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ help_given

unsigned int gengetopt_args_info::help_given

Whether help was given.

Definition at line 133 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and main().

◆ help_help

const char* gengetopt_args_info::help_help

Print help and exit help description.

Definition at line 44 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ hostname_arg

char* gengetopt_args_info::hostname_arg

Set the name of the server with the requested service..

Definition at line 91 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ hostname_given

unsigned int gengetopt_args_info::hostname_given

Whether hostname was given.

Definition at line 153 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ hostname_help

const char* gengetopt_args_info::hostname_help

Set the name of the server with the requested service. help description.

Definition at line 93 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ hostname_orig

char* gengetopt_args_info::hostname_orig

Set the name of the server with the requested service. original value given at command line.

Definition at line 92 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ imap_flag

int gengetopt_args_info::imap_flag

Use a IMAP-like logon procedure (client only). Also sets the –service default to 'imap'. (default=off).

Definition at line 61 of file gsasl_cmd.h.

Referenced by authenticate(), clear_args(), cmdline_parser_internal(), greeting(), logout(), main(), select_mechanism(), step_recv(), and step_send().

◆ imap_given

unsigned int gengetopt_args_info::imap_given

Whether imap was given.

Definition at line 142 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ imap_help

const char* gengetopt_args_info::imap_help

Use a IMAP-like logon procedure (client only). Also sets the –service default to 'imap'. help description.

Definition at line 62 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ inputs

char** gengetopt_args_info::inputs

unamed options (options without names)

Definition at line 170 of file gsasl_cmd.h.

Referenced by cmdline_parser_init(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ inputs_num

unsigned gengetopt_args_info::inputs_num

unamed options number

Definition at line 171 of file gsasl_cmd.h.

Referenced by cmdline_parser_init(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ iteration_count_arg

int gengetopt_args_info::iteration_count_arg

Indicate PBKDF2 hash iteration count (SCRAM only). (default='65536').

Definition at line 104 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and mkpasswd().

◆ iteration_count_given

unsigned int gengetopt_args_info::iteration_count_given

Whether iteration-count was given.

Definition at line 158 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ iteration_count_help

const char* gengetopt_args_info::iteration_count_help

Indicate PBKDF2 hash iteration count (SCRAM only). help description.

Definition at line 106 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ iteration_count_orig

char* gengetopt_args_info::iteration_count_orig

Indicate PBKDF2 hash iteration count (SCRAM only). original value given at command line.

Definition at line 105 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ mechanism_arg

char* gengetopt_args_info::mechanism_arg

Mechanism to use..

Definition at line 65 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), cmdline_parser_release(), main(), mkpasswd(), and select_mechanism().

◆ mechanism_given

unsigned int gengetopt_args_info::mechanism_given

Whether mechanism was given.

Definition at line 144 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ mechanism_help

const char* gengetopt_args_info::mechanism_help

Mechanism to use. help description.

Definition at line 67 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ mechanism_orig

char* gengetopt_args_info::mechanism_orig

Mechanism to use. original value given at command line.

Definition at line 66 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ mkpasswd_flag

int gengetopt_args_info::mkpasswd_flag

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).

Definition at line 54 of file gsasl_cmd.h.

Referenced by clear_args(), and cmdline_parser_internal().

◆ mkpasswd_given

unsigned int gengetopt_args_info::mkpasswd_given

Whether mkpasswd was given.

Definition at line 139 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and main().

◆ mkpasswd_help

const char* gengetopt_args_info::mkpasswd_help

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.

Definition at line 55 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ no_cb_flag

int gengetopt_args_info::no_cb_flag

Don't use channel bindings from TLS. (default=off).

Definition at line 114 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), and main().

◆ no_cb_given

unsigned int gengetopt_args_info::no_cb_given

Whether no-cb was given.

Definition at line 162 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ no_cb_help

const char* gengetopt_args_info::no_cb_help

Don't use channel bindings from TLS. help description.

Definition at line 115 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ no_client_first_flag

int gengetopt_args_info::no_client_first_flag

Disallow client to send data first (client only). (default=off).

Definition at line 68 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and main().

◆ no_client_first_given

unsigned int gengetopt_args_info::no_client_first_given

Whether no-client-first was given.

Definition at line 145 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ no_client_first_help

const char* gengetopt_args_info::no_client_first_help

Disallow client to send data first (client only). help description.

Definition at line 69 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ no_starttls_flag

int gengetopt_args_info::no_starttls_flag

Unconditionally disable STARTTLS. (default=off).

Definition at line 112 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and main().

◆ no_starttls_given

unsigned int gengetopt_args_info::no_starttls_given

Whether no-starttls was given.

Definition at line 161 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ no_starttls_help

const char* gengetopt_args_info::no_starttls_help

Unconditionally disable STARTTLS. help description.

Definition at line 113 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ passcode_arg

char* gengetopt_args_info::passcode_arg

Passcode for authentication (SECURID only)..

Definition at line 85 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), and cmdline_parser_release().

◆ passcode_given

unsigned int gengetopt_args_info::passcode_given

Whether passcode was given.

Definition at line 151 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ passcode_help

const char* gengetopt_args_info::passcode_help

Passcode for authentication (SECURID only). help description.

Definition at line 87 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ passcode_orig

char* gengetopt_args_info::passcode_orig

Passcode for authentication (SECURID only). original value given at command line.

Definition at line 86 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ password_arg

char* gengetopt_args_info::password_arg

Password for authentication (insecure for non-testing purposes)..

Definition at line 79 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and mkpasswd().

◆ password_given

unsigned int gengetopt_args_info::password_given

Whether password was given.

Definition at line 149 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ password_help

const char* gengetopt_args_info::password_help

Password for authentication (insecure for non-testing purposes). help description.

Definition at line 81 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ password_orig

char* gengetopt_args_info::password_orig

Password for authentication (insecure for non-testing purposes). original value given at command line.

Definition at line 80 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ priority_arg

char* gengetopt_args_info::priority_arg

Cipher priority string..

Definition at line 125 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ priority_given

unsigned int gengetopt_args_info::priority_given

Whether priority was given.

Definition at line 166 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ priority_help

const char* gengetopt_args_info::priority_help

Cipher priority string. help description.

Definition at line 127 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ priority_orig

char* gengetopt_args_info::priority_orig

Cipher priority string. original value given at command line.

Definition at line 126 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ quality_of_protection_arg

char* gengetopt_args_info::quality_of_protection_arg

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'..

Definition at line 101 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), and cmdline_parser_release().

◆ quality_of_protection_given

unsigned int gengetopt_args_info::quality_of_protection_given

Whether quality-of-protection was given.

Definition at line 157 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ quality_of_protection_help

const char* gengetopt_args_info::quality_of_protection_help

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.

Definition at line 103 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ quality_of_protection_orig

char* gengetopt_args_info::quality_of_protection_orig

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.

Definition at line 102 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ quiet_flag

int gengetopt_args_info::quiet_flag

Don't produce any diagnostic output. (default=off).

Definition at line 130 of file gsasl_cmd.h.

Referenced by clear_args(), and cmdline_parser_internal().

◆ quiet_given

unsigned int gengetopt_args_info::quiet_given

◆ quiet_help

const char* gengetopt_args_info::quiet_help

Don't produce any diagnostic output. help description.

Definition at line 131 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ realm_arg

char* gengetopt_args_info::realm_arg

Realm. Defaults to hostname..

Definition at line 82 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), and cmdline_parser_release().

◆ realm_given

unsigned int gengetopt_args_info::realm_given

Whether realm was given.

Definition at line 150 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ realm_help

const char* gengetopt_args_info::realm_help

Realm. Defaults to hostname. help description.

Definition at line 84 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ realm_orig

char* gengetopt_args_info::realm_orig

Realm. Defaults to hostname. original value given at command line.

Definition at line 83 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ salt_arg

char* gengetopt_args_info::salt_arg

Indicate PBKDF2 salt as base64-encoded string (SCRAM only)..

Definition at line 107 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and mkpasswd().

◆ salt_given

unsigned int gengetopt_args_info::salt_given

Whether salt was given.

Definition at line 159 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and mkpasswd().

◆ salt_help

const char* gengetopt_args_info::salt_help

Indicate PBKDF2 salt as base64-encoded string (SCRAM only). help description.

Definition at line 109 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ salt_orig

char* gengetopt_args_info::salt_orig

Indicate PBKDF2 salt as base64-encoded string (SCRAM only). original value given at command line.

Definition at line 108 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ server_flag

◆ server_given

unsigned int gengetopt_args_info::server_given

Whether server was given.

Definition at line 136 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and main().

◆ server_help

const char* gengetopt_args_info::server_help

Act as server. help description.

Definition at line 49 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ server_mechanisms_flag

int gengetopt_args_info::server_mechanisms_flag

Write name of supported server mechanisms separated by space to stdout. (default=off).

Definition at line 52 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and main().

◆ server_mechanisms_given

unsigned int gengetopt_args_info::server_mechanisms_given

Whether server-mechanisms was given.

Definition at line 138 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ server_mechanisms_help

const char* gengetopt_args_info::server_mechanisms_help

Write name of supported server mechanisms separated by space to stdout. help description.

Definition at line 53 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ service_arg

char* gengetopt_args_info::service_arg

Set the requested service name (should be a registered GSSAPI host based service name)..

Definition at line 88 of file gsasl_cmd.h.

Referenced by callback(), clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ service_given

unsigned int gengetopt_args_info::service_given

Whether service was given.

Definition at line 152 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and main().

◆ service_help

const char* gengetopt_args_info::service_help

Set the requested service name (should be a registered GSSAPI host based service name). help description.

Definition at line 90 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ service_name_arg

char* gengetopt_args_info::service_name_arg

Set the generic server name in case of a replicated server (DIGEST-MD5 only)..

Definition at line 94 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and cmdline_parser_release().

◆ service_name_given

unsigned int gengetopt_args_info::service_name_given

Whether service-name was given.

Definition at line 154 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ service_name_help

const char* gengetopt_args_info::service_name_help

Set the generic server name in case of a replicated server (DIGEST-MD5 only). help description.

Definition at line 96 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ service_name_orig

char* gengetopt_args_info::service_name_orig

Set the generic server name in case of a replicated server (DIGEST-MD5 only). original value given at command line.

Definition at line 95 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ service_orig

char* gengetopt_args_info::service_orig

Set the requested service name (should be a registered GSSAPI host based service name). original value given at command line.

Definition at line 89 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ smtp_flag

int gengetopt_args_info::smtp_flag

Use a SMTP-like logon procedure (client only). Also sets the –service default to 'smtp'. (default=off).

Definition at line 63 of file gsasl_cmd.h.

Referenced by authenticate(), clear_args(), cmdline_parser_internal(), greeting(), logout(), main(), select_mechanism(), step_recv(), and step_send().

◆ smtp_given

unsigned int gengetopt_args_info::smtp_given

Whether smtp was given.

Definition at line 143 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ smtp_help

const char* gengetopt_args_info::smtp_help

Use a SMTP-like logon procedure (client only). Also sets the –service default to 'smtp'. help description.

Definition at line 64 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ starttls_flag

int gengetopt_args_info::starttls_flag

Force use of STARTTLS. The default is to use STARTTLS when available. (default=off).

Definition at line 110 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), and main().

◆ starttls_given

unsigned int gengetopt_args_info::starttls_given

Whether starttls was given.

Definition at line 160 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ starttls_help

const char* gengetopt_args_info::starttls_help

Force use of STARTTLS. The default is to use STARTTLS when available. help description.

Definition at line 111 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ verbose_flag

int gengetopt_args_info::verbose_flag

Produce verbose output. (default=off).

Definition at line 128 of file gsasl_cmd.h.

Referenced by clear_args(), and cmdline_parser_internal().

◆ verbose_given

unsigned int gengetopt_args_info::verbose_given

Whether verbose was given.

Definition at line 167 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), main(), and mkpasswd().

◆ verbose_help

const char* gengetopt_args_info::verbose_help

Produce verbose output. help description.

Definition at line 129 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ version_given

unsigned int gengetopt_args_info::version_given

Whether version was given.

Definition at line 134 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), cmdline_parser_internal(), and main().

◆ version_help

const char* gengetopt_args_info::version_help

Print version and exit help description.

Definition at line 45 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ x509_ca_file_arg

char* gengetopt_args_info::x509_ca_file_arg

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..

Definition at line 116 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ x509_ca_file_given

unsigned int gengetopt_args_info::x509_ca_file_given

Whether x509-ca-file was given.

Definition at line 163 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ x509_ca_file_help

const char* gengetopt_args_info::x509_ca_file_help

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.

Definition at line 118 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ x509_ca_file_orig

char* gengetopt_args_info::x509_ca_file_orig

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.

Definition at line 117 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ x509_cert_file_arg

char* gengetopt_args_info::x509_cert_file_arg

File containing client X.509 certificate in PEM format. Used together with –x509-key-file to specify the certificate/key pair..

Definition at line 119 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ x509_cert_file_given

unsigned int gengetopt_args_info::x509_cert_file_given

Whether x509-cert-file was given.

Definition at line 164 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ x509_cert_file_help

const char* gengetopt_args_info::x509_cert_file_help

File containing client X.509 certificate in PEM format. Used together with –x509-key-file to specify the certificate/key pair. help description.

Definition at line 121 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ x509_cert_file_orig

char* gengetopt_args_info::x509_cert_file_orig

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.

Definition at line 120 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().

◆ x509_key_file_arg

char* gengetopt_args_info::x509_key_file_arg

Private key for the client X.509 certificate in PEM format. Used together with –x509-key-file to specify the certificate/key pair..

Definition at line 122 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_internal(), cmdline_parser_release(), and main().

◆ x509_key_file_given

unsigned int gengetopt_args_info::x509_key_file_given

Whether x509-key-file was given.

Definition at line 165 of file gsasl_cmd.h.

Referenced by clear_given(), cmdline_parser_dump(), and cmdline_parser_internal().

◆ x509_key_file_help

const char* gengetopt_args_info::x509_key_file_help

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.

Definition at line 124 of file gsasl_cmd.h.

Referenced by init_args_info().

◆ x509_key_file_orig

char* gengetopt_args_info::x509_key_file_orig

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.

Definition at line 123 of file gsasl_cmd.h.

Referenced by clear_args(), cmdline_parser_dump(), cmdline_parser_internal(), and cmdline_parser_release().


The documentation for this struct was generated from the following file: