CMAC_CTX(3ossl)

πŸ’– CMAC_CTX(3ossl) β€” or, the girlies' guide to cipher-based message authentication codes πŸ’–

okay so bestie, welcome to CMAC_CTX(3ossl), part of the OpenSSL manual, and honestly? this one comes with a big fat deprecation warning attached, so buckle up πŸŽ€


✨ NAME ✨

CMAC_CTX, CMAC_CTX_new, CMAC_CTX_cleanup, CMAC_CTX_free, CMAC_CTX_get0_cipher_ctx, CMAC_CTX_copy, CMAC_Init, CMAC_Update, CMAC_Final, CMAC_resume β€” they make cipher-based message authentication codes. that's the whole vibe πŸ’…


🌸 SYNOPSIS 🌸

#include <openssl/cmac.h>
🚨 heads up babes: every single one of these functions has been deprecated since OpenSSL 3.0, and you can disable them entirely by defining OPENSSL_API_COMPAT with a suitable version value. see openssl_user_macros(7) for the deets.
typedef struct CMAC_CTX_st CMAC_CTX;

CMAC_CTX *CMAC_CTX_new(void);
void CMAC_CTX_cleanup(CMAC_CTX *ctx);
void CMAC_CTX_free(CMAC_CTX *ctx);
EVP_CIPHER_CTX *CMAC_CTX_get0_cipher_ctx(CMAC_CTX *ctx);
int CMAC_CTX_copy(CMAC_CTX *out, const CMAC_CTX *in);
int CMAC_Init(CMAC_CTX *ctx, const void *key, size_t keylen,
              const EVP_CIPHER *cipher, ENGINE *impl);
int CMAC_Update(CMAC_CTX *ctx, const void *data, size_t dlen);
int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen);
int CMAC_resume(CMAC_CTX *ctx);

πŸ¦‹ DESCRIPTION πŸ¦‹

so, the low-level MAC functions documented on this page are deprecated, periodt. applications should use the new EVP_MAC(3) interface instead. and specifically, for your MAC operations, you're gonna want these:

or alternatively, if you just want a single-step MAC computation, use the EVP_Q_mac(3) function. slay ✨

the CMAC_CTX type is a structure used for the provision of CMAC (Cipher-based Message Authentication Code) operations. iconic.

CMAC_CTX_new() creates a new CMAC_CTX structure and returns a pointer to it. fresh out the box πŸŽ€

CMAC_CTX_cleanup() resets the CMAC_CTX structure, clearing any internal data but not freeing the structure itself. so like, a glow-up, not a goodbye.

CMAC_CTX_free() frees the CMAC_CTX structure and any associated resources. if the argument is NULL, no action is taken. she's polite like that 🫢

CMAC_CTX_get0_cipher_ctx() returns a pointer to the internal EVP_CIPHER_CTX structure within the CMAC_CTX.

CMAC_CTX_copy() copies the state from one CMAC_CTX structure to another. twin energy πŸ‘―

CMAC_Init() initializes the CMAC_CTX structure for a new CMAC calculation with the specified key, key length, and cipher type. optionally, an ENGINE can be provided.

CMAC_Update() processes data to be included in the CMAC calculation. you can call this function multiple times to update the context with additional data β€” feed her, bestie πŸ“

CMAC_Final() finalizes the CMAC calculation and retrieves the resulting MAC value. the output is stored in the provided buffer, and the length is stored in the variable pointed to by poutlen. to figure out the required buffer size, call it with out set to NULL, which stores only the length in poutlen. then allocate a buffer of that size and call CMAC_Final() again with the allocated buffer to actually get the MAC. two-step moment, but it works πŸ’…

CMAC_resume() resumes a previously finalized CMAC calculation, allowing additional data to be processed and a new MAC to be generated. she's back and she's better 🌈


πŸ‘‘ RETURN VALUES πŸ‘‘

CMAC_CTX_new() returns a pointer to a new CMAC_CTX structure, or NULL if an error occurs. 😭

CMAC_CTX_get0_cipher_ctx() returns a pointer to the internal EVP_CIPHER_CTX structure, or NULL if an error occurs. 😭

CMAC_CTX_copy(), CMAC_Init(), CMAC_Update(), CMAC_Final() and CMAC_resume() return 1 for success or 0 if an error occurs. no in-between, no situationship, just 1 or 0 periodt.


πŸ’€ HISTORY πŸ’€

all functions described here were deprecated in OpenSSL 3.0. for replacements, see EVP_MAC_CTX_new(3), EVP_MAC_CTX_free(3), EVP_MAC_init(3), EVP_MAC_update(3), and EVP_MAC_final(3). not me still seeing these in the wild in 2026 πŸ’€


Copyright 2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.


okay that's the whole page bestie, you ate that πŸ’…βœ¨ this was OpenSSL 3.5.9, dated 2026-09-29, and yeah the CMAC_CTX girlies are deprecated so go use EVP_MAC instead, mwah πŸ«ΆπŸŽ€

πŸ“¦ where this page comes from