/
messages.go
171 lines (152 loc) · 4.4 KB
/
messages.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package interop
import (
"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
)
// MessageHeader is the common LoRaWAN Backend Interfaces message header.
type MessageHeader struct {
ProtocolVersion ProtocolVersion
TransactionID uint32
MessageType MessageType
SenderID,
ReceiverID string
SenderNSID *EUI64 `json:",omitempty"`
ReceiverNSID *EUI64 `json:",omitempty"`
SenderToken Buffer `json:",omitempty"`
ReceiverToken Buffer `json:",omitempty"`
VSExtension *VSExtension `json:",omitempty"`
}
// AnswerHeader returns the header of the answer message.
func (h MessageHeader) AnswerHeader() (MessageHeader, error) {
ansType, ok := h.MessageType.Answer()
if !ok {
return MessageHeader{}, errInvalidRequestType.WithAttributes("type", h.MessageType)
}
return MessageHeader{
ProtocolVersion: h.ProtocolVersion,
TransactionID: h.TransactionID,
MessageType: ansType,
ReceiverToken: h.SenderToken,
ReceiverID: h.SenderID,
ReceiverNSID: h.SenderNSID,
SenderID: h.ReceiverID,
SenderToken: h.ReceiverToken,
SenderNSID: h.ReceiverNSID,
}, nil
}
// VSExtension is a vendor-specific extension.
type VSExtension struct {
VendorID VendorID
}
// Result contains the result of an operation.
type Result struct {
ResultCode ResultCode
Description string `json:",omitempty"`
}
// ErrorMessage is a message with raw header and a result field.
type ErrorMessage struct {
MessageHeader
Result Result
}
// NsMessageHeader contains the message header for NS messages.
type NsMessageHeader struct {
MessageHeader
SenderID NetID
SenderNSID *EUI64 `json:",omitempty"`
}
// AsMessageHeader contains the message header for AS messages.
type AsMessageHeader struct {
MessageHeader
}
// NsJsMessageHeader contains the message header for NS to JS messages.
type NsJsMessageHeader struct {
MessageHeader
SenderID NetID
SenderNSID *EUI64 `json:",omitempty"`
// ReceiverID is a JoinEUI.
ReceiverID EUI64
}
// JsNsMessageHeader contains the message header for JS to NS messages.
type JsNsMessageHeader struct {
MessageHeader
// SenderID is a JoinEUI.
SenderID EUI64
ReceiverID NetID
ReceiverNSID *EUI64 `json:",omitempty"`
}
// AsJsMessageHeader contains the message header for AS to JS messages.
type AsJsMessageHeader struct {
MessageHeader
SenderID string
// ReceiverID is a JoinEUI.
ReceiverID EUI64
}
// JsAsMessageHeader contains the message header for JS to AS messages.
type JsAsMessageHeader struct {
MessageHeader
// SenderID is a JoinEUI.
SenderID EUI64
ReceiverID string
}
// JoinReq is a join-request message.
type JoinReq struct {
NsJsMessageHeader
MACVersion MACVersion
PHYPayload Buffer
DevEUI EUI64
DevAddr DevAddr
DLSettings Buffer
RxDelay ttnpb.RxDelay
CFList Buffer `json:",omitempty"`
}
// JoinAns is an answer to a JoinReq message.
type JoinAns struct {
JsNsMessageHeader
PHYPayload Buffer
Result Result
Lifetime uint32
SNwkSIntKey *KeyEnvelope `json:",omitempty"`
FNwkSIntKey *KeyEnvelope `json:",omitempty"`
NwkSEncKey *KeyEnvelope `json:",omitempty"`
NwkSKey *KeyEnvelope `json:",omitempty"`
AppSKey *KeyEnvelope `json:",omitempty"`
SessionKeyID Buffer `json:",omitempty"`
}
// AppSKeyReq is a AppSKey request message.
type AppSKeyReq struct {
AsJsMessageHeader
DevEUI EUI64
SessionKeyID Buffer
}
// AppSKeyAns is an answer to an AppSKeyReq message.
type AppSKeyAns struct {
JsAsMessageHeader
Result Result
DevEUI EUI64
AppSKey *KeyEnvelope
SessionKeyID Buffer
}
// HomeNSReq is a NetID request message.
type HomeNSReq struct {
NsJsMessageHeader
DevEUI EUI64
}
// HomeNSAns is an answer to a HomeNSReq message.
type HomeNSAns struct {
JsNsMessageHeader
Result Result
HNSID *EUI64 `json:",omitempty"`
HNetID NetID
}