Module: RbNaCl

Defined in:: lib/rbnacl.rb,
lib/rbnacl/auth.rb,
lib/rbnacl/hash.rb,
lib/rbnacl/init.rb,
lib/rbnacl/util.rb,
lib/rbnacl/random.rb,
lib/rbnacl/sodium.rb,
lib/rbnacl/version.rb,
lib/rbnacl/aead/base.rb,
lib/rbnacl/self_test.rb,
lib/rbnacl/simple_box.rb,
lib/rbnacl/hash/sha256.rb,
lib/rbnacl/hash/sha512.rb,
lib/rbnacl/hmac/sha256.rb,
lib/rbnacl/hmac/sha512.rb,
lib/rbnacl/boxes/sealed.rb,
lib/rbnacl/hash/blake2b.rb,
lib/rbnacl/serializable.rb,
lib/rbnacl/test_vectors.rb,
lib/rbnacl/password_hash.rb,
lib/rbnacl/hmac/sha512256.rb,
lib/rbnacl/key_comparator.rb,
lib/rbnacl/sodium/version.rb,
lib/rbnacl/signatures/ed25519.rb,
lib/rbnacl/password_hash/argon2.rb,
lib/rbnacl/password_hash/scrypt.rb,
lib/rbnacl/one_time_auths/poly1305.rb,
lib/rbnacl/group_elements/curve25519.rb,
lib/rbnacl/aead/chacha20poly1305_ietf.rb,
lib/rbnacl/aead/xchacha20poly1305_ietf.rb,
lib/rbnacl/aead/chacha20poly1305_legacy.rb,
lib/rbnacl/secret_boxes/xsalsa20poly1305.rb,
lib/rbnacl/signatures/ed25519/verify_key.rb,
lib/rbnacl/signatures/ed25519/signing_key.rb,
lib/rbnacl/boxes/curve25519xsalsa20poly1305.rb,
lib/rbnacl/boxes/curve25519xsalsa20poly1305/public_key.rb,
lib/rbnacl/boxes/curve25519xsalsa20poly1305/private_key.rb

Overview

NaCl/libsodium for Ruby rubocop:disable Metrics/ModuleLength

Defined Under Namespace

Modules: AEAD, Boxes, GroupElements, HMAC, Hash, Init, KeyComparator, OneTimeAuths, PasswordHash, Random, SecretBoxes, SelfTest, Serializable, Signatures, Sodium, Util Classes: Auth, BadAuthenticatorError, BadSignatureError, CryptoError, IncorrectPrimitiveError, LengthError, SelfTestFailure, SimpleBox

Constant Summary collapse

Box = Bind aliases used by the public API

Boxes::Curve25519XSalsa20Poly1305

PrivateKey =

Boxes::Curve25519XSalsa20Poly1305::PrivateKey

PublicKey =

Boxes::Curve25519XSalsa20Poly1305::PublicKey

SealedBox =

Boxes::Sealed

SecretBox =

SecretBoxes::XSalsa20Poly1305

SigningKey =

Signatures::Ed25519::SigningKey

VerifyKey =

Signatures::Ed25519::VerifyKey

GroupElement =

GroupElements::Curve25519

OneTimeAuth =

OneTimeAuths::Poly1305

VERSION = The library's version

"7.1.1"

RandomNonceBox = Backwards compatibility with the old RandomNonceBox name

SimpleBox

TEST_VECTORS = Reference library of test vectors used to verify the software is correct

{
  #
  # Curve25519 test vectors
  # Taken from the NaCl distribution
  #
  alice_private: "77076d0a7318a57d3c16c17251b26645df4c2f87ebc0992ab177fba51db92c2a",
  alice_public: "8520f0098930a754748b7ddcb43ef75a0dbf3a0d26381af4eba4a98eaa9b4e6a",
  bob_private: "5dab087e624a8a4b79e17f8b83800ee66f3bb1292618b6fd1c2f8b27ff88e0eb",
  bob_public: "de9edb7d7b7dc1b4d35b61c2ece435373f8343c85b78674dadfc7e146f882b4f",
  alice_mult_bob: "4a5d9d5ba4ce2de1728e3bf480350f25e07e21c947d19e3376f09b3c1e161742",

  #
  # Box test vectors
  # Taken from the NaCl distribution
  #
  secret_key: "1b27556473e985d462cd51197a9a46c76009549eac6474f206c4ee0844f68389",
  box_nonce: "69696ee955b62b73cd62bda875fc73d68219e0036b7a0b37",
  box_message: "be075fc53c81f2d5cf141316ebeb0c7b5228c52a4c62cbd44b66849b64244ffc" \
                     "e5ecbaaf33bd751a1ac728d45e6c61296cdc3c01233561f41db66cce314adb31" \
                     "0e3be8250c46f06dceea3a7fa1348057e2f6556ad6b1318a024a838f21af1fde" \
                     "048977eb48f59ffd4924ca1c60902e52f0a089bc76897040e082f93776384864" \
                     "5e0705",

  box_ciphertext: "f3ffc7703f9400e52a7dfb4b3d3305d98e993b9f48681273c29650ba32fc76ce" \
                     "48332ea7164d96a4476fb8c531a1186ac0dfc17c98dce87b4da7f011ec48c972" \
                     "71d2c20f9b928fe2270d6fb863d51738b48eeee314a7cc8ab932164548e526ae" \
                     "90224368517acfeabd6bb3732bc0e9da99832b61ca01b6de56244a9e88d5f9b3" \
                     "7973f622a43d14a6599b1f654cb45a74e355a5",

  #
  # Ed25519 test vectors
  # Taken from the Python test vectors: http://ed25519.cr.yp.to/python/sign.input
  #
  sign_private: "b18e1d0045995ec3d010c387ccfeb984d783af8fbb0f40fa7db126d889f6dadd",
  sign_public: "77f48b59caeda77751ed138b0ec667ff50f8768c25d48309a8f386a2bad187fb",
  sign_keypair: "b18e1d0045995ec3d010c387ccfeb984d783af8fbb0f40fa7db126d889f6dadd" \
                  "77f48b59caeda77751ed138b0ec667ff50f8768c25d48309a8f386a2bad187fb",
  sign_message: "916c7d1d268fc0e77c1bef238432573c39be577bbea0998936add2b50a653171" \
                  "ce18a542b0b7f96c1691a3be6031522894a8634183eda38798a0c5d5d79fbd01" \
                  "dd04a8646d71873b77b221998a81922d8105f892316369d5224c9983372d2313" \
                  "c6b1f4556ea26ba49d46e8b561e0fc76633ac9766e68e21fba7edca93c4c7460" \
                  "376d7f3ac22ff372c18f613f2ae2e856af40",
  sign_signature: "6bd710a368c1249923fc7a1610747403040f0cc30815a00f9ff548a896bbda0b" \
                     "4eb2ca19ebcf917f0f34200a9edbad3901b64ab09cc5ef7b9bcc3c40c0ff7509",

  #
  # SHA256 test vectors
  # Taken from the NSRL test vectors: http://www.nsrl.nist.gov/testdata/
  sha256_message: "6162636462636465636465666465666765666768666768696768696a68696a6b" \
                  "696a6b6c6a6b6c6d6b6c6d6e6c6d6e6f6d6e6f706e6f7071",
  sha256_digest: "248d6a61d20638b8e5c026930c3e6039a33ce45964ff2167f6ecedd419db06c1",
  sha256_empty: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",

  #
  # SHA512 test vectors
  # self-created (FIXME: find standard test vectors)
  sha512_message: "54686520717569636b2062726f776e20666f78206a756d7073206f7665722074" \
                  "6865206c617a7920646f672e",
  sha512_digest: "91ea1245f20d46ae9a037a989f54f1f790f0a47607eeb8a14d12890cea77a1bb" \
                  "c6c7ed9cf205e67b7f2b8fd4c7dfd3a7a8617e45f3c463d481c7e586c39ac1ed",
  sha512_empty: "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce" \
                  "47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e",

  # Blake2b test vectors
  # self-created? (TODO: double check, fix)
  blake2b_message: "54686520717569636b2062726f776e20666f78206a756d7073206f7665722074" \
                   "6865206c617a7920646f67",
  blake2b_digest: "a8add4bdddfd93e4877d2746e62817b116364a1fa7bc148d95090bc7333b3673" \
                   "f82401cf7aa2e4cb1ecd90296e3f14cb5413f8ed77be73045b13914cdcd6a918",
  blake2b_empty: "786a02f742015903c6c6fd852552d272912f4740e15847618a86e217f71f5419" \
                   "d25e1031afee585313896444934eb04b903a685b1448b755d56f701afe9be2ce",

  # from the Blake2 paper(?) (TODO: double check)
  blake2b_keyed_message: "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f" \
                         "202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f" \
                         "404142434445464748494a4b4c4d4e4f505152535455565758595a5b5c5d5e5f" \
                         "606162636465666768696a6b6c6d6e6f707172737475767778797a7b7c7d7e7f" \
                         "808182838485868788898a8b8c8d8e8f909192939495969798999a9b9c9d9e9f" \
                         "a0a1a2a3a4a5a6a7a8a9aaabacadaeafb0b1b2b3b4b5b6b7b8b9babbbcbdbebf" \
                         "c0c1c2c3c4c5c6c7c8c9cacbcccdcecfd0d1d2d3d4d5d6d7d8d9dadbdcdddedf" \
                         "e0e1e2e3e4e5e6e7e8e9eaebecedeeeff0f1f2f3f4f5f6f7f8f9fafbfcfdfe",
  blake2b_key: "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f" \
                         "202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f",
  blake2b_keyed_digest: "142709d62e28fcccd0af97fad0f8465b971e82201dc51070faa0372aa43e9248" \
                         "4be1c1e73ba10906d5d1853db6a4106e0a7bf9800d373d6dee2d46d62ef2a461",

  # Generated using the blake2 reference code
  blake2b_personal: "000102030405060708090a0b0c0d0e0f",

  blake2b_personal_digest: "7c86d3f929c9ac7f08c7940095da7c1cad2cf29db2e7a25fb05d99163e587cbd" \
                            "f3564e8ce727b734a0559ee76f6ff5aeebd4e1e8872f1829174c9b1a9dab80e3",

  blake2b_salt: "000102030405060708090a0b0c0d0e0f",

  blake2b_salt_digest: "16e2e2cfb97e6061bccf2fcc1e605e117dee806c959ef2ad01249d4d12ce98cb" \
                            "c993f400003ba57449f60a7b071ffdaff9c0acb16891a01a9b397ffe89db96bb",

  blake2b_personal_short: "0001020304050607",

  blake2b_personal_short_digest: "41b984967f852308710a6042d25f5faf4a84900b2001039075dab13aecfab7c8" \
                                 "40def9506326563fbb355b3da629181d97d2556e4624711d68f8f655b7cbb435",

  blake2b_salt_short: "0001020304050607",

  blake2b_salt_short_digest: "873f35a1ca28febc872d6f842a8cd23136f3a2c22c19e8f0dac4cc704ced3371"\
                             "abe5105f65d344cd48bad8aba755620f63f1e0b35ae4439bf871ffe72485a309",

  # scrypt test vectors
  # Taken from http://tools.ietf.org/html/draft-josefsson-scrypt-kdf-01#page-14
  scrypt_password: "4a857e2ee8aa9b6056f2424e84d24a72473378906ee04a46cb05311502d5250b" \
                   "82ad86b83c8f20a23dbb74f6da60b0b6ecffd67134d45946ac8ebfb3064294bc" \
                   "097d43ced68642bfb8bbbdd0f50b30118f5e",
  scrypt_salt: "39d82eef32010b8b79cc5ba88ed539fbaba741100f2edbeca7cc171ffeabf258",
  scrypt_opslimit: 758_010,
  scrypt_memlimit: 5_432_947,
  scrypt_digest: "bcc5c2fd785e4781d1201ed43d84925537e2a540d3de55f5812f29e9dd0a4a00" \
                   "451a5c8ddbb4862c03d45c75bf91b7fb49265feb667ad5c899fdbf2ca19eac67",

  # argon2 vectors
  # from libsodium/test/default/pwhash_argon2i.c
  argon2i_password: "a347ae92bce9f80f6f595a4480fc9c2fe7e7d7148d371e9487d75f5c23008ffae0" \
                   "65577a928febd9b1973a5a95073acdbeb6a030cfc0d79caa2dc5cd011cef02c08d" \
                   "a232d76d52dfbca38ca8dcbd665b17d1665f7cf5fe59772ec909733b24de97d6f5" \
                   "8d220b20c60d7c07ec1fd93c52c31020300c6c1facd77937a597c7a6",
  argon2i_salt: "5541fbc995d5c197ba290346d2c559de",
  argon2i_outlen: 155,
  argon2i_opslimit: 5,
  argon2i_memlimit: 7_256_678,
  argon2i_digest: "23b803c84eaa25f4b44634cc1e5e37792c53fcd9b1eb20f865329c68e09cbfa9f19" \
                   "68757901b383fce221afe27713f97914a041395bbe1fb70e079e5bed2c7145b1f61" \
                   "54046f5958e9b1b29055454e264d1f2231c316f26be2e3738e83a80315e9a0951ce" \
                   "4b137b52e7d5ee7b37f7d936dcee51362bcf792595e3c896ad5042734fc90c92cae" \
                   "572ce63ff659a2f7974a3bd730d04d525d253ccc38",

  # from libsodium/test/default/pwhash_argon2id.c
  argon2id_password: "a347ae92bce9f80f6f595a4480fc9c2fe7e7d7148d371e9487d75f5c23008ffae0" \
                     "65577a928febd9b1973a5a95073acdbeb6a030cfc0d79caa2dc5cd011cef02c08d" \
                     "a232d76d52dfbca38ca8dcbd665b17d1665f7cf5fe59772ec909733b24de97d6f5" \
                     "8d220b20c60d7c07ec1fd93c52c31020300c6c1facd77937a597c7a6",
  argon2id_salt: "5541fbc995d5c197ba290346d2c559de",
  argon2id_outlen: 155,
  argon2id_opslimit: 5,
  argon2id_memlimit: 7_256_678,
  argon2id_digest: "18acec5d6507739f203d1f5d9f1d862f7c2cdac4f19d2bdff64487e60d969e3ced6" \
                     "15337b9eec6ac4461c6ca07f0939741e57c24d0005c7ea171a0ee1e7348249d135b" \
                     "38f222e4dad7b9a033ed83f5ca27277393e316582033c74affe2566a2bea47f91f0" \
                     "fd9fe49ece7e1f79f3ad6e9b23e0277c8ecc4b313225748dd2a80f5679534a0700e" \
                     "246a79a49b3f74eb89ec6205fe1eeb941c73b1fcf1",

  # argon2_str vectors
  # from libsodium/test/default/pwhash.c
  argon2_str_digest: "$argon2i$v=19$m=4096,t=3,p=2$b2RpZHVlamRpc29kaXNrdw" \
                     "$TNnWIwlu1061JHrnCqIAmjs3huSxYIU+0jWipu7Kc9M",
  argon2_str_passwd: "password",

  # Auth test vectors
  # Taken from NaCl distribution
  #
  auth_key_32: "eea6a7251c1e72916d11c2cb214d3c252539121d8e234e652d651fa4c8cff880",
  auth_key_64: "eaaa4c73ef13e7e9a53011304c5be141da9c3713b5ca822037ed57aded31b70a" \
                "50a0dd80843d580fe5b57e470bb534333e907a624cf02873c6b9eaba70e0fc7e",
  auth_message: "8e993b9f48681273c29650ba32fc76ce48332ea7164d96a4476fb8c531a1186a" \
                "c0dfc17c98dce87b4da7f011ec48c97271d2c20f9b928fe2270d6fb863d51738" \
                "b48eeee314a7cc8ab932164548e526ae90224368517acfeabd6bb3732bc0e9da" \
                "99832b61ca01b6de56244a9e88d5f9b37973f622a43d14a6599b1f654cb45a74" \
                "e355a5",
  auth_onetime: "f3ffc7703f9400e52a7dfb4b3d3305d9",
  # self-created (FIXME: find standard test vectors)
  auth_hmacsha256: "7f7b9b707e8790ca8620ff94df5e6533ddc8e994060ce310c9d7de04d44aabc3",
  auth_hmacsha512256: "b2a31b8d4e01afcab2ee545b5caf4e3d212a99d7b3a116a97cec8e83c32e107d",
  auth_hmacsha512: "b2a31b8d4e01afcab2ee545b5caf4e3d212a99d7b3a116a97cec8e83c32e107d" \
                      "270e3921f69016c267a63ab4b226449a0dee0dc7dcb897a9bce9d27d788f8e8d",

  # HMAC-SHA Identifiers and Test Vectors
  # ref: https://tools.ietf.org/html/rfc4231#section-4.8
  #
  auth_hmac_key: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
                          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
                          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
                          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
                          "aaaaaa",
  auth_hmac_data: "5468697320697320612074657374207573696e672061206c6172676572207468" \
                          "616e20626c6f636b2d73697a65206b657920616e642061206c61726765722074" \
                          "68616e20626c6f636b2d73697a6520646174612e20546865206b6579206e6565" \
                          "647320746f20626520686173686564206265666f7265206265696e6720757365" \
                          "642062792074686520484d414320616c676f726974686d2e",
  auth_hmacsha256_tag: "9b09ffa71b942fcb27635fbcd5b0e944bfdc63644f0713938a7f51535c3a35e2",
  auth_hmacsha512_tag: "e37b6a775dc87dbaa4dfa9f96e5e3ffddebd71f8867289865df5a32d20cdc944" \
                          "b6022cac3c4982b10d5eeb55c3e4de15134676fb6de0446065c97440fa8c6a58",
  auth_hmacsha512256_tag: "bfaae3b4292b56d6170154cc089af73f79e089ecf27d4720eed6fd0a7ffcccf1",

  auth_hmacsha256_mult_tag: "367a7a7e8292759844dcf820c90daa5fea5a4b769e537038cd0dc28290fbf2cb",
  auth_hmacsha512_mult_tag: "1006b7bef1e24725ed55049c8b787b7b174f4afbe197124a389205c499956a90" \
                            "fea5c44b616a9e1a286d024c2880c67ae0e1ec7524530f15ae1086b144192d93",
  auth_hmacsha512256_mult_tag: "bf280508996bba2bd590a2c1662d8c47fcceb8111bfcc4bdff5f2c28b0301449",
  # AEAD ChaCha20-Poly1305 original implementation test vectors
  # Taken from https://tools.ietf.org/html/draft-agl-tls-chacha20poly1305-04
  aead_chacha20poly1305_orig_key: "4290bcb154173531f314af57f3be3b5006da371ece272afa1b5dbdd1100a1007",
  aead_chacha20poly1305_orig_message: "86d09974840bded2a5ca",
  aead_chacha20poly1305_orig_nonce: "cd7cf67be39c794a",
  aead_chacha20poly1305_orig_ad: "87e229d4500845a079c0",
  aead_chacha20poly1305_orig_ciphertext: "e3e446f7ede9a19b62a4677dabf4e3d24b876bb284753896e1d6",

  # AEAD ChaCha20-Poly1305 IETF test vectors
  # Taken from https://tools.ietf.org/html/rfc7539
  aead_chacha20poly1305_ietf_key: "808182838485868788898a8b8c8d8e8f909192939495969798999a9b9c9d9e9f",
  aead_chacha20poly1305_ietf_message: "4c616469657320616e642047656e746c656d656e206f662074686520636c6173" \
                                              "73206f66202739393a204966204920636f756c64206f6666657220796f75206f" \
                                              "6e6c79206f6e652074697020666f7220746865206675747572652c2073756e73" \
                                              "637265656e20776f756c642062652069742e",
  aead_chacha20poly1305_ietf_nonce: "070000004041424344454647",
  aead_chacha20poly1305_ietf_ad: "50515253c0c1c2c3c4c5c6c7",
  aead_chacha20poly1305_ietf_ciphertext: "d31a8d34648e60db7b86afbc53ef7ec2a4aded51296e08fea9e2b5a736ee62d6" \
                                              "3dbea45e8ca9671282fafb69da92728b1a71de0a9e060b2905d6a5b67ecd3b36" \
                                              "92ddbd7f2d778b8c9803aee328091b58fab324e4fad675945585808b4831d7bc" \
                                              "3ff4def08e4b7a9de576d26586cec64b61161ae10b594f09e26a7e902ecbd060" \
                                              "0691",

  # Jank AEAD XChaCha20-Poly1305 test vectors
  # Unfortunately, I couldn't find any public variants of these, so I used:
  # https://github.com/jedisct1/libsodium/blob/1.0.16/test/default/aead_xchacha20poly1305.c
  # Doubly unfortunately, that doesn't even have a ciphertext vector. I
  # generated one using crypto_aead_xchacha20poly1305_ietf_encrypt on
  # libsodium 1.0.16
  aead_xchacha20poly1305_ietf_key: "808182838485868788898a8b8c8d8e8f909192939495969798999a9b9c9d9e9f",
  aead_xchacha20poly1305_ietf_message: "4c616469657320616e642047656e746c656d656e206f662074686520636c6173" \
                                              "73206f66202739393a204966204920636f756c64206f6666657220796f75206f" \
                                              "6e6c79206f6e652074697020666f7220746865206675747572652c2073756e73" \
                                              "637265656e20776f756c642062652069742e",
  aead_xchacha20poly1305_ietf_nonce: "07000000404142434445464748494a4b0000000000000000",
  aead_xchacha20poly1305_ietf_ad: "50515253c0c1c2c3c4c5c6c7",
  aead_xchacha20poly1305_ietf_ciphertext: "453c0693a7407f04ff4c56aedb17a3c0a1afff01174930fc22287c33dbcf0ac8" \
                                              "b89ad929530a1bb3ab5e69f24c7f6070c8f840c9abb4f69fbfc8a7ff5126faee" \
                                              "bbb55805ee9c1cf2ce5a57263287aec5780f04ec324c3514122cfc3231fc1a8b" \
                                              "718a62863730a2702bb76366116bed09e0fd5c6d84b6b0c1abaf249d5dd0f7f5" \
                                              "a7ea"
}.freeze