opcua_transport_layer.h

/******************************************************************************
** Copyright (C) 2006-2009 ascolab GmbH. All Rights Reserved.
** Web: http://www.ascolab.com
**
** SPDX-License-Identifier: GPL-2.0-or-later
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** Project: OpcUa Wireshark Plugin
**
** Description: OpcUa Transport Layer Decoder.
**
** Author: Gerhard Gappmeier <[email protected]>
******************************************************************************/
 
/* This struct is used to pass meta data down to decoding functions. */
struct ua_metadata {
    bool encrypted; /* true if payload is encrypted, false if no encryption was used or it was successfully decrypted. */
};
 
extern int g_opcua_default_sig_len;
 
/* Transport Layer: message parsers */
int parseHello(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseAcknowledge(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseError(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseReverseHello(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseMessage(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseAbort(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseService(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseOpenSecureChannel(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
int parseCloseSecureChannel(proto_tree *tree, tvbuff_t *tvb, packet_info *pinfo, int *pOffset, struct ua_metadata *data);
void registerTransportLayerTypes(int proto);
 
/*
 * The per-conversation encryption information is stored in a pointer
 * value; here are functions to construct the pointer value, as a
 * uintptr_t and extract values from the pointer value.
 */
#include "opcua_simpletypes.h"
static inline uintptr_t
construct_encryption_info(enum ua_message_mode mode, uint8_t sig_len)
{
    return ((uintptr_t)sig_len << 8) | (uintptr_t)mode;
}
 
static inline enum ua_message_mode
extract_message_mode(uintptr_t data)
{
    return (enum ua_message_mode)(data & 0xff);
}
 
static inline uint8_t
extract_signature_length(uintptr_t data)
{
    return (uint8_t)(data >> 8);
}
 
void store_encryption_info(packet_info *pinfo, enum ua_message_mode mode, uint8_t sig_len);
void get_encryption_info(packet_info *pinfo, enum ua_message_mode *mode, uint8_t *sig_len);