git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_get_dn.3

   1 .TH LDAP_GET_DN 3 "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 ldap_get_dn, ldap_explode_dn, ldap_explode_rdn, ldap_dn2ufn, ldap_is_dns_dn, ldap_explode_dns \- LDAP DN handling routines
   4 .SH SYNOPSIS
   5 .nf
   6 .ft B
   7 #include <lber.h>
   8 #include <ldap.h>
   9 .LP
  10 .ft B
  11 char *ldap_get_dn(ld, entry)
  12 .ft
  13 LDAP *ld;
  14 LDAPMessage *entry;
  15 .LP
  16 .ft B
  17 char **ldap_explode_dn(dn, notypes)
  18 .ft
  19 char *dn;
  20 int notypes;
  21 .LP
  22 .ft B
  23 char **ldap_explode_rdn(rdn, notypes)
  24 .ft
  25 char *rdn;
  26 int notypes;
  27 .LP
  28 .ft B
  29 char *ldap_dn2ufn(dn)
  30 .ft
  31 char *dn;
  32 .LP
  33 .ft B
  34 int ldap_is_dns_dn(dn)
  35 .ft
  36 char *dn;
  37 .LP
  38 .ft B
  39 char **ldap_explode_dns(dn)
  40 .ft
  41 char *dn;
  42 .SH DESCRIPTION
  43 These routines allow LDAP entry names (Distinguished Names, or DNs)
  44 to be obtained, parsed, converted to a user-friendly form, and tested.
  45 A DN has the form described in RFC 1779 "A String Representation of
  46 Distinguished Names", unless it is an experimental DNS-style DN
  47 which takes the form of an RFC 822 mail address.
  48 .LP
  49 The
  50 .B ldap_get_dn()
  51 routine takes an \fIentry\fP as returned by
  52 .BR ldap_first_entry (3)
  53 or
  54 .BR ldap_next_entry (3)
  55 and returns a copy of
  56 the entry's DN.  Space for the DN will have been obtained via
  57 .BR malloc (3),
  58 and should be freed by the caller by a call to
  59 .BR free (3).
  60 .LP
  61 The
  62 .B ldap_explode_dn()
  63 routine takes a DN as returned by
  64 .B ldap_get_dn()
  65 and breaks it up into its component parts.  Each part is known as a
  66 Relative Distinguished Name, or RDN.
  67 .B ldap_explode_dn()
  68 returns a
  69 NULL-terminated array, each component of which contains an RDN from the
  70 DN.  The \fInotypes\fP parameter is used to request that only the RDN
  71 values be returned, not their types.  For example, the DN "cn=Bob,
  72 c=US" would return as either { "cn=Bob", "c=US", NULL } or { "Bob",
  73 "US", NULL }, depending on whether notypes was 0 or 1, respectively.
  74 The result can be freed by calling
  75 .BR ldap_value_free (3).
  76 .LP
  77 Similarly, the
  78 .B ldap_explode_rdn()
  79 routine takes an RDN as returned by
  80 .B ldap_explode_dn(dn,0)
  81 and breaks it up into its "type=value" component parts (or just "value",
  82 if the \fInotypes\fP parameter is set).  The result can be freed by
  83 calling
  84 .BR ldap_value_free (3).
  85 .LP
  86 .B ldap_dn2ufn()
  87 is used to turn a DN as returned by
  88 .B ldap_get_dn()
  89 into a more user-friendly form, stripping off type names.  See
  90 RFC 1781 "Using the Directory to Achieve User Friendly Naming"
  91 for more details on the UFN format.  The space for the UFN returned
  92 is obtained by a call to
  93 .BR malloc (3),
  94 and the user is responsible for freeing it via a call to
  95 .BR free (3).
  96 .LP
  97 .B ldap_is_dns_dn()
  98 returns non-zero if the dn string is an experimental
  99 DNS-style DN (generally in the form of an RFC 822 e-mail address).  It
 100 returns zero if the dn appears to be an RFC 1779 format DN.
 101 .LP
 102 .B ldap_explode_dns()
 103 takes a DNS-style DN and breaks it up into its
 104 component parts.
 105 .B ldap_explode_dns()
 106 returns a NULL-terminated array.
 107 For example, the DN "mcs.umich.edu" will return { "mcs", "umich", "edu",
 108 NULL }.  The result can be freed by calling
 109 .BR ldap_value_free (3).
 110 .SH ERRORS
 111 If an error occurs in
 112 .BR ldap_get_dn() ,
 113 NULL is returned and the
 114 .B ld_errno
 115 field in the \fIld\fP parameter is set to indicate the error.  See
 116 .BR ldap_error (3)
 117 for a description of possible error codes.
 118 .BR ldap_explode_dn() ,
 119 .BR ldap_explode_rdn() ,
 120 .B ldap_explode_dns()
 121 and
 122 .B ldap_dn2ufn()
 123 will return NULL with
 124 .BR errno (3)
 125 set appropriately in case of trouble.
 126 .SH NOTES
 127 These routines malloc memory that the caller must free.
 128 .SH SEE ALSO
 129 .BR ldap(3),
 130 .BR ldap_first_entry(3),
 131 .BR ldap_error(3),
 132 .BR ldap_value_free(3)
 133 .SH ACKNOWLEDGEMENTS
 134 .B      OpenLDAP
 135 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 136 .B      OpenLDAP
 137 is derived from University of Michigan LDAP 3.3 Release.