c3a4c229fe
* Enable lcov coverage in unit testing via cmake. * fix pipeline build error * add compile options for unit test to silence some warnings * remove all BAC_TEST unit tests in src/bacnet/ folder. They are now in test/bacnet/ folders using ztest. * removed key.c - only used for unit test. * produce XML test result output for parsing * produce junit XML test result output * change lint workflow to quality * update readme badge for quality results Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
354 lines
13 KiB
C
354 lines
13 KiB
C
/*####COPYRIGHTBEGIN####
|
|
-------------------------------------------
|
|
Copyright (C) 2006 Steve Karg
|
|
|
|
This program is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License
|
|
as published by the Free Software Foundation; either version 2
|
|
of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to:
|
|
The Free Software Foundation, Inc.
|
|
59 Temple Place - Suite 330
|
|
Boston, MA 02111-1307, USA.
|
|
|
|
As a special exception, if other files instantiate templates or
|
|
use macros or inline functions from this file, or you compile
|
|
this file and link it with other works to produce a work based
|
|
on this file, this file does not by itself cause the resulting
|
|
work to be covered by the GNU General Public License. However
|
|
the source code for this file must still be made available in
|
|
accordance with section (3) of the GNU General Public License.
|
|
|
|
This exception does not invalidate any other reasons why a work
|
|
based on this file might be covered by the GNU General Public
|
|
License.
|
|
-------------------------------------------
|
|
####COPYRIGHTEND####*/
|
|
#include <stdint.h>
|
|
#include "bacnet/bacenum.h"
|
|
#include "bacnet/bacdcode.h"
|
|
#include "bacnet/bacdef.h"
|
|
#include "bacnet/bacapp.h"
|
|
#include "bacnet/timesync.h"
|
|
|
|
/** @file timesync.c Encode/Decode TimeSync APDUs */
|
|
#if BACNET_SVC_TS_A
|
|
/** Encode the time synchronisation service.
|
|
*
|
|
* @param apdu [in] Buffer in which the APDU contents are written
|
|
* @param service [in] Time service that shall be encoded, like
|
|
* SERVICE_UNCONFIRMED_UTC_TIME_SYNCHRONIZATION.
|
|
* @param my_date [in] Pointer to the date structure used to encode.
|
|
* @param my_time [in] Pointer to the time structure used to encode.
|
|
*
|
|
* @return Count of encoded bytes.
|
|
*/
|
|
int timesync_encode_apdu_service(uint8_t *apdu,
|
|
BACNET_UNCONFIRMED_SERVICE service,
|
|
BACNET_DATE *my_date,
|
|
BACNET_TIME *my_time)
|
|
{
|
|
int len = 0; /* length of each encoding */
|
|
int apdu_len = 0; /* total length of the apdu, return value */
|
|
|
|
if (apdu && my_date && my_time) {
|
|
apdu[0] = PDU_TYPE_UNCONFIRMED_SERVICE_REQUEST;
|
|
apdu[1] = service;
|
|
apdu_len = 2;
|
|
len = encode_application_date(&apdu[apdu_len], my_date);
|
|
apdu_len += len;
|
|
len = encode_application_time(&apdu[apdu_len], my_time);
|
|
apdu_len += len;
|
|
}
|
|
|
|
return apdu_len;
|
|
}
|
|
|
|
/** Encode the service 'UTC_TIME_SYNCHRONIZATION'.
|
|
*
|
|
* @param apdu [in] Buffer in which the APDU contents are written
|
|
* @param my_date [in] Pointer to the date structure used to encode.
|
|
* @param my_time [in] Pointer to the time structure used to encode.
|
|
*
|
|
* @return Count of encoded bytes.
|
|
*/
|
|
int timesync_utc_encode_apdu(
|
|
uint8_t *apdu, BACNET_DATE *my_date, BACNET_TIME *my_time)
|
|
{
|
|
return timesync_encode_apdu_service(
|
|
apdu, SERVICE_UNCONFIRMED_UTC_TIME_SYNCHRONIZATION, my_date, my_time);
|
|
}
|
|
|
|
/** Encode the service 'TIME_SYNCHRONIZATION'.
|
|
*
|
|
* @param apdu [in] Buffer in which the APDU contents are written
|
|
* @param my_date [in] Pointer to the date structure used to encode.
|
|
* @param my_time [in] Pointer to the time structure used to encode.
|
|
*
|
|
* @return Count of encoded bytes.
|
|
*/
|
|
int timesync_encode_apdu(
|
|
uint8_t *apdu, BACNET_DATE *my_date, BACNET_TIME *my_time)
|
|
{
|
|
return timesync_encode_apdu_service(
|
|
apdu, SERVICE_UNCONFIRMED_TIME_SYNCHRONIZATION, my_date, my_time);
|
|
}
|
|
#endif
|
|
|
|
/** Decode the service request only.
|
|
*
|
|
* @param apdu [in] Buffer in which the APDU contents are read
|
|
* @param apdu_len [in] length of the APDU buffer.
|
|
* @param my_date [in] Pointer to the date structure filled in.
|
|
* @param my_time [in] Pointer to the time structure filled in.
|
|
*
|
|
* @return Count of decoded bytes.
|
|
*/
|
|
int timesync_decode_service_request(uint8_t *apdu,
|
|
unsigned apdu_len,
|
|
BACNET_DATE *my_date,
|
|
BACNET_TIME *my_time)
|
|
{
|
|
int len = 0;
|
|
uint8_t tag_number = 0;
|
|
uint32_t len_value = 0;
|
|
|
|
if (apdu_len && my_date && my_time) {
|
|
/* date */
|
|
len += decode_tag_number_and_value(&apdu[len], &tag_number, &len_value);
|
|
if (tag_number == BACNET_APPLICATION_TAG_DATE) {
|
|
if ((unsigned)(len + 4) <= apdu_len) {
|
|
len += decode_date(&apdu[len], my_date);
|
|
} else {
|
|
return -1;
|
|
}
|
|
} else {
|
|
return -1;
|
|
}
|
|
/* time */
|
|
len += decode_tag_number_and_value(&apdu[len], &tag_number, &len_value);
|
|
if (tag_number == BACNET_APPLICATION_TAG_TIME) {
|
|
if ((unsigned)(len + 4) <= apdu_len) {
|
|
len += decode_bacnet_time(&apdu[len], my_time);
|
|
} else {
|
|
return -1;
|
|
}
|
|
} else {
|
|
return -1;
|
|
}
|
|
}
|
|
|
|
return len;
|
|
}
|
|
|
|
/** Handle a request to encode the list of timesync recipients.
|
|
*
|
|
* Invoked by a request to read the Device object's
|
|
* PROP_TIME_SYNCHRONIZATION_RECIPIENTS.
|
|
* Loops through the list of timesync recipients, and, for each one,
|
|
* adds its data to the APDU.
|
|
*
|
|
* BACnetRecipient ::= CHOICE {
|
|
* device [0] BACnetObjectIdentifier,
|
|
* address [1] BACnetAddress
|
|
* }
|
|
*
|
|
* BACnetAddress ::= SEQUENCE {
|
|
* network-number Unsigned16, -- A value of 0 indicates the local network
|
|
* mac-address OCTET STRING -- A string of length 0 indicates a broadcast
|
|
* }
|
|
*
|
|
* @param apdu [out] Buffer in which the APDU contents are built.
|
|
* @param max_apdu [in] Max length of the APDU buffer.
|
|
* @param recipient [in] BACNET_RECIPIENT_LIST type linked list of recipients.
|
|
*
|
|
* @return How many bytes were encoded in the buffer, or
|
|
* BACNET_STATUS_ABORT if the response would not fit within the buffer.
|
|
*/
|
|
int timesync_encode_timesync_recipients(
|
|
uint8_t *apdu, unsigned max_apdu, BACNET_RECIPIENT_LIST *recipient)
|
|
{
|
|
int len = 0;
|
|
int apdu_len = 0;
|
|
BACNET_OCTET_STRING octet_string;
|
|
BACNET_RECIPIENT_LIST *pRecipient;
|
|
|
|
if ((!apdu) || (max_apdu < 1) || (!recipient)) {
|
|
return (0);
|
|
}
|
|
|
|
pRecipient = recipient;
|
|
while (pRecipient != NULL) {
|
|
if (pRecipient->tag == 0) {
|
|
if (max_apdu >= (1 + 4)) {
|
|
/* CHOICE - device [0] BACnetObjectIdentifier */
|
|
len = encode_context_object_id(&apdu[apdu_len], 0,
|
|
pRecipient->type.device.type,
|
|
pRecipient->type.device.instance);
|
|
apdu_len += len;
|
|
} else {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
} else if (pRecipient->tag == 1) {
|
|
if (pRecipient->type.address.net) {
|
|
len = (int)(1 + 3 + 2 + pRecipient->type.address.len + 1);
|
|
} else {
|
|
len = (int)(1 + 3 + 2 + pRecipient->type.address.mac_len + 1);
|
|
}
|
|
if (max_apdu >= (unsigned)len) {
|
|
/* CHOICE - address [1] BACnetAddress - opening */
|
|
len = encode_opening_tag(&apdu[apdu_len], 1);
|
|
apdu_len += len;
|
|
/* network-number Unsigned16, */
|
|
/* -- A value of 0 indicates the local network */
|
|
len = encode_application_unsigned(
|
|
&apdu[apdu_len], pRecipient->type.address.net);
|
|
apdu_len += len;
|
|
/* mac-address OCTET STRING */
|
|
/* -- A string of length 0 indicates a broadcast */
|
|
if (pRecipient->type.address.net == BACNET_BROADCAST_NETWORK) {
|
|
octetstring_init(&octet_string, NULL, 0);
|
|
} else if (pRecipient->type.address.net) {
|
|
octetstring_init(&octet_string,
|
|
&pRecipient->type.address.adr[0],
|
|
pRecipient->type.address.len);
|
|
} else {
|
|
octetstring_init(&octet_string,
|
|
&pRecipient->type.address.mac[0],
|
|
pRecipient->type.address.mac_len);
|
|
}
|
|
len = encode_application_octet_string(
|
|
&apdu[apdu_len], &octet_string);
|
|
apdu_len += len;
|
|
/* CHOICE - address [1] BACnetAddress - closing */
|
|
len = encode_closing_tag(&apdu[apdu_len], 1);
|
|
apdu_len += len;
|
|
} else {
|
|
/* not a valid tag - don't encode this one */
|
|
}
|
|
}
|
|
pRecipient = pRecipient->next;
|
|
}
|
|
|
|
return apdu_len;
|
|
}
|
|
|
|
/** Handle a request to decode a list of timesync recipients.
|
|
*
|
|
* Invoked by a request to write the Device object's
|
|
* PROP_TIME_SYNCHRONIZATION_RECIPIENTS.
|
|
* Loops through the list of timesync recipients, and, for each one,
|
|
* adds its data from the APDU.
|
|
*
|
|
* BACnetRecipient ::= CHOICE {
|
|
* device [0] BACnetObjectIdentifier,
|
|
* address [1] BACnetAddress
|
|
* }
|
|
*
|
|
* BACnetAddress ::= SEQUENCE {
|
|
* network-number Unsigned16, -- A value of 0 indicates the local network
|
|
* mac-address OCTET STRING -- A string of length 0 indicates a broadcast
|
|
* }
|
|
*
|
|
* @param apdu [in] Buffer in which the APDU contents are read
|
|
* @param max_apdu [in] length of the APDU buffer.
|
|
* @param recipient [out] BACNET_RECIPIENT_LIST type linked list of recipients.
|
|
*
|
|
* @return How many bytes were decoded from the buffer, or
|
|
* BACNET_STATUS_ABORT if there was a problem decoding the buffer
|
|
*/
|
|
int timesync_decode_timesync_recipients(
|
|
uint8_t *apdu, unsigned max_apdu, BACNET_RECIPIENT_LIST *recipient)
|
|
{
|
|
int len = 0;
|
|
int apdu_len = 0;
|
|
int tag_len = 0;
|
|
uint8_t tag_number = 0;
|
|
uint32_t len_value_type = 0;
|
|
BACNET_UNSIGNED_INTEGER unsigned_value = 0;
|
|
BACNET_OCTET_STRING octet_string;
|
|
BACNET_RECIPIENT_LIST *pRecipient;
|
|
|
|
if ((!apdu) || (max_apdu < 1) || (!recipient)) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
|
|
pRecipient = recipient;
|
|
while (pRecipient != NULL) {
|
|
/* device [0] BACnetObjectIdentifier */
|
|
if (decode_is_context_tag(&apdu[apdu_len], 0)) {
|
|
pRecipient->tag = 0;
|
|
if ((unsigned)(apdu_len + 4) > max_apdu) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
len = decode_context_object_id(&apdu[apdu_len], 0,
|
|
&pRecipient->type.device.type,
|
|
&pRecipient->type.device.instance);
|
|
if (len < 0) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
apdu_len += len;
|
|
} else if (decode_is_opening_tag_number(&apdu[apdu_len], 1)) {
|
|
apdu_len += 1;
|
|
pRecipient->tag = 1;
|
|
/* network-number Unsigned16 */
|
|
tag_len = decode_tag_number_and_value(
|
|
&apdu[apdu_len], &tag_number, &len_value_type);
|
|
apdu_len += tag_len;
|
|
if ((unsigned)apdu_len > max_apdu) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
if (tag_number != BACNET_APPLICATION_TAG_UNSIGNED_INT) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
len = decode_unsigned(
|
|
&apdu[apdu_len], len_value_type, &unsigned_value);
|
|
pRecipient->type.address.net = (uint16_t)unsigned_value;
|
|
apdu_len += len;
|
|
if ((unsigned)apdu_len > max_apdu) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
/* mac-address OCTET STRING */
|
|
tag_len = decode_tag_number_and_value(
|
|
&apdu[apdu_len], &tag_number, &len_value_type);
|
|
apdu_len += tag_len;
|
|
if (tag_number != BACNET_APPLICATION_TAG_OCTET_STRING) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
len = bacnet_octet_string_decode(&apdu[apdu_len],
|
|
max_apdu - apdu_len, len_value_type, &octet_string);
|
|
if (len < 0) {
|
|
return BACNET_STATUS_ERROR;
|
|
}
|
|
apdu_len += len;
|
|
if (octetstring_length(&octet_string) == 0) {
|
|
/* -- A string of length 0 indicates a broadcast */
|
|
} else if (pRecipient->type.address.net) {
|
|
pRecipient->type.address.len =
|
|
octetstring_copy_value(&pRecipient->type.address.adr[0],
|
|
sizeof(pRecipient->type.address.adr), &octet_string);
|
|
} else {
|
|
pRecipient->type.address.mac_len =
|
|
octetstring_copy_value(&pRecipient->type.address.mac[0],
|
|
sizeof(pRecipient->type.address.mac), &octet_string);
|
|
}
|
|
if (!decode_is_closing_tag_number(&apdu[apdu_len], 1)) {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
apdu_len += 1;
|
|
} else {
|
|
return BACNET_STATUS_ABORT;
|
|
}
|
|
pRecipient = pRecipient->next;
|
|
}
|
|
|
|
return apdu_len;
|
|
}
|