Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / src-html / org / apache / archiva / redback / common / ldap / LdapUtils.html
blob: 6a39f26b8b714a954ae4395ab116e32e9371475a [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.common.ldap;</a>
<span class="sourceLineNo">002</span><a id="line.2"></a>
<span class="sourceLineNo">003</span><a id="line.3">/*</a>
<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">013</span><a id="line.13"> *</a>
<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
<span class="sourceLineNo">020</span><a id="line.20"> */</a>
<span class="sourceLineNo">021</span><a id="line.21"></a>
<span class="sourceLineNo">022</span><a id="line.22">import javax.naming.CompositeName;</a>
<span class="sourceLineNo">023</span><a id="line.23">import javax.naming.InvalidNameException;</a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.naming.NamingEnumeration;</a>
<span class="sourceLineNo">025</span><a id="line.25">import javax.naming.NamingException;</a>
<span class="sourceLineNo">026</span><a id="line.26">import javax.naming.directory.Attribute;</a>
<span class="sourceLineNo">027</span><a id="line.27">import javax.naming.directory.Attributes;</a>
<span class="sourceLineNo">028</span><a id="line.28">import javax.naming.ldap.LdapName;</a>
<span class="sourceLineNo">029</span><a id="line.29">import javax.naming.ldap.Rdn;</a>
<span class="sourceLineNo">030</span><a id="line.30"></a>
<span class="sourceLineNo">031</span><a id="line.31">/**</a>
<span class="sourceLineNo">032</span><a id="line.32"> * </a>
<span class="sourceLineNo">033</span><a id="line.33"> *</a>
<span class="sourceLineNo">034</span><a id="line.34"> */</a>
<span class="sourceLineNo">035</span><a id="line.35">public final class LdapUtils</a>
<span class="sourceLineNo">036</span><a id="line.36">{</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> private static String[] FILTER_ESCAPE_TABLE = new String['\\' + 1];</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"></a>
<span class="sourceLineNo">041</span><a id="line.41"> // Characters that must be escaped in a user filter</a>
<span class="sourceLineNo">042</span><a id="line.42"> static {</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> // Filter encoding table -------------------------------------</a>
<span class="sourceLineNo">045</span><a id="line.45"> // fill with char itself</a>
<span class="sourceLineNo">046</span><a id="line.46"> for (char c = 0; c &lt; FILTER_ESCAPE_TABLE.length; c++) {</a>
<span class="sourceLineNo">047</span><a id="line.47"> FILTER_ESCAPE_TABLE[c] = String.valueOf(c);</a>
<span class="sourceLineNo">048</span><a id="line.48"> }</a>
<span class="sourceLineNo">049</span><a id="line.49"></a>
<span class="sourceLineNo">050</span><a id="line.50"> // escapes (RFC2254)</a>
<span class="sourceLineNo">051</span><a id="line.51"> FILTER_ESCAPE_TABLE['*'] = "\\2a";</a>
<span class="sourceLineNo">052</span><a id="line.52"> FILTER_ESCAPE_TABLE['('] = "\\28";</a>
<span class="sourceLineNo">053</span><a id="line.53"> FILTER_ESCAPE_TABLE[')'] = "\\29";</a>
<span class="sourceLineNo">054</span><a id="line.54"> FILTER_ESCAPE_TABLE['\\'] = "\\5c";</a>
<span class="sourceLineNo">055</span><a id="line.55"> FILTER_ESCAPE_TABLE[0] = "\\00";</a>
<span class="sourceLineNo">056</span><a id="line.56"> }</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"> private LdapUtils()</a>
<span class="sourceLineNo">060</span><a id="line.60"> {</a>
<span class="sourceLineNo">061</span><a id="line.61"> // no op</a>
<span class="sourceLineNo">062</span><a id="line.62"> }</a>
<span class="sourceLineNo">063</span><a id="line.63"></a>
<span class="sourceLineNo">064</span><a id="line.64"> @SuppressWarnings("unchecked")</a>
<span class="sourceLineNo">065</span><a id="line.65"> public static String getLabeledUriValue( Attributes attributes, String attrName, String label,</a>
<span class="sourceLineNo">066</span><a id="line.66"> String attributeDescription )</a>
<span class="sourceLineNo">067</span><a id="line.67"> throws MappingException</a>
<span class="sourceLineNo">068</span><a id="line.68"> {</a>
<span class="sourceLineNo">069</span><a id="line.69"> if ( attrName == null )</a>
<span class="sourceLineNo">070</span><a id="line.70"> {</a>
<span class="sourceLineNo">071</span><a id="line.71"> return null;</a>
<span class="sourceLineNo">072</span><a id="line.72"> }</a>
<span class="sourceLineNo">073</span><a id="line.73"></a>
<span class="sourceLineNo">074</span><a id="line.74"> Attribute attribute = attributes.get( attrName );</a>
<span class="sourceLineNo">075</span><a id="line.75"> if ( attribute != null )</a>
<span class="sourceLineNo">076</span><a id="line.76"> {</a>
<span class="sourceLineNo">077</span><a id="line.77"> NamingEnumeration attrs;</a>
<span class="sourceLineNo">078</span><a id="line.78"> try</a>
<span class="sourceLineNo">079</span><a id="line.79"> {</a>
<span class="sourceLineNo">080</span><a id="line.80"> attrs = attribute.getAll();</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"> catch ( NamingException e )</a>
<span class="sourceLineNo">083</span><a id="line.83"> {</a>
<span class="sourceLineNo">084</span><a id="line.84"> throw new MappingException(</a>
<span class="sourceLineNo">085</span><a id="line.85"> "Failed to retrieve " + attributeDescription + " (attribute: \'" + attrName + "\').", e );</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87"></a>
<span class="sourceLineNo">088</span><a id="line.88"> while ( attrs.hasMoreElements() )</a>
<span class="sourceLineNo">089</span><a id="line.89"> {</a>
<span class="sourceLineNo">090</span><a id="line.90"> Object value = attrs.nextElement();</a>
<span class="sourceLineNo">091</span><a id="line.91"></a>
<span class="sourceLineNo">092</span><a id="line.92"> String val = String.valueOf( value );</a>
<span class="sourceLineNo">093</span><a id="line.93"></a>
<span class="sourceLineNo">094</span><a id="line.94"> if ( val.endsWith( " " + label ) )</a>
<span class="sourceLineNo">095</span><a id="line.95"> {</a>
<span class="sourceLineNo">096</span><a id="line.96"> return val.substring( 0, val.length() - ( label.length() + 1 ) );</a>
<span class="sourceLineNo">097</span><a id="line.97"> }</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"> }</a>
<span class="sourceLineNo">100</span><a id="line.100"></a>
<span class="sourceLineNo">101</span><a id="line.101"> return null;</a>
<span class="sourceLineNo">102</span><a id="line.102"> }</a>
<span class="sourceLineNo">103</span><a id="line.103"></a>
<span class="sourceLineNo">104</span><a id="line.104"> public static String getAttributeValue( Attributes attributes, String attrName, String attributeDescription )</a>
<span class="sourceLineNo">105</span><a id="line.105"> throws MappingException</a>
<span class="sourceLineNo">106</span><a id="line.106"> {</a>
<span class="sourceLineNo">107</span><a id="line.107"> if ( attrName == null )</a>
<span class="sourceLineNo">108</span><a id="line.108"> {</a>
<span class="sourceLineNo">109</span><a id="line.109"> return null;</a>
<span class="sourceLineNo">110</span><a id="line.110"> }</a>
<span class="sourceLineNo">111</span><a id="line.111"></a>
<span class="sourceLineNo">112</span><a id="line.112"> Attribute attribute = attributes.get( attrName );</a>
<span class="sourceLineNo">113</span><a id="line.113"> if ( attribute != null )</a>
<span class="sourceLineNo">114</span><a id="line.114"> {</a>
<span class="sourceLineNo">115</span><a id="line.115"> try</a>
<span class="sourceLineNo">116</span><a id="line.116"> {</a>
<span class="sourceLineNo">117</span><a id="line.117"> Object value = attribute.get();</a>
<span class="sourceLineNo">118</span><a id="line.118"></a>
<span class="sourceLineNo">119</span><a id="line.119"> return String.valueOf( value );</a>
<span class="sourceLineNo">120</span><a id="line.120"> }</a>
<span class="sourceLineNo">121</span><a id="line.121"> catch ( NamingException e )</a>
<span class="sourceLineNo">122</span><a id="line.122"> {</a>
<span class="sourceLineNo">123</span><a id="line.123"> throw new MappingException(</a>
<span class="sourceLineNo">124</span><a id="line.124"> "Failed to retrieve " + attributeDescription + " (attribute: \'" + attrName + "\').", e );</a>
<span class="sourceLineNo">125</span><a id="line.125"> }</a>
<span class="sourceLineNo">126</span><a id="line.126"> }</a>
<span class="sourceLineNo">127</span><a id="line.127"></a>
<span class="sourceLineNo">128</span><a id="line.128"> return null;</a>
<span class="sourceLineNo">129</span><a id="line.129"> }</a>
<span class="sourceLineNo">130</span><a id="line.130"></a>
<span class="sourceLineNo">131</span><a id="line.131"> public static String getAttributeValueFromByteArray( Attributes attributes, String attrName,</a>
<span class="sourceLineNo">132</span><a id="line.132"> String attributeDescription )</a>
<span class="sourceLineNo">133</span><a id="line.133"> throws MappingException</a>
<span class="sourceLineNo">134</span><a id="line.134"> {</a>
<span class="sourceLineNo">135</span><a id="line.135"> if ( attrName == null )</a>
<span class="sourceLineNo">136</span><a id="line.136"> {</a>
<span class="sourceLineNo">137</span><a id="line.137"> return null;</a>
<span class="sourceLineNo">138</span><a id="line.138"> }</a>
<span class="sourceLineNo">139</span><a id="line.139"></a>
<span class="sourceLineNo">140</span><a id="line.140"> Attribute attribute = attributes.get( attrName );</a>
<span class="sourceLineNo">141</span><a id="line.141"> if ( attribute != null )</a>
<span class="sourceLineNo">142</span><a id="line.142"> {</a>
<span class="sourceLineNo">143</span><a id="line.143"> try</a>
<span class="sourceLineNo">144</span><a id="line.144"> {</a>
<span class="sourceLineNo">145</span><a id="line.145"> byte[] value = (byte[]) attribute.get();</a>
<span class="sourceLineNo">146</span><a id="line.146"></a>
<span class="sourceLineNo">147</span><a id="line.147"> return new String( value );</a>
<span class="sourceLineNo">148</span><a id="line.148"> }</a>
<span class="sourceLineNo">149</span><a id="line.149"> catch ( NamingException e )</a>
<span class="sourceLineNo">150</span><a id="line.150"> {</a>
<span class="sourceLineNo">151</span><a id="line.151"> throw new MappingException(</a>
<span class="sourceLineNo">152</span><a id="line.152"> "Failed to retrieve " + attributeDescription + " (attribute: \'" + attrName + "\').", e );</a>
<span class="sourceLineNo">153</span><a id="line.153"> }</a>
<span class="sourceLineNo">154</span><a id="line.154"> }</a>
<span class="sourceLineNo">155</span><a id="line.155"></a>
<span class="sourceLineNo">156</span><a id="line.156"> return null;</a>
<span class="sourceLineNo">157</span><a id="line.157"> }</a>
<span class="sourceLineNo">158</span><a id="line.158"></a>
<span class="sourceLineNo">159</span><a id="line.159"> /**</a>
<span class="sourceLineNo">160</span><a id="line.160"> * Returns a LDAP name from a given RDN string. The &lt;code&gt;name&lt;/code&gt; parameter must be a string</a>
<span class="sourceLineNo">161</span><a id="line.161"> * representation of a composite name (as returned by ldapsearch result getName())</a>
<span class="sourceLineNo">162</span><a id="line.162"> * @param name The string of the RDN (may be escaped)</a>
<span class="sourceLineNo">163</span><a id="line.163"> * @return The LdapName that corresponds to this string</a>
<span class="sourceLineNo">164</span><a id="line.164"> * @throws InvalidNameException If the string cannot be parsed as LDAP name</a>
<span class="sourceLineNo">165</span><a id="line.165"> */</a>
<span class="sourceLineNo">166</span><a id="line.166"> public static LdapName getLdapNameFromString(final String name) throws InvalidNameException</a>
<span class="sourceLineNo">167</span><a id="line.167"> {</a>
<span class="sourceLineNo">168</span><a id="line.168"> CompositeName coName = new CompositeName( name );</a>
<span class="sourceLineNo">169</span><a id="line.169"> LdapName ldapName = new LdapName( "" );</a>
<span class="sourceLineNo">170</span><a id="line.170"> ldapName.addAll( coName );</a>
<span class="sourceLineNo">171</span><a id="line.171"> return ldapName;</a>
<span class="sourceLineNo">172</span><a id="line.172"> }</a>
<span class="sourceLineNo">173</span><a id="line.173"></a>
<span class="sourceLineNo">174</span><a id="line.174"> /**</a>
<span class="sourceLineNo">175</span><a id="line.175"> * Returns the first RDN value that matches the given type.</a>
<span class="sourceLineNo">176</span><a id="line.176"> * E.g. for the RDN ou=People,dc=test,dc=de, and type dc it will return 'test'.</a>
<span class="sourceLineNo">177</span><a id="line.177"> *</a>
<span class="sourceLineNo">178</span><a id="line.178"> * @param name the ldap name</a>
<span class="sourceLineNo">179</span><a id="line.179"> * @param type the type of the RDN entry</a>
<span class="sourceLineNo">180</span><a id="line.180"> * @return</a>
<span class="sourceLineNo">181</span><a id="line.181"> */</a>
<span class="sourceLineNo">182</span><a id="line.182"> public static String findFirstRdnValue(LdapName name, String type) {</a>
<span class="sourceLineNo">183</span><a id="line.183"> for ( Rdn rdn : name.getRdns() )</a>
<span class="sourceLineNo">184</span><a id="line.184"> {</a>
<span class="sourceLineNo">185</span><a id="line.185"> if ( rdn.getType( ).equals( type ) )</a>
<span class="sourceLineNo">186</span><a id="line.186"> {</a>
<span class="sourceLineNo">187</span><a id="line.187"> Object val = rdn.getValue( );</a>
<span class="sourceLineNo">188</span><a id="line.188"> if (val!=null) {</a>
<span class="sourceLineNo">189</span><a id="line.189"> return val.toString( );</a>
<span class="sourceLineNo">190</span><a id="line.190"> } else {</a>
<span class="sourceLineNo">191</span><a id="line.191"> return "";</a>
<span class="sourceLineNo">192</span><a id="line.192"> }</a>
<span class="sourceLineNo">193</span><a id="line.193"> }</a>
<span class="sourceLineNo">194</span><a id="line.194"> }</a>
<span class="sourceLineNo">195</span><a id="line.195"> return "";</a>
<span class="sourceLineNo">196</span><a id="line.196"> }</a>
<span class="sourceLineNo">197</span><a id="line.197"></a>
<span class="sourceLineNo">198</span><a id="line.198"> /**</a>
<span class="sourceLineNo">199</span><a id="line.199"> * Escape a value for use in a filter.</a>
<span class="sourceLineNo">200</span><a id="line.200"> * This method is copied from the spring framework class org.springframework.security.ldap.authentication.LdapEncoder</a>
<span class="sourceLineNo">201</span><a id="line.201"> *</a>
<span class="sourceLineNo">202</span><a id="line.202"> * @param value the value to escape.</a>
<span class="sourceLineNo">203</span><a id="line.203"> * @return a properly escaped representation of the supplied value.</a>
<span class="sourceLineNo">204</span><a id="line.204"> */</a>
<span class="sourceLineNo">205</span><a id="line.205"> public static String encodeFilterValue(String value) {</a>
<span class="sourceLineNo">206</span><a id="line.206"></a>
<span class="sourceLineNo">207</span><a id="line.207"> if (value == null) {</a>
<span class="sourceLineNo">208</span><a id="line.208"> return null;</a>
<span class="sourceLineNo">209</span><a id="line.209"> }</a>
<span class="sourceLineNo">210</span><a id="line.210"></a>
<span class="sourceLineNo">211</span><a id="line.211"> // make buffer roomy</a>
<span class="sourceLineNo">212</span><a id="line.212"> StringBuilder encodedValue = new StringBuilder(value.length() * 2);</a>
<span class="sourceLineNo">213</span><a id="line.213"></a>
<span class="sourceLineNo">214</span><a id="line.214"> int length = value.length();</a>
<span class="sourceLineNo">215</span><a id="line.215"></a>
<span class="sourceLineNo">216</span><a id="line.216"> for (int i = 0; i &lt; length; i++) {</a>
<span class="sourceLineNo">217</span><a id="line.217"></a>
<span class="sourceLineNo">218</span><a id="line.218"> char c = value.charAt(i);</a>
<span class="sourceLineNo">219</span><a id="line.219"></a>
<span class="sourceLineNo">220</span><a id="line.220"> if (c &lt; FILTER_ESCAPE_TABLE.length) {</a>
<span class="sourceLineNo">221</span><a id="line.221"> encodedValue.append(FILTER_ESCAPE_TABLE[c]);</a>
<span class="sourceLineNo">222</span><a id="line.222"> }</a>
<span class="sourceLineNo">223</span><a id="line.223"> else {</a>
<span class="sourceLineNo">224</span><a id="line.224"> // default: add the char</a>
<span class="sourceLineNo">225</span><a id="line.225"> encodedValue.append(c);</a>
<span class="sourceLineNo">226</span><a id="line.226"> }</a>
<span class="sourceLineNo">227</span><a id="line.227"> }</a>
<span class="sourceLineNo">228</span><a id="line.228"></a>
<span class="sourceLineNo">229</span><a id="line.229"> return encodedValue.toString();</a>
<span class="sourceLineNo">230</span><a id="line.230"> }</a>
<span class="sourceLineNo">231</span><a id="line.231">}</a>
</pre>
</div>
</main>
</body>
</html>