From 4845ebe52fb11899efb0882b11b9de1f60a3e1d5 Mon Sep 17 00:00:00 2001 From: RunasSudo Date: Sun, 13 Jun 2021 03:15:15 +1000 Subject: [PATCH] Implement --ties random --- Cargo.lock | 63 ++++++++++++++++++++++++++++++++++++++++++++++++ Cargo.toml | 1 + docs/rng.md | 11 +++++++++ html/index.html | 4 +-- html/index.js | 8 ++++++ src/election.rs | 3 +++ src/lib.rs | 1 + src/main.rs | 5 ++++ src/sharandom.rs | 63 ++++++++++++++++++++++++++++++++++++++++++++++++ src/stv/mod.rs | 20 +++++++++++---- src/stv/wasm.rs | 15 ++++++++++-- src/ties.rs | 11 ++++++--- 12 files changed, 192 insertions(+), 13 deletions(-) create mode 100644 docs/rng.md create mode 100644 src/sharandom.rs diff --git a/Cargo.lock b/Cargo.lock index eea7a63..de66d59 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -38,6 +38,15 @@ version = "1.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693" +[[package]] +name = "block-buffer" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4152116fd6e9dadb291ae18fc1ec3575ed6d84c29642d97890f4b4a3417297e4" +dependencies = [ + "generic-array", +] + [[package]] name = "bstr" version = "0.2.16" @@ -122,6 +131,15 @@ version = "0.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6245d59a3e82a7fc217c5828a6692dbc6dfb63a0c8c90495621f7b9d79704a0e" +[[package]] +name = "cpufeatures" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed00c67cb5d0a7d64a44f6ad2668db7e7530311dd53ea79bcd4fb022c64911c8" +dependencies = [ + "libc", +] + [[package]] name = "crc32fast" version = "1.2.1" @@ -171,6 +189,15 @@ version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "524cbf6897b527295dff137cec09ecf3a05f4fddffd7dfcd1585403449e74198" +[[package]] +name = "digest" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3dd60d1080a57a05ab032377049e0591415d2b31afd7028356dbf3cc6dcb066" +dependencies = [ + "generic-array", +] + [[package]] name = "doc-comment" version = "0.3.3" @@ -195,6 +222,16 @@ dependencies = [ "miniz_oxide", ] +[[package]] +name = "generic-array" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "501466ecc8a30d1d3b7fc9229b122b2ce8ed6e9d9223f1138d4babb253e51817" +dependencies = [ + "typenum", + "version_check", +] + [[package]] name = "git-version" version = "0.3.4" @@ -368,6 +405,12 @@ dependencies = [ "autocfg", ] +[[package]] +name = "opaque-debug" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "624a8340c38c1b80fd549087862da4ba43e08858af025b236e509b6649fc13d5" + [[package]] name = "opentally" version = "0.1.0" @@ -387,6 +430,7 @@ dependencies = [ "num-traits", "paste", "rug", + "sha2", "wasm-bindgen", "xmltree", ] @@ -524,6 +568,19 @@ version = "1.0.126" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ec7505abeacaec74ae4778d9d9328fe5a5d04253220a85c4ee022239fc996d03" +[[package]] +name = "sha2" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b362ae5752fd2137731f9fa25fd4d9058af34666ca1966fb969119cc35719f12" +dependencies = [ + "block-buffer", + "cfg-if 1.0.0", + "cpufeatures", + "digest", + "opaque-debug", +] + [[package]] name = "static_assertions" version = "1.1.0" @@ -553,6 +610,12 @@ version = "0.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a7f741b240f1a48843f9b8e0444fb55fb2a4ff67293b50a9179dfd5ea67f8d41" +[[package]] +name = "typenum" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "879f6906492a7cd215bfa4cf595b600146ccfac0c79bcbd1f3000162af5e8b06" + [[package]] name = "unicode-segmentation" version = "1.7.1" diff --git a/Cargo.toml b/Cargo.toml index 76fb725..83eca80 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -13,6 +13,7 @@ git-version = "0.3.4" ibig = "0.3.2" itertools = "0.10.1" num-traits = "0.2" +sha2 = "0.9.5" wasm-bindgen = "0.2.74" # Only for WebAssembly - include here for syntax highlighting diff --git a/docs/rng.md b/docs/rng.md new file mode 100644 index 0000000..9ed5405 --- /dev/null +++ b/docs/rng.md @@ -0,0 +1,11 @@ +# Deterministic random number generator specification + +The deterministic random number generator used in OpenTally is based on an algorithm by [Ronald L Rivest](https://people.csail.mit.edu/rivest/sampler.py). + +The algorithm takes a *seed* value, which is an arbitrary character string. The algorithm has, in its internal state, a *counter*, whose value is initially 0. + +In order to generate a value between 0 (inclusive) and *n* (exclusive), to the state is appended a comma (",") followed by the value of the counter, and a SHA-256 hash *H* is computed of the resulting string encoded using UTF-8. The hash *H* is represented as an unsigned hexadecimal integer, *k*. The counter is incremented by 1. + +In order to avoid modulo bias, if *k* ≥ ⌊*M*/*n*⌋ × *n* (where *M* = 2^256), *k* is discarded and the algorithm is repeated. + +Otherwise, the result is *k* modulo *n*. diff --git a/html/index.html b/html/index.html index 4f9964d..22eb9af 100644 --- a/html/index.html +++ b/html/index.html @@ -127,10 +127,10 @@ - +