Definitions common to NTP client and server. More...

#include "core/net.h"

Macros
#define	NTP_PORT 123

#define	NTP_MAX_MSG_SIZE 68

#define	NTP_UNIX_EPOCH 2208988800U

#define	NTP_KISS_CODE(a, b, c, d) (((a) << 24) \| ((b) << 16) \| ((c) << 8) \| (d))

Enumerations
enum	NtpLeapIndicator { NTP_LI_NO_WARNING = 0, NTP_LI_LAST_MIN_HAS_61_SECS = 1, NTP_LI_LAST_MIN_HAS_59_SECS = 2, NTP_LI_ALARM_CONDITION = 3 }
	Leap indicator. More...

enum	NtpVersion { NTP_VERSION_1 = 1, NTP_VERSION_2 = 2, NTP_VERSION_3 = 3, NTP_VERSION_4 = 4 }
	NTP version numbers. More...

enum	NtpMode { NTP_MODE_SYMMETRIC_ACTIVE = 1, NTP_MODE_SYMMETRIC_PASSIVE = 2, NTP_MODE_CLIENT = 3, NTP_MODE_SERVER = 4, NTP_MODE_BROADCAST = 5 }
	Protocol modes. More...

enum	NtpStratum { NTP_STRATUM_KISS_OF_DEATH = 0, NTP_STRATUM_PRIMARY = 1, NTP_STRATUM_SECONDARY_2 = 2, NTP_STRATUM_SECONDARY_3 = 3, NTP_STRATUM_SECONDARY_4 = 4, NTP_STRATUM_SECONDARY_5 = 5, NTP_STRATUM_SECONDARY_6 = 6, NTP_STRATUM_SECONDARY_7 = 7, NTP_STRATUM_SECONDARY_8 = 8, NTP_STRATUM_SECONDARY_9 = 9, NTP_STRATUM_SECONDARY_10 = 10, NTP_STRATUM_SECONDARY_11 = 11, NTP_STRATUM_SECONDARY_12 = 12, NTP_STRATUM_SECONDARY_13 = 13, NTP_STRATUM_SECONDARY_14 = 14, NTP_STRATUM_SECONDARY_15 = 15 }
	Stratum. More...

enum	NtpKissCode { NTP_KISS_CODE_ACST = NTP_KISS_CODE('A', 'C', 'S', 'T'), NTP_KISS_CODE_AUTH = NTP_KISS_CODE('A', 'U', 'T', 'H'), NTP_KISS_CODE_AUTO = NTP_KISS_CODE('A', 'U', 'T', 'O'), NTP_KISS_CODE_BCST = NTP_KISS_CODE('B', 'C', 'S', 'T'), NTP_KISS_CODE_CRYP = NTP_KISS_CODE('C', 'R', 'Y', 'P'), NTP_KISS_CODE_DENY = NTP_KISS_CODE('D', 'E', 'N', 'Y'), NTP_KISS_CODE_DROP = NTP_KISS_CODE('D', 'R', 'O', 'P'), NTP_KISS_CODE_RSTR = NTP_KISS_CODE('R', 'S', 'T', 'R'), NTP_KISS_CODE_INIT = NTP_KISS_CODE('I', 'N', 'I', 'T'), NTP_KISS_CODE_MCST = NTP_KISS_CODE('M', 'C', 'S', 'T'), NTP_KISS_CODE_NKEY = NTP_KISS_CODE('N', 'K', 'E', 'Y'), NTP_KISS_CODE_RATE = NTP_KISS_CODE('R', 'A', 'T', 'E'), NTP_KISS_CODE_RMOT = NTP_KISS_CODE('R', 'M', 'O', 'T'), NTP_KISS_CODE_STEP = NTP_KISS_CODE('S', 'T', 'E', 'P'), NTP_KISS_CODE_NTSN = NTP_KISS_CODE('N', 'T', 'S', 'N') }
	Kiss codes. More...

enum	NtpExtensionType { NTP_EXTENSION_TYPE_NO_OPERATION_REQ = 0x0002, NTP_EXTENSION_TYPE_UNIQUE_ID = 0x0104, NTP_EXTENSION_TYPE_NTS_COOKIE = 0x0204, NTP_EXTENSION_TYPE_NTS_COOKIE_PLACEHOLDER = 0x0304, NTP_EXTENSION_TYPE_NTS_AEAD = 0x0404, NTP_EXTENSION_TYPE_NO_OPERATION_RESP = 0x8002, NTP_EXTENSION_TYPE_NO_OPERATION_ERROR_RESP = 0xC002 }
	NTP extensions field types. More...

Functions
const NtpExtension *	ntpGetExtension (const uint8_t *extensions, size_t length, uint16_t type, uint_t index)
	Search a NTP packet for a given extension. More...

Variables
typedef	__packed_struct
	NTP timestamp representation. More...

uint32_t	fraction

	NtpTimestamp

uint8_t	vn

uint8_t	li

uint8_t	stratum

uint8_t	poll

int8_t	precision

uint32_t	rootDelay

uint32_t	rootDispersion

uint32_t	referenceId

NtpTimestamp	referenceTimestamp

NtpTimestamp	originateTimestamp

NtpTimestamp	receiveTimestamp

NtpTimestamp	transmitTimestamp

uint8_t	extensions []

	NtpHeader

uint16_t	length

uint8_t	value []

	NtpExtension

uint16_t	nonceLength

uint16_t	ciphertextLength

uint8_t	nonce []

	NtpNtsAeadExtension

Detailed Description

Definitions common to NTP client and server.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneTCP Open.

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.4.4

Definition in file ntp_common.h.

Macro Definition Documentation

◆ NTP_KISS_CODE

#define NTP_KISS_CODE	(	a,
		b,
		c,
		d
	)	(((a) << 24) \| ((b) << 16) \| ((c) << 8) \| (d))

Definition at line 45 of file ntp_common.h.

◆ NTP_MAX_MSG_SIZE

#define NTP_MAX_MSG_SIZE 68

Definition at line 40 of file ntp_common.h.

◆ NTP_PORT

#define NTP_PORT 123

Definition at line 38 of file ntp_common.h.

◆ NTP_UNIX_EPOCH

#define NTP_UNIX_EPOCH 2208988800U

Definition at line 42 of file ntp_common.h.

Enumeration Type Documentation

◆ NtpExtensionType

enum NtpExtensionType

NTP extensions field types.

Enumerator
NTP_EXTENSION_TYPE_NO_OPERATION_REQ	No-Operation Request.
NTP_EXTENSION_TYPE_UNIQUE_ID	Unique Identifier.
NTP_EXTENSION_TYPE_NTS_COOKIE	NTS Cookie.
NTP_EXTENSION_TYPE_NTS_COOKIE_PLACEHOLDER	NTS Cookie Placeholder.
NTP_EXTENSION_TYPE_NTS_AEAD	NTS Authenticator and Encrypted Extension Fields.
NTP_EXTENSION_TYPE_NO_OPERATION_RESP	No-Operation Response.
NTP_EXTENSION_TYPE_NO_OPERATION_ERROR_RESP	No-Operation Error Response.

Definition at line 151 of file ntp_common.h.

◆ NtpKissCode

enum NtpKissCode

Kiss codes.

The kiss codes can provide useful information for an intelligent client. These codes are encoded in four-character ASCII strings left justified and zero filled

Enumerator
NTP_KISS_CODE_ACST	The association belongs to a anycast server.
NTP_KISS_CODE_AUTH	Server authentication failed.
NTP_KISS_CODE_AUTO	Autokey sequence failed.
NTP_KISS_CODE_BCST	The association belongs to a broadcast server.
NTP_KISS_CODE_CRYP	Cryptographic authentication or identification failed.
NTP_KISS_CODE_DENY	Access denied by remote server.
NTP_KISS_CODE_DROP	Lost peer in symmetric mode.
NTP_KISS_CODE_RSTR	Access denied due to local policy.
NTP_KISS_CODE_INIT	The association has not yet synchronized for the first time.
NTP_KISS_CODE_MCST	The association belongs to a manycast server.
NTP_KISS_CODE_NKEY	No key found.
NTP_KISS_CODE_RATE	Rate exceeded.
NTP_KISS_CODE_RMOT	Somebody is tinkering with the association from a remote host running ntpdc.
NTP_KISS_CODE_STEP	A step change in system time has occurred.
NTP_KISS_CODE_NTSN	NTS negative-acknowledgment (NAK)

Definition at line 127 of file ntp_common.h.

◆ NtpLeapIndicator

enum NtpLeapIndicator

Leap indicator.

Enumerator
NTP_LI_NO_WARNING
NTP_LI_LAST_MIN_HAS_61_SECS
NTP_LI_LAST_MIN_HAS_59_SECS
NTP_LI_ALARM_CONDITION

Definition at line 57 of file ntp_common.h.

◆ NtpMode

enum NtpMode

Protocol modes.

Enumerator
NTP_MODE_SYMMETRIC_ACTIVE
NTP_MODE_SYMMETRIC_PASSIVE
NTP_MODE_CLIENT
NTP_MODE_SERVER
NTP_MODE_BROADCAST

Definition at line 83 of file ntp_common.h.

◆ NtpStratum

enum NtpStratum

Stratum.

Enumerator
NTP_STRATUM_KISS_OF_DEATH
NTP_STRATUM_PRIMARY
NTP_STRATUM_SECONDARY_2
NTP_STRATUM_SECONDARY_3
NTP_STRATUM_SECONDARY_4
NTP_STRATUM_SECONDARY_5
NTP_STRATUM_SECONDARY_6
NTP_STRATUM_SECONDARY_7
NTP_STRATUM_SECONDARY_8
NTP_STRATUM_SECONDARY_9
NTP_STRATUM_SECONDARY_10
NTP_STRATUM_SECONDARY_11
NTP_STRATUM_SECONDARY_12
NTP_STRATUM_SECONDARY_13
NTP_STRATUM_SECONDARY_14
NTP_STRATUM_SECONDARY_15

Definition at line 97 of file ntp_common.h.

◆ NtpVersion

enum NtpVersion

NTP version numbers.

Enumerator
NTP_VERSION_1
NTP_VERSION_2
NTP_VERSION_3
NTP_VERSION_4

Definition at line 70 of file ntp_common.h.

Function Documentation

◆ ntpGetExtension()

const NtpExtension* ntpGetExtension	(	const uint8_t *	extensions,
		size_t	length,
		uint16_t	type,
		uint_t	index
	)

Search a NTP packet for a given extension.

Parameters

[in]	extensions	Pointer to the NTP extensions
[in]	length	Length of the NTP extensions, in bytes
[in]	type	Extension type
[in]	index	Extension occurrence index

Returns: If the specified extension is found, a pointer to the corresponding extension is returned. Otherwise NULL pointer is returned

Definition at line 53 of file ntp_common.c.

Variable Documentation

◆ __packed_struct

typedef __packed_struct

Initial value:

{

uint32_t seconds

NTP timestamp representation.

NTS Authenticator and Encrypted Extension Fields extension.

NTP extension field.

NTP packet header.

Definition at line 175 of file ntp_common.h.

◆ ciphertextLength

uint16_t ciphertextLength

Definition at line 232 of file ntp_common.h.

◆ extensions

uint8_t extensions[]

Definition at line 207 of file ntp_common.h.

◆ fraction

uint32_t fraction

Definition at line 178 of file ntp_common.h.

◆ length

uint16_t length

Definition at line 218 of file ntp_common.h.

◆ li

uint8_t li

Definition at line 195 of file ntp_common.h.

◆ nonce

uint8_t nonce[]

Definition at line 233 of file ntp_common.h.

◆ nonceLength

uint16_t nonceLength

Definition at line 231 of file ntp_common.h.

◆ NtpExtension

NtpExtension

Definition at line 220 of file ntp_common.h.

◆ NtpHeader

NtpHeader

Definition at line 208 of file ntp_common.h.

◆ NtpNtsAeadExtension

NtpNtsAeadExtension

Definition at line 234 of file ntp_common.h.

◆ NtpTimestamp

NtpTimestamp

Definition at line 179 of file ntp_common.h.

◆ originateTimestamp

NtpTimestamp originateTimestamp

Definition at line 204 of file ntp_common.h.

◆ poll

uint8_t poll

Definition at line 198 of file ntp_common.h.

◆ precision

int8_t precision

Definition at line 199 of file ntp_common.h.

◆ receiveTimestamp

NtpTimestamp receiveTimestamp

Definition at line 205 of file ntp_common.h.

◆ referenceId

uint32_t referenceId

Definition at line 202 of file ntp_common.h.

◆ referenceTimestamp

NtpTimestamp referenceTimestamp

Definition at line 203 of file ntp_common.h.

◆ rootDelay

uint32_t rootDelay

Definition at line 200 of file ntp_common.h.

◆ rootDispersion

uint32_t rootDispersion

Definition at line 201 of file ntp_common.h.

◆ stratum

uint8_t stratum

Definition at line 197 of file ntp_common.h.

◆ transmitTimestamp

NtpTimestamp transmitTimestamp

Definition at line 206 of file ntp_common.h.

◆ value

uint8_t value[]

Definition at line 219 of file ntp_common.h.

◆ vn

uint8_t vn

Definition at line 194 of file ntp_common.h.

Macros

Enumerations

Functions

Variables