# ldapvc

## NAME



           ldapvc - LDAP verify credentials tool
    


## SYNOPSIS



           **ldapvc**[**-V**[**V**]] [**-d** _debuglevel_] [**-a**] [**-b**] [**-n**] [**-v**] [**-x**]
           [**-D** _binddn_] [**-W**] [**-w** _passwd_] [**-y** _passwdfile_] [**-H** _ldapuri_]
           [**-e**[**!**]_ext_[**=**_extparam_]] [**-E**[**!**]_ext_[**=**_extparam_]] [**-o** _opt_[=_optparam_]]
           [**-O** _security-properties_] [**-I**] [**-Q**] [**-N**] [**-U** _authcid_] [**-R** _realm_]
           [**-X** _authzid_] [**-Y** _mech_] [**-Z**[**Z**]] _Distinguished Name [Credentials]_
    


## DESCRIPTION



           _ldapvc_ implements the LDAP "Verify Credentials" extended
           operation.
    
           **Verify Credentials** operation behaves like LDAP Bind but has no
           impact upon the underlying LDAP session.
    


## OPTIONS



           **-V**[**V**]  Print version info.  If **-VV** is given, only the version
                  information is printed.
    
           **-d** _debuglevel_
                  Set the LDAP debugging level to _debuglevel_.  **ldapvc** must be
                  compiled with LDAP_DEBUG defined for this option to have
                  any effect.
    
           **-a** Print the authzID resulting from a successful verification
                  of credentials.
    
           **-b** Print the results from the ppolicy control after
                  verification of credentials.
    
           **-n** Show what would be done, but don't actually perform the
                  operation.  Useful for debugging in conjunction with **-v**.
    
           **-v** Run in verbose mode, with many diagnostics written to
                  standard output.
    
           **-x** Use simple authentication instead of SASL.
    
           **-D** _binddn_
                  Use the Distinguished Name _binddn_ to bind to the LDAP
                  directory.  For SASL binds, the server is expected to
                  ignore this value.
    
           **-W** Prompt for simple authentication.  This is used instead of
                  specifying the password on the command line.
    
           **-w** _passwd_
                  Use _passwd_ as the password for simple authentication.
    
           **-y** _passwdfile_
                  Use complete contents of _passwdfile_ as the password for
                  simple authentication.
    
           **-H** _ldapuri_
                  Specify URI(s) referring to the ldap server(s); only the
                  protocol/host/port fields are allowed; a list of URI,
                  separated by whitespace or commas is expected.
    
           **-e**[**!**]_ext_[**=**_extparam_]
    
           **-E**[**!**]_ext_[**=**_extparam_]
    
                  Specify general extensions with **-e** and Verify Credentials
                  extensions with **-E**.  ´**!** ´ indicates criticality.
    
                  General extensions:
                    [!]assert=<filter>    (an RFC 4515 Filter)
                    [!]bauthzid           (RFC 3829 authzid control)
                    [!]chaining[=<resolve>[/<cont>]]
                    [!]manageDSAit
                    [!]noop
                    ppolicy
                    [!]postread[=<attrs>] (a comma-separated attribute list)
                    [!]preread[=<attrs>]  (a comma-separated attribute list)
                    [!]relax
                    sessiontracking[=<username>]
                    abandon,cancel,ignore (SIGINT sends abandon/cancel,
                    or ignores response; if critical, doesn't wait for SIGINT.
                    not really controls)
    
                  Verify Credentials extensions:
    
                  The following options set SASL params on the Verify
                  Credentials request:
                    authcid=<authcid>    (SASL Authentication Identity "dn:<dn>" or "u:<user>")
                    authzid=<authzid>    (SASL Authorization Identity "dn:<dn>" or "u:<user>")
                    mech=<mech>          (SASL mechanism default e.g. Simple)
                    realm=<realm>        (SASL Realm, defaults to none)
                    sasl=a[utomatic]|i[nteractive]|q[uiet]  (SASL mode defaults to automatic if any other -E option provided, otherwise none)
                    secprops=<secprops>  (SASL Security Properties)
    
           **-o** _opt_[=_optparam_]
    
                  Specify any ldap.conf(5) option or one of the following:
                    nettimeout=<timeout>  (in seconds, or "none" or "max")
                    ldif_wrap=<width>     (in columns, or "no" for no wrapping)
    
                  **-o** option that can be passed here, check ldap.conf(5) for
                  details.
    
           **-O** _security-properties_
                  Specify SASL security properties.
    
           **-I** Enable SASL Interactive mode.  Always prompt.  Default is
                  to prompt only as needed.
    
           **-Q** Enable SASL Quiet mode.  Never prompt.
    
           **-N** Do not use reverse DNS to canonicalize SASL host name.
    
           **-U** _authcid_
                  Specify the authentication ID for SASL bind. The form of
                  the ID depends on the actual SASL mechanism used.
    
           **-R** _realm_
                  Specify the realm of authentication ID for SASL bind. The
                  form of the realm depends on the actual SASL mechanism
                  used.
    
           **-X** _authzid_
                  Specify the requested authorization ID for SASL bind.
                  _authzid_ must be one of the following formats:
                  **dn:**_< distinguished name>_ or **u:**_< username>_
    
           **-Y** _mech_
                  Specify the SASL mechanism to be used for authentication.
                  If it's not specified, the program will choose the best
                  mechanism the server knows.
    
           **-Z**[**Z**]  Issue StartTLS (Transport Layer Security) extended
                  operation. If you use **-ZZ** , the command will require the
                  operation to be successful.
    


## EXAMPLE



               ldapvc -x "uid=Alice,ou=People,dc=example,dc=com"
    


## ACKNOWLEDGEMENTS



           **OpenLDAP Software** is developed and maintained by The OpenLDAP
           Project <http://www.openldap.org/>.  **OpenLDAP Software** is derived
           from the University of Michigan LDAP 3.3 Release.
    


* * *