docs wording

DESCRIPTION

@@ -23,4 +23,4 @@ URL: https://shikokuchuo.net/secretbase/,
 Encoding: UTF-8
 Depends: 
     R (>= 3.5)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1

R/base.R

@@ -36,8 +36,6 @@
 #'
 #' @useDynLib secretbase, .registration = TRUE
 #'
-#' @docType package
-#'
 "_PACKAGE"
 
 # secretbase - Main Functions --------------------------------------------------
@@ -47,11 +45,10 @@
 #' Returns a SHA-3 hash of the supplied R object.
 #'
 #' @param x an object.
-#' @param bits [default 256L] output size of the returned hash - uses the
-#'     relevant SHA-3 hash function if one of 224, 256, 384 or 512, or
-#'     else the SHAKE256 extendable-output function (XOF) for arbitrary values.
-#'     The supplied value must be between 8 and 2^24, and is automatically
-#'     coerced to integer.
+#' @param bits [default 256L] output size of the returned hash. If one of 224,
+#'     256, 384 or 512, uses the relevant SHA-3 cryptographic hash function. For
+#'     other values, uses the SHAKE256 extendable-output function (XOF). The
+#'     supplied value must be between 8 and 2^24, and is coerced to integer.
 #' @param convert [default TRUE] if TRUE, the hash is converted to its hex
 #'     representation as a character string, if FALSE, output directly as a raw
 #'     vector, or if NA, a vector of (32-bit) integer values.

README.Rmd

@@ -67,7 +67,7 @@ sha3("", bits = 512)
 Hash arbitrary R objects:
 
  - done in-place, in a 'streaming' fashion, by R serialization but without allocation of the serialized object
- - ensures portability by always using R serialization version 3, big endian representation, skipping the headers
+ - ensures portability by always using R serialization version 3, big endian representation, skipping the headers (which contain R version and native encoding information)
 
 ```{r streaming}
 sha3(data.frame(a = 1, b = 2), bits = 160)

README.md

@@ -71,7 +71,8 @@ Hash arbitrary R objects:
 - done in-place, in a ‘streaming’ fashion, by R serialization but
   without allocation of the serialized object
 - ensures portability by always using R serialization version 3, big
-  endian representation, skipping the headers
+  endian representation, skipping the headers (which contain R version
+  and native encoding information)
 
 ``` r
 sha3(data.frame(a = 1, b = 2), bits = 160)

src/secret.c

@@ -241,34 +241,39 @@ SEXP secretbase_sha3(SEXP x, SEXP bits, SEXP convert) {
   const int size = Rf_asInteger(bits);
   if (size < 8 || size > (1 << 24))
     Rf_error("'bits' must be between 8 and 2^24");
-
   const size_t outlen = (size_t) (size / 8);
   unsigned char output[outlen];
+
   mbedtls_sha3_id id;
+  mbedtls_sha3_context ctx;
   SEXP out;
 
   switch (size) {
   case 224:
-    id = MBEDTLS_SHA3_224; break;
+    id = MBEDTLS_SHA3_224;
+    break;
   case 256:
-    id = MBEDTLS_SHA3_256; break;
+    id = MBEDTLS_SHA3_256;
+    break;
   case 384:
-    id = MBEDTLS_SHA3_384; break;
+    id = MBEDTLS_SHA3_384;
+    break;
   case 512:
-    id = MBEDTLS_SHA3_512; break;
+    id = MBEDTLS_SHA3_512;
+    break;
   default:
-    id = MBEDTLS_SHA3_SHAKE256; break;
+    id = MBEDTLS_SHA3_SHAKE256;
+    break;
   }
 
-  mbedtls_sha3_context ctx;
   mbedtls_sha3_init(&ctx);
   mbedtls_sha3_starts(&ctx, id);
 
   switch (TYPEOF(x)) {
   case STRSXP:
     if (XLENGTH(x) == 1 && ATTRIB(x) == R_NilValue) {
       const char *s = CHAR(STRING_ELT(x, 0));
-      mbedtls_sha3_update(&ctx, (const uint8_t *) s, (size_t) strlen(s));
+      mbedtls_sha3_update(&ctx, (const uint8_t *) s, strlen(s));
       goto finish;
     }
     break;
@@ -300,7 +305,7 @@ SEXP secretbase_sha3(SEXP x, SEXP bits, SEXP convert) {
   finish:
 
   mbedtls_sha3_finish(&ctx, output, outlen);
-
+  
   switch (conv) {
   case 0:
     out = Rf_allocVector(RAWSXP, outlen);
@@ -312,8 +317,8 @@ SEXP secretbase_sha3(SEXP x, SEXP bits, SEXP convert) {
   default:
     out = Rf_allocVector(INTSXP, outlen / sizeof(int));
     memcpy(STDVEC_DATAPTR(out), output, outlen);
+    break;
   }
-
   return out;
 
 }