.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Crypt::Mac::XCBC 3pm" .TH Crypt::Mac::XCBC 3pm "2020-11-09" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Crypt::Mac::XCBC \- Message authentication code XCBC (RFC 3566) .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& ### Functional interface: \& use Crypt::Mac::XCBC qw( xcbc xcbc_hex ); \& \& # calculate MAC from string/buffer \& $xcbc_raw = xcbc($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& $xcbc_hex = xcbc_hex($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& $xcbc_b64 = xcbc_b64($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& $xcbc_b64u = xcbc_b64u($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& \& ### OO interface: \& use Crypt::Mac::XCBC; \& \& $d = Crypt::Mac::XCBC\->new($cipher_name, $key); \& $d\->add(\*(Aqany data\*(Aq); \& $d\->addfile(\*(Aqfilename.dat\*(Aq); \& $d\->addfile(*FILEHANDLE); \& $result_raw = $d\->mac; # raw bytes \& $result_hex = $d\->hexmac; # hexadecimal form \& $result_b64 = $d\->b64mac; # Base64 form \& $result_b64u = $d\->b64umac; # Base64 URL Safe form .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Provides an interface to the \s-1XCBC\s0 message authentication code (\s-1MAC\s0) algorithm. .SH "EXPORT" .IX Header "EXPORT" Nothing is exported by default. .PP You can export selected functions: .PP .Vb 1 \& use Crypt::Mac::XCBC qw(xcbc xcbc_hex ); .Ve .PP Or all of them at once: .PP .Vb 1 \& use Crypt::Mac::XCBC \*(Aq:all\*(Aq; .Ve .SH "FUNCTIONS" .IX Header "FUNCTIONS" .SS "xcbc" .IX Subsection "xcbc" Logically joins all arguments into a single string, and returns its \s-1XCBC\s0 message authentication code encoded as a binary string. .PP .Vb 3 \& $xcbc_raw = xcbc($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& #or \& $xcbc_raw = xcbc($cipher_name, $key, \*(Aqany data\*(Aq, \*(Aqmore data\*(Aq, \*(Aqeven more data\*(Aq); .Ve .SS "xcbc_hex" .IX Subsection "xcbc_hex" Logically joins all arguments into a single string, and returns its \s-1XCBC\s0 message authentication code encoded as a hexadecimal string. .PP .Vb 3 \& $xcbc_hex = xcbc_hex($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& #or \& $xcbc_hex = xcbc_hex($cipher_name, $key, \*(Aqany data\*(Aq, \*(Aqmore data\*(Aq, \*(Aqeven more data\*(Aq); .Ve .SS "xcbc_b64" .IX Subsection "xcbc_b64" Logically joins all arguments into a single string, and returns its \s-1XCBC\s0 message authentication code encoded as a Base64 string. .PP .Vb 3 \& $xcbc_b64 = xcbc_b64($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& #or \& $xcbc_b64 = xcbc_b64($cipher_name, $key, \*(Aqany data\*(Aq, \*(Aqmore data\*(Aq, \*(Aqeven more data\*(Aq); .Ve .SS "xcbc_b64u" .IX Subsection "xcbc_b64u" Logically joins all arguments into a single string, and returns its \s-1XCBC\s0 message authentication code encoded as a Base64 \s-1URL\s0 Safe string (see \s-1RFC 4648\s0 section 5). .PP .Vb 3 \& $xcbc_b64url = xcbc_b64u($cipher_name, $key, \*(Aqdata buffer\*(Aq); \& #or \& $xcbc_b64url = xcbc_b64u($cipher_name, $key, \*(Aqany data\*(Aq, \*(Aqmore data\*(Aq, \*(Aqeven more data\*(Aq); .Ve .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" .Vb 1 \& $d = Crypt::Mac::XCBC\->new($cipher_name, $key); .Ve .SS "clone" .IX Subsection "clone" .Vb 1 \& $d\->clone(); .Ve .SS "reset" .IX Subsection "reset" .Vb 1 \& $d\->reset(); .Ve .SS "add" .IX Subsection "add" .Vb 3 \& $d\->add(\*(Aqany data\*(Aq); \& #or \& $d\->add(\*(Aqany data\*(Aq, \*(Aqmore data\*(Aq, \*(Aqeven more data\*(Aq); .Ve .SS "addfile" .IX Subsection "addfile" .Vb 3 \& $d\->addfile(\*(Aqfilename.dat\*(Aq); \& #or \& $d\->addfile(*FILEHANDLE); .Ve .SS "mac" .IX Subsection "mac" .Vb 1 \& $result_raw = $d\->mac(); .Ve .SS "hexmac" .IX Subsection "hexmac" .Vb 1 \& $result_hex = $d\->hexmac(); .Ve .SS "b64mac" .IX Subsection "b64mac" .Vb 1 \& $result_b64 = $d\->b64mac(); .Ve .SS "b64umac" .IX Subsection "b64umac" .Vb 1 \& $result_b64url = $d\->b64umac(); .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 CryptX .IP "\(bu" 4