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

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