iText 9.1.0 API
iText.Kernel.Mac.MacProperties Class Reference

Class which contains configurable properties for MAC integrity protection mechanism. More...

Public Types

enum   MacDigestAlgorithm {
  SHA_256, SHA_384, SHA_512, SHA3_256,
  SHA3_384, SHA3_512
}
  Message digest algorithms, which can be used in MAC integrity protection algorithm. More...
 
enum   MacAlgorithm { HMAC_WITH_SHA_256 }
  MAC algorithms, which can be used during integrity protection operation. More...
 
enum   KeyWrappingAlgorithm { AES_256_NO_PADD }
  Key wrapping algorithms, which can be used in MAC integrity protection algorithm. More...
 

Public Member Functions

  MacProperties (MacProperties.MacDigestAlgorithm macDigestAlgorithm)
  Creates MacProperties class containing provided MacDigestAlgorithm. More...
 
  MacProperties (MacProperties.MacDigestAlgorithm macDigestAlgorithm, MacProperties.MacAlgorithm macAlgorithm, MacProperties.KeyWrappingAlgorithm keyWrappingAlgorithm)
  Creates MacProperties class containing provided properties. More...
 
virtual MacProperties.MacDigestAlgorithm  GetMacDigestAlgorithm ()
  Gets MacDigestAlgorithm to be used in MAC integrity protection algorithm. More...
 
virtual MacProperties.MacAlgorithm  GetMacAlgorithm ()
  Gets MacAlgorithm to be used in MAC integrity protection algorithm. More...
 
virtual MacProperties.KeyWrappingAlgorithm  GetKeyWrappingAlgorithm ()
  Gets KeyWrappingAlgorithm to be used in MAC integrity protection algorithm. More...
 

Static Public Member Functions

static String  MacDigestAlgorithmToString (MacProperties.MacDigestAlgorithm macDigestAlgorithm)
 

Detailed Description

Class which contains configurable properties for MAC integrity protection mechanism.

Member Enumeration Documentation

◆ KeyWrappingAlgorithm

Key wrapping algorithms, which can be used in MAC integrity protection algorithm.

◆ MacAlgorithm

MAC algorithms, which can be used during integrity protection operation.

◆ MacDigestAlgorithm

Message digest algorithms, which can be used in MAC integrity protection algorithm.

Constructor & Destructor Documentation

◆ MacProperties() [1/2]

iText.Kernel.Mac.MacProperties.MacProperties ( MacProperties.MacDigestAlgorithm  macDigestAlgorithm )
inline

Creates MacProperties class containing provided MacDigestAlgorithm.

Creates MacProperties class containing provided MacDigestAlgorithm. For other properties default values are used.

Parameters
macDigestAlgorithm

MacDigestAlgorithm to be used in MAC integrity protection algorithm

◆ MacProperties() [2/2]

iText.Kernel.Mac.MacProperties.MacProperties ( MacProperties.MacDigestAlgorithm  macDigestAlgorithm,
MacProperties.MacAlgorithm  macAlgorithm,
MacProperties.KeyWrappingAlgorithm  keyWrappingAlgorithm 
)
inline

Creates MacProperties class containing provided properties.

Parameters
macDigestAlgorithm

MacDigestAlgorithm to be used in MAC integrity protection algorithm

Parameters
macAlgorithm

MacAlgorithm to be used in MAC integrity protection algorithm

Parameters
keyWrappingAlgorithm

KeyWrappingAlgorithm to be used in MAC integrity protection algorithm

Member Function Documentation

◆ GetKeyWrappingAlgorithm()

virtual MacProperties.KeyWrappingAlgorithm iText.Kernel.Mac.MacProperties.GetKeyWrappingAlgorithm ( )
inlinevirtual

Gets KeyWrappingAlgorithm to be used in MAC integrity protection algorithm.

Returns

KeyWrappingAlgorithm to be used in MAC integrity protection algorithm

◆ GetMacAlgorithm()

virtual MacProperties.MacAlgorithm iText.Kernel.Mac.MacProperties.GetMacAlgorithm ( )
inlinevirtual

Gets MacAlgorithm to be used in MAC integrity protection algorithm.

Returns

MacAlgorithm to be used in MAC integrity protection algorithm

◆ GetMacDigestAlgorithm()

virtual MacProperties.MacDigestAlgorithm iText.Kernel.Mac.MacProperties.GetMacDigestAlgorithm ( )
inlinevirtual

Gets MacDigestAlgorithm to be used in MAC integrity protection algorithm.

Returns

MacDigestAlgorithm to be used in MAC integrity protection algorithm