# Struct ipworksencrypt::CMAC

The CMAC struct may be used to produce a MAC (or Tag) value using the AES CMAC algorithm.

## Syntax

```text
ipworksencrypt::CMAC
```

## Remarks

The CMAC struct implements the AES CMAC algorithm defined in RFC 4493. This may be used to compute a MAC (or Tag) value on data of any length.

The [key](#key-property-cmac-struct) must be set to a 128-bit (16 bytes), 192-bit (24 bytes), or 256-bit (32 bytes) key before computing the MAC. The computed MAC is 128-bit (16 bytes) in size.

**ComputeMAC Notes**

[compute_mac](#compute_mac-method-cmac-struct) computes the MAC (Message Authentication Code) from the input data.

Before calling this method set [key](#key-property-cmac-struct) to a 128-bit (16 bytes), 192-bit (24 bytes), or 256-bit (32 bytes) key. If [encode_mac](#encode_mac-property-cmac-struct) is set to True (default) the output data will be hex encoded.

**Input Notes**

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

- [input_file](#input_file-property-cmac-struct)
- [input_message](#input_message-property-cmac-struct)

 When a valid source is found the search stops.

After calling this method [mac_value](#mac_value-property-cmac-struct) will be populated with the computed 128 bit (16 byte) value.

**ComputeMAC Example**

```csharp
CMAC cmac = new CMAC();
cmac.KeyB = new byte[] { 0x1c, 0x92, 0x40, 0xa5, 0xeb, 0x55, 0xd3, 0x8a, 0xf3, 0x33, 0x88, 0x86, 0x04, 0xf6, 0xb5, 0xf0, 0x47, 0x39, 0x17, 0xc1, 0x40, 0x2b, 0x80, 0x09, 0x9d, 0xca, 0x5c, 0xbc, 0x20, 0x70, 0x75, 0xc0 };
cmac.InputMessage = "Hello CMAC";
cmac.EncodeMAC = true; //hex output
cmac.ComputeMAC();

//This outputs "1234E6C7808BF17C1CBD951D1A139E4D"
Console.WriteLine(cmac.MACValue);
```

**ComputeMACBlock Notes**

[compute_mac_block](#compute_mac_block-method-cmac-struct) allows input to the struct to be specified in blocks. This method will return the MAC value only when the parameter LastBlock is True.

*InputBuffer* specifies the input data.

*LastBlock* specifies whether the block is the last block. If this is False the method will return an empty byte array.

To calculate the MAC value of data that is broken apart into multiple blocks make multiple calls to this method. For instance:

```text
//Encode output in hex
cmac.EncodeMAC = true; //hex output

//Pass any number of parts, of any size
cmac.ComputeMACBlock(part1,false);
cmac.ComputeMACBlock(part2,false);
cmac.ComputeMACBlock(part3,false);

//Pass true for the last block
cmac.ComputeMACBlock(lastPart,true);

//The MACValue property holds the MAC value
Console.WriteLine(cmac.MACValue);
```

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the CMAC struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of CMAC when you have finished using the instance.

## Property List

*The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [encode_mac](#encode_mac-property-cmac-struct) | Whether the MAC value is hex encoded. |
| [input_file](#input_file-property-cmac-struct) | The file to process. |
| [input_message](#input_message-property-cmac-struct) | The message to process. |
| [key](#key-property-cmac-struct) | The key to be used when computing a MAC (Message Authentication Code). |
| [mac_value](#mac_value-property-cmac-struct) | The computed MAC value. |

## Method List

*The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [compute_mac](#compute_mac-method-cmac-struct) | Computes the MAC. |
| [compute_mac_block](#compute_mac_block-method-cmac-struct) | Computes the MAC value of specified data. |
| [config](#config-method-cmac-struct) | Sets or retrieves a configuration setting. |
| [reset](#reset-method-cmac-struct) | Resets the struct. |

## Event List

*The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [on_error](#on_error-event-cmac-struct) | Fired when information is available about errors during data delivery. |
| [on_progress](#on_progress-event-cmac-struct) | Fired as progress is made. |

## Config Settings

*The following is a list of config settings for the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# encode_mac property ([CMAC](#struct-ipworksencryptcmac) Struct)

Whether the MAC value is hex encoded.

## Syntax

*Rust Syntax*

```text
fn encode_mac(&self ) -> Result<bool, IPWorksEncryptError> fn set_encode_mac(&self, value : bool) ->  Option<IPWorksEncryptError>
```

## Default Value

true

## Remarks

This property specifies whether the computed MAC value is hex encoded. When set to True (default) the struct will hex encode the computed MAC for easier use. Set this value to False to obtain the MAC value in an unmodified form.

The default value is True.

## Data Type

bool

# input_file property ([CMAC](#struct-ipworksencryptcmac) Struct)

The file to process.

## Syntax

*Rust Syntax*

```text
fn input_file(&self ) -> Result<String, IPWorksEncryptError> fn set_input_file(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- input_file
- [input_message](#input_message-property-cmac-struct)

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- output_file
- output_message: The output data is written to this property if no other destination is specified.

## Data Type

String

# input_message property ([CMAC](#struct-ipworksencryptcmac) Struct)

The message to process.

## Syntax

*Rust Syntax*

```text
fn input_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_input_message(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_input_message_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the message to be processed.

**Input and Output Properties**

The struct will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

- [input_file](#input_file-property-cmac-struct)
- input_message

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

- output_file
- output_message: The output data is written to this property if no other destination is specified.

## Data Type

Vec

# key property ([CMAC](#struct-ipworksencryptcmac) Struct)

The key to be used when computing a MAC (Message Authentication Code).

## Syntax

*Rust Syntax*

```text
fn key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property holds the secret key used when computing the [mac_value](#mac_value-property-cmac-struct). The key must be 128-bit (16 bytes), 192-bit (24 bytes), or 256-bit (32 bytes) long.

## Data Type

Vec

# mac_value property ([CMAC](#struct-ipworksencryptcmac) Struct)

The computed MAC value.

## Syntax

*Rust Syntax*

```text
fn mac_value(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
```

## Default Value

""

## Remarks

The 128 bit (16 byte) MAC value calculated after calling [compute_mac](#compute_mac-method-cmac-struct).

This property is read-only.

## Data Type

Vec

# compute_mac method ([CMAC](#struct-ipworksencryptcmac) Struct)

Computes the MAC.

## Syntax

*Rust Syntax*

```text
fn compute_mac(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

compute_mac computes the MAC (Message Authentication Code) from the input data.

Before calling this method set [key](#key-property-cmac-struct) to a 128-bit (16 bytes), 192-bit (24 bytes), or 256-bit (32 bytes) key. If [encode_mac](#encode_mac-property-cmac-struct) is set to True (default) the output data will be hex encoded.

**Input Notes**

The struct will determine the source of the input based on which properties are set.

The order in which the input properties are checked are as follows:

- [input_file](#input_file-property-cmac-struct)
- [input_message](#input_message-property-cmac-struct)

 When a valid source is found the search stops.

After calling this method [mac_value](#mac_value-property-cmac-struct) will be populated with the computed 128 bit (16 byte) value.

**ComputeMAC Example**

```csharp
CMAC cmac = new CMAC();
cmac.KeyB = new byte[] { 0x1c, 0x92, 0x40, 0xa5, 0xeb, 0x55, 0xd3, 0x8a, 0xf3, 0x33, 0x88, 0x86, 0x04, 0xf6, 0xb5, 0xf0, 0x47, 0x39, 0x17, 0xc1, 0x40, 0x2b, 0x80, 0x09, 0x9d, 0xca, 0x5c, 0xbc, 0x20, 0x70, 0x75, 0xc0 };
cmac.InputMessage = "Hello CMAC";
cmac.EncodeMAC = true; //hex output
cmac.ComputeMAC();

//This outputs "1234E6C7808BF17C1CBD951D1A139E4D"
Console.WriteLine(cmac.MACValue);
```

# compute_mac_block method ([CMAC](#struct-ipworksencryptcmac) Struct)

Computes the MAC value of specified data.

## Syntax

*Rust Syntax*

```text
fn compute_mac_block(&self, input_buffer : &[u8], last_block : bool) ->  Result<Vec<u8>, IPWorksEncryptError>
```

## Remarks

compute_mac_block allows input to the struct to be specified in blocks. This method will return the MAC value only when the parameter LastBlock is True.

*InputBuffer* specifies the input data.

*LastBlock* specifies whether the block is the last block. If this is False the method will return an empty byte array.

To calculate the MAC value of data that is broken apart into multiple blocks make multiple calls to this method. For instance:

```text
//Encode output in hex
cmac.EncodeMAC = true; //hex output

//Pass any number of parts, of any size
cmac.ComputeMACBlock(part1,false);
cmac.ComputeMACBlock(part2,false);
cmac.ComputeMACBlock(part3,false);

//Pass true for the last block
cmac.ComputeMACBlock(lastPart,true);

//The MACValue property holds the MAC value
Console.WriteLine(cmac.MACValue);
```

# config method ([CMAC](#struct-ipworksencryptcmac) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-cmac-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-cmac-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# reset method ([CMAC](#struct-ipworksencryptcmac) Struct)

Resets the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

When called, the struct will reset all of its properties to their default values.

# on_error event ([CMAC](#struct-ipworksencryptcmac) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// CMACErrorEventArgs carries the CMAC Error event's parameters.
pub struct CMACErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// CMACErrorEvent defines the signature of the CMAC Error event's handler function.
pub trait CMACErrorEvent {
  fn on_error(&self, sender : CMAC, e : &mut CMACErrorEventArgs);
}

impl <'a> CMAC<'a> {
  pub fn on_error(&self) -> &'a dyn CMACErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn CMACErrorEvent);
  ...
}
```

## Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The *error_code* parameter contains an error code, and the *description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-cmac-struct) section.

# on_progress event ([CMAC](#struct-ipworksencryptcmac) Struct)

Fired as progress is made.

## Syntax

*Rust Syntax*

```text
// CMACProgressEventArgs carries the CMAC Progress event's parameters.
pub struct CMACProgressEventArgs {
  fn bytes_processed(&self) -> i64
  fn percent_processed(&self) -> i32
}

// CMACProgressEvent defines the signature of the CMAC Progress event's handler function.
pub trait CMACProgressEvent {
  fn on_progress(&self, sender : CMAC, e : &mut CMACProgressEventArgs);
}

impl <'a> CMAC<'a> {
  pub fn on_progress(&self) -> &'a dyn CMACProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn CMACProgressEvent);
  ...
}
```

## Remarks

This event is fired automatically as data is processed by the struct.

The *PercentProcessed* parameter indicates the current status of the operation.

The *BytesProcessed* parameter holds the total number of bytes processed so far.

# Config Settings ([CMAC](#struct-ipworksencryptcmac) Struct)

 The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [config](#config-method-cmac-struct) method.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([CMAC](#struct-ipworksencryptcmac) Struct)

### CMAC Errors

|  |  |
| --- | --- |
| 104 | Cannot read or write file. |
| 108 | Invalid key size. |
| 304 | Cannot write file. |
| 305 | Cannot read file. |