blob: cb7bdadaa664891985245f87a9cd8469cead16d1 [file] [log] [blame]
<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> /*<a name="line.19"></a>
<FONT color="green">020</FONT> * The apr_md5_encode() routine in the APR project's apr_md5.c file uses much<a name="line.20"></a>
<FONT color="green">021</FONT> * code obtained from the FreeBSD 3.0 MD5 crypt() function, which is licenced<a name="line.21"></a>
<FONT color="green">022</FONT> * as follows:<a name="line.22"></a>
<FONT color="green">023</FONT> * ----------------------------------------------------------------------------<a name="line.23"></a>
<FONT color="green">024</FONT> * "THE BEER-WARE LICENSE" (Revision 42):<a name="line.24"></a>
<FONT color="green">025</FONT> * &lt;phk@login.dknet.dk&gt; wrote this file. As long as you retain this notice you<a name="line.25"></a>
<FONT color="green">026</FONT> * can do whatever you want with this stuff. If we meet some day, and you think<a name="line.26"></a>
<FONT color="green">027</FONT> * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp<a name="line.27"></a>
<FONT color="green">028</FONT> * ----------------------------------------------------------------------------<a name="line.28"></a>
<FONT color="green">029</FONT> */<a name="line.29"></a>
<FONT color="green">030</FONT> package org.apache.shiro.codec;<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> import java.io.IOException;<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> /**<a name="line.34"></a>
<FONT color="green">035</FONT> * Codec for &lt;a href="http://en.wikipedia.org/wiki/Crypt_(Unix)"&gt;Unix Crypt&lt;/a&gt;-style encoding. While similar to<a name="line.35"></a>
<FONT color="green">036</FONT> * Base64, it is not compatible with Base64.<a name="line.36"></a>
<FONT color="green">037</FONT> * &lt;p/&gt;<a name="line.37"></a>
<FONT color="green">038</FONT> * This implementation is based on encoding algorithms found in the Apache Portable Runtime library's<a name="line.38"></a>
<FONT color="green">039</FONT> * &lt;a href="http://svn.apache.org/viewvc/apr/apr/trunk/crypto/apr_md5.c?revision=HEAD&amp;view=markup"&gt;apr_md5.c&lt;/a&gt;<a name="line.39"></a>
<FONT color="green">040</FONT> * implementation for its {@code crypt}-style support. The APR team in turn received inspiration for its encoding<a name="line.40"></a>
<FONT color="green">041</FONT> * implementation based on FreeBSD 3.0's {@code /usr/src/lib/libcrypt/crypt.c} implementation. The<a name="line.41"></a>
<FONT color="green">042</FONT> * accompanying license headers have been retained at the top of this source file.<a name="line.42"></a>
<FONT color="green">043</FONT> * &lt;p/&gt;<a name="line.43"></a>
<FONT color="green">044</FONT> * This file and all that it contains is ASL 2.0 compatible.<a name="line.44"></a>
<FONT color="green">045</FONT> *<a name="line.45"></a>
<FONT color="green">046</FONT> * @since 1.2<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> public class H64 {<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> private static final char[] itoa64 = "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz".toCharArray();<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> private static short toShort(byte b) {<a name="line.52"></a>
<FONT color="green">053</FONT> return (short) (b &amp; 0xff);<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> private static int toInt(byte[] bytes, int offset, int numBytes) {<a name="line.56"></a>
<FONT color="green">057</FONT> if (numBytes &lt; 1 || numBytes &gt; 4) {<a name="line.57"></a>
<FONT color="green">058</FONT> throw new IllegalArgumentException("numBytes must be between 1 and 4.");<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> int val = toShort(bytes[offset]); //1st byte<a name="line.60"></a>
<FONT color="green">061</FONT> for (int i = 1; i &lt; numBytes; i++) { //any remaining bytes:<a name="line.61"></a>
<FONT color="green">062</FONT> short s = toShort(bytes[offset + i]);<a name="line.62"></a>
<FONT color="green">063</FONT> switch (i) {<a name="line.63"></a>
<FONT color="green">064</FONT> case 1: val |= s &lt;&lt; 8; break;<a name="line.64"></a>
<FONT color="green">065</FONT> case 2: val |= s &lt;&lt; 16; break;<a name="line.65"></a>
<FONT color="green">066</FONT> case 3: val |= s &lt;&lt; 24; break;<a name="line.66"></a>
<FONT color="green">067</FONT> }<a name="line.67"></a>
<FONT color="green">068</FONT> }<a name="line.68"></a>
<FONT color="green">069</FONT> return val;<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> /**<a name="line.72"></a>
<FONT color="green">073</FONT> * Appends the specified character into the buffer, rethrowing any encountered<a name="line.73"></a>
<FONT color="green">074</FONT> * {@link IOException} as an {@link IllegalStateException} (since this method is used for internal<a name="line.74"></a>
<FONT color="green">075</FONT> * implementation needs and we only ever use StringBuilders, we should never encounter an IOException).<a name="line.75"></a>
<FONT color="green">076</FONT> *<a name="line.76"></a>
<FONT color="green">077</FONT> * @param buf the buffer to append to<a name="line.77"></a>
<FONT color="green">078</FONT> * @param c the character to append.<a name="line.78"></a>
<FONT color="green">079</FONT> */<a name="line.79"></a>
<FONT color="green">080</FONT> private static void append(Appendable buf, char c) {<a name="line.80"></a>
<FONT color="green">081</FONT> try {<a name="line.81"></a>
<FONT color="green">082</FONT> buf.append(c);<a name="line.82"></a>
<FONT color="green">083</FONT> } catch (IOException e) {<a name="line.83"></a>
<FONT color="green">084</FONT> throw new IllegalStateException("Unable to append character to internal buffer.", e);<a name="line.84"></a>
<FONT color="green">085</FONT> }<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> <a name="line.87"></a>
<FONT color="green">088</FONT> /**<a name="line.88"></a>
<FONT color="green">089</FONT> * Encodes the specified integer to {@code numChars} H64-compatible characters and appends them into {@code buf}.<a name="line.89"></a>
<FONT color="green">090</FONT> *<a name="line.90"></a>
<FONT color="green">091</FONT> * @param value the integer to encode to H64-compatible characters<a name="line.91"></a>
<FONT color="green">092</FONT> * @param buf the output buffer<a name="line.92"></a>
<FONT color="green">093</FONT> * @param numChars the number of characters the value should be converted to. 3, 2 or 1.<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> private static void encodeAndAppend(int value, Appendable buf, int numChars) {<a name="line.95"></a>
<FONT color="green">096</FONT> for (int i = 0; i &lt; numChars; i++) {<a name="line.96"></a>
<FONT color="green">097</FONT> append(buf, itoa64[value &amp; 0x3f]);<a name="line.97"></a>
<FONT color="green">098</FONT> value &gt;&gt;= 6;<a name="line.98"></a>
<FONT color="green">099</FONT> }<a name="line.99"></a>
<FONT color="green">100</FONT> }<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> /**<a name="line.102"></a>
<FONT color="green">103</FONT> * Encodes the specified bytes to an {@code H64}-encoded String.<a name="line.103"></a>
<FONT color="green">104</FONT> *<a name="line.104"></a>
<FONT color="green">105</FONT> * @param bytes<a name="line.105"></a>
<FONT color="green">106</FONT> * @return<a name="line.106"></a>
<FONT color="green">107</FONT> */<a name="line.107"></a>
<FONT color="green">108</FONT> public static String encodeToString(byte[] bytes) {<a name="line.108"></a>
<FONT color="green">109</FONT> if (bytes == null || bytes.length == 0) return null;<a name="line.109"></a>
<FONT color="green">110</FONT> <a name="line.110"></a>
<FONT color="green">111</FONT> StringBuilder buf = new StringBuilder();<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> int length = bytes.length;<a name="line.113"></a>
<FONT color="green">114</FONT> int remainder = length % 3;<a name="line.114"></a>
<FONT color="green">115</FONT> int i = 0; //starting byte<a name="line.115"></a>
<FONT color="green">116</FONT> int last3ByteIndex = length - remainder; //last byte whose index is a multiple of 3<a name="line.116"></a>
<FONT color="green">117</FONT> <a name="line.117"></a>
<FONT color="green">118</FONT> for(; i &lt; last3ByteIndex; i += 3) {<a name="line.118"></a>
<FONT color="green">119</FONT> int twentyFourBit = toInt(bytes, i, 3);<a name="line.119"></a>
<FONT color="green">120</FONT> encodeAndAppend(twentyFourBit, buf, 4);<a name="line.120"></a>
<FONT color="green">121</FONT> }<a name="line.121"></a>
<FONT color="green">122</FONT> if (remainder &gt; 0) {<a name="line.122"></a>
<FONT color="green">123</FONT> //one or two bytes that we still need to encode:<a name="line.123"></a>
<FONT color="green">124</FONT> int a = toInt(bytes, i, remainder);<a name="line.124"></a>
<FONT color="green">125</FONT> encodeAndAppend(a, buf, remainder + 1);<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> return buf.toString();<a name="line.127"></a>
<FONT color="green">128</FONT> }<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
</PRE>
</BODY>
</HTML>