---
name: "Crypt::Mac::Pelican"
section: "3pm"
platform: "linux"
package: "perl-cryptx"
version: "0.091-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Crypt::Mac::Pelican"
---

# Crypt::Mac::Pelican(3pm)

Message authentication code Pelican (AES based MAC)

## NAME

Crypt::Mac::Pelican - Message authentication code Pelican (AES based MAC)

## SYNOPSIS

```
   ### Functional interface:
   use Crypt::Mac::Pelican qw( pelican pelican_hex pelican_b64 pelican_b64u );
   # calculate MAC from string/buffer
   my $pelican_raw  = pelican($key, 'data buffer');
   my $pelican_hex  = pelican_hex($key, 'data buffer');
   my $pelican_b64  = pelican_b64($key, 'data buffer');
   my $pelican_b64u = pelican_b64u($key, 'data buffer');
   ### OO interface:
   use Crypt::Mac::Pelican;
   my $d = Crypt::Mac::Pelican->new($key);
   $d->add('any data');
   my $result_hex = $d->hexmac;   # finalizes the object
   # for another output encoding use a fresh object (or clone before finalizing)
   my $result_b64u = Crypt::Mac::Pelican->new($key)->add('any data')->b64umac;
   # or MAC a file instead
   my $file_result_raw = Crypt::Mac::Pelican->new($key)->addfile('filename.dat')->mac;
```

## DESCRIPTION

Provides an interface to the Pelican message authentication code (MAC) algorithm.

## EXPORT

Nothing is exported by default.

You can export selected functions:

```
  use Crypt::Mac::Pelican qw( pelican pelican_hex pelican_b64 pelican_b64u );
```

Or all of them at once:

```
  use Crypt::Mac::Pelican ':all';
```

## FUNCTIONS

### pelican

Joins all arguments into a single string and returns its Pelican message authentication code encoded as a binary string.

Data arguments for the functional helpers are converted to byte strings using Perl's usual scalar stringification. Defined scalars, including numbers and string-overloaded objects, are accepted. `"undef"` is treated as an empty string and may emit Perl's usual "uninitialized value" warning. The same rules apply to `"pelican_hex"`, `"pelican_b64"`, and `"pelican_b64u"`.

```
 my $pelican_raw = pelican($key, 'data buffer');
 #or
 my $pelican_raw = pelican($key, 'any data', 'more data', 'even more data');
```

### pelican\_hex

Joins all arguments into a single string and returns its Pelican message authentication code encoded as a hexadecimal string.

```
 my $pelican_hex = pelican_hex($key, 'data buffer');
 #or
 my $pelican_hex = pelican_hex($key, 'any data', 'more data', 'even more data');
```

### pelican\_b64

Joins all arguments into a single string and returns its Pelican message authentication code encoded as a Base64 string.

```
 my $pelican_b64 = pelican_b64($key, 'data buffer');
 #or
 my $pelican_b64 = pelican_b64($key, 'any data', 'more data', 'even more data');
```

### pelican\_b64u

Joins all arguments into a single string and returns its Pelican message authentication code encoded as a Base64 URL-safe string (see RFC 4648 section 5).

```
 my $pelican_b64url = pelican_b64u($key, 'data buffer');
 #or
 my $pelican_b64url = pelican_b64u($key, 'any data', 'more data', 'even more data');
```

## METHODS

Unless noted otherwise, assume `$d` is an existing MAC object created via `"new"`, for example:

```
 my $d = Crypt::Mac::Pelican->new($key);
```

### new

```
 my $d = Crypt::Mac::Pelican->new($key);
 # $key .. [binary string] exactly 16 bytes (AES-128 key; Pelican is AES-based)
```

### clone

```
 $d->clone();
```

### add

Appends data to the message. Returns the object itself (for chaining). Croaks if the object has already been finalized by `"mac"`, `"hexmac"`, `"b64mac"`, or `"b64umac"`.

Each argument is converted to bytes using Perl's usual scalar stringification. Defined scalars, including numbers and string-overloaded objects, are accepted. `"undef"` is treated as an empty string and may emit Perl's usual "uninitialized value" warning.

```
 $d->add('any data');
 #or
 $d->add('any data', 'more data', 'even more data');
```

### addfile

Reads the file content and appends it to the message. Returns the object itself (for chaining). Croaks if the object has already been finalized by `"mac"`, `"hexmac"`, `"b64mac"`, or `"b64umac"`.

```
 $d->addfile('filename.dat');
 #or
 my $filehandle = ...; # existing binary-mode filehandle
 $d->addfile($filehandle);
```

### mac

Returns the binary MAC (raw bytes) and finalizes the object. After the first call to `"mac"`, `"hexmac"`, `"b64mac"`, or `"b64umac"`, later calls to `"add"`, `"addfile"`, or any MAC getter croak.

```
 my $result_raw = $d->mac();
```

### hexmac

Returns the MAC encoded as a lowercase hexadecimal string and finalizes the object. After the first call to `"mac"`, `"hexmac"`, `"b64mac"`, or `"b64umac"`, later calls to `"add"`, `"addfile"`, or any MAC getter croak.

```
 my $result_hex = $d->hexmac();
```

### b64mac

Returns the MAC encoded as a Base64 string with trailing `"="` padding and finalizes the object. After the first call to `"mac"`, `"hexmac"`, `"b64mac"`, or `"b64umac"`, later calls to `"add"`, `"addfile"`, or any MAC getter croak.

```
 my $result_b64 = $d->b64mac();
```

### b64umac

Returns the MAC encoded as a Base64 URL-safe string (no trailing `"="`) and finalizes the object. After the first call to `"mac"`, `"hexmac"`, `"b64mac"`, or `"b64umac"`, later calls to `"add"`, `"addfile"`, or any MAC getter croak.

```
 my $result_b64url = $d->b64umac();
```

## SEE ALSO

- •

  CryptX

- •

  \<https://eprint.iacr.org/2005/088.pdf\>