Skip to content

Privatize functions and some types/macros in cipher.h #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open

Privatize functions and some types/macros in cipher.h #259

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1434e2b
Privatize functions and some types/macros in cipher.h
felixc-arm Apr 16, 2025
458ec1e
Unprivatized some macros and types to fix CI
felixc-arm Apr 17, 2025
a940dde
Re-privatize KEY_BITLEN_SHIFT & IV_SIZE_SHIFT
felixc-arm Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions drivers/builtin/include/mbedtls/cipher.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,10 @@
/** The context is invalid. For example, because it was freed. */
#define MBEDTLS_ERR_CIPHER_INVALID_CONTEXT -0x6380

#if defined(MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS)
#define MBEDTLS_CIPHER_VARIABLE_IV_LEN 0x01 /**< Cipher accepts IVs of variable length. */
#define MBEDTLS_CIPHER_VARIABLE_KEY_LEN 0x02 /**< Cipher accepts keys of variable length. */
#endif

#ifdef __cplusplus
extern "C" {
Expand Down Expand Up @@ -186,6 +188,7 @@ typedef enum {
MBEDTLS_MODE_KWP, /**< The SP800-38F KWP mode */
} mbedtls_cipher_mode_t;

#if defined(MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS)
/** Supported cipher padding types. */
typedef enum {
MBEDTLS_PADDING_PKCS7 = 0, /**< PKCS7 padding (default). */
Expand All @@ -194,6 +197,7 @@ typedef enum {
MBEDTLS_PADDING_ZEROS, /**< Zero padding (not reversible). */
MBEDTLS_PADDING_NONE, /**< Never pad (full blocks only). */
} mbedtls_cipher_padding_t;
#endif /* MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS */

/** Type of operation. */
typedef enum {
Expand All @@ -202,6 +206,7 @@ typedef enum {
MBEDTLS_ENCRYPT,
} mbedtls_operation_t;

#if defined(MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS)
enum {
/** Undefined key length. */
MBEDTLS_KEY_LENGTH_NONE = 0,
Expand All @@ -212,6 +217,7 @@ enum {
/** Key length in bits, including parity, for DES in three-key EDE. \warning 3DES is considered weak. */
MBEDTLS_KEY_LENGTH_DES_EDE3 = 192,
};
#endif /* MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS */

/** Maximum length of any IV, in Bytes. */
/* This should ideally be derived automatically from list of ciphers.
Expand Down Expand Up @@ -266,13 +272,13 @@ typedef struct mbedtls_cipher_info_t {
/** The block size, in bytes. */
unsigned int MBEDTLS_PRIVATE(block_size) : 5;

/** IV or nonce size, in bytes (right shifted by #MBEDTLS_IV_SIZE_SHIFT).
/** IV or nonce size, in bytes (right shifted by MBEDTLS_IV_SIZE_SHIFT).
* For ciphers that accept variable IV sizes,
* this is the recommended size.
*/
unsigned int MBEDTLS_PRIVATE(iv_size) : 3;

/** The cipher key length, in bits (right shifted by #MBEDTLS_KEY_BITLEN_SHIFT).
/** The cipher key length, in bits (right shifted by MBEDTLS_KEY_BITLEN_SHIFT).
* This is the default length for variable sized ciphers.
* Includes parity bits for ciphers like DES.
*/
Expand Down Expand Up @@ -302,10 +308,13 @@ typedef struct mbedtls_cipher_info_t {

} mbedtls_cipher_info_t;

#if defined(MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS)
/* For internal use only.
* These are used to more compactly represent the fields above. */
#define MBEDTLS_KEY_BITLEN_SHIFT 6
#define MBEDTLS_IV_SIZE_SHIFT 2
#endif

/**
* Generic cipher context.
*/
Expand Down Expand Up @@ -363,6 +372,7 @@ typedef struct mbedtls_cipher_context_t {

} mbedtls_cipher_context_t;

#if defined(MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS)
/**
* \brief This function retrieves the list of ciphers supported
* by the generic cipher module.
Expand Down Expand Up @@ -1160,6 +1170,9 @@ int mbedtls_cipher_auth_decrypt_ext(mbedtls_cipher_context_t *ctx,
unsigned char *output, size_t output_len,
size_t *olen, size_t tag_len);
#endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */

#endif /* MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS */

#ifdef __cplusplus
}
#endif
Expand Down