git.sur5r.net Git - openldap/blob - doc/man/man8/slapauth.8

   1 .TH SLAPAUTH 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2006 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .SH NAME
   5 slapauth \- Check a list of string-represented IDs for authc/authz.
   6 .SH SYNOPSIS
   7 .B SBINDIR/slapauth
   8 .B [\-d level]
   9 .B [\-f slapd.conf]
  10 .B [\-F confdir]
  11 .B [\-M mech]
  12 .B [\-o name[=value]
  13 .B [\-R realm]
  14 .B [\-U authcID]
  15 .B [\-v]
  16 .B [\-X authzID]
  17 .B ID [...]
  18 .LP
  19 .SH DESCRIPTION
  20 .LP
  21 .B Slapauth
  22 is used to check the behavior of the slapd in mapping identities
  23 for authentication and authorization purposes, as specified in
  24 .BR slapd.conf (5).
  25 It opens the
  26 .BR slapd.conf (5)
  27 configuration file, reads in the
  28 .B authz-policy
  29 and
  30 .B authz-regexp
  31 directives, and then parses the
  32 .B ID
  33 list given on the command-line.
  34 .LP
  35 .SH OPTIONS
  36 .TP
  37 .BI \-d " level"
  38 enable debugging messages as defined by the specified
  39 .IR level .
  40 .TP
  41 .BI \-f " slapd.conf"
  42 specify an alternative
  43 .BR slapd.conf (5)
  44 file.
  45 .TP
  46 .BI \-F " confdir"
  47 specify a config directory.
  48 If both
  49 .B -f
  50 and
  51 .B -F
  52 are specified, the config file will be read and converted to
  53 config directory format and written to the specified directory.
  54 If neither option is specified, an attempt to read the
  55 default config directory will be made before trying to use the default
  56 config file. If a valid config directory exists then the
  57 default config file is ignored.
  58 .TP
  59 .BI \-M " mech"
  60 specify a mechanism.
  61 .TP
  62 .BI \-o " option[=value]"
  63 Specify an
  64 .BR option
  65 with a(n optional)
  66 .BR value .
  67 Possible generic options/values are:
  68 .LP
  69 .nf
  70               syslog=<subsystems>  (see `\-s' in slapd(8))
  71               syslog-level=<level> (see `\-S' in slapd(8))
  72               syslog-user=<user>   (see `\-l' in slapd(8))
  73
  74 .fi
  75 .TP
  76 .BI \-R " realm"
  77 specify a realm.
  78 .TP
  79 .BI \-U " authcID"
  80 specify an ID to be used as
  81 .I authcID
  82 throughout the test session.
  83 If present, and if no
  84 .B authzID
  85 is given, the IDs in the ID list are treated as
  86 .BR authzID .
  87 .TP
  88 .BI \-X " authzID"
  89 specify an ID to be used as
  90 .I authzID
  91 throughout the test session.
  92 If present, and if no
  93 .B authcID
  94 is given, the IDs in the ID list are treated as
  95 .BR authcID .
  96 If both
  97 .I authcID
  98 and
  99 .I authzID
 100 are given via command line switch, the ID list cannot be present.
 101 .TP
 102 .B \-v
 103 enable verbose mode.
 104 .SH EXAMPLES
 105 The command
 106 .LP
 107 .nf
 108 .ft tt
 109         SBINDIR/slapauth -f /ETCDIR/slapd.conf -v \\
 110             -U bjorn -X u:bjensen
 111
 112 .ft
 113 .fi
 114 tests whether the user
 115 .I bjorn
 116 can assume the identity of the user
 117 .I bjensen
 118 provided the directives
 119 .LP
 120 .nf
 121 .ft tt
 122         authz-policy from
 123         authz-regexp "^uid=([^,]+).*,cn=auth$"
 124                 "ldap:///dc=example,dc=net??sub?uid=$1"
 125
 126 .ft
 127 .fi
 128 are defined in
 129 .BR slapd.conf (5).
 130 .SH "SEE ALSO"
 131 .BR ldap (3),
 132 .BR slapd (8)
 133 .BR slaptest (8)
 134 .LP
 135 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 136 .SH ACKNOWLEDGEMENTS
 137 .so ../Project