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

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