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