{
    "content": [
        {
            "type": "text",
            "text": "# Crypt::Mac::Pelican (perldoc)\n\n## NAME\n\nCrypt::Mac::Pelican - Message authentication code Pelican (AES based MAC)\n\n## SYNOPSIS\n\n### Functional interface:\nuse Crypt::Mac::Pelican qw( pelican pelicanhex );\n# calculate MAC from string/buffer\n$pelicanraw  = pelican($key, 'data buffer');\n$pelicanhex  = pelicanhex($key, 'data buffer');\n$pelicanb64  = pelicanb64($key, 'data buffer');\n$pelicanb64u = pelicanb64u($key, 'data buffer');\n### OO interface:\nuse Crypt::Mac::Pelican;\n$d = Crypt::Mac::Pelican->new($key);\n$d->add('any data');\n$d->addfile('filename.dat');\n$d->addfile(*FILEHANDLE);\n$resultraw  = $d->mac;     # raw bytes\n$resulthex  = $d->hexmac;  # hexadecimal form\n$resultb64  = $d->b64mac;  # Base64 form\n$resultb64u = $d->b64umac; # Base64 URL Safe form\n\n## DESCRIPTION\n\nProvides an interface to the Pelican message authentication code (MAC) algorithm.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **EXPORT**\n- **FUNCTIONS**\n- **METHODS**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Crypt::Mac::Pelican",
        "section": "",
        "mode": "perldoc",
        "summary": "Crypt::Mac::Pelican - Message authentication code Pelican (AES based MAC)",
        "synopsis": "### Functional interface:\nuse Crypt::Mac::Pelican qw( pelican pelicanhex );\n# calculate MAC from string/buffer\n$pelicanraw  = pelican($key, 'data buffer');\n$pelicanhex  = pelicanhex($key, 'data buffer');\n$pelicanb64  = pelicanb64($key, 'data buffer');\n$pelicanb64u = pelicanb64u($key, 'data buffer');\n### OO interface:\nuse Crypt::Mac::Pelican;\n$d = Crypt::Mac::Pelican->new($key);\n$d->add('any data');\n$d->addfile('filename.dat');\n$d->addfile(*FILEHANDLE);\n$resultraw  = $d->mac;     # raw bytes\n$resulthex  = $d->hexmac;  # hexadecimal form\n$resultb64  = $d->b64mac;  # Base64 form\n$resultb64u = $d->b64umac; # Base64 URL Safe form",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 21,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "EXPORT",
                "lines": 10,
                "subsections": []
            },
            {
                "name": "FUNCTIONS",
                "lines": 32,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 31,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 4,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Crypt::Mac::Pelican - Message authentication code Pelican (AES based MAC)\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "### Functional interface:\nuse Crypt::Mac::Pelican qw( pelican pelicanhex );\n\n# calculate MAC from string/buffer\n$pelicanraw  = pelican($key, 'data buffer');\n$pelicanhex  = pelicanhex($key, 'data buffer');\n$pelicanb64  = pelicanb64($key, 'data buffer');\n$pelicanb64u = pelicanb64u($key, 'data buffer');\n\n### OO interface:\nuse Crypt::Mac::Pelican;\n\n$d = Crypt::Mac::Pelican->new($key);\n$d->add('any data');\n$d->addfile('filename.dat');\n$d->addfile(*FILEHANDLE);\n$resultraw  = $d->mac;     # raw bytes\n$resulthex  = $d->hexmac;  # hexadecimal form\n$resultb64  = $d->b64mac;  # Base64 form\n$resultb64u = $d->b64umac; # Base64 URL Safe form\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Provides an interface to the Pelican message authentication code (MAC) algorithm.\n",
                "subsections": []
            },
            "EXPORT": {
                "content": "Nothing is exported by default.\n\nYou can export selected functions:\n\nuse Crypt::Mac::Pelican qw(pelican pelicanhex );\n\nOr all of them at once:\n\nuse Crypt::Mac::Pelican ':all';\n",
                "subsections": []
            },
            "FUNCTIONS": {
                "content": "pelican\nLogically joins all arguments into a single string, and returns its Pelican message\nauthentication code encoded as a binary string.\n\n$pelicanraw = pelican($key, 'data buffer');\n#or\n$pelicanraw = pelican($key, 'any data', 'more data', 'even more data');\n\npelicanhex\nLogically joins all arguments into a single string, and returns its Pelican message\nauthentication code encoded as a hexadecimal string.\n\n$pelicanhex = pelicanhex($key, 'data buffer');\n#or\n$pelicanhex = pelicanhex($key, 'any data', 'more data', 'even more data');\n\npelicanb64\nLogically joins all arguments into a single string, and returns its Pelican message\nauthentication code encoded as a Base64 string.\n\n$pelicanb64 = pelicanb64($key, 'data buffer');\n#or\n$pelicanb64 = pelicanb64($key, 'any data', 'more data', 'even more data');\n\npelicanb64u\nLogically joins all arguments into a single string, and returns its Pelican message\nauthentication code encoded as a Base64 URL Safe string (see RFC 4648 section 5).\n\n$pelicanb64url = pelicanb64u($key, 'data buffer');\n#or\n$pelicanb64url = pelicanb64u($key, 'any data', 'more data', 'even more data');\n",
                "subsections": []
            },
            "METHODS": {
                "content": "new\n$d = Crypt::Mac::Pelican->new($key);\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\nmac\n$resultraw = $d->mac();\n\nhexmac\n$resulthex = $d->hexmac();\n\nb64mac\n$resultb64 = $d->b64mac();\n\nb64umac\n$resultb64url = $d->b64umac();\n",
                "subsections": []
            },
            "SEE ALSO": {
                "content": "*   CryptX\n\n*   <http://eprint.iacr.org/2005/088.pdf>\n",
                "subsections": []
            }
        }
    }
}