summaryrefslogtreecommitdiff
path: root/crypto_libraries/inc/nx_crypto_hmac.h
blob: 29cab5d103f52e9790b2d2a84f2b99441016afa6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2025-present Eclipse ThreadX Contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** NetX Crypto Component                                                 */
/**                                                                       */
/**   HMAC Mode                                                           */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/**************************************************************************/
/*                                                                        */
/*  APPLICATION INTERFACE DEFINITION                       RELEASE        */
/*                                                                        */
/*    nx_crypto_hmac.h                                    PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Timothy Stapko, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This file defines the basic Application Interface (API) to the      */
/*    NetX Crypto HMAC module.                                            */
/*                                                                        */
/**************************************************************************/

#ifndef NX_CRYPTO_HMAC_H
#define NX_CRYPTO_HMAC_H

/* Determine if a C++ compiler is being used.  If so, ensure that standard
   C is used to process the API information.  */
#ifdef __cplusplus

/* Yes, C++ compiler is present.  Use standard C.  */
extern   "C" {

#endif

/* Include the ThreadX and port-specific data type file.  */

#include "nx_crypto.h"

#ifndef NX_CRYPTO_HMAC_MAX_PAD_SIZE
#define NX_CRYPTO_HMAC_MAX_PAD_SIZE  (128)
#endif

typedef struct NX_CRYPTO_HMAC_STRUCT
{
    VOID  *context;
    UCHAR  k_ipad[NX_CRYPTO_HMAC_MAX_PAD_SIZE];
    UCHAR  k_opad[NX_CRYPTO_HMAC_MAX_PAD_SIZE];
    UINT   algorithm;
    UINT   block_size;
    UINT   output_length;
    UINT   (*crypto_initialize)(VOID *, UINT);
    UINT   (*crypto_update)(VOID *, UCHAR *, UINT);
    UINT   (*crypto_digest_calculate)(VOID *, UCHAR *, UINT);
    NX_CRYPTO_METHOD *hash_method;
    VOID *hash_context;
} NX_CRYPTO_HMAC;

UINT _nx_crypto_hmac(NX_CRYPTO_HMAC *crypto_matadata,
                     UCHAR *input_ptr, UINT input_length,
                     UCHAR *key_ptr, UINT key_length,
                     UCHAR *digest_ptr, UINT digest_length);

UINT _nx_crypto_hmac_initialize(NX_CRYPTO_HMAC *crypto_matadata, UCHAR *key_ptr, UINT key_length);

UINT _nx_crypto_hmac_update(NX_CRYPTO_HMAC *crypto_matadata, UCHAR *input_ptr, UINT input_length);

UINT _nx_crypto_hmac_digest_calculate(NX_CRYPTO_HMAC *crypto_matadata, UCHAR *digest_ptr, UINT digest_length);

VOID _nx_crypto_hmac_metadata_set(NX_CRYPTO_HMAC *hmac_metadata,
                                  VOID *context,
                                  UINT algorithm, UINT block_size, UINT output_length,
                                  UINT (*crypto_initialize)(VOID *, UINT),
                                  UINT (*crypto_update)(VOID *, UCHAR *, UINT),
                                  UINT (*crypto_digest_calculate)(VOID *, UCHAR *, UINT));

UINT _nx_crypto_hmac_hash_initialize(VOID *context, UINT algorithm);
UINT   _nx_crypto_hmac_hash_update(VOID *context, UCHAR *input, UINT input_length);
UINT   _nx_crypto_hmac_hash_digest_calculate(VOID *context, UCHAR *digest, UINT algorithm);



UINT  _nx_crypto_method_hmac_init(struct  NX_CRYPTO_METHOD_STRUCT *method,
                                                        UCHAR *key, NX_CRYPTO_KEY_SIZE key_size_in_bits,
                                                        VOID  **handle,
                                                        VOID  *crypto_metadata,
                                                        ULONG crypto_metadata_size);

UINT  _nx_crypto_method_hmac_cleanup(VOID *crypto_metadata);

UINT _nx_crypto_method_hmac_operation(UINT op,      /* Encrypt, Decrypt, Authenticate */
                                                     VOID *handle, /* Crypto handler */
                                                     struct NX_CRYPTO_METHOD_STRUCT *method,
                                                     UCHAR *key,
                                                     NX_CRYPTO_KEY_SIZE key_size_in_bits,
                                                     UCHAR *input,
                                                     ULONG input_length_in_byte,
                                                     UCHAR *iv_ptr,
                                                     UCHAR *output,
                                                     ULONG output_length_in_byte,
                                                     VOID *crypto_metadata,
                                                     ULONG crypto_metadata_size,
                                                     VOID *packet_ptr,
                                                     VOID (*nx_crypto_hw_process_callback)(VOID *packet_ptr, UINT status));


#ifdef __cplusplus
}
#endif


#endif /* NX_CRYPTO_HAMC_H */