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