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