CMAC_CTX(3ossl)

📦
version 15.1 · 2 versions
, in freebsd 15.1

💅 CMAC_CTX — the 3ossl OpenSSL glow-up

Okay bestie, sit down, grab your boba 🍓 — this is the OpenSSL manual page for CMAC_CTX and its whole friend group, and yes, they're all lowkey retired 👑. This page lives in section 3ossl of the OpenSSL manuals, so iykyk.

✨ 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 — the whole squad that makes cipher-based message authentication codes happen 🎀

🌸 SYNOPSIS 🌸

#include <openssl/cmac.h>
⚠️ Heads up bestie: the following functions have been deprecated since OpenSSL 3.0, and can be disabled entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros(7). So like… they still work but they're giving "senior who won't retire" energy 😭
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 here's the tea ☕: the low-level MAC functions documented on this page are deprecated. Like, not "deprecated" in a cute way — in an actual "please move on" way. Applications should use the new EVP_MAC(3) interface instead. Specifically, use these besties for your MAC operations, periodt:

Or, alternatively, for a single-step MAC computation, use the EVP_Q_mac(3) function. One and done, no cap 💅

The CMAC_CTX type is a structure used for the provision of CMAC (Cipher-based Message Authentication Code) operations. That's the whole vibe.

CMAC_CTX_new() creates a new CMAC_CTX structure and returns a pointer to it. Fresh out the box, main character energy 👑

CMAC_CTX_cleanup() resets the CMAC_CTX structure, clearing any internal data but not freeing the structure itself. So it wipes the slate but keeps the body, iconic ✨

CMAC_CTX_free() frees the CMAC_CTX structure and any associated resources. If the argument is NULL, no action is taken — very "no thoughts, head empty" of it 🙈

CMAC_CTX_get0_cipher_ctx() returns a pointer to the internal EVP_CIPHER_CTX structure within the CMAC_CTX. Peek inside, it's giving backstage pass 🎟️

CMAC_CTX_copy() copies the state from one CMAC_CTX structure to another. Twin energy fr fr 🫶

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. Basically setting up the whole situation 🔥

CMAC_Update() processes data to be included in the CMAC calculation. This function can be called multiple times to update the context with additional data — feed it data in chunks, it eats every time 🍓

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 determine the required buffer size, call with out set to NULL, which stores only the length in poutlen. Allocate a buffer of this size and call CMAC_Final() again with the allocated buffer to retrieve the MAC. Two-step slay: first ask how big, then actually do it 💅

CMAC_resume() resumes a previously finalized CMAC calculation, allowing additional data to be processed and a new MAC to be generated. It's the "wait, one more thing" of functions 😭

🌈 RETURN VALUES 🌈

  • CMAC_CTX_new() returns a pointer to a new CMAC_CTX structure or NULL if an error occurs. NULL = it's not you, it's the error 💀
  • 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. Binary queen — either ate or didn't 🎀

⭐ 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). Move on bestie, the new interface is right there and it's gorgeous 💜

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, hope it ate 💖✨ — courtesy of the OpenSSL crew, version 3.5.6, dated 2026-04-07, and that's the cute little sign-off, mwah 🫶🎀

📦 where this page comes from