{
    "content": [
        {
            "type": "text",
            "text": "# Crypt::Digest::SHA1 (perldoc)\n\n## NAME\n\nCrypt::Digest::SHA1 - Hash function SHA-1 [size: 160 bits]\n\n## SYNOPSIS\n\n### Functional interface:\nuse Crypt::Digest::SHA1 qw( sha1 sha1hex sha1b64 sha1b64u\nsha1file sha1filehex sha1fileb64 sha1fileb64u );\n# calculate digest from string/buffer\n$sha1raw  = sha1('data string');\n$sha1hex  = sha1hex('data string');\n$sha1b64  = sha1b64('data string');\n$sha1b64u = sha1b64u('data string');\n# calculate digest from file\n$sha1raw  = sha1file('filename.dat');\n$sha1hex  = sha1filehex('filename.dat');\n$sha1b64  = sha1fileb64('filename.dat');\n$sha1b64u = sha1fileb64u('filename.dat');\n# calculate digest from filehandle\n$sha1raw  = sha1file(*FILEHANDLE);\n$sha1hex  = sha1filehex(*FILEHANDLE);\n$sha1b64  = sha1fileb64(*FILEHANDLE);\n$sha1b64u = sha1fileb64u(*FILEHANDLE);\n### OO interface:\nuse Crypt::Digest::SHA1;\n$d = Crypt::Digest::SHA1->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\n## DESCRIPTION\n\nProvides an interface to the SHA1 digest 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::Digest::SHA1",
        "section": "",
        "mode": "perldoc",
        "summary": "Crypt::Digest::SHA1 - Hash function SHA-1 [size: 160 bits]",
        "synopsis": "### Functional interface:\nuse Crypt::Digest::SHA1 qw( sha1 sha1hex sha1b64 sha1b64u\nsha1file sha1filehex sha1fileb64 sha1fileb64u );\n# calculate digest from string/buffer\n$sha1raw  = sha1('data string');\n$sha1hex  = sha1hex('data string');\n$sha1b64  = sha1b64('data string');\n$sha1b64u = sha1b64u('data string');\n# calculate digest from file\n$sha1raw  = sha1file('filename.dat');\n$sha1hex  = sha1filehex('filename.dat');\n$sha1b64  = sha1fileb64('filename.dat');\n$sha1b64u = sha1fileb64u('filename.dat');\n# calculate digest from filehandle\n$sha1raw  = sha1file(*FILEHANDLE);\n$sha1hex  = sha1filehex(*FILEHANDLE);\n$sha1b64  = sha1fileb64(*FILEHANDLE);\n$sha1b64u = sha1fileb64u(*FILEHANDLE);\n### OO interface:\nuse Crypt::Digest::SHA1;\n$d = Crypt::Digest::SHA1->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",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 32,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "EXPORT",
                "lines": 11,
                "subsections": []
            },
            {
                "name": "FUNCTIONS",
                "lines": 67,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 45,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 4,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Crypt::Digest::SHA1 - Hash function SHA-1 [size: 160 bits]\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "### Functional interface:\nuse Crypt::Digest::SHA1 qw( sha1 sha1hex sha1b64 sha1b64u\nsha1file sha1filehex sha1fileb64 sha1fileb64u );\n\n# calculate digest from string/buffer\n$sha1raw  = sha1('data string');\n$sha1hex  = sha1hex('data string');\n$sha1b64  = sha1b64('data string');\n$sha1b64u = sha1b64u('data string');\n# calculate digest from file\n$sha1raw  = sha1file('filename.dat');\n$sha1hex  = sha1filehex('filename.dat');\n$sha1b64  = sha1fileb64('filename.dat');\n$sha1b64u = sha1fileb64u('filename.dat');\n# calculate digest from filehandle\n$sha1raw  = sha1file(*FILEHANDLE);\n$sha1hex  = sha1filehex(*FILEHANDLE);\n$sha1b64  = sha1fileb64(*FILEHANDLE);\n$sha1b64u = sha1fileb64u(*FILEHANDLE);\n\n### OO interface:\nuse Crypt::Digest::SHA1;\n\n$d = Crypt::Digest::SHA1->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 SHA1 digest algorithm.\n",
                "subsections": []
            },
            "EXPORT": {
                "content": "Nothing is exported by default.\n\nYou can export selected functions:\n\nuse Crypt::Digest::SHA1 qw(sha1 sha1hex sha1b64 sha1b64u\nsha1file sha1filehex sha1fileb64 sha1fileb64u);\n\nOr all of them at once:\n\nuse Crypt::Digest::SHA1 ':all';\n",
                "subsections": []
            },
            "FUNCTIONS": {
                "content": "sha1\nLogically joins all arguments into a single string, and returns its SHA1 digest encoded as a\nbinary string.\n\n$sha1raw = sha1('data string');\n#or\n$sha1raw = sha1('any data', 'more data', 'even more data');\n\nsha1hex\nLogically joins all arguments into a single string, and returns its SHA1 digest encoded as a\nhexadecimal string.\n\n$sha1hex = sha1hex('data string');\n#or\n$sha1hex = sha1hex('any data', 'more data', 'even more data');\n\nsha1b64\nLogically joins all arguments into a single string, and returns its SHA1 digest encoded as a\nBase64 string, with trailing '=' padding.\n\n$sha1b64 = sha1b64('data string');\n#or\n$sha1b64 = sha1b64('any data', 'more data', 'even more data');\n\nsha1b64u\nLogically joins all arguments into a single string, and returns its SHA1 digest encoded as a\nBase64 URL Safe string (see RFC 4648 section 5).\n\n$sha1b64url = sha1b64u('data string');\n#or\n$sha1b64url = sha1b64u('any data', 'more data', 'even more data');\n\nsha1file\nReads file (defined by filename or filehandle) content, and returns its SHA1 digest encoded as a\nbinary string.\n\n$sha1raw = sha1file('filename.dat');\n#or\n$sha1raw = sha1file(*FILEHANDLE);\n\nsha1filehex\nReads file (defined by filename or filehandle) content, and returns its SHA1 digest encoded as a\nhexadecimal string.\n\n$sha1hex = sha1filehex('filename.dat');\n#or\n$sha1hex = sha1filehex(*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\nsha1fileb64\nReads file (defined by filename or filehandle) content, and returns its SHA1 digest encoded as a\nBase64 string, with trailing '=' padding.\n\n$sha1b64 = sha1fileb64('filename.dat');\n#or\n$sha1b64 = sha1fileb64(*FILEHANDLE);\n\nsha1fileb64u\nReads file (defined by filename or filehandle) content, and returns its SHA1 digest encoded as a\nBase64 URL Safe string (see RFC 4648 section 5).\n\n$sha1b64url = sha1fileb64u('filename.dat');\n#or\n$sha1b64url = sha1fileb64u(*FILEHANDLE);\n",
                "subsections": []
            },
            "METHODS": {
                "content": "The OO interface provides the same set of functions as Crypt::Digest.\n\nnew\n$d = Crypt::Digest::SHA1->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::SHA1->hashsize();\n#or\nCrypt::Digest::SHA1::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/SHA-1>\n",
                "subsections": []
            }
        }
    }
}