| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.codec;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> /**<a name="line.21"></a> |
| <FONT color="green">022</FONT> * <a href="http://en.wikipedia.org/wiki/Hexadecimal">Hexadecimal</a> encoder and decoder.<a name="line.22"></a> |
| <FONT color="green">023</FONT> * <p/><a name="line.23"></a> |
| <FONT color="green">024</FONT> * This class was borrowed from Apache Commons Codec SVN repository (rev. {@code 560660}) with modifications<a name="line.24"></a> |
| <FONT color="green">025</FONT> * to enable Hex conversion without a full dependency on Commons Codec. We didn't want to reinvent the wheel of<a name="line.25"></a> |
| <FONT color="green">026</FONT> * great work they've done, but also didn't want to force every Shiro user to depend on the commons-codec.jar<a name="line.26"></a> |
| <FONT color="green">027</FONT> * <p/><a name="line.27"></a> |
| <FONT color="green">028</FONT> * As per the Apache 2.0 license, the original copyright notice and all author and copyright information have<a name="line.28"></a> |
| <FONT color="green">029</FONT> * remained in tact.<a name="line.29"></a> |
| <FONT color="green">030</FONT> *<a name="line.30"></a> |
| <FONT color="green">031</FONT> * @see <a href="http://en.wikipedia.org/wiki/Hexadecimal">Wikipedia: Hexadecimal</a><a name="line.31"></a> |
| <FONT color="green">032</FONT> * @since 0.9<a name="line.32"></a> |
| <FONT color="green">033</FONT> */<a name="line.33"></a> |
| <FONT color="green">034</FONT> public class Hex {<a name="line.34"></a> |
| <FONT color="green">035</FONT> <a name="line.35"></a> |
| <FONT color="green">036</FONT> /**<a name="line.36"></a> |
| <FONT color="green">037</FONT> * Used to build output as Hex<a name="line.37"></a> |
| <FONT color="green">038</FONT> */<a name="line.38"></a> |
| <FONT color="green">039</FONT> private static final char[] DIGITS = {<a name="line.39"></a> |
| <FONT color="green">040</FONT> '0', '1', '2', '3', '4', '5', '6', '7',<a name="line.40"></a> |
| <FONT color="green">041</FONT> '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'<a name="line.41"></a> |
| <FONT color="green">042</FONT> };<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> /**<a name="line.44"></a> |
| <FONT color="green">045</FONT> * Encodes the specifed byte array to a character array and then returns that character array<a name="line.45"></a> |
| <FONT color="green">046</FONT> * as a String.<a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * @param bytes the byte array to Hex-encode.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * @return A String representation of the resultant hex-encoded char array.<a name="line.49"></a> |
| <FONT color="green">050</FONT> */<a name="line.50"></a> |
| <FONT color="green">051</FONT> public static String encodeToString(byte[] bytes) {<a name="line.51"></a> |
| <FONT color="green">052</FONT> char[] encodedChars = encode(bytes);<a name="line.52"></a> |
| <FONT color="green">053</FONT> return new String(encodedChars);<a name="line.53"></a> |
| <FONT color="green">054</FONT> }<a name="line.54"></a> |
| <FONT color="green">055</FONT> <a name="line.55"></a> |
| <FONT color="green">056</FONT> /**<a name="line.56"></a> |
| <FONT color="green">057</FONT> * Converts an array of bytes into an array of characters representing the hexidecimal values of each byte in order.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * The returned array will be double the length of the passed array, as it takes two characters to represent any<a name="line.58"></a> |
| <FONT color="green">059</FONT> * given byte.<a name="line.59"></a> |
| <FONT color="green">060</FONT> *<a name="line.60"></a> |
| <FONT color="green">061</FONT> * @param data byte[] to convert to Hex characters<a name="line.61"></a> |
| <FONT color="green">062</FONT> * @return A char[] containing hexidecimal characters<a name="line.62"></a> |
| <FONT color="green">063</FONT> */<a name="line.63"></a> |
| <FONT color="green">064</FONT> public static char[] encode(byte[] data) {<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> int l = data.length;<a name="line.66"></a> |
| <FONT color="green">067</FONT> <a name="line.67"></a> |
| <FONT color="green">068</FONT> char[] out = new char[l << 1];<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> // two characters form the hex value.<a name="line.70"></a> |
| <FONT color="green">071</FONT> for (int i = 0, j = 0; i < l; i++) {<a name="line.71"></a> |
| <FONT color="green">072</FONT> out[j++] = DIGITS[(0xF0 & data[i]) >>> 4];<a name="line.72"></a> |
| <FONT color="green">073</FONT> out[j++] = DIGITS[0x0F & data[i]];<a name="line.73"></a> |
| <FONT color="green">074</FONT> }<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> return out;<a name="line.76"></a> |
| <FONT color="green">077</FONT> }<a name="line.77"></a> |
| <FONT color="green">078</FONT> <a name="line.78"></a> |
| <FONT color="green">079</FONT> /**<a name="line.79"></a> |
| <FONT color="green">080</FONT> * Converts an array of character bytes representing hexidecimal values into an<a name="line.80"></a> |
| <FONT color="green">081</FONT> * array of bytes of those same values. The returned array will be half the<a name="line.81"></a> |
| <FONT color="green">082</FONT> * length of the passed array, as it takes two characters to represent any<a name="line.82"></a> |
| <FONT color="green">083</FONT> * given byte. An exception is thrown if the passed char array has an odd<a name="line.83"></a> |
| <FONT color="green">084</FONT> * number of elements.<a name="line.84"></a> |
| <FONT color="green">085</FONT> *<a name="line.85"></a> |
| <FONT color="green">086</FONT> * @param array An array of character bytes containing hexidecimal digits<a name="line.86"></a> |
| <FONT color="green">087</FONT> * @return A byte array containing binary data decoded from<a name="line.87"></a> |
| <FONT color="green">088</FONT> * the supplied byte array (representing characters).<a name="line.88"></a> |
| <FONT color="green">089</FONT> * @throws IllegalArgumentException Thrown if an odd number of characters is supplied<a name="line.89"></a> |
| <FONT color="green">090</FONT> * to this function<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @see #decode(char[])<a name="line.91"></a> |
| <FONT color="green">092</FONT> */<a name="line.92"></a> |
| <FONT color="green">093</FONT> public static byte[] decode(byte[] array) throws IllegalArgumentException {<a name="line.93"></a> |
| <FONT color="green">094</FONT> String s = CodecSupport.toString(array);<a name="line.94"></a> |
| <FONT color="green">095</FONT> return decode(s);<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> /**<a name="line.98"></a> |
| <FONT color="green">099</FONT> * Converts the specified Hex-encoded String into a raw byte array. This is a<a name="line.99"></a> |
| <FONT color="green">100</FONT> * convenience method that merely delegates to {@link #decode(char[])} using the<a name="line.100"></a> |
| <FONT color="green">101</FONT> * argument's hex.toCharArray() value.<a name="line.101"></a> |
| <FONT color="green">102</FONT> *<a name="line.102"></a> |
| <FONT color="green">103</FONT> * @param hex a Hex-encoded String.<a name="line.103"></a> |
| <FONT color="green">104</FONT> * @return A byte array containing binary data decoded from the supplied String's char array.<a name="line.104"></a> |
| <FONT color="green">105</FONT> */<a name="line.105"></a> |
| <FONT color="green">106</FONT> public static byte[] decode(String hex) {<a name="line.106"></a> |
| <FONT color="green">107</FONT> return decode(hex.toCharArray());<a name="line.107"></a> |
| <FONT color="green">108</FONT> }<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> /**<a name="line.110"></a> |
| <FONT color="green">111</FONT> * Converts an array of characters representing hexidecimal values into an<a name="line.111"></a> |
| <FONT color="green">112</FONT> * array of bytes of those same values. The returned array will be half the<a name="line.112"></a> |
| <FONT color="green">113</FONT> * length of the passed array, as it takes two characters to represent any<a name="line.113"></a> |
| <FONT color="green">114</FONT> * given byte. An exception is thrown if the passed char array has an odd<a name="line.114"></a> |
| <FONT color="green">115</FONT> * number of elements.<a name="line.115"></a> |
| <FONT color="green">116</FONT> *<a name="line.116"></a> |
| <FONT color="green">117</FONT> * @param data An array of characters containing hexidecimal digits<a name="line.117"></a> |
| <FONT color="green">118</FONT> * @return A byte array containing binary data decoded from<a name="line.118"></a> |
| <FONT color="green">119</FONT> * the supplied char array.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @throws IllegalArgumentException if an odd number or illegal of characters<a name="line.120"></a> |
| <FONT color="green">121</FONT> * is supplied<a name="line.121"></a> |
| <FONT color="green">122</FONT> */<a name="line.122"></a> |
| <FONT color="green">123</FONT> public static byte[] decode(char[] data) throws IllegalArgumentException {<a name="line.123"></a> |
| <FONT color="green">124</FONT> <a name="line.124"></a> |
| <FONT color="green">125</FONT> int len = data.length;<a name="line.125"></a> |
| <FONT color="green">126</FONT> <a name="line.126"></a> |
| <FONT color="green">127</FONT> if ((len & 0x01) != 0) {<a name="line.127"></a> |
| <FONT color="green">128</FONT> throw new IllegalArgumentException("Odd number of characters.");<a name="line.128"></a> |
| <FONT color="green">129</FONT> }<a name="line.129"></a> |
| <FONT color="green">130</FONT> <a name="line.130"></a> |
| <FONT color="green">131</FONT> byte[] out = new byte[len >> 1];<a name="line.131"></a> |
| <FONT color="green">132</FONT> <a name="line.132"></a> |
| <FONT color="green">133</FONT> // two characters form the hex value.<a name="line.133"></a> |
| <FONT color="green">134</FONT> for (int i = 0, j = 0; j < len; i++) {<a name="line.134"></a> |
| <FONT color="green">135</FONT> int f = toDigit(data[j], j) << 4;<a name="line.135"></a> |
| <FONT color="green">136</FONT> j++;<a name="line.136"></a> |
| <FONT color="green">137</FONT> f = f | toDigit(data[j], j);<a name="line.137"></a> |
| <FONT color="green">138</FONT> j++;<a name="line.138"></a> |
| <FONT color="green">139</FONT> out[i] = (byte) (f & 0xFF);<a name="line.139"></a> |
| <FONT color="green">140</FONT> }<a name="line.140"></a> |
| <FONT color="green">141</FONT> <a name="line.141"></a> |
| <FONT color="green">142</FONT> return out;<a name="line.142"></a> |
| <FONT color="green">143</FONT> }<a name="line.143"></a> |
| <FONT color="green">144</FONT> <a name="line.144"></a> |
| <FONT color="green">145</FONT> /**<a name="line.145"></a> |
| <FONT color="green">146</FONT> * Converts a hexadecimal character to an integer.<a name="line.146"></a> |
| <FONT color="green">147</FONT> *<a name="line.147"></a> |
| <FONT color="green">148</FONT> * @param ch A character to convert to an integer digit<a name="line.148"></a> |
| <FONT color="green">149</FONT> * @param index The index of the character in the source<a name="line.149"></a> |
| <FONT color="green">150</FONT> * @return An integer<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @throws IllegalArgumentException if ch is an illegal hex character<a name="line.151"></a> |
| <FONT color="green">152</FONT> */<a name="line.152"></a> |
| <FONT color="green">153</FONT> protected static int toDigit(char ch, int index) throws IllegalArgumentException {<a name="line.153"></a> |
| <FONT color="green">154</FONT> int digit = Character.digit(ch, 16);<a name="line.154"></a> |
| <FONT color="green">155</FONT> if (digit == -1) {<a name="line.155"></a> |
| <FONT color="green">156</FONT> throw new IllegalArgumentException("Illegal hexadecimal charcter " + ch + " at index " + index);<a name="line.156"></a> |
| <FONT color="green">157</FONT> }<a name="line.157"></a> |
| <FONT color="green">158</FONT> return digit;<a name="line.158"></a> |
| <FONT color="green">159</FONT> }<a name="line.159"></a> |
| <FONT color="green">160</FONT> <a name="line.160"></a> |
| <FONT color="green">161</FONT> <a name="line.161"></a> |
| <FONT color="green">162</FONT> }<a name="line.162"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
