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

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