Add documentation to the new functions added. Fix some tests.

Fix some poorly worded older documentation statements.

Author: genio

Changes

@@ -1,6 +1,9 @@
 Change history for Sodium-FFI
 
 {{$NEXT}}
+    - Added crypto_box_seal (Thanks, Brian D Foy)
+    - Added crypto_box_seal_open (Thanks, Brian D Foy)
+    - Fixed some documentation
 
 0.008     2023-01-10
     - Update tagline to say what Sodium is.

META.json

@@ -84,7 +84,7 @@
    "provides" : {
       "Sodium::FFI" : {
          "file" : "lib/Sodium/FFI.pm",
-         "version" : "0.008"
+         "version" : "0.009"
       }
    },
    "release_status" : "stable",
@@ -99,8 +99,9 @@
          "web" : "https://github.com/genio/sodium-ffi"
       }
    },
-   "version" : "0.008",
+   "version" : "0.009",
    "x_contributors" : [
+      "brian d foy <[email protected]>",
       "Chase Whitener <[email protected]>"
    ],
    "x_generated_by_perl" : "v5.32.1",

README.md

@@ -23,7 +23,7 @@ C library. Sodium is a modern, easy-to-use software library for encryption, decr
 signatures, password hashing, and more. These bindings have been created using FFI
 via [FFI::Platypus](https://metacpan.org/pod/FFI%3A%3APlatypus).
 
-While we also intend to eventually fix [Crypt::NaCl::Sodium](https://metacpan.org/pod/Crypt%3A%3ANaCl%3A%3ASodium) so that it can use newer versions
+We also intend to eventually fix [Crypt::NaCl::Sodium](https://metacpan.org/pod/Crypt%3A%3ANaCl%3A%3ASodium) so that it can use newer versions
 of LibSodium.
 
 # Crypto Auth Functions
@@ -373,6 +373,37 @@ if ($decrypted eq $msg) {
 The [crypto\_box\_open\_easy](https://doc.libsodium.org/public-key_cryptography/authenticated_encryption#combined-mode)
 function decrypts a cipher text produced by [crypto\_box\_easy](https://metacpan.org/pod/crypto_box_easy).
 
+## crypto\_box\_seal
+
+```perl
+use Sodium::FFI qw(crypto_box_keypair crypto_box_seal);
+my ($public_key, $secret_key) = crypto_box_keypair();
+my $msg = "test";
+my $cipher_text = crypto_box_seal($msg, $public_key);
+```
+
+The [crypto\_box\_seal](https://doc.libsodium.org/public-key_cryptography/sealed_boxes)
+function encrypts a message for a recipient whose public key is provided. The
+function creates a new key pair for each message and attaches the public key
+to the ciphertext. The secret key is overwritten and is not accessible after
+this function returns.
+
+## crypto\_box\_seal\_open
+
+```perl
+use Sodium::FFI qw(crypto_box_keypair crypto_box_seal crypto_box_seal_open);
+my ($public_key, $secret_key) = crypto_box_keypair();
+my $msg = "test";
+my $cipher_text = crypto_box_seal($msg, $public_key);
+my $decrypted = crypto_box_seal_open($cipher_text, $public_key, $secret_key);
+if ($decrypted eq $msg) {
+    say "Yay!";
+}
+```
+
+The [crypto\_box\_seal\_open](https://doc.libsodium.org/public-key_cryptography/sealed_boxes)
+function decrypts a cipher text produced by [crypto\_box\_seal](https://metacpan.org/pod/crypto_box_seal).
+
 ## crypto\_box\_seed\_keypair
 
 ```perl

lib/Sodium/FFI.pm

@@ -1112,7 +1112,7 @@ C library. Sodium is a modern, easy-to-use software library for encryption, decr
 signatures, password hashing, and more. These bindings have been created using FFI
 via L<FFI::Platypus>.
 
-While we also intend to eventually fix L<Crypt::NaCl::Sodium> so that it can use newer versions
+We also intend to eventually fix L<Crypt::NaCl::Sodium> so that it can use newer versions
 of LibSodium.
 
 =head1 Crypto Auth Functions
@@ -1430,6 +1430,33 @@ function randomly generates a secret key and a corresponding public key.
 The L<crypto_box_open_easy|https://doc.libsodium.org/public-key_cryptography/authenticated_encryption#combined-mode>
 function decrypts a cipher text produced by L<crypto_box_easy>.
 
+=head2 crypto_box_seal
+
+    use Sodium::FFI qw(crypto_box_keypair crypto_box_seal);
+    my ($public_key, $secret_key) = crypto_box_keypair();
+    my $msg = "test";
+    my $cipher_text = crypto_box_seal($msg, $public_key);
+
+The L<crypto_box_seal|https://doc.libsodium.org/public-key_cryptography/sealed_boxes>
+function encrypts a message for a recipient whose public key is provided. The
+function creates a new key pair for each message and attaches the public key
+to the ciphertext. The secret key is overwritten and is not accessible after
+this function returns.
+
+=head2 crypto_box_seal_open
+
+    use Sodium::FFI qw(crypto_box_keypair crypto_box_seal crypto_box_seal_open);
+    my ($public_key, $secret_key) = crypto_box_keypair();
+    my $msg = "test";
+    my $cipher_text = crypto_box_seal($msg, $public_key);
+    my $decrypted = crypto_box_seal_open($cipher_text, $public_key, $secret_key);
+    if ($decrypted eq $msg) {
+        say "Yay!";
+    }
+
+The L<crypto_box_seal_open|https://doc.libsodium.org/public-key_cryptography/sealed_boxes>
+function decrypts a cipher text produced by L<crypto_box_seal>.
+
 =head2 crypto_box_seed_keypair
 
     use Sodium::FFI qw(crypto_box_seed_keypair crypto_sign_SEEDBYTES randombytes_buf);

t/pub_key_crypto/box.t

@@ -77,7 +77,6 @@ subtest crypto_box_seal => sub {
     is(length($priv), crypto_box_SECRETKEYBYTES, 'crypto_box_keypair: priv is right length');
 
     my $msg = "Making the hard things possible";
-    my $nonce = randombytes_buf(crypto_box_NONCEBYTES);
 
     # crypto_box_seal
     my $cipher = crypto_box_seal($msg, $pub);