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@42:222a4f45f916, 2017-10-15 (annotated)

Committer:
andrewboyson
Date:
Sun Oct 15 17:54:09 2017 +0000
Revision:
42:222a4f45f916
Parent:
37:793b39683406
Child:
43:bc028d5a6424
Made the use of IPv4 or IPv6 for client requests a configurable option

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