summaryrefslogtreecommitdiff
path: root/nx_secure/src/nx_secure_tls_ciphersuite_lookup.c
blob: fd80ee5b9ba37cff1a258c5b4beb840a81e5c08d (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
/***************************************************************************
 * 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 Secure Component                                                 */
/**                                                                       */
/**    Transport Layer Security (TLS)                                     */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SECURE_SOURCE_CODE

#include "nx_secure_tls.h"

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_secure_tls_ciphersuite_lookup                   PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Timothy Stapko, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function returns data about a selected ciphersuite for use     */
/*    in various TLS internal functions, such as the ciphers used and     */
/*    associated key sizes.                                               */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    tls_session                           TLS session control block     */
/*    ciphersuite                           Ciphersuite value             */
/*    info                                  Pointer to ciphersuite info   */
/*                                            structure (output)          */
/*    priority                              Priority index of ciphersuite */
/*                                            in the ciphersuite table    */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    _nx_secure_dtls_process_clienthello   Process ClientHello           */
/*    _nx_secure_tls_process_clienthello    Process ClientHello           */
/*    _nx_secure_tls_process_serverhello    Process ServerHello           */
/*                                                                        */
/**************************************************************************/
UINT _nx_secure_tls_ciphersuite_lookup(NX_SECURE_TLS_SESSION *tls_session, UINT ciphersuite,
                                       NX_SECURE_TLS_CIPHERSUITE_INFO const **info, USHORT *priority)
{
USHORT                          index;
NX_SECURE_TLS_CIPHERSUITE_INFO *cipher_table;
USHORT                          cipher_table_size;

    cipher_table = tls_session -> nx_secure_tls_crypto_table -> nx_secure_tls_ciphersuite_lookup_table;
    cipher_table_size = tls_session -> nx_secure_tls_crypto_table -> nx_secure_tls_ciphersuite_lookup_table_size;

    /* The number of ciphersuites is very small so a linear search should be fine. */
    for (index = 0; index < cipher_table_size; ++index)
    {
        /* See if the ciphersuite is supported. */
        if (cipher_table[index].nx_secure_tls_ciphersuite == ciphersuite)
        {
            /* Return the ciphersuite information. */
            *info = &cipher_table[index];

            /* Return the priority index (lower number == higher priority). */
            *priority = index;
            return(NX_SUCCESS);
        }
    }

    /* No ciphersuite found, suite unknown. */
    return(NX_SECURE_TLS_UNKNOWN_CIPHERSUITE);
}