src/gsasl.ggo

   1 # Copyright (C) 2002, 2003, 2004, 2005, 2007 Simon Josefsson.
   2 #
   3 # This file is part of GNU SASL.
   4 #
   5 # This program is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 purpose "Authenticate user to a server using Simple Authentication and
  19 Security Layer.  Currently IMAP and SMTP servers are supported.  This
  20 is a command line interface for the GNU SASL library."
  21
  22 section "Commands"
  23 option "client" c "Act as client." flag on
  24 option "server" s "Act as server." flag off
  25 option "client-mechanisms" - "Write name of supported client mechanisms separated by space to stdout." flag off
  26 option "server-mechanisms" - "Write name of supported server mechanisms separated by space to stdout." flag off
  27
  28 section "Network options"
  29 option "connect" - "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." string typestr="HOST[:PORT]" no
  30
  31 section "Generic options"
  32 option "application-data" d "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." flag on
  33 option "imap" - "Use a IMAP-like logon procedure (client only). Also sets the --service default to 'imap'." flag off
  34 option "smtp" - "Use a SMTP-like logon procedure (client only). Also sets the --service default to 'smtp'." flag off
  35 option "mechanism" m "Mechanism to use." string no
  36 option "no-client-first" - "Disallow client to send data first (client only)." flag off
  37
  38 section "SASL mechanism options (they are prompted for when required)"
  39 option "anonymous-token" n "Token for anonymous authentication, usually mail address (ANONYMOUS only)." string no
  40 option "authentication-id" a "Identity of credential owner." string no
  41 option "authorization-id" z "Identity to request service for." string no
  42 option "password" p "Password for authentication (insecure for non-testing purposes)." string no
  43 option "realm" r "Realm. Defaults to hostname." string no
  44 option "maxbuf" x "Indicate maximum buffer size (DIGEST-MD5 only)." int typestr="NUMBER" no
  45 option "passcode" - "Passcode for authentication (SECURID only)." string typestr="NUMBER" no
  46 option "service" - "Set the requested service name (should be a registered GSSAPI host based service name)." string no
  47 option "hostname" - "Set the name of the server with the requested service." string no
  48 option "service-name" - "Set the generic server name in case of a replicated server (DIGEST-MD5 only)." string no
  49 option "enable-cram-md5-validate" - "Validate CRAM-MD5 challenge and response interactively." flag off
  50 option "disable-cleartext-validate" - "Disable cleartext validate hook, forcing server to prompt for password." flag off
  51 option "quality-of-protection" - "How application payload will be protected. 'auth' means no protection, 'auth-int' means integrity protection, 'auth-conf' means integrity and confidentialiy protection.  Currently only used by DIGEST-MD5, where the default is 'auth-conf'." string typestr="TYPE" no
  52
  53 section "STARTTLS options"
  54 option "starttls" - "Force use of STARTTLS.  The default is to use STARTTLS when available." flag off
  55 option "no-starttls" - "Unconditionally disable STARTTLS." flag off
  56 option "x509-ca-file" - "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, no verification of the remote server certificate will be done." string typestr="FILE" no
  57 option "x509-cert-file" - "File containing client X.509 certificate in PEM format.  Used together with --x509-key-file to specify the certificate/key pair." string typestr="FILE" no
  58 option "x509-key-file" - "Private key for the client X.509 certificate in PEM format.  Used together with --x509-key-file to specify the certificate/key pair." string typestr="FILE" no
  59
  60 section "Other options"
  61 option "verbose" - "Produce verbose output." flag off
  62 option "quiet" - "Don't produce any diagnostic output." flag off