utils/pluginviewer.8

   1 .\" pluginviewer.8 -- pluginviewer man page
   2 .\" Alexey Melnikov
   3 .\"
   4
   5 .\" Copyright (c) 2006 Carnegie Mellon University.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. The name ""Carnegie Mellon University"" must not be used to
  20 .\"    endorse or promote products derived from this software without
  21 .\"    prior written permission. For permission or any other legal
  22 .\"    details, please contact
  23 .\"      Office of Technology Transfer
  24 .\"      Carnegie Mellon University
  25 .\"      5000 Forbes Avenue
  26 .\"      Pittsburgh, PA  15213-3890
  27 .\"      (412) 268-4387, fax: (412) 268-7395
  28 .\"      tech-transfer@andrew.cmu.edu
  29 .\"
  30 .\" 4. Redistributions of any form whatsoever must retain the following
  31 .\"    acknowledgment:
  32 .\"    ""This product includes software developed by Computing Services
  33 .\"     at Carnegie Mellon University (http://www.cmu.edu/computing/).""
  34 .\"
  35 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  36 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  37 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  38 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  39 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  40 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  41 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  42
  43 .\"
  44 .TH PLUGINVIEWER 8 "Apr 10, 2006" "CMU SASL"
  45 .SH NAME
  46 pluginviewer \- list loadable SASL plugins and their properties
  47 .SH SYNOPSIS
  48 .B pluginviewer
  49 .RB [ -a ]
  50 .RB [ -s ]
  51 .RB [ -c ]
  52 .RB [ -b\ min=N,max=N ]
  53 .RB [ -e\ ssf=N,id=ID ]
  54 .RB [ -m\ MECHS ]
  55 .RB [ -x\ AUXPROP_MECH ]
  56 .RB [ -f\ FLAGS ]
  57 .RB [ -p\ PATH ]
  58 .SH DESCRIPTION
  59 .I pluginviewer
  60 can be used by a server administrator to troubleshoot SASL installations.
  61 The utility can list loadable (properly configured) client and server
  62 side plugins, as well as auxprop plugins.
  63 .
  64 .SH OPTIONS
  65 .TP
  66 .B -a
  67 List auxprop plugins.
  68 .TP
  69 .B -s
  70 List server authentication (SASL) plugins.
  71 .TP
  72 .B -c
  73 List client authentication (SASL) plugins.
  74 .TP
  75 .B -b min=N1,max=N2
  76 List client authentication (SASL) plugins.
  77 Strength of the SASL security layer in bits. min=N1 specifies the minumum strength
  78 to use (1 => integrity protection). max=N2 specifies the maximum strength to use.
  79 Only SASL mechanisms which support security layer with strength M such that N1 <= M <= N2
  80 will be shown.
  81 .TP
  82 .B -e ssf=N,id=ID
  83 Assume that an external security layer (e.g. TLS) with N-bit strength is installed.
  84 The ID is the authentication identity used by the external security layer.
  85 .TP
  86 .B -m MECHS
  87 Limit listed SASL plugins to the ones included in the MECHS (space separated) list.
  88 .TP
  89 .B -x AUXPROP_MECHS
  90 Limit listed auxprop plugins to the one listed in the AUXPROP_MECHS (space separated) list.
  91 .TP
  92 .B -f FLAGS
  93 Set security flags. FLAGS is a comma separated list of one or more of the following security flags:
  94 noplain (SASL mechanism doesn\'t send password in the clear during authentication),
  95 noactive (require protection from active attacks), nodict (require mechanisms which are
  96 secure against passive dictionary attacks), forwardsec (require forward secrecy),
  97 passcred (require mechanisms that can delegate client credentials),
  98 maximum (require all security flags).
  99 .TP
 100 .B -p PATH
 101 Specifies a colon-separated search path for plugins.
 102 .SH SEE ALSO
 103 .TP
 104 rfc2222 \- Simple Authentication and Security Layer (SASL)