| <!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>Base64 xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/shiro/codec/Base64.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> <strong class="jxr_keyword">package</strong> org.apache.shiro.codec; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment"> * Provides <a href="<a href="http://en.wikipedia.org/wiki/Base64" target="alexandria_uri">http://en.wikipedia.org/wiki/Base64</a>">Base 64</a> encoding and decoding as defined by</em> |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.ietf.org/rfc/rfc2045.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc2045.txt</a>">RFC 2045</a>.</em> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> from RFC 2045 <cite>Multipurpose</em> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies</cite> by Freed and Borenstein.</em> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * This class was borrowed from Apache Commons Codec SVN repository (rev. 618419) with modifications</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * to enable Base64 conversion without a full dependency on Commons Codec. We didn't want to reinvent the wheel of</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * great work they've done, but also didn't want to force every Shiro user to depend on the commons-codec.jar</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * As per the Apache 2.0 license, the original copyright notice and all author and copyright information have</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * remained in tact.</em> |
| <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"> * @see <a href="<a href="http://en.wikipedia.org/wiki/Base64" target="alexandria_uri">http://en.wikipedia.org/wiki/Base64</a>">Wikipedia: Base 64</a></em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://www.ietf.org/rfc/rfc2045.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc2045.txt</a>">RFC 2045</a></em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @since 0.9</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="Base64" href="../../../../org/apache/shiro/codec/Base64.html#Base64">Base64</a> { |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Chunk size per RFC 2045 section 6.8.</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * The character limit does not count the trailing CRLF, but counts all other characters, including any</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * equal signs.</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://www.ietf.org/rfc/rfc2045.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc2045.txt</a>">RFC 2045 section 6.8</a></em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> CHUNK_SIZE = 76; |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * Chunk separator per RFC 2045 section 2.1.</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://www.ietf.org/rfc/rfc2045.txt" target="alexandria_uri">http://www.ietf.org/rfc/rfc2045.txt</a>">RFC 2045 section 2.1</a></em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] CHUNK_SEPARATOR = <span class="jxr_string">"\r\n"</span>.getBytes(); |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * The base length.</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> BASELENGTH = 255; |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Lookup length.</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> LOOKUPLENGTH = 64; |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Used to calculate the number of bits in a byte.</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> EIGHTBIT = 8; |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * Used when encoding something which has fewer than 24 bits.</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> SIXTEENBIT = 16; |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * Used to determine how many bits data contains.</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> TWENTYFOURBITGROUP = 24; |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * Used to get the number of Quadruples.</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> FOURBYTE = 4; |
| <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"> * Used to test the sign of a byte.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> SIGN = -128; |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Byte used to pad output.</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte PAD = (byte) '='; |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * Contains the Base64 values <code>0</code> through <code>63</code> accessed by using character encodings as</em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * indices.</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * <p>For example, <code>base64Alphabet['+']</code> returns <code>62</code>.</p></em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <p>The value of undefined encodings is <code>-1</code>.</p></em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] base64Alphabet = <strong class="jxr_keyword">new</strong> byte[BASELENGTH]; |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * <p>Contains the Base64 encodings <code>A</code> through <code>Z</code>, followed by <code>a</code> through</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * <code>z</code>, followed by <code>0</code> through <code>9</code>, followed by <code>+</code>, and</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * <code>/</code>.</p></em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * <p>This array is accessed by using character values as indices.</p></em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * <p/></em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * <p>For example, <code>lookUpBase64Alphabet[62] </code> returns <code>'+'</code>.</p></em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] lookUpBase64Alphabet = <strong class="jxr_keyword">new</strong> byte[LOOKUPLENGTH]; |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_comment">// Populating the lookup and character arrays</em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">static</strong> { |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < BASELENGTH; i++) { |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> base64Alphabet[i] = (byte) -1; |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> } |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 'Z'; i >= 'A'; i--) { |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> base64Alphabet[i] = (byte) (i - 'A'); |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> } |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 'z'; i >= 'a'; i--) { |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> base64Alphabet[i] = (byte) (i - 'a' + 26); |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> } |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = '9'; i >= '0'; i--) { |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> base64Alphabet[i] = (byte) (i - '0' + 52); |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> } |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> base64Alphabet['+'] = 62; |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> base64Alphabet['/'] = 63; |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i <= 25; i++) { |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> lookUpBase64Alphabet[i] = (byte) ('A' + i); |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> } |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 26, j = 0; i <= 51; i++, j++) { |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> lookUpBase64Alphabet[i] = (byte) ('a' + j); |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> } |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 52, j = 0; i <= 61; i++, j++) { |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> lookUpBase64Alphabet[i] = (byte) ('0' + j); |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> } |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> lookUpBase64Alphabet[62] = (byte) '+'; |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> lookUpBase64Alphabet[63] = (byte) '/'; |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> } |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * Returns whether or not the <code>octet</code> is in the base 64 alphabet.</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * @param octect The value to test</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the value is defined in the the base 64 alphabet, <code>false</code> otherwise.</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isBase64(byte octect) { |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">if</strong> (octect == PAD) { |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> } <strong class="jxr_keyword">else</strong> <em class="jxr_comment">//noinspection RedundantIfStatement</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> (octect < 0 || base64Alphabet[octect] == -1) { |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> } |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> } |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @param arrayOctect byte array to test</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * empty; false, otherwise</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isBase64(byte[] arrayOctect) { |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> arrayOctect = discardWhitespace(arrayOctect); |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">int</strong> length = arrayOctect.length; |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (length == 0) { |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_comment">// shouldn't a 0 length array be valid base64 data?</em> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_comment">// return false;</em> |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> } |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < length; i++) { |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">if</strong> (!isBase64(arrayOctect[i])) { |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> } |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> } |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> } |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * Discards any whitespace from a base-64 encoded block.</em> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * @param data The base-64 encoded data to discard the whitespace from.</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * @return The data, less whitespace (see RFC 2045).</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">static</strong> byte[] discardWhitespace(byte[] data) { |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> byte groomedData[] = <strong class="jxr_keyword">new</strong> byte[data.length]; |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">int</strong> bytesCopied = 0; |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">for</strong> (byte aByte : data) { |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">switch</strong> (aByte) { |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">case</strong> (byte) ' ': |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">case</strong> (byte) '\n': |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">case</strong> (byte) '\r': |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">case</strong> (byte) '\t': |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">default</strong>: |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> groomedData[bytesCopied++] = aByte; |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> } |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> } |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> byte packedData[] = <strong class="jxr_keyword">new</strong> byte[bytesCopied]; |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> System.arraycopy(groomedData, 0, packedData, 0, bytesCopied); |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">return</strong> packedData; |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> } |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * Base64 encodes the specified byte array and then encodes it as a String using Shiro's preferred character</em> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * encoding (UTF-8).</em> |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * @param bytes the byte array to Base64 encode.</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * @return a UTF-8 encoded String of the resulting Base64 encoded byte array.</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String encodeToString(byte[] bytes) { |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> byte[] encoded = encode(bytes); |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">return</strong> CodecSupport.toString(encoded); |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> } |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks</em> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * @param binaryData binary data to encodeToChars</em> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * @return Base64 characters chunked in 76 character blocks</em> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> byte[] encodeChunked(byte[] binaryData) { |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">return</strong> encode(binaryData, <strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> } |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.</em> |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * @param pArray a byte array containing binary data</em> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * @return A byte array containing only Base64 character data</em> |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> byte[] encode(byte[] pArray) { |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">return</strong> encode(pArray, false); |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> } |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.</em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * @param binaryData Array containing binary data to encodeToChars.</em> |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * @param isChunked if <code>true</code> this encoder will chunk the base64 output into 76 character blocks</em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * @return Base64-encoded data.</em> |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException Thrown when the input array needs an output array bigger than {@link Integer#MAX_VALUE}</em> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> byte[] encode(byte[] binaryData, <strong class="jxr_keyword">boolean</strong> isChunked) { |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">long</strong> binaryDataLength = binaryData.length; |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">long</strong> lengthDataBits = binaryDataLength * EIGHTBIT; |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">long</strong> fewerThan24bits = lengthDataBits % TWENTYFOURBITGROUP; |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">long</strong> tripletCount = lengthDataBits / TWENTYFOURBITGROUP; |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">long</strong> encodedDataLengthLong; |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">int</strong> chunckCount = 0; |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">if</strong> (fewerThan24bits != 0) { |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_comment">// data not divisible by 24 bit</em> |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> encodedDataLengthLong = (tripletCount + 1) * 4; |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_comment">// 16 or 8 bit</em> |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> encodedDataLengthLong = tripletCount * 4; |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> } |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_comment">// If the output is to be "chunked" into 76 character sections,</em> |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_comment">// for compliance with RFC 2045 MIME, then it is important to</em> |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_comment">// allow for extra length to account for the separator(s)</em> |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">if</strong> (isChunked) { |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> chunckCount = (CHUNK_SEPARATOR.length == 0 ? 0 : (<strong class="jxr_keyword">int</strong>) Math |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> .ceil((<strong class="jxr_keyword">float</strong>) encodedDataLengthLong / CHUNK_SIZE)); |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> encodedDataLengthLong += chunckCount * CHUNK_SEPARATOR.length; |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> } |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">if</strong> (encodedDataLengthLong > Integer.MAX_VALUE) { |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException( |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <span class="jxr_string">"Input array too big, output array would be bigger than Integer.MAX_VALUE="</span> + Integer.MAX_VALUE); |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> } |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">int</strong> encodedDataLength = (<strong class="jxr_keyword">int</strong>) encodedDataLengthLong; |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> byte encodedData[] = <strong class="jxr_keyword">new</strong> byte[encodedDataLength]; |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> byte k, l, b1, b2, b3; |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">int</strong> encodedIndex = 0; |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">int</strong> dataIndex; |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">int</strong> i; |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">int</strong> nextSeparatorIndex = CHUNK_SIZE; |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">int</strong> chunksSoFar = 0; |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_comment">// log.debug("number of triplets = " + numberTriplets);</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">for</strong> (i = 0; i < tripletCount; i++) { |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> dataIndex = i * 3; |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> b1 = binaryData[dataIndex]; |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> b2 = binaryData[dataIndex + 1]; |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> b3 = binaryData[dataIndex + 2]; |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_comment">// log.debug("b1= " + b1 +", b2= " + b2 + ", b3= " + b3);</em> |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> l = (byte) (b2 & 0x0f); |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> k = (byte) (b1 & 0x03); |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> byte val1 = ((b1 & SIGN) == 0) ? (byte) (b1 >> 2) : (byte) ((b1) >> 2 ^ 0xc0); |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> byte val2 = ((b2 & SIGN) == 0) ? (byte) (b2 >> 4) : (byte) ((b2) >> 4 ^ 0xf0); |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> byte val3 = ((b3 & SIGN) == 0) ? (byte) (b3 >> 6) : (byte) ((b3) >> 6 ^ 0xfc); |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_comment">// log.debug( "val2 = " + val2 );</em> |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_comment">// log.debug( "k4 = " + (k<<4) );</em> |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_comment">// log.debug( "vak = " + (val2 | (k<<4)) );</em> |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> encodedData[encodedIndex + 1] = lookUpBase64Alphabet[val2 | (k << 4)]; |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> encodedData[encodedIndex + 2] = lookUpBase64Alphabet[(l << 2) | val3]; |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> encodedData[encodedIndex + 3] = lookUpBase64Alphabet[b3 & 0x3f]; |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> encodedIndex += 4; |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_comment">// If we are chunking, let's put a chunk separator down.</em> |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">if</strong> (isChunked) { |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_comment">// this assumes that CHUNK_SIZE % 4 == 0</em> |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">if</strong> (encodedIndex == nextSeparatorIndex) { |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> System.arraycopy(CHUNK_SEPARATOR, 0, encodedData, encodedIndex, CHUNK_SEPARATOR.length); |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> chunksSoFar++; |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> nextSeparatorIndex = (CHUNK_SIZE * (chunksSoFar + 1)) + (chunksSoFar * CHUNK_SEPARATOR.length); |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> encodedIndex += CHUNK_SEPARATOR.length; |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> } |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> } |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> } |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_comment">// form integral number of 6-bit groups</em> |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> dataIndex = i * 3; |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">if</strong> (fewerThan24bits == EIGHTBIT) { |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> b1 = binaryData[dataIndex]; |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> k = (byte) (b1 & 0x03); |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_comment">// log.debug("b1=" + b1);</em> |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_comment">// log.debug("b1<<2 = " + (b1>>2) );</em> |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> byte val1 = ((b1 & SIGN) == 0) ? (byte) (b1 >> 2) : (byte) ((b1) >> 2 ^ 0xc0); |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> encodedData[encodedIndex + 1] = lookUpBase64Alphabet[k << 4]; |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> encodedData[encodedIndex + 2] = PAD; |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> encodedData[encodedIndex + 3] = PAD; |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (fewerThan24bits == SIXTEENBIT) { |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> b1 = binaryData[dataIndex]; |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> b2 = binaryData[dataIndex + 1]; |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> l = (byte) (b2 & 0x0f); |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> k = (byte) (b1 & 0x03); |
| <a class="jxr_linenumber" name="L363" href="#L363">363</a> |
| <a class="jxr_linenumber" name="L364" href="#L364">364</a> byte val1 = ((b1 & SIGN) == 0) ? (byte) (b1 >> 2) : (byte) ((b1) >> 2 ^ 0xc0); |
| <a class="jxr_linenumber" name="L365" href="#L365">365</a> byte val2 = ((b2 & SIGN) == 0) ? (byte) (b2 >> 4) : (byte) ((b2) >> 4 ^ 0xf0); |
| <a class="jxr_linenumber" name="L366" href="#L366">366</a> |
| <a class="jxr_linenumber" name="L367" href="#L367">367</a> encodedData[encodedIndex] = lookUpBase64Alphabet[val1]; |
| <a class="jxr_linenumber" name="L368" href="#L368">368</a> encodedData[encodedIndex + 1] = lookUpBase64Alphabet[val2 | (k << 4)]; |
| <a class="jxr_linenumber" name="L369" href="#L369">369</a> encodedData[encodedIndex + 2] = lookUpBase64Alphabet[l << 2]; |
| <a class="jxr_linenumber" name="L370" href="#L370">370</a> encodedData[encodedIndex + 3] = PAD; |
| <a class="jxr_linenumber" name="L371" href="#L371">371</a> } |
| <a class="jxr_linenumber" name="L372" href="#L372">372</a> |
| <a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">if</strong> (isChunked) { |
| <a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_comment">// we also add a separator to the end of the final chunk.</em> |
| <a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">if</strong> (chunksSoFar < chunckCount) { |
| <a class="jxr_linenumber" name="L376" href="#L376">376</a> System.arraycopy(CHUNK_SEPARATOR, 0, encodedData, encodedDataLength - CHUNK_SEPARATOR.length, |
| <a class="jxr_linenumber" name="L377" href="#L377">377</a> CHUNK_SEPARATOR.length); |
| <a class="jxr_linenumber" name="L378" href="#L378">378</a> } |
| <a class="jxr_linenumber" name="L379" href="#L379">379</a> } |
| <a class="jxr_linenumber" name="L380" href="#L380">380</a> |
| <a class="jxr_linenumber" name="L381" href="#L381">381</a> <strong class="jxr_keyword">return</strong> encodedData; |
| <a class="jxr_linenumber" name="L382" href="#L382">382</a> } |
| <a class="jxr_linenumber" name="L383" href="#L383">383</a> |
| <a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * Converts the specified UTF-8 Base64 encoded String and decodes it to a resultant UTF-8 encoded string.</em> |
| <a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * @param base64Encoded a UTF-8 Base64 encoded String</em> |
| <a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * @return the decoded String, UTF-8 encoded.</em> |
| <a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String decodeToString(String base64Encoded) { |
| <a class="jxr_linenumber" name="L391" href="#L391">391</a> byte[] encodedBytes = CodecSupport.toBytes(base64Encoded); |
| <a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">return</strong> decodeToString(encodedBytes); |
| <a class="jxr_linenumber" name="L393" href="#L393">393</a> } |
| <a class="jxr_linenumber" name="L394" href="#L394">394</a> |
| <a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * Decodes the specified Base64 encoded byte array and returns the decoded result as a UTF-8 encoded.</em> |
| <a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * @param base64Encoded a Base64 encoded byte array</em> |
| <a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * @return the decoded String, UTF-8 encoded.</em> |
| <a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String decodeToString(byte[] base64Encoded) { |
| <a class="jxr_linenumber" name="L402" href="#L402">402</a> byte[] decoded = decode(base64Encoded); |
| <a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">return</strong> CodecSupport.toString(decoded); |
| <a class="jxr_linenumber" name="L404" href="#L404">404</a> } |
| <a class="jxr_linenumber" name="L405" href="#L405">405</a> |
| <a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * Converts the specified UTF-8 Base64 encoded String and decodes it to a raw Base64 decoded byte array.</em> |
| <a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * @param base64Encoded a UTF-8 Base64 encoded String</em> |
| <a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * @return the raw Base64 decoded byte array.</em> |
| <a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> byte[] decode(String base64Encoded) { |
| <a class="jxr_linenumber" name="L413" href="#L413">413</a> byte[] bytes = CodecSupport.toBytes(base64Encoded); |
| <a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">return</strong> decode(bytes); |
| <a class="jxr_linenumber" name="L415" href="#L415">415</a> } |
| <a class="jxr_linenumber" name="L416" href="#L416">416</a> |
| <a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * Decodes Base64 data into octets</em> |
| <a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * @param base64Data Byte array containing Base64 data</em> |
| <a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @return Array containing decoded data.</em> |
| <a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> byte[] decode(byte[] base64Data) { |
| <a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_comment">// RFC 2045 requires that we discard ALL non-Base64 characters</em> |
| <a class="jxr_linenumber" name="L425" href="#L425">425</a> base64Data = discardNonBase64(base64Data); |
| <a class="jxr_linenumber" name="L426" href="#L426">426</a> |
| <a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_comment">// handle the edge case, so we don't have to worry about it later</em> |
| <a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">if</strong> (base64Data.length == 0) { |
| <a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> byte[0]; |
| <a class="jxr_linenumber" name="L430" href="#L430">430</a> } |
| <a class="jxr_linenumber" name="L431" href="#L431">431</a> |
| <a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">int</strong> numberQuadruple = base64Data.length / FOURBYTE; |
| <a class="jxr_linenumber" name="L433" href="#L433">433</a> byte decodedData[]; |
| <a class="jxr_linenumber" name="L434" href="#L434">434</a> byte b1, b2, b3, b4, marker0, marker1; |
| <a class="jxr_linenumber" name="L435" href="#L435">435</a> |
| <a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_comment">// Throw away anything not in base64Data</em> |
| <a class="jxr_linenumber" name="L437" href="#L437">437</a> |
| <a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">int</strong> encodedIndex = 0; |
| <a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">int</strong> dataIndex; |
| <a class="jxr_linenumber" name="L440" href="#L440">440</a> { |
| <a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_comment">// this sizes the output array properly - rlw</em> |
| <a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">int</strong> lastData = base64Data.length; |
| <a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_comment">// ignore the '=' padding</em> |
| <a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">while</strong> (base64Data[lastData - 1] == PAD) { |
| <a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">if</strong> (--lastData == 0) { |
| <a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> byte[0]; |
| <a class="jxr_linenumber" name="L447" href="#L447">447</a> } |
| <a class="jxr_linenumber" name="L448" href="#L448">448</a> } |
| <a class="jxr_linenumber" name="L449" href="#L449">449</a> decodedData = <strong class="jxr_keyword">new</strong> byte[lastData - numberQuadruple]; |
| <a class="jxr_linenumber" name="L450" href="#L450">450</a> } |
| <a class="jxr_linenumber" name="L451" href="#L451">451</a> |
| <a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < numberQuadruple; i++) { |
| <a class="jxr_linenumber" name="L453" href="#L453">453</a> dataIndex = i * 4; |
| <a class="jxr_linenumber" name="L454" href="#L454">454</a> marker0 = base64Data[dataIndex + 2]; |
| <a class="jxr_linenumber" name="L455" href="#L455">455</a> marker1 = base64Data[dataIndex + 3]; |
| <a class="jxr_linenumber" name="L456" href="#L456">456</a> |
| <a class="jxr_linenumber" name="L457" href="#L457">457</a> b1 = base64Alphabet[base64Data[dataIndex]]; |
| <a class="jxr_linenumber" name="L458" href="#L458">458</a> b2 = base64Alphabet[base64Data[dataIndex + 1]]; |
| <a class="jxr_linenumber" name="L459" href="#L459">459</a> |
| <a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">if</strong> (marker0 != PAD && marker1 != PAD) { |
| <a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_comment">// No PAD e.g 3cQl</em> |
| <a class="jxr_linenumber" name="L462" href="#L462">462</a> b3 = base64Alphabet[marker0]; |
| <a class="jxr_linenumber" name="L463" href="#L463">463</a> b4 = base64Alphabet[marker1]; |
| <a class="jxr_linenumber" name="L464" href="#L464">464</a> |
| <a class="jxr_linenumber" name="L465" href="#L465">465</a> decodedData[encodedIndex] = (byte) (b1 << 2 | b2 >> 4); |
| <a class="jxr_linenumber" name="L466" href="#L466">466</a> decodedData[encodedIndex + 1] = (byte) (((b2 & 0xf) << 4) | ((b3 >> 2) & 0xf)); |
| <a class="jxr_linenumber" name="L467" href="#L467">467</a> decodedData[encodedIndex + 2] = (byte) (b3 << 6 | b4); |
| <a class="jxr_linenumber" name="L468" href="#L468">468</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (marker0 == PAD) { |
| <a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_comment">// Two PAD e.g. 3c[Pad][Pad]</em> |
| <a class="jxr_linenumber" name="L470" href="#L470">470</a> decodedData[encodedIndex] = (byte) (b1 << 2 | b2 >> 4); |
| <a class="jxr_linenumber" name="L471" href="#L471">471</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_comment">// One PAD e.g. 3cQ[Pad]</em> |
| <a class="jxr_linenumber" name="L473" href="#L473">473</a> b3 = base64Alphabet[marker0]; |
| <a class="jxr_linenumber" name="L474" href="#L474">474</a> decodedData[encodedIndex] = (byte) (b1 << 2 | b2 >> 4); |
| <a class="jxr_linenumber" name="L475" href="#L475">475</a> decodedData[encodedIndex + 1] = (byte) (((b2 & 0xf) << 4) | ((b3 >> 2) & 0xf)); |
| <a class="jxr_linenumber" name="L476" href="#L476">476</a> } |
| <a class="jxr_linenumber" name="L477" href="#L477">477</a> encodedIndex += 3; |
| <a class="jxr_linenumber" name="L478" href="#L478">478</a> } |
| <a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">return</strong> decodedData; |
| <a class="jxr_linenumber" name="L480" href="#L480">480</a> } |
| <a class="jxr_linenumber" name="L481" href="#L481">481</a> |
| <a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L483" href="#L483">483</a> <em class="jxr_javadoccomment"> * Discards any characters outside of the base64 alphabet, per the requirements on page 25 of RFC 2045 - "Any</em> |
| <a class="jxr_linenumber" name="L484" href="#L484">484</a> <em class="jxr_javadoccomment"> * characters outside of the base64 alphabet are to be ignored in base64 encoded data."</em> |
| <a class="jxr_linenumber" name="L485" href="#L485">485</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L486" href="#L486">486</a> <em class="jxr_javadoccomment"> * @param data The base-64 encoded data to groom</em> |
| <a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment"> * @return The data, less non-base64 characters (see RFC 2045).</em> |
| <a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">static</strong> byte[] discardNonBase64(byte[] data) { |
| <a class="jxr_linenumber" name="L490" href="#L490">490</a> byte groomedData[] = <strong class="jxr_keyword">new</strong> byte[data.length]; |
| <a class="jxr_linenumber" name="L491" href="#L491">491</a> <strong class="jxr_keyword">int</strong> bytesCopied = 0; |
| <a class="jxr_linenumber" name="L492" href="#L492">492</a> |
| <a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">for</strong> (byte aByte : data) { |
| <a class="jxr_linenumber" name="L494" href="#L494">494</a> <strong class="jxr_keyword">if</strong> (isBase64(aByte)) { |
| <a class="jxr_linenumber" name="L495" href="#L495">495</a> groomedData[bytesCopied++] = aByte; |
| <a class="jxr_linenumber" name="L496" href="#L496">496</a> } |
| <a class="jxr_linenumber" name="L497" href="#L497">497</a> } |
| <a class="jxr_linenumber" name="L498" href="#L498">498</a> |
| <a class="jxr_linenumber" name="L499" href="#L499">499</a> byte packedData[] = <strong class="jxr_keyword">new</strong> byte[bytesCopied]; |
| <a class="jxr_linenumber" name="L500" href="#L500">500</a> |
| <a class="jxr_linenumber" name="L501" href="#L501">501</a> System.arraycopy(groomedData, 0, packedData, 0, bytesCopied); |
| <a class="jxr_linenumber" name="L502" href="#L502">502</a> |
| <a class="jxr_linenumber" name="L503" href="#L503">503</a> <strong class="jxr_keyword">return</strong> packedData; |
| <a class="jxr_linenumber" name="L504" href="#L504">504</a> } |
| <a class="jxr_linenumber" name="L505" href="#L505">505</a> |
| <a class="jxr_linenumber" name="L506" href="#L506">506</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
