src/shisa.ggo

   1 ## Process this file with gengetopt to produce shisa_cmd.*
   2 # Copyright (C) 2002, 2003, 2004, 2005, 2007 Simon Josefsson.
   3 #
   4 # This file is part of Shishi.
   5 #
   6 # Shishi is free software; you can redistribute it and/or modify it
   7 # under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # Shishi is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with Shishi; if not, see http://www.gnu.org/licenses or write
  18 # to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  19 # Floor, Boston, MA 02110-1301, USA.
  20
  21 package "shisa"
  22
  23 purpose "Manipulate information stored in the Shisa user database."
  24
  25 section "Operations"
  26 option "add" a "Add realm or principal to database." no
  27 option "dump" d "Dump entries in database." no
  28 option "key-add" n "Add new key to a principal in database." no
  29 option "key-remove" - "Remove a key from a principal in database." no
  30 option "list" l "List entries in database." no
  31 option "modify" m "Modify principal entry in database." no
  32 option "remove" r "Remove realm or principal from database." no
  33
  34 section "Parameters"
  35 option "force" f "Allow removal of non-empty realms.\n" flag off
  36 option "enabled" - "Only dump or list enabled principals.\n" flag off
  37 option "disabled" - "Only dump or list disabled principals.\n" flag off
  38 option "keys" - "Print cryptographic key and password in hostkey format." flag off
  39
  40 section "Values"
  41 option "encryption-type" E "Override default key encryption type.  Valid values include 'aes128', 'aes256', 'aes' (same as 'aes256'), '3des', 'des-md5', 'des-md4', 'des-crc', 'des' (same as 'des-md5'), and 'arcfour'." string no
  42 option "key-version" - "Version of key." long typestr="NUMBER" no
  43 option "password" - "Derive key from this password." string no argoptional
  44 option "priority" - "Specify key priority, used to differentiate between keys when multiple keys are eligible for use.  Higher value means higher priority.  (default is 0, which mean a random key of the best etype is chosen)" long typestr="NUMBER" no
  45 option "random" - "Use a random key.  (default)" no
  46 option "salt" - "Use specified salt for deriving key.  Defaults to concatenation of realm and (unwrapped) principal name." string no
  47 option "string-to-key-parameter" - "Encryption algorithm specific parameter for password derivation.  Currently only the AES algorithm can utilize this, where it is interpreted as the iteration count of the PKCS#5 PBKDF2 key deriver." string typestr="HEX" no
  48
  49 section "Other options"
  50 option "configuration-file" c "Use specified configuration file." string typestr="FILE" no
  51 option "library-options" o "Parse string as configuration file statement." string typestr="STRING" no
  52
  53 option "verbose" v "Produce verbose output.\n" flag off
  54 option "quiet" q "Don't produce any diagnostic output.\n" flag off