Andrew Boyson / net

A stack which works with or without an Mbed os library. Provides IPv4 or IPv6 with a full 1500 byte buffer.

Dependents:   oldheating gps motorhome heating

udp/ntp.cpp@50:492f2d2954e4, 2017-11-03 (annotated)

Committer:
andrewboyson
Date:
Fri Nov 03 16:19:15 2017 +0000
Revision:
50:492f2d2954e4
Parent:
49:1a6336f2b3f9
Child:
59:e0e556c8bd46
Split name resolution into NR4 and NR6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
andrewboyson 37:793b39683406 1 #include "mbed.h"
andrewboyson 37:793b39683406 2 #include "log.h"
andrewboyson 37:793b39683406 3 #include "net.h"
andrewboyson 37:793b39683406 4 #include "action.h"
andrewboyson 49:1a6336f2b3f9 5 #include "ip6addr.h"
andrewboyson 37:793b39683406 6 #include "udp.h"
andrewboyson 48:952dddb74b8b 7 #include "ar4.h"
andrewboyson 48:952dddb74b8b 8 #include "ar6.h"
andrewboyson 37:793b39683406 9 #include "arp.h"
andrewboyson 37:793b39683406 10 #include "io.h"
andrewboyson 37:793b39683406 11 #include "eth.h"
andrewboyson 50:492f2d2954e4 12 #include "nr4.h"
andrewboyson 50:492f2d2954e4 13 #include "nr6.h"
andrewboyson 37:793b39683406 14 #include "dns.h"
andrewboyson 37:793b39683406 15 #include "mac.h"
andrewboyson 22:914b970356f0 16
andrewboyson 37:793b39683406 17 bool NtpTrace = false;
andrewboyson 0:faa09bd4e6bf 18
andrewboyson 0:faa09bd4e6bf 19 #define HEADER_SIZE 48
andrewboyson 0:faa09bd4e6bf 20
andrewboyson 42:222a4f45f916 21 #define USE_IP4 false
andrewboyson 42:222a4f45f916 22
andrewboyson 0:faa09bd4e6bf 23 #define CLIENT 3
andrewboyson 0:faa09bd4e6bf 24 #define SERVER 4
andrewboyson 0:faa09bd4e6bf 25
andrewboyson 22:914b970356f0 26 uint64_t (*NtpGetClockNowFunction) ();
andrewboyson 22:914b970356f0 27
andrewboyson 22:914b970356f0 28 bool NtpServerEnable = false;
andrewboyson 22:914b970356f0 29 uint64_t (*NtpGetClockRefFunction) ();
andrewboyson 22:914b970356f0 30 int (*NtpGetClockStratumFunction)();
andrewboyson 22:914b970356f0 31 char * (*NtpGetClockIdentFunction) ();
andrewboyson 22:914b970356f0 32
andrewboyson 36:900e24b27bfb 33 uint32_t NtpServerIp4;
andrewboyson 36:900e24b27bfb 34 char NtpServerIp6[16];
andrewboyson 22:914b970356f0 35 bool NtpClientRequest = false;
andrewboyson 35:93c39d260a83 36 char NtpServerName[DNS_MAX_LABEL_LENGTH+1];
andrewboyson 35:93c39d260a83 37 void (*NtpSetClockFunction) (uint64_t ori, uint64_t rec);
andrewboyson 35:93c39d260a83 38
andrewboyson 0:faa09bd4e6bf 39 __packed struct header {
andrewboyson 0:faa09bd4e6bf 40 unsigned Mode : 3;
andrewboyson 0:faa09bd4e6bf 41 unsigned VN : 3;
andrewboyson 0:faa09bd4e6bf 42 unsigned LI : 2;
andrewboyson 0:faa09bd4e6bf 43 uint8_t Stratum;
andrewboyson 0:faa09bd4e6bf 44 int8_t Poll;
andrewboyson 0:faa09bd4e6bf 45 int8_t Precision;
andrewboyson 0:faa09bd4e6bf 46 uint32_t RootDelay;
andrewboyson 0:faa09bd4e6bf 47 uint32_t Dispersion;
andrewboyson 0:faa09bd4e6bf 48 char RefIdentifier[4];
andrewboyson 0:faa09bd4e6bf 49
andrewboyson 0:faa09bd4e6bf 50 uint64_t RefTimeStamp;
andrewboyson 0:faa09bd4e6bf 51 uint64_t OriTimeStamp;
andrewboyson 0:faa09bd4e6bf 52 uint64_t RecTimeStamp;
andrewboyson 0:faa09bd4e6bf 53 uint64_t TraTimeStamp;
andrewboyson 0:faa09bd4e6bf 54 };
andrewboyson 37:793b39683406 55 static void logHeader(struct header* pHeader)
andrewboyson 37:793b39683406 56 {
andrewboyson 43:bc028d5a6424 57 if (NetTraceVerbose)
andrewboyson 43:bc028d5a6424 58 {
andrewboyson 43:bc028d5a6424 59 Log ("NTP header\r\n");
andrewboyson 43:bc028d5a6424 60 LogF(" Mode %d", pHeader->Mode);
andrewboyson 43:bc028d5a6424 61 LogF(", Version %d", pHeader->VN);
andrewboyson 43:bc028d5a6424 62 LogF(", LI %d", pHeader->LI);
andrewboyson 43:bc028d5a6424 63 LogF(", Stratum %d", pHeader->Stratum);
andrewboyson 43:bc028d5a6424 64 LogF(", Poll %d", pHeader->Poll);
andrewboyson 43:bc028d5a6424 65 LogF(", Precision %d", pHeader->Precision);
andrewboyson 43:bc028d5a6424 66 LogF(", Root delay %d", NetToHost32(pHeader->RootDelay));
andrewboyson 43:bc028d5a6424 67 LogF(", Dispersion %d", NetToHost32(pHeader->Dispersion));
andrewboyson 43:bc028d5a6424 68 Log (", Ident ");
andrewboyson 43:bc028d5a6424 69 for (int i = 0; i < 4; i++) if (pHeader->RefIdentifier[i]) LogPush(pHeader->RefIdentifier[i]);
andrewboyson 43:bc028d5a6424 70 Log ("\r\n");
andrewboyson 43:bc028d5a6424 71 LogF(" REF %llu\r\n", NetToHost64(pHeader->RefTimeStamp));
andrewboyson 43:bc028d5a6424 72 LogF(" ORI %llu\r\n", NetToHost64(pHeader->OriTimeStamp));
andrewboyson 43:bc028d5a6424 73 LogF(" REC %llu\r\n", NetToHost64(pHeader->RecTimeStamp));
andrewboyson 43:bc028d5a6424 74 LogF(" TRA %llu\r\n", NetToHost64(pHeader->TraTimeStamp));
andrewboyson 43:bc028d5a6424 75 }
andrewboyson 43:bc028d5a6424 76 else
andrewboyson 43:bc028d5a6424 77 {
andrewboyson 43:bc028d5a6424 78 Log ("NTP header");
andrewboyson 43:bc028d5a6424 79 LogF(": Mode %d", pHeader->Mode);
andrewboyson 43:bc028d5a6424 80 LogF(", Version %d", pHeader->VN);
andrewboyson 43:bc028d5a6424 81 LogF(", LI %d", pHeader->LI);
andrewboyson 43:bc028d5a6424 82 LogF(", Stratum %d", pHeader->Stratum);
andrewboyson 43:bc028d5a6424 83 LogF(", Poll %d", pHeader->Poll);
andrewboyson 43:bc028d5a6424 84 LogF(", Precision %d", pHeader->Precision);
andrewboyson 43:bc028d5a6424 85 LogF(", Root delay %d", NetToHost32(pHeader->RootDelay));
andrewboyson 43:bc028d5a6424 86 LogF(", Dispersion %d", NetToHost32(pHeader->Dispersion));
andrewboyson 43:bc028d5a6424 87 Log (", Ident ");
andrewboyson 43:bc028d5a6424 88 for (int i = 0; i < 4; i++) if (pHeader->RefIdentifier[i]) LogPush(pHeader->RefIdentifier[i]);
andrewboyson 43:bc028d5a6424 89 Log ("\r\n");
andrewboyson 43:bc028d5a6424 90 }
andrewboyson 37:793b39683406 91 }
andrewboyson 22:914b970356f0 92 static int handleRequest(struct header* pHeader)
andrewboyson 0:faa09bd4e6bf 93 {
andrewboyson 22:914b970356f0 94 if (!NtpServerEnable) return DO_NOTHING;
andrewboyson 17:e475ab861365 95
andrewboyson 17:e475ab861365 96 if (!NtpGetClockRefFunction || !NtpGetClockNowFunction || !NtpGetClockStratumFunction || !NtpGetClockIdentFunction)
andrewboyson 17:e475ab861365 97 {
andrewboyson 17:e475ab861365 98 LogTimeF("NtpHandleRequest - NTP server is enabled but has not been plumbed into a clock\r\n");
andrewboyson 17:e475ab861365 99 return DO_NOTHING;
andrewboyson 17:e475ab861365 100 }
andrewboyson 22:914b970356f0 101
andrewboyson 20:23f2b29b48ea 102 uint64_t refNtp = NtpGetClockRefFunction();
andrewboyson 20:23f2b29b48ea 103 uint64_t nowNtp = NtpGetClockNowFunction();
andrewboyson 20:23f2b29b48ea 104 int stratum = NtpGetClockStratumFunction();
andrewboyson 20:23f2b29b48ea 105 char* ident = NtpGetClockIdentFunction();
andrewboyson 22:914b970356f0 106
andrewboyson 22:914b970356f0 107 pHeader->Mode = SERVER;
andrewboyson 22:914b970356f0 108 pHeader->LI = 0;
andrewboyson 22:914b970356f0 109 pHeader->Stratum = stratum;
andrewboyson 22:914b970356f0 110 pHeader->Poll = 0;
andrewboyson 22:914b970356f0 111 pHeader->Precision = 0;
andrewboyson 22:914b970356f0 112 pHeader->RootDelay = 0;
andrewboyson 22:914b970356f0 113 pHeader->Dispersion = 0;
andrewboyson 22:914b970356f0 114 pHeader->RefIdentifier[0] = ident[0]; //For stratum 1 (reference clock), this is a four-octet, left-justified, zero-padded ASCII string.
andrewboyson 22:914b970356f0 115 pHeader->RefIdentifier[1] = ident[1];
andrewboyson 22:914b970356f0 116 pHeader->RefIdentifier[2] = ident[2];
andrewboyson 22:914b970356f0 117 pHeader->RefIdentifier[3] = ident[3];
andrewboyson 22:914b970356f0 118
andrewboyson 22:914b970356f0 119 pHeader->RefTimeStamp = NetToHost64(refNtp);
andrewboyson 22:914b970356f0 120 pHeader->OriTimeStamp = pHeader->TraTimeStamp;
andrewboyson 22:914b970356f0 121 pHeader->RecTimeStamp = NetToHost64(nowNtp);
andrewboyson 22:914b970356f0 122 pHeader->TraTimeStamp = NetToHost64(nowNtp);
andrewboyson 22:914b970356f0 123 return UNICAST;
andrewboyson 22:914b970356f0 124 }
andrewboyson 37:793b39683406 125 static void (*pTraceBack)(void);
andrewboyson 22:914b970356f0 126 static int handleReply(struct header* pHeader)
andrewboyson 22:914b970356f0 127 {
andrewboyson 22:914b970356f0 128 if (!NtpGetClockNowFunction || !NtpSetClockFunction)
andrewboyson 22:914b970356f0 129 {
andrewboyson 22:914b970356f0 130 LogTimeF("Ntp reply has been received but NTP has not been plumbed into a clock\r\n");
andrewboyson 22:914b970356f0 131 return DO_NOTHING;
andrewboyson 22:914b970356f0 132 }
andrewboyson 22:914b970356f0 133 if (pHeader->Mode != SERVER)
andrewboyson 22:914b970356f0 134 {
andrewboyson 22:914b970356f0 135 LogTimeF("Ntp reply has been received but mode is not SERVER it is %d\r\n", pHeader->Mode);
andrewboyson 22:914b970356f0 136 return DO_NOTHING;
andrewboyson 22:914b970356f0 137 }
andrewboyson 37:793b39683406 138 if (NtpTrace)
andrewboyson 22:914b970356f0 139 {
andrewboyson 43:bc028d5a6424 140 if (NetTraceNewLine) Log("\r\n");
andrewboyson 22:914b970356f0 141 LogTimeF("NTP received reply\r\n");
andrewboyson 43:bc028d5a6424 142 if (NetTraceStack) pTraceBack();
andrewboyson 37:793b39683406 143 logHeader(pHeader);
andrewboyson 22:914b970356f0 144 }
andrewboyson 37:793b39683406 145
andrewboyson 22:914b970356f0 146 uint64_t ori = NetToHost64(pHeader->OriTimeStamp);
andrewboyson 22:914b970356f0 147 uint64_t rec = NetToHost64(pHeader->RecTimeStamp);
andrewboyson 22:914b970356f0 148
andrewboyson 22:914b970356f0 149 NtpSetClockFunction(ori, rec);
andrewboyson 22:914b970356f0 150 return DO_NOTHING;
andrewboyson 22:914b970356f0 151 }
andrewboyson 37:793b39683406 152 int NtpHandlePacketReceived(void (*traceback)(void), int* pSize, void * pPacket)
andrewboyson 22:914b970356f0 153 {
andrewboyson 37:793b39683406 154 pTraceBack = traceback;
andrewboyson 37:793b39683406 155
andrewboyson 22:914b970356f0 156 if (*pSize != HEADER_SIZE)
andrewboyson 22:914b970356f0 157 {
andrewboyson 22:914b970356f0 158 LogTimeF("\r\nNTP packet wrong size %d\r\n", *pSize);
andrewboyson 22:914b970356f0 159 return DO_NOTHING;
andrewboyson 22:914b970356f0 160 }
andrewboyson 22:914b970356f0 161 struct header* pHeader = (struct header*)pPacket;
andrewboyson 17:e475ab861365 162
andrewboyson 0:faa09bd4e6bf 163 switch (pHeader->Mode)
andrewboyson 0:faa09bd4e6bf 164 {
andrewboyson 22:914b970356f0 165 case CLIENT: return handleRequest(pHeader);
andrewboyson 22:914b970356f0 166 case SERVER: return handleReply(pHeader);
andrewboyson 0:faa09bd4e6bf 167 default:
andrewboyson 22:914b970356f0 168 LogTimeF("\r\nNTP packet unknown mode %d\r\n", pHeader->Mode);
andrewboyson 22:914b970356f0 169 return DO_NOTHING;
andrewboyson 0:faa09bd4e6bf 170 }
andrewboyson 22:914b970356f0 171 }
andrewboyson 22:914b970356f0 172 static int sendRequest(void* pPacket, int* pSize)
andrewboyson 22:914b970356f0 173 {
andrewboyson 22:914b970356f0 174 struct header* pHeader = (struct header*)pPacket;
andrewboyson 22:914b970356f0 175
andrewboyson 22:914b970356f0 176 pHeader->Mode = CLIENT;
andrewboyson 22:914b970356f0 177 pHeader->VN = 3;
andrewboyson 22:914b970356f0 178 pHeader->LI = 0;
andrewboyson 22:914b970356f0 179 pHeader->Stratum = 0;
andrewboyson 22:914b970356f0 180 pHeader->Poll = 0;
andrewboyson 22:914b970356f0 181 pHeader->Precision = 0;
andrewboyson 22:914b970356f0 182 pHeader->RootDelay = 0;
andrewboyson 22:914b970356f0 183 pHeader->Dispersion = 0;
andrewboyson 22:914b970356f0 184 pHeader->RefIdentifier[0] = 0;
andrewboyson 22:914b970356f0 185 pHeader->RefIdentifier[1] = 0;
andrewboyson 22:914b970356f0 186 pHeader->RefIdentifier[2] = 0;
andrewboyson 22:914b970356f0 187 pHeader->RefIdentifier[3] = 0;
andrewboyson 22:914b970356f0 188
andrewboyson 22:914b970356f0 189 pHeader->RefTimeStamp = 0;
andrewboyson 22:914b970356f0 190 pHeader->OriTimeStamp = 0;
andrewboyson 22:914b970356f0 191 pHeader->RecTimeStamp = 0;
andrewboyson 22:914b970356f0 192 pHeader->TraTimeStamp = NetToHost64(NtpGetClockNowFunction());
andrewboyson 22:914b970356f0 193 *pSize = HEADER_SIZE;
andrewboyson 22:914b970356f0 194
andrewboyson 22:914b970356f0 195 return UNICAST_NTP;
andrewboyson 0:faa09bd4e6bf 196 }
andrewboyson 36:900e24b27bfb 197 static bool resolve4(char* server, uint32_t* pIp)
andrewboyson 36:900e24b27bfb 198 {
andrewboyson 36:900e24b27bfb 199 //Check if have IP, if not, then request it and stop
andrewboyson 50:492f2d2954e4 200 Nr4NameToIp(server, pIp);
andrewboyson 36:900e24b27bfb 201 if (!*pIp)
andrewboyson 36:900e24b27bfb 202 {
andrewboyson 50:492f2d2954e4 203 Nr4MakeRequestForIpFromName(server); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 204 return false;
andrewboyson 36:900e24b27bfb 205 }
andrewboyson 35:93c39d260a83 206
andrewboyson 36:900e24b27bfb 207 //Check if have MAC and, if not, request it and stop
andrewboyson 36:900e24b27bfb 208 char mac[6];
andrewboyson 48:952dddb74b8b 209 Ar4IpToMac(*pIp, mac);
andrewboyson 36:900e24b27bfb 210 if (MacIsEmpty(mac))
andrewboyson 36:900e24b27bfb 211 {
andrewboyson 48:952dddb74b8b 212 Ar4MakeRequestForMacFromIp(*pIp); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 213 return false;
andrewboyson 36:900e24b27bfb 214 }
andrewboyson 36:900e24b27bfb 215
andrewboyson 36:900e24b27bfb 216 return true;
andrewboyson 36:900e24b27bfb 217 }
andrewboyson 36:900e24b27bfb 218 static bool resolve6(char* server, char* ip)
andrewboyson 36:900e24b27bfb 219 {
andrewboyson 36:900e24b27bfb 220 //Check if have IP, if not, then request it and stop
andrewboyson 50:492f2d2954e4 221 Nr6NameToIp(server, ip);
andrewboyson 49:1a6336f2b3f9 222 if (Ip6AddressIsEmpty(ip))
andrewboyson 36:900e24b27bfb 223 {
andrewboyson 50:492f2d2954e4 224 Nr6MakeRequestForIpFromName(server); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 225 return false;
andrewboyson 36:900e24b27bfb 226 }
andrewboyson 36:900e24b27bfb 227
andrewboyson 36:900e24b27bfb 228 //Check if have MAC and, if not, request it and stop
andrewboyson 36:900e24b27bfb 229 char mac[6];
andrewboyson 48:952dddb74b8b 230 Ar6IpToMac(ip, mac);
andrewboyson 36:900e24b27bfb 231 if (MacIsEmpty(mac))
andrewboyson 36:900e24b27bfb 232 {
andrewboyson 48:952dddb74b8b 233 Ar6MakeRequestForMacFromIp(ip); //The request is only repeated if made after a freeze time - call as often as you want.
andrewboyson 36:900e24b27bfb 234 return false;
andrewboyson 36:900e24b27bfb 235 }
andrewboyson 36:900e24b27bfb 236
andrewboyson 36:900e24b27bfb 237 return true;
andrewboyson 36:900e24b27bfb 238 }
andrewboyson 22:914b970356f0 239 int NtpPollForPacketToSend(int type, void* pPacket, int* pSize)
andrewboyson 22:914b970356f0 240 {
andrewboyson 22:914b970356f0 241 if (!NtpClientRequest) return DO_NOTHING; //Wait until a request for time is made
andrewboyson 22:914b970356f0 242
andrewboyson 35:93c39d260a83 243 if (!NtpServerName[0])
andrewboyson 35:93c39d260a83 244 {
andrewboyson 35:93c39d260a83 245 LogTimeF("NtpPollForRequestToSend - A request to send a client message has been made but no server name has been specified\r\n");
andrewboyson 35:93c39d260a83 246 NtpClientRequest = false;
andrewboyson 35:93c39d260a83 247 return DO_NOTHING;
andrewboyson 35:93c39d260a83 248 }
andrewboyson 35:93c39d260a83 249
andrewboyson 35:93c39d260a83 250 if (!NtpGetClockNowFunction || !NtpSetClockFunction)
andrewboyson 22:914b970356f0 251 {
andrewboyson 22:914b970356f0 252 LogTimeF("NtpPollForRequestToSend - A request to send a client message has been made but NTP has not been plumbed into a clock\r\n");
andrewboyson 22:914b970356f0 253 NtpClientRequest = false;
andrewboyson 22:914b970356f0 254 return DO_NOTHING;
andrewboyson 22:914b970356f0 255 }
andrewboyson 42:222a4f45f916 256
andrewboyson 42:222a4f45f916 257 if (type == IPV4)
andrewboyson 42:222a4f45f916 258 {
andrewboyson 42:222a4f45f916 259 if (!resolve4(NtpServerName, &NtpServerIp4)) return DO_NOTHING;
andrewboyson 42:222a4f45f916 260 }
andrewboyson 42:222a4f45f916 261 else if (type == IPV6)
andrewboyson 42:222a4f45f916 262 {
andrewboyson 42:222a4f45f916 263 if (!resolve6(NtpServerName, NtpServerIp6)) return DO_NOTHING;
andrewboyson 42:222a4f45f916 264 }
andrewboyson 42:222a4f45f916 265 else
andrewboyson 42:222a4f45f916 266 {
andrewboyson 42:222a4f45f916 267 return DO_NOTHING;
andrewboyson 42:222a4f45f916 268 }
andrewboyson 35:93c39d260a83 269
andrewboyson 35:93c39d260a83 270 //Have IP and MAC so send request
andrewboyson 42:222a4f45f916 271 NtpClientRequest = false;
andrewboyson 42:222a4f45f916 272 int dest = sendRequest(pPacket, pSize);
andrewboyson 42:222a4f45f916 273 if (NtpTrace)
andrewboyson 37:793b39683406 274 {
andrewboyson 43:bc028d5a6424 275 if (NetTraceNewLine) Log("\r\n");
andrewboyson 37:793b39683406 276 LogTimeF("Sending NTP request\r\n");
andrewboyson 42:222a4f45f916 277 logHeader((struct header*)pPacket);
andrewboyson 37:793b39683406 278 }
andrewboyson 43:bc028d5a6424 279 return ActionMakeFromDestAndTrace(dest, NtpTrace && NetTraceStack);
andrewboyson 22:914b970356f0 280 }
andrewboyson 22:914b970356f0 281