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