use v6;
use NativeCall;
use Crypt::TweetNacl::Constants;
use Crypt::TweetNacl::Basics;

unit module Crypt::TweetNacl::SecretKey;



head

Crypt::TweetNacl::SecretKey - secret key crypto library


# create Buf to encrypt
my $msg = 'Hello World'.encode('UTF-8');


# encrypt
my $csb = CryptoSecretBox.new(sk => $alice.secret);
my $data = $csb.encrypt($msg);


# decrypt
my $csbo = CryptoSecretBoxOpen.new(sk => $alice.secret);
my $rmsg = $csbo.decrypt($data);
say $rmsg.decode('UTF-8') # 'Hello World'


In case problems arise this is reported by an exception.


Various other(not documented) classes and methods might be exported
by the library. Please ignore them.


- https://nacl.cr.yp.to/secretbox.html
- https://tweetnacl.cr.yp.to/tweetnacl-20131229.pdf





DOC INIT {
        use Pod::To::Text;
        pod2text($


# C NaCl provides a crypto_secretbox function callable as follows:

#      #include "crypto_secretbox.h"

#      const unsigned char k[crypto_secretbox_KEYBYTES];
#      const unsigned char n[crypto_secretbox_NONCEBYTES];
#      const unsigned char m[...]; unsigned long long mlen;
#      unsigned char c[...]; unsigned long long clen;

#      crypto_secretbox(c,m,mlen,n,k);

# The crypto_secretbox function encrypts and authenticates a message
# m[0], m[1], ..., m[mlen-1] using a secret key k[0], ...,
# k[crypto_secretbox_KEYBYTES-1] and a nonce n[0], n[1], ...,
# n[crypto_secretbox_NONCEBYTES-1]. The crypto_secretbox function puts
# the ciphertext into c[0], c[1], ..., c[mlen-1]. It then returns 0.

# WARNING: Messages in the C NaCl API are 0-padded versions of
# messages in the C++ NaCl API. Specifically: The caller must ensure,
# before calling the C NaCl crypto_secretbox function, that the first
# crypto_secretbox_ZEROBYTES bytes of the message m are all 0. Typical
# higher-level applications will work with the remaining bytes of the
# message; note, however, that mlen counts all of the bytes, including
# the bytes required to be 0.
# Similarly, ciphertexts in the C NaCl API are 0-padded versions of
# messages in the C++ NaCl API. Specifically: The crypto_secretbox
# function ensures that the first crypto_secretbox_BOXZEROBYTES bytes
# of the ciphertext c are all 0.


sub crypto_secretbox_int (CArray[uint8], CArray[uint8], ulonglong, CArray[uint8], CArray[uint8]) is symbol('crypto_secretbox') is native(TWEETNACL) is export returns int32 { * };

# C NaCl also provides a crypto_secretbox_open function callable as follows:

#      #include "crypto_secretbox.h"

#      const unsigned char k[crypto_secretbox_KEYBYTES];
#      const unsigned char n[crypto_secretbox_NONCEBYTES];
#      const unsigned char c[...]; unsigned long long clen;
#      unsigned char m[...];

#      crypto_secretbox_open(m,c,clen,n,k);

# The crypto_secretbox_open function verifies and decrypts a
# ciphertext c[0], c[1], ..., c[clen-1] using a secret key k[0], k[1],
# ..., k[crypto_secretbox_KEYBYTES-1] and a nonce n[0], ...,
# n[crypto_secretbox_NONCEBYTES-1]. The crypto_secretbox_open function
# puts the plaintext into m[0], m[1], ..., m[clen-1]. It then returns
# 0.

# If the ciphertext fails verification, crypto_secretbox_open instead
# returns -1, possibly after modifying m[0], m[1], etc.

# The caller must ensure, before calling the crypto_secretbox_open
# function, that the first crypto_secretbox_BOXZEROBYTES bytes of the
# ciphertext c are all 0. The crypto_secretbox_open function ensures
# (in case of success) that the first crypto_secretbox_ZEROBYTES bytes
# of the plaintext m are all 0.

sub crypto_secretbox_open_int (CArray[uint8], CArray[uint8], ulonglong, CArray[uint8], CArray[uint8]) is symbol('crypto_secretbox_open') is native(TWEETNACL) is export returns int32 { * };


class Key is export
{
    has $.secret;
    submethod BUILD()
    {
        $!secret = randombytes(CRYPTO_SECRETBOX_KEYBYTES);
    }
}

class CryptoSecretBox is export
{
    has $!key;
    submethod BUILD(CArray :$sk!)
    {
        $!key = $sk;
        if ($!key.elems != CRYPTO_SECRETBOX_KEYBYTES) {
            die "CryptoSecretBox, bad secret key lenght";
        }
    }

    multi method encrypt(Blob $buf!, CArray $nonce!)
    {
        my ulonglong $mlen = CRYPTO_SECRETBOX_ZEROBYTES + $buf.elems;
        my $data = CArray[uint8].new;
        $data[$mlen - 1] = 0;   #alloc
        my $msg  = prepend_zeros($buf, CRYPTO_SECRETBOX_ZEROBYTES);
        my $ret = crypto_secretbox_int($data, $msg, $mlen, $nonce, $!key);
        if ($ret != 0) {
            die "crypto_secretbox_int, bad return code: $ret";
        }
        return $data;
    }

    multi method encrypt(Blob $buf!)
    {
        my $nonce = nonce();
        my $data  = self.encrypt($buf, $nonce);
        my $ciph  = Ciphertext.new(zdata => $data, nonce => $nonce);
        return $ciph;
    }
}

class CryptoSecretBoxOpen is export
{
    has $!key;
    submethod BUILD(CArray :$sk!)
    {
        $!key = $sk;
        if ($!key.elems != CRYPTO_SECRETBOX_KEYBYTES) {
            die "CryptoSecretBoxOpen, bad secret key lenght";
        }
    }

    multi method decrypt(CArray $c!, CArray $nonce!)
    {
        my $msg  = CArray[uint8].new;
        my $clen = $c.elems;
        $msg[$clen - 1] = 0;    #alloc
        my $i;
        loop ($i=0; $i < CRYPTO_SECRETBOX_BOXZEROBYTES ; $i++)
        {
            if ($c[$i] != 0) {
                die "crypto_box_open, bad ciphertext";
            }
        }
        my $ret = crypto_secretbox_open_int($msg, $c, $clen, $nonce, $!key);
        if ($ret != 0) {
            die "crypto_secretbox_open_int, bad return code: $ret";

        }
        return remove_leading_elems(Buf, $msg, CRYPTO_SECRETBOX_ZEROBYTES);
    }

    multi method decrypt(Ciphertext $ciph!)
    {
        return self.decrypt($ciph.zdata, $ciph.nonce);
    }
}


root

Sign

PublicKey

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


SecretKey

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

RETURN VALUE

ERRORS

DIAGNOSTICS

EXAMPLES

ENVIRONMENT

FILES

CAVEATS

BUGS

RESTRICTIONS

NOTES

SEE ALSO

AUTHOR

HISTORY