summaryrefslogtreecommitdiff
path: root/nx_secure/src/nx_secure_dtls_session_client_info_get.c
blob: 619b65b25bf01e7bff939b494c3634498446f6de (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
/***************************************************************************
 * 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                                                 */
/**                                                                       */
/**    Datagram Transport Layer Security (DTLS)                           */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define NX_SECURE_SOURCE_CODE

#include "nx_secure_dtls.h"
#include "nx_ipv6.h"

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _nx_secure_dtls_session_client_info_get             PORTABLE C      */
/*                                                           6.4.3        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Timothy Stapko, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function returns relevant information about a remote client    */
/*    that is connected to a DTLS server session instance.                */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    dtls_session                          DTLS session control block    */
/*    client_ip_address                     Return remote host IP address */
/*    client_port                           Return remote host UDP port   */
/*    local_port                            Return local UDP port         */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    status                                Completion status             */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    COPY_IPV6_ADDRESS                     Copy IPv6 address to return   */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application Code                                                    */
/*                                                                        */
/**************************************************************************/
UINT _nx_secure_dtls_session_client_info_get(NX_SECURE_DTLS_SESSION *dtls_session,
                                             NXD_ADDRESS *client_ip_address, UINT *client_port, UINT *local_port)
{
#ifdef NX_SECURE_ENABLE_DTLS
NX_UDP_SOCKET *socket_ptr;
NXD_ADDRESS *ip_address;

    /* Get our UDP socket. */
    socket_ptr = dtls_session->nx_secure_dtls_udp_socket;

    /* Make sure we have received a packet on the UDP socket - otherwise
       we don't have a DTLS connection and can't get info from a non-existent Client! */
    if(socket_ptr->nx_udp_socket_receive_head == NX_NULL)
    {
        return(NX_NOT_CONNECTED);
    }

    /* Get our local IP address for the deep copy below. */
    ip_address = &(dtls_session->nx_secure_dtls_remote_ip_address);

    /* Copy address version. */
    client_ip_address -> nxd_ip_version = ip_address -> nxd_ip_version;

#ifndef NX_DISABLE_IPV4
    if (ip_address -> nxd_ip_version == NX_IP_VERSION_V4)
    {
        /* Pickup the source IP address.  */
        client_ip_address -> nxd_ip_address.v4 = ip_address -> nxd_ip_address.v4;
    }
#endif /* NX_DISABLE_IPV4 */

#ifdef FEATURE_NX_IPV6
    if (ip_address -> nxd_ip_version == NX_IP_VERSION_V6)
    {
        COPY_IPV6_ADDRESS(ip_address -> nxd_ip_address.v6,
                          client_ip_address -> nxd_ip_address.v6);
    }
#endif /* FEATURE_NX_IPV6 */

    /* Copy the remote and local ports to our return parameters. */
    *client_port = dtls_session->nx_secure_dtls_remote_port;
    *local_port = dtls_session->nx_secure_dtls_local_port;

    return(NX_SUCCESS);
#else
    NX_PARAMETER_NOT_USED(dtls_session);
    NX_PARAMETER_NOT_USED(client_ip_address);
    NX_PARAMETER_NOT_USED(client_port);
    NX_PARAMETER_NOT_USED(local_port);

    return(NX_NOT_SUPPORTED);
#endif /* NX_SECURE_ENABLE_DTLS */
}