cryptography-core/dev.whyoleg.cryptography.algorithms/AES

AES

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface AES<K : AES.Key> : CryptographyAlgorithm(source)

Advanced Encryption Standard (AES) symmetric encryption algorithm as defined in FIPS 197.

AES supports multiple modes of operation:

GCM and CCM — authenticated encryption with associated data (AEAD).
CTR, CBC, OFB, CFB, CFB8 — unauthenticated block/stream cipher modes.
ECB — electronic codebook, unsuitable for most use cases.
CMAC — message authentication code.

Key sizes of 128, 192, or 256 bits are available via Key.Size. For authenticated encryption, prefer GCM. For legacy compatibility, CBC is widely supported.

Inheritors

Types

CBC

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface CBC : AES<AES.CBC.Key>

AES in Cipher Block Chaining (CBC) mode as defined in NIST SP 800-38A.

CCM

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface CCM : AES<AES.CCM.Key>

AES in Counter with CBC-MAC (CCM) mode, an authenticated encryption scheme as defined in NIST SP 800-38C.

CFB

@DelicateCryptographyApi

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface CFB : AES<AES.CFB.Key>

AES in Cipher Feedback (CFB) mode with full-block feedback, a stream cipher as defined in NIST SP 800-38A.

CFB8

@DelicateCryptographyApi

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface CFB8 : AES<AES.CFB8.Key>

AES in Cipher Feedback (CFB8) mode with 8-bit feedback as defined in NIST SP 800-38A.

CMAC

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface CMAC : AES<AES.CMAC.Key>

AES Cipher-based Message Authentication Code (CMAC) as defined in NIST SP 800-38B.

CTR

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface CTR : AES<AES.CTR.Key>

AES in Counter (CTR) mode, a stream cipher as defined in NIST SP 800-38A.

ECB

@DelicateCryptographyApi

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface ECB : AES<AES.ECB.Key>

AES in Electronic Codebook (ECB) mode as defined in NIST SP 800-38A.

GCM

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface GCM : AES<AES.GCM.Key>

AES in Galois/Counter Mode (GCM), an authenticated encryption scheme as defined in NIST SP 800-38D.

Key

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface Key : Encodable<AES.Key.Format>

OFB

@DelicateCryptographyApi

@SubclassOptInRequired(markerClass = [CryptographyProviderApi::class])

interface OFB : AES<AES.OFB.Key>

AES in Output Feedback (OFB) mode, a stream cipher as defined in NIST SP 800-38A.

Properties

abstract val id: CryptographyAlgorithmId<*>

The typed identifier that uniquely distinguishes this algorithm and is used to look it up from a CryptographyProvider.

Functions

keyDecoder

abstract fun keyDecoder(): Decoder<AES.Key.Format, K>

Returns a Decoder that decodes AES keys from the specified Key.Format.

keyGenerator

abstract fun keyGenerator(keySize: BinarySize = Key.Size.B256): KeyGenerator<K>

Returns a KeyGenerator that generates AES keys of the given keySize.