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