forked from brocaar/chirpstack-application-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
as.go
587 lines (490 loc) · 16.2 KB
/
as.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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
package as
import (
"database/sql"
"fmt"
"math"
"net"
"time"
"github.com/golang/protobuf/ptypes"
"github.com/golang/protobuf/ptypes/empty"
"github.com/jmoiron/sqlx"
"github.com/lib/pq/hstore"
"github.com/pkg/errors"
log "github.com/sirupsen/logrus"
"golang.org/x/net/context"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"github.com/brocaar/chirpstack-api/go/v3/as"
pb "github.com/brocaar/chirpstack-api/go/v3/as/integration"
"github.com/brocaar/lorawan"
"github.com/kamicuu/chirpstack-application-server/internal/api/helpers"
"github.com/kamicuu/chirpstack-application-server/internal/config"
"github.com/kamicuu/chirpstack-application-server/internal/events/uplink"
"github.com/kamicuu/chirpstack-application-server/internal/gwping"
"github.com/kamicuu/chirpstack-application-server/internal/integration"
"github.com/kamicuu/chirpstack-application-server/internal/storage"
)
var (
bind string
caCert string
tlsCert string
tlsKey string
)
// Setup configures the package.
func Setup(conf config.Config) error {
bind = conf.ApplicationServer.API.Bind
caCert = conf.ApplicationServer.API.CACert
tlsCert = conf.ApplicationServer.API.TLSCert
tlsKey = conf.ApplicationServer.API.TLSKey
log.WithFields(log.Fields{
"bind": bind,
"ca_cert": caCert,
"tls_cert": tlsCert,
"tls_key": tlsKey,
}).Info("api/as: starting application-server api")
grpcOpts := helpers.GetgRPCServerOptions()
if caCert != "" && tlsCert != "" && tlsKey != "" {
creds, err := helpers.GetTransportCredentials(caCert, tlsCert, tlsKey, true)
if err != nil {
return errors.Wrap(err, "get transport credentials error")
}
grpcOpts = append(grpcOpts, grpc.Creds(creds))
}
server := grpc.NewServer(grpcOpts...)
as.RegisterApplicationServerServiceServer(server, NewApplicationServerAPI())
ln, err := net.Listen("tcp", bind)
if err != nil {
return errors.Wrap(err, "start application-server api listener error")
}
go server.Serve(ln)
return nil
}
// ApplicationServerAPI implements the as.ApplicationServerServer interface.
type ApplicationServerAPI struct {
}
// NewApplicationServerAPI returns a new ApplicationServerAPI.
func NewApplicationServerAPI() *ApplicationServerAPI {
return &ApplicationServerAPI{}
}
// HandleUplinkData handles incoming (uplink) data.
func (a *ApplicationServerAPI) HandleUplinkData(ctx context.Context, req *as.HandleUplinkDataRequest) (*empty.Empty, error) {
if err := uplink.Handle(ctx, *req); err != nil {
return nil, grpc.Errorf(codes.Internal, "handle uplink data error: %s", err)
}
return &empty.Empty{}, nil
}
// HandleDownlinkACK handles an ack on a downlink transmission.
func (a *ApplicationServerAPI) HandleDownlinkACK(ctx context.Context, req *as.HandleDownlinkACKRequest) (*empty.Empty, error) {
var devEUI lorawan.EUI64
copy(devEUI[:], req.DevEui)
d, err := storage.GetDevice(ctx, storage.DB(), devEUI, false, true)
if err != nil {
errStr := fmt.Sprintf("get device error: %s", err)
log.WithField("dev_eui", devEUI).Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
app, err := storage.GetApplication(ctx, storage.DB(), d.ApplicationID)
if err != nil {
errStr := fmt.Sprintf("get application error: %s", err)
log.WithField("id", d.ApplicationID).Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
log.WithFields(log.Fields{
"dev_eui": devEUI,
}).Info("downlink device-queue item acknowledged")
pl := pb.AckEvent{
ApplicationId: uint64(app.ID),
ApplicationName: app.Name,
DeviceName: d.Name,
DevEui: devEUI[:],
Acknowledged: req.Acknowledged,
FCnt: req.FCnt,
Tags: make(map[string]string),
PublishedAt: ptypes.TimestampNow(),
}
// set tags
for k, v := range d.Tags.Map {
if v.Valid {
pl.Tags[k] = v.String
}
}
vars := make(map[string]string)
for k, v := range d.Variables.Map {
if v.Valid {
vars[k] = v.String
}
}
err = integration.ForApplicationID(app.ID).HandleAckEvent(ctx, vars, pl)
if err != nil {
log.WithError(err).Error("send ack event error")
}
return &empty.Empty{}, nil
}
// HandleTxAck handles a tx acknowledgement.
func (a *ApplicationServerAPI) HandleTxAck(ctx context.Context, req *as.HandleTxAckRequest) (*empty.Empty, error) {
var devEUI lorawan.EUI64
copy(devEUI[:], req.DevEui)
d, err := storage.GetDevice(ctx, storage.DB(), devEUI, false, true)
if err != nil {
errStr := fmt.Sprintf("get device error: %s", err)
log.WithField("dev_eui", devEUI).Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
app, err := storage.GetApplication(ctx, storage.DB(), d.ApplicationID)
if err != nil {
errStr := fmt.Sprintf("get application error: %s", err)
log.WithField("id", d.ApplicationID).Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
log.WithFields(log.Fields{
"dev_eui": devEUI,
}).Info("downlink tx acknowledged by gateway")
pl := pb.TxAckEvent{
ApplicationId: uint64(app.ID),
ApplicationName: app.Name,
DeviceName: d.Name,
DevEui: devEUI[:],
FCnt: req.FCnt,
Tags: make(map[string]string),
GatewayId: req.GatewayId,
TxInfo: req.TxInfo,
PublishedAt: ptypes.TimestampNow(),
}
// set tags
for k, v := range d.Tags.Map {
if v.Valid {
pl.Tags[k] = v.String
}
}
vars := make(map[string]string)
for k, v := range d.Variables.Map {
if v.Valid {
vars[k] = v.String
}
}
err = integration.ForApplicationID(app.ID).HandleTxAckEvent(ctx, vars, pl)
if err != nil {
log.WithError(err).Error("send tx ack event error")
}
return &empty.Empty{}, nil
}
// HandleError handles an incoming error.
func (a *ApplicationServerAPI) HandleError(ctx context.Context, req *as.HandleErrorRequest) (*empty.Empty, error) {
var devEUI lorawan.EUI64
copy(devEUI[:], req.DevEui)
d, err := storage.GetDevice(ctx, storage.DB(), devEUI, false, true)
if err != nil {
errStr := fmt.Sprintf("get device error: %s", err)
log.WithField("dev_eui", devEUI).Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
app, err := storage.GetApplication(ctx, storage.DB(), d.ApplicationID)
if err != nil {
errStr := fmt.Sprintf("get application error: %s", err)
log.WithField("id", d.ApplicationID).Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
log.WithFields(log.Fields{
"type": req.Type,
"dev_eui": devEUI,
}).Error(req.Error)
var errType pb.ErrorType
switch req.Type {
case as.ErrorType_OTAA:
errType = pb.ErrorType_OTAA
case as.ErrorType_DATA_UP_FCNT_RESET:
errType = pb.ErrorType_UPLINK_FCNT_RESET
case as.ErrorType_DATA_UP_FCNT_RETRANSMISSION:
errType = pb.ErrorType_UPLINK_FCNT_RETRANSMISSION
case as.ErrorType_DATA_UP_MIC:
errType = pb.ErrorType_UPLINK_MIC
case as.ErrorType_DEVICE_QUEUE_ITEM_SIZE:
errType = pb.ErrorType_DOWNLINK_PAYLOAD_SIZE
case as.ErrorType_DEVICE_QUEUE_ITEM_FCNT:
errType = pb.ErrorType_DOWNLINK_FCNT
case as.ErrorType_DATA_DOWN_GATEWAY:
errType = pb.ErrorType_DOWNLINK_GATEWAY
}
pl := pb.ErrorEvent{
ApplicationId: uint64(app.ID),
ApplicationName: app.Name,
DeviceName: d.Name,
DevEui: devEUI[:],
Type: errType,
Error: req.Error,
FCnt: req.FCnt,
Tags: make(map[string]string),
PublishedAt: ptypes.TimestampNow(),
}
// set tags
for k, v := range d.Tags.Map {
if v.Valid {
pl.Tags[k] = v.String
}
}
vars := make(map[string]string)
for k, v := range d.Variables.Map {
if v.Valid {
vars[k] = v.String
}
}
err = integration.ForApplicationID(app.ID).HandleErrorEvent(ctx, vars, pl)
if err != nil {
errStr := fmt.Sprintf("send error notification to integration error: %s", err)
log.Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
metrics := storage.MetricsRecord{
Time: time.Now(),
Metrics: map[string]float64{
fmt.Sprintf("error_%s", req.Type.String()): 1.0,
},
}
if err := storage.SaveMetrics(ctx, fmt.Sprintf("device:%s", d.DevEUI), metrics); err != nil {
return nil, errors.Wrap(err, "save metrics error")
}
return &empty.Empty{}, nil
}
// HandleProprietaryUplink handles proprietary uplink payloads.
func (a *ApplicationServerAPI) HandleProprietaryUplink(ctx context.Context, req *as.HandleProprietaryUplinkRequest) (*empty.Empty, error) {
if req.TxInfo == nil {
return nil, grpc.Errorf(codes.InvalidArgument, "tx_info must not be nil")
}
err := gwping.HandleReceivedPing(ctx, req)
if err != nil {
errStr := fmt.Sprintf("handle received ping error: %s", err)
log.Error(errStr)
return nil, grpc.Errorf(codes.Internal, errStr)
}
return &empty.Empty{}, nil
}
// SetDeviceStatus updates the device-status for the given device.
func (a *ApplicationServerAPI) SetDeviceStatus(ctx context.Context, req *as.SetDeviceStatusRequest) (*empty.Empty, error) {
var devEUI lorawan.EUI64
copy(devEUI[:], req.DevEui)
var d storage.Device
var err error
err = storage.Transaction(func(tx sqlx.Ext) error {
d, err = storage.GetDevice(ctx, tx, devEUI, true, true)
if err != nil {
return helpers.ErrToRPCError(errors.Wrap(err, "get device error"))
}
marg := int(req.Margin)
d.DeviceStatusMargin = &marg
if req.BatteryLevelUnavailable {
d.DeviceStatusBattery = nil
d.DeviceStatusExternalPower = false
} else if req.ExternalPowerSource {
d.DeviceStatusExternalPower = true
d.DeviceStatusBattery = nil
} else {
d.DeviceStatusExternalPower = false
d.DeviceStatusBattery = &req.BatteryLevel
}
if err = storage.UpdateDevice(ctx, tx, &d, true); err != nil {
return helpers.ErrToRPCError(errors.Wrap(err, "update device error"))
}
return nil
})
if err != nil {
return nil, err
}
app, err := storage.GetApplication(ctx, storage.DB(), d.ApplicationID)
if err != nil {
return nil, helpers.ErrToRPCError(errors.Wrap(err, "get application error"))
}
pl := pb.StatusEvent{
ApplicationId: uint64(app.ID),
ApplicationName: app.Name,
DeviceName: d.Name,
DevEui: d.DevEUI[:],
Margin: req.Margin,
ExternalPowerSource: req.ExternalPowerSource,
BatteryLevel: float32(math.Round(float64(req.BatteryLevel*100))) / 100,
BatteryLevelUnavailable: req.BatteryLevelUnavailable,
Tags: make(map[string]string),
PublishedAt: ptypes.TimestampNow(),
}
// set tags
for k, v := range d.Tags.Map {
if v.Valid {
pl.Tags[k] = v.String
}
}
vars := make(map[string]string)
for k, v := range d.Variables.Map {
if v.Valid {
vars[k] = v.String
}
}
err = integration.ForApplicationID(app.ID).HandleStatusEvent(ctx, vars, pl)
if err != nil {
return nil, helpers.ErrToRPCError(errors.Wrap(err, "send status notification to handler error"))
}
return &empty.Empty{}, nil
}
// SetDeviceLocation updates the device-location.
func (a *ApplicationServerAPI) SetDeviceLocation(ctx context.Context, req *as.SetDeviceLocationRequest) (*empty.Empty, error) {
if req.Location == nil {
return nil, grpc.Errorf(codes.InvalidArgument, "location must not be nil")
}
var devEUI lorawan.EUI64
copy(devEUI[:], req.DevEui)
var d storage.Device
var err error
err = storage.Transaction(func(tx sqlx.Ext) error {
d, err = storage.GetDevice(ctx, tx, devEUI, true, true)
if err != nil {
return helpers.ErrToRPCError(errors.Wrap(err, "get device error"))
}
d.Latitude = &req.Location.Latitude
d.Longitude = &req.Location.Longitude
d.Altitude = &req.Location.Altitude
if err = storage.UpdateDevice(ctx, tx, &d, true); err != nil {
return helpers.ErrToRPCError(errors.Wrap(err, "update device error"))
}
return nil
})
if err != nil {
return nil, err
}
app, err := storage.GetApplication(ctx, storage.DB(), d.ApplicationID)
if err != nil {
return nil, helpers.ErrToRPCError(errors.Wrap(err, "get application error"))
}
pl := pb.LocationEvent{
ApplicationId: uint64(app.ID),
ApplicationName: app.Name,
DeviceName: d.Name,
DevEui: d.DevEUI[:],
Location: req.Location,
UplinkIds: req.UplinkIds,
Tags: make(map[string]string),
PublishedAt: ptypes.TimestampNow(),
}
// set tags
for k, v := range d.Tags.Map {
if v.Valid {
pl.Tags[k] = v.String
}
}
vars := make(map[string]string)
for k, v := range d.Variables.Map {
if v.Valid {
vars[k] = v.String
}
}
err = integration.ForApplicationID(app.ID).HandleLocationEvent(ctx, vars, pl)
if err != nil {
return nil, helpers.ErrToRPCError(errors.Wrap(err, "send location notification to handler error"))
}
return &empty.Empty{}, nil
}
// HandleGatewayStats handles the given gateway stats.
func (a *ApplicationServerAPI) HandleGatewayStats(ctx context.Context, req *as.HandleGatewayStatsRequest) (*empty.Empty, error) {
var gatewayID lorawan.EUI64
copy(gatewayID[:], req.GatewayId)
ts := time.Now()
err := storage.Transaction(func(tx sqlx.Ext) error {
gw, err := storage.GetGateway(ctx, tx, gatewayID, true)
if err != nil {
return helpers.ErrToRPCError(errors.Wrap(err, "get gateway error"))
}
if gw.FirstSeenAt == nil {
gw.FirstSeenAt = &ts
}
gw.LastSeenAt = &ts
if loc := req.Location; loc != nil {
gw.Latitude = loc.Latitude
gw.Longitude = loc.Longitude
gw.Altitude = loc.Altitude
}
gw.Metadata = hstore.Hstore{
Map: make(map[string]sql.NullString),
}
for k, v := range req.Metadata {
gw.Metadata.Map[k] = sql.NullString{Valid: true, String: v}
}
if err := storage.UpdateGateway(ctx, tx, &gw); err != nil {
return helpers.ErrToRPCError(errors.Wrap(err, "update gateway error"))
}
return nil
})
if err != nil {
return nil, err
}
metrics := storage.MetricsRecord{
Time: ts,
Metrics: map[string]float64{
"rx_count": float64(req.RxPacketsReceived),
"rx_ok_count": float64(req.RxPacketsReceivedOk),
"tx_count": float64(req.TxPacketsReceived),
"tx_ok_count": float64(req.TxPacketsEmitted),
},
}
for k, v := range req.TxPacketsPerFrequency {
metrics.Metrics[fmt.Sprintf("tx_freq_%d", k)] = float64(v)
}
for k, v := range req.RxPacketsPerFrequency {
metrics.Metrics[fmt.Sprintf("rx_freq_%d", k)] = float64(v)
}
for k, v := range req.TxPacketsPerDr {
metrics.Metrics[fmt.Sprintf("tx_dr_%d", k)] = float64(v)
}
for k, v := range req.RxPacketsPerDr {
metrics.Metrics[fmt.Sprintf("rx_dr_%d", k)] = float64(v)
}
for k, v := range req.TxPacketsPerStatus {
metrics.Metrics[fmt.Sprintf("tx_status_%s", k)] = float64(v)
}
if err := storage.SaveMetrics(ctx, fmt.Sprintf("gw:%s", gatewayID), metrics); err != nil {
return nil, helpers.ErrToRPCError(errors.Wrap(err, "save metrics error"))
}
return &empty.Empty{}, nil
}
// ReEncryptDeviceQueueItems handles the re-encryption of device queue-items.
func (a *ApplicationServerAPI) ReEncryptDeviceQueueItems(ctx context.Context, req *as.ReEncryptDeviceQueueItemsRequest) (*as.ReEncryptDeviceQueueItemsResponse, error) {
var devEUI lorawan.EUI64
copy(devEUI[:], req.DevEui)
var devAddr lorawan.DevAddr
copy(devAddr[:], req.DevAddr)
fCnt := req.FCntStart
var out as.ReEncryptDeviceQueueItemsResponse
if err := storage.Transaction(func(tx sqlx.Ext) error {
// Lock the device to avoid concurrent enqueue actions for the same
// device as this would result in re-use of the same frame-counter.
d, err := storage.GetDevice(ctx, tx, devEUI, true, true)
if err != nil {
return helpers.ErrToRPCError(err)
}
// Validate that the security context is in sync.
if devAddr != d.DevAddr {
return grpc.Errorf(codes.FailedPrecondition, "devaddr does not match, the security-context is out of sync")
}
for _, qi := range req.GetItems() {
// decrypt using old parameters
bDecr, err := lorawan.EncryptFRMPayload(d.AppSKey, false, d.DevAddr, qi.FCnt, qi.FrmPayload)
if err != nil {
return grpc.Errorf(codes.Internal, "decrypt frmpayload error: %s", err)
}
// re-encrypt using the new frame-counter
bEncr, err := lorawan.EncryptFRMPayload(d.AppSKey, false, d.DevAddr, fCnt, bDecr)
if err != nil {
return grpc.Errorf(codes.Internal, "encrypt frmpayload error: %s", err)
}
// append the item to the output
out.Items = append(out.Items, &as.ReEncryptedDeviceQueueItem{
FrmPayload: bEncr,
FCnt: fCnt,
FPort: qi.FPort,
Confirmed: qi.Confirmed,
})
// increment the frame-counter
fCnt++
}
return nil
}); err != nil {
return nil, err
}
return &out, nil
}