<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache Portable Runtime: apr_ldap_init.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>apr_ldap_init.h</h1> </div>
</div>
<div class="contents">
<a href="apr__ldap__init_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016 <span class="comment"></span>
<a name="l00017"></a>00017 <span class="comment">/**</span>
<a name="l00018"></a>00018 <span class="comment"> * @file apr_ldap_init.h</span>
<a name="l00019"></a>00019 <span class="comment"> * @brief APR-UTIL LDAP ldap_init() functions</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef APR_LDAP_INIT_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define APR_LDAP_INIT_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00024"></a>00024 <span class="comment">/**</span>
<a name="l00025"></a>00025 <span class="comment"> * @addtogroup APR_Util_LDAP</span>
<a name="l00026"></a>00026 <span class="comment"> * @{</span>
<a name="l00027"></a>00027 <span class="comment"> */</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="apr__ldap_8h.html" title="APR-UTIL LDAP.">apr_ldap.h</a>"</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#if APR_HAS_LDAP</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00035"></a>00035 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/**</span>
<a name="l00039"></a>00039 <span class="comment"> * Macro to detect security related return values.</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a>00041 <span class="preprocessor">#if defined(LDAP_INSUFFICIENT_ACCESS)</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_ACCESS</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#elif defined(LDAP_INSUFFICIENT_RIGHTS)</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#elif defined(APR_HAS_MICROSOFT_LDAPSDK)</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="comment">/* The macros above fail to contemplate that LDAP_RETCODE values</span>
<a name="l00047"></a>00047 <span class="comment"> * may be represented by an enum. autoconf tests would be much</span>
<a name="l00048"></a>00048 <span class="comment"> * more robust.</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a><a class="code" href="group___a_p_r___util___l_d_a_p.html#ga381609c46f026364996ee2bc88ccbc68">00050</a> <span class="preprocessor">#define APU_LDAP_INSUFFICIENT_ACCESS LDAP_INSUFFICIENT_RIGHTS</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">#error The security return codes must be added to support this LDAP toolkit.</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span>
<a name="l00055"></a>00055 <span class="preprocessor">#if defined(LDAP_SECURITY_ERROR)</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_SECURITY_ERROR LDAP_SECURITY_ERROR</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#define APU_LDAP_SECURITY_ERROR(n) \</span>
<a name="l00059"></a>00059 <span class="preprocessor"> (LDAP_INAPPROPRIATE_AUTH == n) ? 1 \</span>
<a name="l00060"></a>00060 <span class="preprocessor"> : (LDAP_INVALID_CREDENTIALS == n) ? 1 \</span>
<a name="l00061"></a>00061 <span class="preprocessor"> : (APU_LDAP_INSUFFICIENT_ACCESS == n) ? 1 \</span>
<a name="l00062"></a>00062 <span class="preprocessor"> : 0</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span>
<a name="l00065"></a>00065 <span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment">/**</span>
<a name="l00067"></a>00067 <span class="comment"> * APR LDAP SSL Initialise function</span>
<a name="l00068"></a>00068 <span class="comment"> *</span>
<a name="l00069"></a>00069 <span class="comment"> * This function initialises SSL on the underlying LDAP toolkit</span>
<a name="l00070"></a>00070 <span class="comment"> * if this is necessary.</span>
<a name="l00071"></a>00071 <span class="comment"> *</span>
<a name="l00072"></a>00072 <span class="comment"> * If a CA certificate is provided, this is set, however the setting</span>
<a name="l00073"></a>00073 <span class="comment"> * of certificates via this method has been deprecated and will be removed in</span>
<a name="l00074"></a>00074 <span class="comment"> * APR v2.0.</span>
<a name="l00075"></a>00075 <span class="comment"> *</span>
<a name="l00076"></a>00076 <span class="comment"> * The apr_ldap_set_option() function with the APR_LDAP_OPT_TLS_CERT option</span>
<a name="l00077"></a>00077 <span class="comment"> * should be used instead to set certificates.</span>
<a name="l00078"></a>00078 <span class="comment"> *</span>
<a name="l00079"></a>00079 <span class="comment"> * If SSL support is not available on this platform, or a problem</span>
<a name="l00080"></a>00080 <span class="comment"> * was encountered while trying to set the certificate, the function</span>
<a name="l00081"></a>00081 <span class="comment"> * will return APR_EGENERAL. Further LDAP specific error information</span>
<a name="l00082"></a>00082 <span class="comment"> * can be found in result_err.</span>
<a name="l00083"></a>00083 <span class="comment"> * @param pool The pool to use</span>
<a name="l00084"></a>00084 <span class="comment"> * @param cert_auth_file The name of the certificate to use, can be NULL</span>
<a name="l00085"></a>00085 <span class="comment"> * @param cert_file_type The type of certificate specified. See the</span>
<a name="l00086"></a>00086 <span class="comment"> * apr_ldap_set_option() APR_LDAP_OPT_TLS_CERT option for details.</span>
<a name="l00087"></a>00087 <span class="comment"> * @param result_err The returned result</span>
<a name="l00088"></a>00088 <span class="comment"> */</span>
<a name="l00089"></a>00089 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___l_d_a_p.html#ga8530e90ca597f822a571b6813021e1f1">apr_ldap_ssl_init</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
<a name="l00090"></a>00090 const <span class="keywordtype">char</span> *cert_auth_file,
<a name="l00091"></a>00091 <span class="keywordtype">int</span> cert_file_type,
<a name="l00092"></a>00092 <a class="code" href="structapr__ldap__err__t.html">apr_ldap_err_t</a> **result_err);
<a name="l00093"></a>00093 <span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment">/**</span>
<a name="l00095"></a>00095 <span class="comment"> * APR LDAP SSL De-Initialise function</span>
<a name="l00096"></a>00096 <span class="comment"> *</span>
<a name="l00097"></a>00097 <span class="comment"> * This function tears down any SSL certificate setup previously</span>
<a name="l00098"></a>00098 <span class="comment"> * set using apr_ldap_ssl_init(). It should be called to clean</span>
<a name="l00099"></a>00099 <span class="comment"> * up if a graceful restart of a service is attempted.</span>
<a name="l00100"></a>00100 <span class="comment"> * @todo currently we do not check whether apr_ldap_ssl_init()</span>
<a name="l00101"></a>00101 <span class="comment"> * has been called first - we probably should.</span>
<a name="l00102"></a>00102 <span class="comment"> */</span>
<a name="l00103"></a>00103 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___l_d_a_p.html#ga4425baf721f1857e0d8e066076aa595c">apr_ldap_ssl_deinit</a>(<span class="keywordtype">void</span>);
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment">/**</span>
<a name="l00106"></a>00106 <span class="comment"> * APR LDAP initialise function</span>
<a name="l00107"></a>00107 <span class="comment"> *</span>
<a name="l00108"></a>00108 <span class="comment"> * This function is responsible for initialising an LDAP</span>
<a name="l00109"></a>00109 <span class="comment"> * connection in a toolkit independant way. It does the</span>
<a name="l00110"></a>00110 <span class="comment"> * job of ldap_init() from the C api.</span>
<a name="l00111"></a>00111 <span class="comment"> *</span>
<a name="l00112"></a>00112 <span class="comment"> * It handles both the SSL and non-SSL case, and attempts</span>
<a name="l00113"></a>00113 <span class="comment"> * to hide the complexity setup from the user. This function</span>
<a name="l00114"></a>00114 <span class="comment"> * assumes that any certificate setup necessary has already</span>
<a name="l00115"></a>00115 <span class="comment"> * been done.</span>
<a name="l00116"></a>00116 <span class="comment"> *</span>
<a name="l00117"></a>00117 <span class="comment"> * If SSL or STARTTLS needs to be enabled, and the underlying</span>
<a name="l00118"></a>00118 <span class="comment"> * toolkit supports it, the following values are accepted for</span>
<a name="l00119"></a>00119 <span class="comment"> * secure:</span>
<a name="l00120"></a>00120 <span class="comment"> *</span>
<a name="l00121"></a>00121 <span class="comment"> * APR_LDAP_NONE: No encryption</span>
<a name="l00122"></a>00122 <span class="comment"> * APR_LDAP_SSL: SSL encryption (ldaps://)</span>
<a name="l00123"></a>00123 <span class="comment"> * APR_LDAP_STARTTLS: Force STARTTLS on ldap://</span>
<a name="l00124"></a>00124 <span class="comment"> * @remark The Novell toolkit is only able to set the SSL mode via this</span>
<a name="l00125"></a>00125 <span class="comment"> * function. To work around this limitation, set the SSL mode here if no</span>
<a name="l00126"></a>00126 <span class="comment"> * per connection client certificates are present, otherwise set secure</span>
<a name="l00127"></a>00127 <span class="comment"> * APR_LDAP_NONE here, then set the per connection client certificates,</span>
<a name="l00128"></a>00128 <span class="comment"> * followed by setting the SSL mode via apr_ldap_set_option(). As Novell</span>
<a name="l00129"></a>00129 <span class="comment"> * does not support per connection client certificates, this problem is</span>
<a name="l00130"></a>00130 <span class="comment"> * worked around while still being compatible with other LDAP toolkits.</span>
<a name="l00131"></a>00131 <span class="comment"> * @param pool The pool to use</span>
<a name="l00132"></a>00132 <span class="comment"> * @param ldap The LDAP handle</span>
<a name="l00133"></a>00133 <span class="comment"> * @param hostname The name of the host to connect to. This can be either a</span>
<a name="l00134"></a>00134 <span class="comment"> * DNS name, or an IP address.</span>
<a name="l00135"></a>00135 <span class="comment"> * @param portno The port to connect to</span>
<a name="l00136"></a>00136 <span class="comment"> * @param secure The security mode to set</span>
<a name="l00137"></a>00137 <span class="comment"> * @param result_err The returned result</span>
<a name="l00138"></a>00138 <span class="comment"> */</span>
<a name="l00139"></a>00139 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___l_d_a_p.html#ga9b7929b5fafe485a79cb83273ef8de43">apr_ldap_init</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
<a name="l00140"></a>00140 LDAP **ldap,
<a name="l00141"></a>00141 const <span class="keywordtype">char</span> *hostname,
<a name="l00142"></a>00142 <span class="keywordtype">int</span> portno,
<a name="l00143"></a>00143 <span class="keywordtype">int</span> secure,
<a name="l00144"></a>00144 <a class="code" href="structapr__ldap__err__t.html">apr_ldap_err_t</a> **result_err);
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">/**</span>
<a name="l00147"></a>00147 <span class="comment"> * APR LDAP info function</span>
<a name="l00148"></a>00148 <span class="comment"> *</span>
<a name="l00149"></a>00149 <span class="comment"> * This function returns a string describing the LDAP toolkit</span>
<a name="l00150"></a>00150 <span class="comment"> * currently in use. The string is placed inside result_err->reason.</span>
<a name="l00151"></a>00151 <span class="comment"> * @param pool The pool to use</span>
<a name="l00152"></a>00152 <span class="comment"> * @param result_err The returned result</span>
<a name="l00153"></a>00153 <span class="comment"> */</span>
<a name="l00154"></a>00154 APU_DECLARE_LDAP(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___l_d_a_p.html#ga59cae74d6182dea8d93080b602845866">apr_ldap_info</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
<a name="l00155"></a>00155 <a class="code" href="structapr__ldap__err__t.html">apr_ldap_err_t</a> **result_err);
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00158"></a>00158 <span class="preprocessor"></span>}
<a name="l00159"></a>00159 <span class="preprocessor">#endif</span>
<a name="l00160"></a>00160 <span class="preprocessor"></span>
<a name="l00161"></a>00161 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_LDAP */</span>
<a name="l00162"></a>00162 <span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment">/** @} */</span>
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="preprocessor">#endif </span><span class="comment">/* APR_LDAP_URL_H */</span>
</pre></div></div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
