{
    "mode": "perldoc",
    "parameter": "Crypt::AuthEnc::ChaCha20Poly1305",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Crypt%3A%3AAuthEnc%3A%3AChaCha20Poly1305/json",
    "generated": "2026-06-11T21:29:20Z",
    "synopsis": "### OO interface\nuse Crypt::AuthEnc::ChaCha20Poly1305;\n# encrypt and authenticate\nmy $ae = Crypt::AuthEnc::ChaCha20Poly1305->new($key, $iv);\n$ae->adataadd('additionalauthenticateddata1');\n$ae->adataadd('additionalauthenticateddata2');\nmy $ct = $ae->encryptadd('data1');\n$ct .= $ae->encryptadd('data2');\n$ct .= $ae->encryptadd('data3');\nmy $tag = $ae->encryptdone();\n# decrypt and verify\nmy $ae = Crypt::AuthEnc::ChaCha20Poly1305->new($key, $iv);\n$ae->adataadd('additionalauthenticateddata1');\n$ae->adataadd('additionalauthenticateddata2');\nmy $pt = $ae->decryptadd('ciphertext1');\n$pt .= $ae->decryptadd('ciphertext2');\n$pt .= $ae->decryptadd('ciphertext3');\nmy $tag = $ae->decryptdone();\ndie \"decrypt failed\" unless $tag eq $expectedtag;\n#or\nmy $result = $ae->decryptdone($expectedtag); # 0 or 1\n### functional interface\nuse Crypt::AuthEnc::ChaCha20Poly1305 qw(chacha20poly1305encryptauthenticate chacha20poly1305decryptverify);\nmy ($ciphertext, $tag) = chacha20poly1305encryptauthenticate($key, $iv, $adata, $plaintext);\nmy $plaintext = chacha20poly1305decryptverify($key, $iv, $adata, $ciphertext, $tag);",
    "sections": {
        "NAME": {
            "content": "Crypt::AuthEnc::ChaCha20Poly1305 - Authenticated encryption in ChaCha20-Poly1305 mode\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "### OO interface\nuse Crypt::AuthEnc::ChaCha20Poly1305;\n\n# encrypt and authenticate\nmy $ae = Crypt::AuthEnc::ChaCha20Poly1305->new($key, $iv);\n$ae->adataadd('additionalauthenticateddata1');\n$ae->adataadd('additionalauthenticateddata2');\nmy $ct = $ae->encryptadd('data1');\n$ct .= $ae->encryptadd('data2');\n$ct .= $ae->encryptadd('data3');\nmy $tag = $ae->encryptdone();\n\n# decrypt and verify\nmy $ae = Crypt::AuthEnc::ChaCha20Poly1305->new($key, $iv);\n$ae->adataadd('additionalauthenticateddata1');\n$ae->adataadd('additionalauthenticateddata2');\nmy $pt = $ae->decryptadd('ciphertext1');\n$pt .= $ae->decryptadd('ciphertext2');\n$pt .= $ae->decryptadd('ciphertext3');\nmy $tag = $ae->decryptdone();\ndie \"decrypt failed\" unless $tag eq $expectedtag;\n\n#or\nmy $result = $ae->decryptdone($expectedtag); # 0 or 1\n\n### functional interface\nuse Crypt::AuthEnc::ChaCha20Poly1305 qw(chacha20poly1305encryptauthenticate chacha20poly1305decryptverify);\n\nmy ($ciphertext, $tag) = chacha20poly1305encryptauthenticate($key, $iv, $adata, $plaintext);\nmy $plaintext = chacha20poly1305decryptverify($key, $iv, $adata, $ciphertext, $tag);\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Provides encryption and authentication based on ChaCha20 + Poly1305 as defined in RFC 7539 -\n<https://tools.ietf.org/html/rfc7539>\n",
            "subsections": []
        },
        "EXPORT": {
            "content": "Nothing is exported by default.\n\nYou can export selected functions:\n\nuse Crypt::AuthEnc::ChaCha20Poly1305 qw(chacha20poly1305encryptauthenticate chacha20poly1305decryptverify);\n",
            "subsections": []
        },
        "FUNCTIONS": {
            "content": "chacha20poly1305encryptauthenticate\nmy ($ciphertext, $tag) = chacha20poly1305encryptauthenticate($key, $iv, $adata, $plaintext);\n\n# $key ..... key of proper length (128 or 256 bits / 16 or 32 bytes)\n# $iv ...... initialization vector (64 or 96 bits / 8 or 12 bytes)\n# $adata ... additional authenticated data (optional)\n\nchacha20poly1305decryptverify\nmy $plaintext = chacha20poly1305decryptverify($key, $iv, $adata, $ciphertext, $tag);\n# on error returns undef\n",
            "subsections": []
        },
        "METHODS": {
            "content": "new\nmy $ae = Crypt::AuthEnc::ChaCha20Poly1305->new($key, $iv);\n\n# $key ..... encryption key of proper length (128 or 256 bits / 16 or 32 bytes)\n# $iv ...... initialization vector (64 or 96 bits / 8 or 12 bytes)\n\nadataadd\nAdd additional authenticated data. Can be called before the first \"encryptadd\" or\n\"decryptadd\";\n\n$ae->adataadd($aaddata);                     # can be called multiple times\n\nencryptadd\n$ciphertext = $ae->encryptadd($data);         # can be called multiple times\n\nencryptdone\n$tag = $ae->encryptdone();                    # returns $tag value\n\ndecryptadd\n$plaintext = $ae->decryptadd($ciphertext);    # can be called multiple times\n\ndecryptdone\nmy $tag = $ae->decryptdone;           # returns $tag value\n#or\nmy $result = $ae->decryptdone($tag);  # returns 1 (success) or 0 (failure)\n\nsetiv\nmy $ae = Crypt::AuthEnc::ChaCha20Poly1305->new($key)->setiv($iv);\n# $iv ...... initialization vector (64 or 96 bits / 8 or 12 bytes)\n\nsetivrfc7905\nSee <https://tools.ietf.org/html/rfc7905>\n\nmy $ae = Crypt::AuthEnc::ChaCha20Poly1305->new($key)->setivrfc7905($iv, $seqnum);\n# $iv ...... initialization vector (96 bits / 12 bytes)\n# $seqnum .. 64bit integer (sequence number)\n\nclone\nmy $aenew = $ae->clone;\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "*   CryptX, Crypt::AuthEnc::GCM, Crypt::AuthEnc::CCM, Crypt::AuthEnc::EAX, Crypt::AuthEnc::OCB\n\n*   <https://tools.ietf.org/html/rfc7539>\n",
            "subsections": []
        }
    },
    "summary": "Crypt::AuthEnc::ChaCha20Poly1305 - Authenticated encryption in ChaCha20-Poly1305 mode",
    "flags": [],
    "examples": [],
    "see_also": []
}