From bc2b1b7df1e1ff91de067735265d7b4edad8509f Mon Sep 17 00:00:00 2001
From: shikokuchuo <53399081+shikokuchuo@users.noreply.github.com>
Date: Sat, 20 Jan 2024 13:54:17 +0000
Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20shikokuc?=
 =?UTF-8?q?huo/secretbase@51a14f067e7acccbae089bbe12dcbb47652e535a=20?=
 =?UTF-8?q?=F0=9F=9A=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 index.html          | 21 ++++++++++++++++-----
 pkgdown.yml         |  2 +-
 reference/sha3.html | 17 ++++++++++-------
 3 files changed, 27 insertions(+), 13 deletions(-)

diff --git a/index.html b/index.html
index 294f12e..e84e26e 100644
--- a/index.html
+++ b/index.html
@@ -97,7 +97,7 @@ <h3 id="installation">Installation<a class="anchor" aria-label="anchor" href="#i
 <div class="section level3">
 <h3 id="quick-start">Quick Start<a class="anchor" aria-label="anchor" href="#quick-start"></a>
 </h3>
-<p><code>secretbase</code> offers one main function <code><a href="reference/sha3.html">sha3()</a></code>:</p>
+<p><code>secretbase</code> offers one main function: <code><a href="reference/sha3.html">sha3()</a></code></p>
 <p>To use:</p>
 <ul>
 <li>SHA-3 cryptographic hash algorithm, specify ‘size’ as one of ‘224’, ‘256’, ‘384’ or ‘512’.</li>
@@ -116,13 +116,24 @@ <h3 id="quick-start">Quick Start<a class="anchor" aria-label="anchor" href="#qui
 <span><span class="fu"><a href="reference/sha3.html">sha3</a></span><span class="op">(</span><span class="st">"秘密の基地の中"</span>, size <span class="op">=</span> <span class="fl">224</span><span class="op">)</span></span>
 <span><span class="co">#&gt; [1] "d9e291d0c9f3dc3007dc0c111aea0b6a938929c8b4766332d8ea791a"</span></span>
 <span></span>
-<span><span class="fu"><a href="reference/sha3.html">sha3</a></span><span class="op">(</span><span class="st">"秘密の基地の中"</span>, size <span class="op">=</span> <span class="fl">512</span><span class="op">)</span></span>
-<span><span class="co">#&gt; [1] "e30cdc73f6575c40d55b5edc8eb4f97940f5ca491640b41612e02a05f3e59dd9c6c33f601d8d7a8e2ca0504b8c22f7bc69fa8f10d7c01aab392781ff4ae1e610"</span></span></code></pre></div>
-<p>To:</p>
+<span><span class="fu"><a href="reference/sha3.html">sha3</a></span><span class="op">(</span><span class="st">""</span>, size <span class="op">=</span> <span class="fl">512</span><span class="op">)</span></span>
+<span><span class="co">#&gt; [1] "a69f73cca23a9ac5c8b567dc185a756e97c982164fe25859e0d1dcc1475c80a615b2123af1f5f94c11e3e9402c3ac558f500199d95b6d3e301758586281dcd26"</span></span></code></pre></div>
+<p>Hash arbitrary R objects:</p>
 <ul>
-<li>hash to an integer value, specify a size of ‘32’ and pass the resulting raw vector to <code><a href="reference/read_integer.html">read_integer()</a></code>.</li>
+<li>done in-place, in a ‘streaming’ fashion, by R serialization but without allocation of the serialized object</li>
+<li>ensures portability by always using R serialization version 3, big endian representation, skipping the headers</li>
 </ul>
 <div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
+<code class="sourceCode R"><span><span class="fu"><a href="reference/sha3.html">sha3</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>a <span class="op">=</span> <span class="fl">1</span>, b <span class="op">=</span> <span class="fl">2</span><span class="op">)</span><span class="op">)</span></span>
+<span><span class="co">#&gt; [1] "05d4308e79d029b4af5604739ecc6c4efa1f602a23add0ed2d247b7407d4832f"</span></span>
+<span></span>
+<span><span class="fu"><a href="reference/sha3.html">sha3</a></span><span class="op">(</span><span class="cn">NULL</span><span class="op">)</span></span>
+<span><span class="co">#&gt; [1] "b3e37e4c5def1bfb2841b79ef8503b83d1fed46836b5b913d7c16de92966dcee"</span></span></code></pre></div>
+<p>To hash to an integer value:</p>
+<ul>
+<li>specify a size of ‘32’ and pass the resulting raw vector to <code><a href="reference/read_integer.html">read_integer()</a></code>.</li>
+</ul>
+<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
 <code class="sourceCode R"><span><span class="va">hash</span> <span class="op">&lt;-</span> <span class="fu"><a href="reference/sha3.html">sha3</a></span><span class="op">(</span><span class="st">"秘密の基地の中"</span>, size <span class="op">=</span> <span class="fl">32</span>, convert <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span>
 <span><span class="va">hash</span></span>
 <span><span class="co">#&gt; [1] 7f c2 38 77</span></span>
diff --git a/pkgdown.yml b/pkgdown.yml
index b914c36..6150b7b 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 2.19.2
 pkgdown: 2.0.7
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-01-20T13:25Z
+last_built: 2024-01-20T13:54Z
 urls:
   reference: https://shikokuchuo.net/secretbase/reference
   article: https://shikokuchuo.net/secretbase/articles
diff --git a/reference/sha3.html b/reference/sha3.html
index 4e53e15..ab48810 100644
--- a/reference/sha3.html
+++ b/reference/sha3.html
@@ -1,6 +1,6 @@
 <!DOCTYPE html>
-<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Cryptographic Hashing Using the SHA-3 Algorithm — sha3 • secretbase</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Cryptographic Hashing Using the SHA-3 Algorithm — sha3"><meta property="og:description" content="Returns a SHA-3 hash of the supplied R object. This implementation uses code
-    from the 'Mbed TLS' library, under the Trusted Firmware Project."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Cryptographic Hashing Using the SHA-3 Algorithm — sha3 • secretbase</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Cryptographic Hashing Using the SHA-3 Algorithm — sha3"><meta property="og:description" content="Returns a SHA-3 hash of the supplied R object. Uses the implementation by the
+    'Mbed TLS' library from the Trusted Firmware Project."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
 <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
 <![endif]--></head><body data-spy="scroll" data-target="#toc">
@@ -56,8 +56,8 @@ <h1>Cryptographic Hashing Using the SHA-3 Algorithm</h1>
     </div>
 
     <div class="ref-description">
-    <p>Returns a SHA-3 hash of the supplied R object. This implementation uses code
-    from the 'Mbed TLS' library, under the Trusted Firmware Project.</p>
+    <p>Returns a SHA-3 hash of the supplied R object. Uses the implementation by the
+    'Mbed TLS' library from the Trusted Firmware Project.</p>
     </div>
 
     <div id="ref-usage">
@@ -91,9 +91,12 @@ <h2>Value</h2>
     <div id="details">
     <h2>Details</h2>
     <p>For argument 'x', a scalar string or raw vector (with no attributes)
-    is hashed 'as is'. All other objects are hashed in-place, parsed by R
-    serialization version 3, big-endian representation, skipping the header
-    (for portability as this contains the R version number).</p>
+    is hashed 'as is'.</p>    
+<p>All other objects are hashed in-place, in a 'streaming' fashion by R
+    serialization but without allocation of the serialized object. To ensure
+    portability, R serialization version 3, big-endian representation is
+    always used, skipping the headers (as these contain the R version number
+    and native encoding information).</p>
 <p>The result of hashing is always a byte sequence, which is converted to a
     character string hex representation if 'convert' is TRUE, or returned as
     a raw vector if 'convert' is FALSE.</p>