{
    "mode": "perldoc",
    "parameter": "Crypt::Digest::CHAES",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Crypt%3A%3ADigest%3A%3ACHAES/json",
    "generated": "2026-06-10T13:42:57Z",
    "synopsis": "### Functional interface:\nuse Crypt::Digest::CHAES qw( chaes chaeshex chaesb64 chaesb64u\nchaesfile chaesfilehex chaesfileb64 chaesfileb64u );\n# calculate digest from string/buffer\n$chaesraw  = chaes('data string');\n$chaeshex  = chaeshex('data string');\n$chaesb64  = chaesb64('data string');\n$chaesb64u = chaesb64u('data string');\n# calculate digest from file\n$chaesraw  = chaesfile('filename.dat');\n$chaeshex  = chaesfilehex('filename.dat');\n$chaesb64  = chaesfileb64('filename.dat');\n$chaesb64u = chaesfileb64u('filename.dat');\n# calculate digest from filehandle\n$chaesraw  = chaesfile(*FILEHANDLE);\n$chaeshex  = chaesfilehex(*FILEHANDLE);\n$chaesb64  = chaesfileb64(*FILEHANDLE);\n$chaesb64u = chaesfileb64u(*FILEHANDLE);\n### OO interface:\nuse Crypt::Digest::CHAES;\n$d = Crypt::Digest::CHAES->new;\n$d->add('any data');\n$d->addfile('filename.dat');\n$d->addfile(*FILEHANDLE);\n$resultraw  = $d->digest;     # raw bytes\n$resulthex  = $d->hexdigest;  # hexadecimal form\n$resultb64  = $d->b64digest;  # Base64 form\n$resultb64u = $d->b64udigest; # Base64 URL Safe form",
    "sections": {
        "NAME": {
            "content": "Crypt::Digest::CHAES - Hash function - CipherHash based on AES [size: 128 bits]\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "### Functional interface:\nuse Crypt::Digest::CHAES qw( chaes chaeshex chaesb64 chaesb64u\nchaesfile chaesfilehex chaesfileb64 chaesfileb64u );\n\n# calculate digest from string/buffer\n$chaesraw  = chaes('data string');\n$chaeshex  = chaeshex('data string');\n$chaesb64  = chaesb64('data string');\n$chaesb64u = chaesb64u('data string');\n# calculate digest from file\n$chaesraw  = chaesfile('filename.dat');\n$chaeshex  = chaesfilehex('filename.dat');\n$chaesb64  = chaesfileb64('filename.dat');\n$chaesb64u = chaesfileb64u('filename.dat');\n# calculate digest from filehandle\n$chaesraw  = chaesfile(*FILEHANDLE);\n$chaeshex  = chaesfilehex(*FILEHANDLE);\n$chaesb64  = chaesfileb64(*FILEHANDLE);\n$chaesb64u = chaesfileb64u(*FILEHANDLE);\n\n### OO interface:\nuse Crypt::Digest::CHAES;\n\n$d = Crypt::Digest::CHAES->new;\n$d->add('any data');\n$d->addfile('filename.dat');\n$d->addfile(*FILEHANDLE);\n$resultraw  = $d->digest;     # raw bytes\n$resulthex  = $d->hexdigest;  # hexadecimal form\n$resultb64  = $d->b64digest;  # Base64 form\n$resultb64u = $d->b64udigest; # Base64 URL Safe form\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Provides an interface to the CHAES digest algorithm.\n",
            "subsections": []
        },
        "EXPORT": {
            "content": "Nothing is exported by default.\n\nYou can export selected functions:\n\nuse Crypt::Digest::CHAES qw(chaes chaeshex chaesb64 chaesb64u\nchaesfile chaesfilehex chaesfileb64 chaesfileb64u);\n\nOr all of them at once:\n\nuse Crypt::Digest::CHAES ':all';\n",
            "subsections": []
        },
        "FUNCTIONS": {
            "content": "chaes\nLogically joins all arguments into a single string, and returns its CHAES digest encoded as a\nbinary string.\n\n$chaesraw = chaes('data string');\n#or\n$chaesraw = chaes('any data', 'more data', 'even more data');\n\nchaeshex\nLogically joins all arguments into a single string, and returns its CHAES digest encoded as a\nhexadecimal string.\n\n$chaeshex = chaeshex('data string');\n#or\n$chaeshex = chaeshex('any data', 'more data', 'even more data');\n\nchaesb64\nLogically joins all arguments into a single string, and returns its CHAES digest encoded as a\nBase64 string, with trailing '=' padding.\n\n$chaesb64 = chaesb64('data string');\n#or\n$chaesb64 = chaesb64('any data', 'more data', 'even more data');\n\nchaesb64u\nLogically joins all arguments into a single string, and returns its CHAES digest encoded as a\nBase64 URL Safe string (see RFC 4648 section 5).\n\n$chaesb64url = chaesb64u('data string');\n#or\n$chaesb64url = chaesb64u('any data', 'more data', 'even more data');\n\nchaesfile\nReads file (defined by filename or filehandle) content, and returns its CHAES digest encoded as\na binary string.\n\n$chaesraw = chaesfile('filename.dat');\n#or\n$chaesraw = chaesfile(*FILEHANDLE);\n\nchaesfilehex\nReads file (defined by filename or filehandle) content, and returns its CHAES digest encoded as\na hexadecimal string.\n\n$chaeshex = chaesfilehex('filename.dat');\n#or\n$chaeshex = chaesfilehex(*FILEHANDLE);\n\nBEWARE: You have to make sure that the filehandle is in binary mode before you pass it as\nargument to the addfile() method.\n\nchaesfileb64\nReads file (defined by filename or filehandle) content, and returns its CHAES digest encoded as\na Base64 string, with trailing '=' padding.\n\n$chaesb64 = chaesfileb64('filename.dat');\n#or\n$chaesb64 = chaesfileb64(*FILEHANDLE);\n\nchaesfileb64u\nReads file (defined by filename or filehandle) content, and returns its CHAES digest encoded as\na Base64 URL Safe string (see RFC 4648 section 5).\n\n$chaesb64url = chaesfileb64u('filename.dat');\n#or\n$chaesb64url = chaesfileb64u(*FILEHANDLE);\n",
            "subsections": []
        },
        "METHODS": {
            "content": "The OO interface provides the same set of functions as Crypt::Digest.\n\nnew\n$d = Crypt::Digest::CHAES->new();\n\nclone\n$d->clone();\n\nreset\n$d->reset();\n\nadd\n$d->add('any data');\n#or\n$d->add('any data', 'more data', 'even more data');\n\naddfile\n$d->addfile('filename.dat');\n#or\n$d->addfile(*FILEHANDLE);\n\naddbits\n$d->addbits($bitstring);   # e.g. $d->addbits(\"111100001010\");\n#or\n$d->addbits($data, $nbits); # e.g. $d->addbits(\"\\xF0\\xA0\", 16);\n\nhashsize\n$d->hashsize;\n#or\nCrypt::Digest::CHAES->hashsize();\n#or\nCrypt::Digest::CHAES::hashsize();\n\ndigest\n$resultraw = $d->digest();\n\nhexdigest\n$resulthex = $d->hexdigest();\n\nb64digest\n$resultb64 = $d->b64digest();\n\nb64udigest\n$resultb64url = $d->b64udigest();\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "*   CryptX, Crypt::Digest\n\n*   <https://en.wikipedia.org/wiki/Cryptographichashfunction#Hashfunctionsbasedonblockcip\nhers>\n",
            "subsections": []
        }
    },
    "summary": "Crypt::Digest::CHAES - Hash function - CipherHash based on AES [size: 128 bits]",
    "flags": [],
    "examples": [],
    "see_also": []
}