summaryrefslogtreecommitdiff
path: root/nx_secure/src/nx_secure_x509_remote_endpoint_certificate_get.c
blob: fbe4aa6ddf3d05a63628ae1c4302e331c2759408 (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
131
132
/***************************************************************************
 * 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                                                 */
/**                                                                       */
/**    X.509 Digital Certificates                                         */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SECURE_SOURCE_CODE

#include "nx_secure_x509.h"

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_secure_x509_remote_endpoint_certificate_get     PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Timothy Stapko, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function searches a given certificate store for an endpoint    */
/*    certificate. This is decided by searching the "remote" certificate  */
/*    list in the given store for a certificate that is not the issuer    */
/*    for another certificate in the store.                               */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    store                                 Pointer to certificate store  */
/*    certificate                           Pointer to cert pointer       */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _nx_secure_x509_distinguished_name_compare                          */
/*                                          Compare distinguished name    */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    _nx_secure_tls_process_certificate_verify                           */
/*                                          Process CertificateVerify     */
/*    _nx_secure_tls_remote_certificate_verify                            */
/*                                          Verify the server certificate */
/*    _nx_secure_tls_send_client_key_exchange                             */
/*                                          Send ClientKeyExchange        */
/*    _nx_secure_tls_process_server_key_exchange                          */
/*                                          Process ServerKeyExchange     */
/*                                                                        */
/**************************************************************************/
UINT _nx_secure_x509_remote_endpoint_certificate_get(NX_SECURE_X509_CERTIFICATE_STORE *store,
                                                     NX_SECURE_X509_CERT **certificate)
{
NX_SECURE_X509_CERT *compare_cert;
NX_SECURE_X509_CERT *candidate;
NX_SECURE_X509_CERT *list_head;
INT                  compare_value;


    /* Get the first certificate in the remote store. */
    list_head = store -> nx_secure_x509_remote_certificates;
    candidate = list_head;

    if (candidate == NX_CRYPTO_NULL)
    {
        /* No remote certificates in this store! */
        return(NX_SECURE_X509_CERTIFICATE_NOT_FOUND);
    }

    /* At this point, we have multiple certificates in the remote store. We need to loop
       to find the one that isn't an issuer for the others. The list should almost always be
       short (< 5 entries) so optimization isn't critical. */
    while (candidate -> nx_secure_x509_next_certificate != NX_CRYPTO_NULL)
    {
        compare_cert = list_head;

        while (compare_cert != NX_CRYPTO_NULL)
        {
            /* Search the entire list for this certificate's distinguished name in the issuer fields. */
            compare_value = _nx_secure_x509_distinguished_name_compare(&candidate -> nx_secure_x509_distinguished_name,
                                                                       &compare_cert -> nx_secure_x509_issuer, NX_SECURE_X509_NAME_ALL_FIELDS);

            /* If we matched, break out of the loop. */
            if (compare_value == 0)
            {
                break;
            }

            /* Advance the comparison pointer. */
            compare_cert = compare_cert -> nx_secure_x509_next_certificate;
        }

        if (compare_cert != NX_CRYPTO_NULL)
        {
            /* Advance the pointer to the next entry in the list. */
            candidate = candidate -> nx_secure_x509_next_certificate;
        }
        else
        {
            /* We got through the compare loop without matching an issuer field, so break out of the loop
               and return the candidate. */
            break;
        }
    }

    /* Return the candidate. */
    *certificate = candidate;

    /* No matter what we found, it is a certificate so return success - if the certificate
       is invalid for any reason, that will be caught during certificate verification. */
    return(NX_SECURE_X509_SUCCESS);
}