Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.10.0 / shiro-lang / xref / org / apache / shiro / codec / H64.html
blob: f3108f4c05566875809dc31f2216225d6545ab47 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>H64 xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/shiro/codec/H64.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> * The apr_md5_encode() routine in the APR project's apr_md5.c file uses much</em>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_comment"> * code obtained from the FreeBSD 3.0 MD5 crypt() function, which is licenced</em>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_comment"> * as follows:</em>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_comment"> * ----------------------------------------------------------------------------</em>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_comment"> * "THE BEER-WARE LICENSE" (Revision 42):</em>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_comment"> * &lt;phk@login.dknet.dk&gt; wrote this file. As long as you retain this notice you</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_comment"> * can do whatever you want with this stuff. If we meet some day, and you think</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_comment"> * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_comment"> * ----------------------------------------------------------------------------</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.codec;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Codec for &lt;a href="<a href="http://en.wikipedia.org/wiki/Crypt_(Unix)" target="alexandria_uri">http://en.wikipedia.org/wiki/Crypt_(Unix)</a>"&gt;Unix Crypt&lt;/a&gt;-style encoding. While similar to</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * Base64, it is not compatible with Base64.</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * This implementation is based on encoding algorithms found in the Apache Portable Runtime library's</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * &lt;a href="<a href="http://svn.apache.org/viewvc/apr/apr/trunk/crypto/apr_md5.c?revision=HEAD&amp;view=markup" target="alexandria_uri">http://svn.apache.org/viewvc/apr/apr/trunk/crypto/apr_md5.c?revision=HEAD&amp;view=markup</a>"&gt;apr_md5.c&lt;/a&gt;</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * implementation for its {@code crypt}-style support. The APR team in turn received inspiration for its encoding</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * implementation based on FreeBSD 3.0's {@code /usr/src/lib/libcrypt/crypt.c} implementation. The</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * accompanying license headers have been retained at the top of this source file.</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * This file and all that it contains is ASL 2.0 compatible.</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @since 1.2</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="H64" href="../../../../org/apache/shiro/codec/H64.html#H64">H64</a> {
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] itoa64 = <span class="jxr_string">"./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"</span>.toCharArray();
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">short</strong> toShort(byte b) {
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">return</strong> (<strong class="jxr_keyword">short</strong>) (b &amp; 0xff);
<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> toInt(byte[] bytes, <strong class="jxr_keyword">int</strong> offset, <strong class="jxr_keyword">int</strong> numBytes) {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">if</strong> (numBytes &lt; 1 || numBytes &gt; 4) {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"numBytes must be between 1 and 4."</span>);
<a class="jxr_linenumber" name="L59" href="#L59">59</a> }
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">int</strong> val = toShort(bytes[offset]); <em class="jxr_comment">//1st byte</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 1; i &lt; numBytes; i++) { <em class="jxr_comment">//any remaining bytes:</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">short</strong> s = toShort(bytes[offset + i]);
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">switch</strong> (i) {
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">case</strong> 1: val |= s &lt;&lt; 8; <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">case</strong> 2: val |= s &lt;&lt; 16; <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">case</strong> 3: val |= s &lt;&lt; 24; <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">return</strong> val;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
<a class="jxr_linenumber" name="L71" href="#L71">71</a>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Appends the specified character into the buffer, rethrowing any encountered</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * {@link IOException} as an {@link IllegalStateException} (since this method is used for internal</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * implementation needs and we only ever use StringBuilders, we should never encounter an IOException).</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @param buf the buffer to append to</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param c the character to append.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> append(Appendable buf, <strong class="jxr_keyword">char</strong> c) {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> buf.append(c);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Unable to append character to internal buffer."</span>, e);
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Encodes the specified integer to {@code numChars} H64-compatible characters and appends them into {@code buf}.</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @param value the integer to encode to H64-compatible characters</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @param buf the output buffer</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param numChars the number of characters the value should be converted to. 3, 2 or 1.</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> encodeAndAppend(<strong class="jxr_keyword">int</strong> value, Appendable buf, <strong class="jxr_keyword">int</strong> numChars) {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; numChars; i++) {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> append(buf, itoa64[value &amp; 0x3f]);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> value &gt;&gt;= 6;
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Encodes the specified bytes to an {@code H64}-encoded String.</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @param bytes</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @return</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String encodeToString(byte[] bytes) {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> (bytes == <strong class="jxr_keyword">null</strong> || bytes.length == 0) <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L110" href="#L110">110</a>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="L112" href="#L112">112</a>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">int</strong> length = bytes.length;
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">int</strong> remainder = length % 3;
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">int</strong> i = 0; <em class="jxr_comment">//starting byte</em>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">int</strong> last3ByteIndex = length - remainder; <em class="jxr_comment">//last byte whose index is a multiple of 3</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">for</strong>(; i &lt; last3ByteIndex; i += 3) {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">int</strong> twentyFourBit = toInt(bytes, i, 3);
<a class="jxr_linenumber" name="L120" href="#L120">120</a> encodeAndAppend(twentyFourBit, buf, 4);
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">if</strong> (remainder &gt; 0) {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_comment">//one or two bytes that we still need to encode:</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">int</strong> a = toInt(bytes, i, remainder);
<a class="jxr_linenumber" name="L125" href="#L125">125</a> encodeAndAppend(a, buf, remainder + 1);
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">return</strong> buf.toString();
<a class="jxr_linenumber" name="L128" href="#L128">128</a> }
<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>