Google Git
Sign in
eclipse / gerrit / www.eclipse.org / hono / 6614978738f3d2d115b4926aa56103defa889dcb / . / docs / 1.4 / admin-guide / coap-adapter-config / index.html
blob: 3fc61425cab05539ddd5055951a653ae5408e648 [file] [log] [blame]
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1<!DOCTYPE html>
2<html lang="1.4" class="js csstransforms3d">
3 <head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width, initial-scale=1.0">
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]6 <meta name="generator" content="Hugo 0.81.0" />
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]7 <meta name="description" content="A set of micro-services for connecting millions of devices.">
8<meta name="author" content="The Eclipse Hono Project">
9
10 <link rel="apple-touch-icon" sizes="180x180" href="/hono/docs/favicon/apple-touch-icon.png">
11<link rel="icon" type="image/png" sizes="48x48" href="/hono/docs/favicon/favicon-48x48.png">
12<link rel="icon" type="image/png" sizes="32x32" href="/hono/docs/favicon/favicon-32x32.png">
13<link rel="icon" type="image/png" sizes="16x16" href="/hono/docs/favicon/favicon-16x16.png">
14<link rel="manifest" href="/hono/docs/favicon/site.webmanifest">
15<link rel="mask-icon" href="/hono/docs/favicon/safari-pinned-tab.svg" color="#5bbad5">
16<link rel="shortcut icon" href="/hono/docs/favicon/favicon.ico">
17<meta name="msapplication-TileColor" content="#da532c">
18<meta name="msapplication-config" content="/hono/docs/favicon/browserconfig.xml">
19<meta name="theme-color" content="#ffffff">
20
21 <title>CoAP Adapter Configuration :: Eclipse Hono&trade; Vers.: 1.4</title>
22
23
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]24 <link href="/hono/docs/css/nucleus.css?1627607527" rel="stylesheet">
25 <link href="/hono/docs/css/fontawesome-all.min.css?1627607527" rel="stylesheet">
26 <link href="/hono/docs/css/hybrid.css?1627607527" rel="stylesheet">
27 <link href="/hono/docs/css/featherlight.min.css?1627607527" rel="stylesheet">
28 <link href="/hono/docs/css/perfect-scrollbar.min.css?1627607527" rel="stylesheet">
29 <link href="/hono/docs/css/auto-complete.css?1627607527" rel="stylesheet">
30 <link href="/hono/docs/css/atom-one-dark-reasonable.css?1627607527" rel="stylesheet">
31 <link href="/hono/docs/css/theme.css?1627607527" rel="stylesheet">
32 <link href="/hono/docs/css/hugo-theme.css?1627607527" rel="stylesheet">
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]33
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]34 <link href="/hono/docs/css/theme-hono.css?1627607527" rel="stylesheet">
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]35
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]36 <link href="/hono/docs/css/hono.css?1627607527" rel="stylesheet">
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]37
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]38 <script src="/hono/docs/js/jquery-3.3.1.min.js?1627607527"></script>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]39
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]40 <style>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]41 :root #header + #content > #left > #rlblock_left{
42 display:none !important;
43 }
44
45 :not(pre) > code + span.copy-to-clipboard {
46 display: none;
47 }
48
49 </style>
50
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]51<link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]52
53
54<meta name="twitter:card" content="summary_large_image">
55<meta name="twitter:site" content="@EclipseHono">
56<meta name="twitter:title" content="CoAP Adapter Configuration :: Eclipse Hono&amp;trade; Vers.: 1.4">
57<meta name="twitter:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png">
58<meta name="twitter:description" content="A set of micro-services for connecting millions of devices.">
59
60
61<meta property="og:title" content="CoAP Adapter Configuration :: Eclipse Hono&amp;trade; Vers.: 1.4" />
62<meta property="og:type" content="website" />
63<meta property="og:url" content="https://www.eclipse.org/hono/docs/1.4/admin-guide/coap-adapter-config//" />
64<meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />
65
66 </head>
67 <body class="" data-url="/hono/docs/1.4/admin-guide/coap-adapter-config/">
68 <nav id="sidebar" class="">
69
70
71
72 <div id="header-wrapper">
73 <div id="header">
74 <a href="https://www.eclipse.org/hono/">
75 <img src="/hono/docs/images/HONO-Logo_Bild-Wort_quer-w-310x120px.svg" alt="Hono logo" class="logo-img">
76</a>
77
78 </div>
79
80 <div class="searchbox">
81 <label for="search-by"><i class="fas fa-search"></i></label>
82 <input data-search-input id="search-by" type="search" placeholder="Search...">
83 <span data-search-clear=""><i class="fas fa-times"></i></span>
84</div>
85
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]86<script type="text/javascript" src="/hono/docs/js/lunr.min.js?1627607527"></script>
87<script type="text/javascript" src="/hono/docs/js/auto-complete.js?1627607527"></script>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]88<script type="text/javascript">
89
90 var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/\/1.4";
91
92</script>
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]93<script type="text/javascript" src="/hono/docs/js/search.js?1627607527"></script>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]94
95
96 </div>
97
98 <div class="highlightable">
99 <ul class="topics">
100
101
102
103
104
105
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]106
107
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]108
109
110
111 <li data-nav-id="/hono/docs/1.4/concepts/" title="Concepts" class="dd-item
112
113
114
115 ">
116 <a href="/hono/docs/1.4/concepts/">
117 <i class="far fa-lightbulb"></i> Concepts
118
119 </a>
120
121
122 <ul>
123
124
125
126
127
128
129
130
131
132
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]133
134
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]135
136
137
138 <li data-nav-id="/hono/docs/1.4/concepts/device-identity/" title="Device Identity" class="dd-item ">
139 <a href="/hono/docs/1.4/concepts/device-identity/">
140 Device Identity
141
142 </a>
143 </li>
144
145
146
147
148
149
150
151
152
153
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]154
155
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]156
157
158
159 <li data-nav-id="/hono/docs/1.4/concepts/tenancy/" title="Multi-Tenancy" class="dd-item ">
160 <a href="/hono/docs/1.4/concepts/tenancy/">
161 Multi-Tenancy
162
163 </a>
164 </li>
165
166
167
168
169
170
171
172
173
174
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]175
176
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]177
178
179
180 <li data-nav-id="/hono/docs/1.4/concepts/device-provisioning/" title="Device Provisioning" class="dd-item ">
181 <a href="/hono/docs/1.4/concepts/device-provisioning/">
182 Device Provisioning
183
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]196
197
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]198
199
200
201 <li data-nav-id="/hono/docs/1.4/concepts/connecting-devices/" title="Connecting Devices" class="dd-item ">
202 <a href="/hono/docs/1.4/concepts/connecting-devices/">
203 Connecting Devices
204
205 </a>
206 </li>
207
208
209
210
211
212
213
214
215
216
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]217
218
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]219
220
221
222 <li data-nav-id="/hono/docs/1.4/concepts/device-notifications/" title="Device Notifications" class="dd-item ">
223 <a href="/hono/docs/1.4/concepts/device-notifications/">
224 Device Notifications
225
226 </a>
227 </li>
228
229
230
231
232
233
234
235
236
237
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]238
239
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]240
241
242
243 <li data-nav-id="/hono/docs/1.4/concepts/command-and-control/" title="Command &amp; Control" class="dd-item ">
244 <a href="/hono/docs/1.4/concepts/command-and-control/">
245 Command &amp; Control
246
247 </a>
248 </li>
249
250
251
252
253
254
255
256
257
258
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]259
260
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]261
262
263
264 <li data-nav-id="/hono/docs/1.4/concepts/resource-limits/" title="Resource limits" class="dd-item ">
265 <a href="/hono/docs/1.4/concepts/resource-limits/">
266 Resource limits
267
268 </a>
269 </li>
270
271
272
273
274
275
276
277
278
279
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]280
281
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]282
283
284
285 <li data-nav-id="/hono/docs/1.4/concepts/connection-events/" title="Connection Events" class="dd-item ">
286 <a href="/hono/docs/1.4/concepts/connection-events/">
287 Connection Events
288
289 </a>
290 </li>
291
292
293
294
295
296
297
298 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]299
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]300 </li>
301
302
303
304
305
306
307
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]308
309
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]310
311
312
313 <li data-nav-id="/hono/docs/1.4/user-guide/" title="User Guide" class="dd-item
314
315
316
317 ">
318 <a href="/hono/docs/1.4/user-guide/">
319 <i class="fas fa-book-reader"></i> User Guide
320
321 </a>
322
323
324 <ul>
325
326
327
328
329
330
331
332
333
334
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]335
336
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]337
338
339
340 <li data-nav-id="/hono/docs/1.4/user-guide/mongodb-based-device-registry/" title="MongoDB Based Device Registry" class="dd-item ">
341 <a href="/hono/docs/1.4/user-guide/mongodb-based-device-registry/">
342 MongoDB Based Device Registry
343
344 </a>
345 </li>
346
347
348
349
350
351
352
353
354
355
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]356
357
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]358
359
360
361 <li data-nav-id="/hono/docs/1.4/user-guide/file-based-device-registry/" title="File Based Device Registry" class="dd-item ">
362 <a href="/hono/docs/1.4/user-guide/file-based-device-registry/">
363 File Based Device Registry
364
365 </a>
366 </li>
367
368
369
370
371
372
373
374
375
376
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]377
378
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]379
380
381
382 <li data-nav-id="/hono/docs/1.4/user-guide/http-adapter/" title="HTTP Adapter" class="dd-item ">
383 <a href="/hono/docs/1.4/user-guide/http-adapter/">
384 HTTP Adapter
385
386 </a>
387 </li>
388
389
390
391
392
393
394
395
396
397
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]398
399
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]400
401
402
403 <li data-nav-id="/hono/docs/1.4/user-guide/mqtt-adapter/" title="MQTT Adapter" class="dd-item ">
404 <a href="/hono/docs/1.4/user-guide/mqtt-adapter/">
405 MQTT Adapter
406
407 </a>
408 </li>
409
410
411
412
413
414
415
416
417
418
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]419
420
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]421
422
423
424 <li data-nav-id="/hono/docs/1.4/user-guide/amqp-adapter/" title="AMQP Adapter" class="dd-item ">
425 <a href="/hono/docs/1.4/user-guide/amqp-adapter/">
426 AMQP Adapter
427
428 </a>
429 </li>
430
431
432
433
434
435
436
437
438
439
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]440
441
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]442
443
444
445 <li data-nav-id="/hono/docs/1.4/user-guide/coap-adapter/" title="CoAP Adapter" class="dd-item ">
446 <a href="/hono/docs/1.4/user-guide/coap-adapter/">
447 CoAP Adapter
448
449 </a>
450 </li>
451
452
453
454
455
456
457
458
459
460
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]461
462
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]463
464
465
466 <li data-nav-id="/hono/docs/1.4/user-guide/kura-adapter/" title="Kura Adapter" class="dd-item ">
467 <a href="/hono/docs/1.4/user-guide/kura-adapter/">
468 Kura Adapter
469
470 </a>
471 </li>
472
473
474
475
476
477
478
479
480
481
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]482
483
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]484
485
486
487 <li data-nav-id="/hono/docs/1.4/user-guide/sigfox-adapter/" title="Sigfox Adapter" class="dd-item ">
488 <a href="/hono/docs/1.4/user-guide/sigfox-adapter/">
489 Sigfox Adapter
490
491 </a>
492 </li>
493
494
495
496
497
498
499
500
501
502
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]503
504
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]505
506
507
508 <li data-nav-id="/hono/docs/1.4/user-guide/jmeter_load_tests/" title="Load Tests with JMeter" class="dd-item ">
509 <a href="/hono/docs/1.4/user-guide/jmeter_load_tests/">
510 Load Tests with JMeter
511
512 </a>
513 </li>
514
515
516
517
518
519
520
521
522
523
524 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]525
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]526 </li>
527
528
529
530
531
532
533
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]534
535
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]536
537
538
539 <li data-nav-id="/hono/docs/1.4/admin-guide/" title="Admin Guide" class="dd-item
540 parent
541
542
543 ">
544 <a href="/hono/docs/1.4/admin-guide/">
545 <i class="fas fa-sliders-h"></i> Admin Guide
546
547 </a>
548
549
550 <ul>
551
552
553
554
555
556
557
558
559
560
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]561
562
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]563
564
565
566 <li data-nav-id="/hono/docs/1.4/admin-guide/common-config/" title="Common Configuration" class="dd-item ">
567 <a href="/hono/docs/1.4/admin-guide/common-config/">
568 Common Configuration
569
570 </a>
571 </li>
572
573
574
575
576
577
578
579
580
581
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]582
583
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]584
585
586
587 <li data-nav-id="/hono/docs/1.4/admin-guide/auth-server-config/" title="Auth Server Configuration" class="dd-item ">
588 <a href="/hono/docs/1.4/admin-guide/auth-server-config/">
589 Auth Server Configuration
590
591 </a>
592 </li>
593
594
595
596
597
598
599
600
601
602
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]603
604
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]605
606
607
608 <li data-nav-id="/hono/docs/1.4/admin-guide/mongodb-device-registry-config/" title="MongoDB Based Device Registry Configuration" class="dd-item ">
609 <a href="/hono/docs/1.4/admin-guide/mongodb-device-registry-config/">
610 MongoDB Based Device Registry Configuration
611
612 </a>
613 </li>
614
615
616
617
618
619
620
621
622
623
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]624
625
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]626
627
628
629 <li data-nav-id="/hono/docs/1.4/admin-guide/file-based-device-registry-config/" title="File Based Device Registry Configuration" class="dd-item ">
630 <a href="/hono/docs/1.4/admin-guide/file-based-device-registry-config/">
631 File Based Device Registry Configuration
632
633 </a>
634 </li>
635
636
637
638
639
640
641
642
643
644
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]645
646
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]647
648
649
650 <li data-nav-id="/hono/docs/1.4/admin-guide/device-connection-config/" title="Configuring the Device Connection Service" class="dd-item ">
651 <a href="/hono/docs/1.4/admin-guide/device-connection-config/">
652 Device Connection Service Configuration
653
654 </a>
655 </li>
656
657
658
659
660
661
662
663
664
665
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]666
667
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]668
669
670
671 <li data-nav-id="/hono/docs/1.4/admin-guide/http-adapter-config/" title="HTTP Adapter Configuration" class="dd-item ">
672 <a href="/hono/docs/1.4/admin-guide/http-adapter-config/">
673 HTTP Adapter Configuration
674
675 </a>
676 </li>
677
678
679
680
681
682
683
684
685
686
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]687
688
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]689
690
691
692 <li data-nav-id="/hono/docs/1.4/admin-guide/mqtt-adapter-config/" title="MQTT Adapter Configuration" class="dd-item ">
693 <a href="/hono/docs/1.4/admin-guide/mqtt-adapter-config/">
694 MQTT Adapter Configuration
695
696 </a>
697 </li>
698
699
700
701
702
703
704
705
706
707
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]708
709
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]710
711
712
713 <li data-nav-id="/hono/docs/1.4/admin-guide/amqp-adapter-config/" title="AMQP Adapter Configuration" class="dd-item ">
714 <a href="/hono/docs/1.4/admin-guide/amqp-adapter-config/">
715 AMQP Adapter Configuration
716
717 </a>
718 </li>
719
720
721
722
723
724
725
726
727
728
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]729
730
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]731
732
733
734 <li data-nav-id="/hono/docs/1.4/admin-guide/coap-adapter-config/" title="CoAP Adapter Configuration" class="dd-item active">
735 <a href="/hono/docs/1.4/admin-guide/coap-adapter-config/">
736 CoAP Adapter Configuration
737
738 </a>
739 </li>
740
741
742
743
744
745
746
747
748
749
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]750
751
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]752
753
754
755 <li data-nav-id="/hono/docs/1.4/admin-guide/kura-adapter-config/" title="Kura Adapter Configuration" class="dd-item ">
756 <a href="/hono/docs/1.4/admin-guide/kura-adapter-config/">
757 Kura Adapter Configuration
758
759 </a>
760 </li>
761
762
763
764
765
766
767
768
769
770
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]771
772
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]773
774
775
776 <li data-nav-id="/hono/docs/1.4/admin-guide/hono-client-configuration/" title="Hono Client Configuration" class="dd-item ">
777 <a href="/hono/docs/1.4/admin-guide/hono-client-configuration/">
778 Hono Client Configuration
779
780 </a>
781 </li>
782
783
784
785
786
787
788
789
790
791
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]792
793
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]794
795
796
797 <li data-nav-id="/hono/docs/1.4/admin-guide/amqp-network-config/" title="AMQP 1.0 Messaging Network Configuration" class="dd-item ">
798 <a href="/hono/docs/1.4/admin-guide/amqp-network-config/">
799 AMQP 1.0 Messaging Network Configuration
800
801 </a>
802 </li>
803
804
805
806
807
808
809
810
811
812
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]813
814
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]815
816
817
818 <li data-nav-id="/hono/docs/1.4/admin-guide/secure_communication/" title="Secure Communication" class="dd-item ">
819 <a href="/hono/docs/1.4/admin-guide/secure_communication/">
820 Secure Communication
821
822 </a>
823 </li>
824
825
826
827
828
829
830
831
832
833
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]834
835
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]836
837
838
839 <li data-nav-id="/hono/docs/1.4/admin-guide/monitoring-tracing-config/" title="Monitoring &amp; Tracing" class="dd-item ">
840 <a href="/hono/docs/1.4/admin-guide/monitoring-tracing-config/">
841 Monitoring &amp; Tracing
842
843 </a>
844 </li>
845
846
847
848
849
850
851
852
853
854
855 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]856
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]857 </li>
858
859
860
861
862
863
864
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]865
866
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]867
868
869
870 <li data-nav-id="/hono/docs/1.4/dev-guide/" title="Developer Guide" class="dd-item
871
872
873
874 ">
875 <a href="/hono/docs/1.4/dev-guide/">
876 <i class="fas fa-tools"></i> Developer Guide
877
878 </a>
879
880
881 <ul>
882
883
884
885
886
887
888
889
890
891
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]892
893
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]894
895
896
897 <li data-nav-id="/hono/docs/1.4/dev-guide/building_hono/" title="Building from Source" class="dd-item ">
898 <a href="/hono/docs/1.4/dev-guide/building_hono/">
899 Building from Source
900
901 </a>
902 </li>
903
904
905
906
907
908
909
910
911
912
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]913
914
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]915
916
917
918 <li data-nav-id="/hono/docs/1.4/dev-guide/amqp_adapter_client/" title="AMQP Adapter Client for Java" class="dd-item ">
919 <a href="/hono/docs/1.4/dev-guide/amqp_adapter_client/">
920 AMQP Adapter Client for Java
921
922 </a>
923 </li>
924
925
926
927
928
929
930
931
932
933
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]934
935
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]936
937
938
939 <li data-nav-id="/hono/docs/1.4/dev-guide/java_client_consumer/" title="Consuming Messages from Java" class="dd-item ">
940 <a href="/hono/docs/1.4/dev-guide/java_client_consumer/">
941 Consuming Messages from Java
942
943 </a>
944 </li>
945
946
947
948
949
950
951
952
953
954
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]955
956
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]957
958
959
960 <li data-nav-id="/hono/docs/1.4/dev-guide/custom_http_adapter/" title="Implement a Custom Hono HTTP Protocol Adapter" class="dd-item ">
961 <a href="/hono/docs/1.4/dev-guide/custom_http_adapter/">
962 Implement a Custom Hono HTTP Protocol Adapter
963
964 </a>
965 </li>
966
967
968
969
970
971
972
973 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]974
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]975 </li>
976
977
978
979
980
981
982
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]983
984
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]985
986
987
988 <li data-nav-id="/hono/docs/1.4/api/" title="API" class="dd-item
989
990
991
992 ">
993 <a href="/hono/docs/1.4/api/">
994 &nbsp;<i class='fas fa-plug'></i>&nbsp;API
995
996 </a>
997
998
999 <ul>
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1010
1011
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1012
1013
1014
1015 <li data-nav-id="/hono/docs/1.4/api/telemetry/" title="Telemetry API Specification" class="dd-item ">
1016 <a href="/hono/docs/1.4/api/telemetry/">
1017 Telemetry API
1018
1019 </a>
1020 </li>
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1031
1032
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1033
1034
1035
1036 <li data-nav-id="/hono/docs/1.4/api/event/" title="Event API Specification" class="dd-item ">
1037 <a href="/hono/docs/1.4/api/event/">
1038 Event API
1039
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1052
1053
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1054
1055
1056
1057 <li data-nav-id="/hono/docs/1.4/api/command-and-control/" title="Command &amp; Control API Specification" class="dd-item ">
1058 <a href="/hono/docs/1.4/api/command-and-control/">
1059 Command &amp; Control API
1060
1061 </a>
1062 </li>
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1073
1074
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1075
1076
1077
1078 <li data-nav-id="/hono/docs/1.4/api/tenant/" title="Tenant API Specification" class="dd-item ">
1079 <a href="/hono/docs/1.4/api/tenant/">
1080 Tenant API
1081
1082 </a>
1083 </li>
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1094
1095
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1096
1097
1098
1099 <li data-nav-id="/hono/docs/1.4/api/device-connection/" title="Device Connection API Specification" class="dd-item ">
1100 <a href="/hono/docs/1.4/api/device-connection/">
1101 Device Connection API
1102
1103 </a>
1104 </li>
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1115
1116
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1117
1118
1119
1120 <li data-nav-id="/hono/docs/1.4/api/device-registration/" title="Device Registration API Specification" class="dd-item ">
1121 <a href="/hono/docs/1.4/api/device-registration/">
1122 Device Registration API
1123
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1136
1137
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1138
1139
1140
1141 <li data-nav-id="/hono/docs/1.4/api/credentials/" title="Credentials API Specification" class="dd-item ">
1142 <a href="/hono/docs/1.4/api/credentials/">
1143 Credentials API
1144
1145 </a>
1146 </li>
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1157
1158
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1159
1160
1161
1162 <li data-nav-id="/hono/docs/1.4/api/authentication/" title="Authentication API Specification" class="dd-item ">
1163 <a href="/hono/docs/1.4/api/authentication/">
1164 Authentication API
1165
1166 </a>
1167 </li>
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1178
1179
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1180
1181
1182
1183 <li data-nav-id="/hono/docs/1.4/api/management/" title="Device Registry Management API Specification" class="dd-item ">
1184 <a href="/hono/docs/1.4/api/management/">
1185 Device Registry Management API
1186
1187 </a>
1188 </li>
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1199
1200
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1201
1202
1203
1204 <li data-nav-id="/hono/docs/1.4/api/metrics/" title="Metrics" class="dd-item ">
1205 <a href="/hono/docs/1.4/api/metrics/">
1206 Metrics
1207
1208 </a>
1209 </li>
1210
1211
1212
1213
1214
1215
1216
1217 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1218
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1219 </li>
1220
1221
1222
1223
1224
1225
1226
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1227
1228
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1229
1230
1231
1232 <li data-nav-id="/hono/docs/1.4/deployment/" title="Deployment" class="dd-item
1233
1234
1235
1236 ">
1237 <a href="/hono/docs/1.4/deployment/">
1238 <i class="fas fa-shipping-fast"></i> Deployment
1239
1240 </a>
1241
1242
1243 <ul>
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1254
1255
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1256
1257
1258
1259 <li data-nav-id="/hono/docs/1.4/deployment/helm-based-deployment/" title="Helm based Deployment" class="dd-item ">
1260 <a href="/hono/docs/1.4/deployment/helm-based-deployment/">
1261 Helm based Deployment
1262
1263 </a>
1264 </li>
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1275
1276
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1277
1278
1279
1280 <li data-nav-id="/hono/docs/1.4/deployment/openshift/" title="OpenShift / OKD" class="dd-item ">
1281 <a href="/hono/docs/1.4/deployment/openshift/">
1282 OpenShift / OKD
1283
1284 </a>
1285 </li>
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1296
1297
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1298
1299
1300
1301 <li data-nav-id="/hono/docs/1.4/deployment/create-kubernetes-cluster/" title="Setting up a Kubernetes Cluster" class="dd-item ">
1302 <a href="/hono/docs/1.4/deployment/create-kubernetes-cluster/">
1303 Setting up a Kubernetes Cluster
1304
1305 </a>
1306 </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1317
1318
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1319
1320
1321
1322 <li data-nav-id="/hono/docs/1.4/deployment/resource-limitation/" title="Limiting Resource Usage" class="dd-item ">
1323 <a href="/hono/docs/1.4/deployment/resource-limitation/">
1324 Limiting Resource Usage
1325
1326 </a>
1327 </li>
1328
1329
1330
1331
1332
1333
1334
1335 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1336
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1337 </li>
1338
1339
1340
1341
1342
1343
1344
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1345
1346
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1347
1348
1349
1350 <li data-nav-id="/hono/docs/1.4/architecture/" title="Architecture" class="dd-item
1351
1352
1353
1354 ">
1355 <a href="/hono/docs/1.4/architecture/">
1356 <i class="fas fa-landmark"></i> Architecture
1357
1358 </a>
1359
1360
1361 <ul>
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1372
1373
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1374
1375
1376
1377 <li data-nav-id="/hono/docs/1.4/architecture/component-view/" title="Component View" class="dd-item ">
1378 <a href="/hono/docs/1.4/architecture/component-view/">
1379 Component View
1380
1381 </a>
1382 </li>
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1393
1394
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1395
1396
1397
1398 <li data-nav-id="/hono/docs/1.4/architecture/auth/" title="Authentication/Authorization" class="dd-item ">
1399 <a href="/hono/docs/1.4/architecture/auth/">
1400 Authentication/Authorization
1401
1402 </a>
1403 </li>
1404
1405
1406
1407
1408
1409
1410
1411 </ul>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1412
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1413 </li>
1414
1415
1416
1417
1418
1419 </ul>
1420
1421
1422
1423 <section id="shortcuts">
1424 <h3></h3>
1425 <ul>
1426
1427 <li>
1428 <a class="padding" href="https://www.eclipse.org/hono/" title="Hono&#39;s Homepage"><i class='fas fa-home'></i> Hono Home</a>
1429 </li>
1430
1431 <li>
1432 <a class="padding" href="https://www.eclipse.org/hono/getting-started/" title="Getting started with Eclipse Hono"><i class='fas fa-plane-departure'></i> Getting Started</a>
1433 </li>
1434
1435 </ul>
1436 </section>
1437
1438
1439
1440 <section id="prefooter">
1441 <hr/>
1442 <ul>
1443
1444 <li>
1445 <div id="select-box-wrapper">
1446 <div id="select-box">
1447 <a class="padding">
1448 Version:&nbsp;
1449 <div class="select-style">
1450 <select id="select-language" onchange="location = this.value;">
1451
1452
1453
1454
1455
1456
1457
1458
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1459 <option id="stable" value="https://www.eclipse.org/hono/docs/admin-guide/coap-adapter-config/">stable (1.9)</option>
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493 <option id="1.9" value="https://www.eclipse.org/hono/docs/1.9/admin-guide/coap-adapter-config/">1.9</option>
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1523
1524
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1525
1526
1527 <option id="1.8" value="https://www.eclipse.org/hono/docs/1.8/admin-guide/coap-adapter-config/">1.8</option>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1555
1556
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1557
1558
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1559
1560
1561 <option id="1.7" value="https://www.eclipse.org/hono/docs/1.7/admin-guide/coap-adapter-config/">1.7</option>
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1587
1588
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1589
1590
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1591
1592
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1593
1594
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1595 <option id="1.6" value="https://www.eclipse.org/hono/docs/1.6/admin-guide/coap-adapter-config/">1.6</option>
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1619
1620
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1621
1622
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1623
1624
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1625
1626
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1627
1628
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1629 <option id="1.5" value="https://www.eclipse.org/hono/docs/1.5/admin-guide/coap-adapter-config/">1.5</option>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1651
1652
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1653
1654
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1655
1656
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1657
1658
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1659
1660
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1661
1662
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1663 <option id="1.4" value="https://www.eclipse.org/hono/docs/1.4/admin-guide/coap-adapter-config/" selected>1.4</option>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1685
1686
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1687
1688
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1689
1690
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1691
1692
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1693
1694
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1695
1696
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1697 <option id="1.3" value="https://www.eclipse.org/hono/docs/1.3/admin-guide/coap-adapter-config/">1.3</option>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1725
1726
Hono Bot650d39f2021-02-02 02:17:46 +0000[diff] [blame]1727
1728
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1729
1730
Hono Bot1f51cfc2021-05-21 01:12:32 +0000[diff] [blame]1731
1732
Hono Bot8fa7d952021-07-14 01:12:12 +0000[diff] [blame]1733
1734
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1735
1736
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1737 <option id="dev" value="https://www.eclipse.org/hono/docs/dev/admin-guide/coap-adapter-config/">dev</option>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1738
1739
1740
1741
1742 </select>
1743 <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
1744 width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
1745 <g>
1746 <g id="arrow-drop-down">
1747 <polygon points="0,63.75 127.5,191.25 255,63.75 " />
1748 </g>
1749 </g>
1750 </svg>
1751 </div>
1752 </a>
1753 </div>
1754 </div>
1755 </li>
1756
1757
1758
1759 </ul>
1760 </section>
1761
1762 <section id="footer">
1763
1764
Hono Botd9322632021-01-01 02:10:48 +0000[diff] [blame]1765<p>&copy; 2021 <a href="https://www.eclipse.org/hono/">The Eclipse Hono Project</a></p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1766
1767<p>
1768 Documentation built with
1769 <a href="https://gohugo.io/" target="_blank">Hugo</a>
1770 using the
1771 <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn</a> theme.
1772</p>
1773
1774<div class="eclipse-logo">
1775 <a href="https://www.eclipse.org" target="_blank">
1776 <img src="https://www.eclipse.org/hono/docs/images/eclipse_foundation_logo.svg"/>
1777 </a>
1778</div>
1779
1780 </section>
1781 </div>
1782</nav>
1783
1784
1785
1786
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1787 <section id="body">
1788 <div id="overlay"></div>
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1789
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1790
Hono Bot93bd24f2020-12-17 02:12:33 +0000[diff] [blame]1791 <div class="old-version-hint">
1792 <p>This page refers to version <em>1.4</em>.
1793 You might want to use the <a href="https://www.eclipse.org/hono/docs/">current stable</a> version.
1794 </p>
1795 </div>
1796
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1797
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1798
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1799 <div class="padding highlightable">
1800
1801 <div>
1802 <div id="top-bar">
1803
1804
1805
1806
1807 <div id="top-github-link">
1808 <a class="github-link" title='Edit this page' href="https://github.com/eclipse/hono/edit/master/site/documentation/content/admin-guide/coap-adapter-config.md" target="blank">
1809 <i class="fas fa-code-branch"></i>
1810 <span id="top-github-link-text">Edit this page</span>
1811 </a>
1812 </div>
1813
1814
1815
1816 <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
1817 <span id="sidebar-toggle-span">
1818 <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
1819 <i class="fas fa-bars"></i>
1820 </a>
1821 </span>
1822
1823 <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
1824
1825 <span class="links">
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839 <a href='/hono/docs/1.4/'>Documentation</a> > <a href='/hono/docs/1.4/admin-guide/'>Admin Guide</a> > CoAP Adapter Configuration
1840
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1841
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1842
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1843
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1844
1845
1846
1847 </span>
1848 </div>
1849
1850 <div class="progress">
1851 <div class="wrapper">
1852<nav id="TableOfContents">
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1853 <ul>
1854 <li><a href="#service-configuration">Service Configuration</a></li>
1855 <li><a href="#port-configuration">Port Configuration</a>
1856 <ul>
1857 <li><a href="#secure-port-only">Secure Port Only</a></li>
1858 <li><a href="#insecure-port-only">Insecure Port Only</a></li>
1859 <li><a href="#dual-port">Dual Port</a></li>
1860 <li><a href="#ephemeral-ports">Ephemeral Ports</a></li>
1861 </ul>
1862 </li>
1863 <li><a href="#authentication">Authentication</a></li>
1864 </ul>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1865</nav>
1866 </div>
1867</div>
1868
1869
1870 </div>
1871 </div>
1872
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1873 <div id="head-tags">
1874
1875 </div>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1876
1877 <div id="body-inner">
1878
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]1879 <h1>
1880
1881 CoAP Adapter Configuration
1882 </h1>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1883
1884
1885
1886
1887
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1888<p>The CoAP protocol adapter exposes CoAP based endpoints for Eclipse Hono™&rsquo;s south bound Telemetry, Event and Command &amp; Control APIs.</p>
1889<p>The adapter is implemented as a Spring Boot application using <a href="https://www.eclipse.org/californium">Eclipse Californium™</a> for implementing
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1890the CoAP protocol handling. It can be run either directly from the command line or by means of starting the corresponding
1891<a href="https://hub.docker.com/r/eclipse/hono-adapter-coap-vertx/">Docker image</a> created from it.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1892<p>The adapter supports the following standard configuration options:</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1893<ul>
1894<li><a href="/hono/docs/1.4/admin-guide/common-config/#java-vm-options">Common Java VM Options</a></li>
1895<li><a href="/hono/docs/1.4/admin-guide/common-config/#vert-x-options">Common vert.x Options</a></li>
1896<li><a href="/hono/docs/1.4/admin-guide/common-config/#protocol-adapter-options">Common Protocol Adapter Options</a></li>
1897<li><a href="/hono/docs/1.4/admin-guide/monitoring-tracing-config/">Monitoring Options</a></li>
1898</ul>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1899<h2 id="service-configuration">Service Configuration</h2>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1900<p>The following table provides an overview of the configuration variables and corresponding command line options for configuring the CoAP adapter.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1901<table>
1902<thead>
1903<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1904<th style="text-align:left">Environment Variable<br>Command Line Option</th>
1905<th style="text-align:center">Mandatory</th>
1906<th style="text-align:left">Default</th>
1907<th style="text-align:left">Description</th>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1908</tr>
1909</thead>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1910<tbody>
1911<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1912<td style="text-align:left"><code>HONO_APP_MAX_INSTANCES</code><br><code>--hono.app.maxInstances</code></td>
1913<td style="text-align:center">no</td>
1914<td style="text-align:left"><em>#CPU cores</em></td>
1915<td style="text-align:left">The number of verticle instances to deploy. If not set, one verticle per processor core is deployed.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1916</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1917<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1918<td style="text-align:left"><code>HONO_COAP_AUTHENTICATION_REQUIRED</code><br><code>--hono.coap.authenticationRequired</code></td>
1919<td style="text-align:center">no</td>
1920<td style="text-align:left"><code>true</code></td>
1921<td style="text-align:left">If set to <code>true</code> the protocol adapter requires devices to authenticate when connecting to the adapter. The credentials provided by the device are verified using the configured <a href="#credentials-service-connection-configuration">Credentials Service</a>. Devices that fail to authenticate are not allowed to connect to the adapter.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1922</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1923<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1924<td style="text-align:left"><code>HONO_COAP_BIND_ADDRESS</code><br><code>--hono.coap.bindAddress</code></td>
1925<td style="text-align:center">no</td>
1926<td style="text-align:left"><code>127.0.0.1</code></td>
1927<td style="text-align:left">The IP address of the network interface that the secure port should be bound to.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1928</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1929<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1930<td style="text-align:left"><code>HONO_COAP_CERT_PATH</code><br><code>--hono.coap.certPath</code></td>
1931<td style="text-align:center">no</td>
1932<td style="text-align:left">-</td>
1933<td style="text-align:left">The absolute path to the PEM file containing the certificate that the protocol adapter should use for authenticating to clients. This option must be used in conjunction with <code>HONO_COAP_KEY_PATH</code>.<br>Alternatively, the <code>HONO_COAP_KEY_STORE_PATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1934</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1935<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1936<td style="text-align:left"><code>HONO_COAP_COAP_THREADS</code><br><code>--hono.coap.coapThreads</code></td>
1937<td style="text-align:center">no</td>
1938<td style="text-align:left">2</td>
1939<td style="text-align:left">The number of threads to use for processing CoAP message exchanges at the protocol layer.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1940</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1941<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1942<td style="text-align:left"><code>HONO_COAP_CONNECTOR_THREADS</code><br><code>--hono.coap.connectorThreads</code></td>
1943<td style="text-align:center">no</td>
1944<td style="text-align:left">2</td>
1945<td style="text-align:left">The number of threads to use for receiving/sending UDP packets. The connector will start the given number of threads for each direction, outbound (sending) as well as inbound (receiving).</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1946</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1947<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1948<td style="text-align:left"><code>HONO_COAP_DTLS_THREADS</code><br><code>--hono.coap.dtlsThreads</code></td>
1949<td style="text-align:center">no</td>
1950<td style="text-align:left">32</td>
1951<td style="text-align:left">The number of threads to use for processing DTLS message exchanges at the connection layer.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1952</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1953<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1954<td style="text-align:left"><code>HONO_COAP_DTLS_RETRANSMISSION_TIMEOUT</code><br><code>--hono.coap.dtlsRetransmissionTimeout</code></td>
1955<td style="text-align:center">no</td>
1956<td style="text-align:left">2000</td>
1957<td style="text-align:left">The timeout in milliseconds for DTLS retransmissions.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1958</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1959<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1960<td style="text-align:left"><code>HONO_COAP_DEFAULTS_ENABLED</code><br><code>--hono.coap.defaultsEnabled</code></td>
1961<td style="text-align:center">no</td>
1962<td style="text-align:left"><code>true</code></td>
1963<td style="text-align:left">If set to <code>true</code> the protocol adapter uses <em>default values</em> registered for a device to augment messages published by the device with missing information like a content type. In particular, the protocol adapter adds default values registered for the device as (application) properties with the same name to the AMQP 1.0 messages it sends downstream to the AMQP Messaging Network.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1964</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1965<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1966<td style="text-align:left"><code>HONO_COAP_EXCHANGE_LIFETIME</code><br><code>--hono.coap.exchangeLifetime</code></td>
1967<td style="text-align:center">no</td>
1968<td style="text-align:left">247000</td>
1969<td style="text-align:left">The exchange lifetime in milliseconds. According RFC 7252, that value is 247s. Such a large time requires also a huge amount of heap. That time includes a processing time of 100s and retransmissions of CON messages. Therefore a practical value could be much smaller.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1970</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1971<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1972<td style="text-align:left"><code>HONO_COAP_INSECURE_NETWORK_CONFIG</code><br><code>--hono.coap.insecureNetworkConfig</code></td>
1973<td style="text-align:center">no</td>
1974<td style="text-align:left">-</td>
1975<td style="text-align:left">The absolute path to a Californium properties file containing network configuration properties that should be used for the insecure CoAP port. If not set, Californium&rsquo;s default properties will be used.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1976</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1977<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1978<td style="text-align:left"><code>HONO_COAP_INSECURE_PORT</code><br><code>--hono.coap.insecurePort</code></td>
1979<td style="text-align:center">no</td>
1980<td style="text-align:left">-</td>
1981<td style="text-align:left">The insecure port the protocol adapter should listen on.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1982</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1983<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1984<td style="text-align:left"><code>HONO_COAP_INSECURE_PORT_BIND_ADDRESS</code><br><code>--hono.coap.insecurePortBindAddress</code></td>
1985<td style="text-align:center">no</td>
1986<td style="text-align:left"><code>127.0.0.1</code></td>
1987<td style="text-align:left">The IP address of the network interface that the insecure port should be bound to.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1988</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1989<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1990<td style="text-align:left"><code>HONO_COAP_INSECURE_PORT_ENABLED</code><br><code>--hono.coap.insecurePortEnabled</code></td>
1991<td style="text-align:center">no</td>
1992<td style="text-align:left"><code>false</code></td>
1993<td style="text-align:left">If set to <code>true</code> the protocol adapter will open an insecure port (not secured by TLS) using either the port number set via <code>HONO_COAP_INSECURE_PORT</code> or the default port number (<code>5683</code>) if not set explicitly.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1994</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]1995<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]1996<td style="text-align:left"><code>HONO_COAP_KEY_PATH</code><br><code>--hono.coap.keyPath</code></td>
1997<td style="text-align:center">no</td>
1998<td style="text-align:left">-</td>
1999<td style="text-align:left">The absolute path to the (PKCS8) PEM file containing the private key that the protocol adapter should use for authenticating to clients. This option must be used in conjunction with <code>HONO_COAP_CERT_PATH</code>. Alternatively, the <code>HONO_COAP_KEY_STORE_PATH</code> option can be used to configure a key store containing both the key as well as the certificate.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2000</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2001<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2002<td style="text-align:left"><code>HONO_COAP_KEY_STORE_PASSWORD</code><br><code>--hono.coap.keyStorePassword</code></td>
2003<td style="text-align:center">no</td>
2004<td style="text-align:left">-</td>
2005<td style="text-align:left">The password required to read the contents of the key store.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2006</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2007<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2008<td style="text-align:left"><code>HONO_COAP_KEY_STORE_PATH</code><br><code>--hono.coap.keyStorePath</code></td>
2009<td style="text-align:center">no</td>
2010<td style="text-align:left">-</td>
2011<td style="text-align:left">The absolute path to the Java key store containing the private key and certificate that the protocol adapter should use for authenticating to clients. Either this option or the <code>HONO_COAP_KEY_PATH</code> and <code>HONO_COAP_CERT_PATH</code> options need to be set in order to enable TLS secured connections with clients. The key store format can be either <code>JKS</code> or <code>PKCS12</code> indicated by a <code>.jks</code> or <code>.p12</code> file suffix respectively.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2012</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2013<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2014<td style="text-align:left"><code>HONO_COAP_MAX_CONNECTIONS</code><br><code>--hono.coap.maxConnections</code></td>
2015<td style="text-align:center">no</td>
2016<td style="text-align:left"><code>0</code></td>
2017<td style="text-align:left">The maximum number of concurrent DTLS connections that the protocol adapter should accept. If set to <code>0</code>, the protocol adapter determines a reasonable value based on the available resources like memory and CPU.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2018</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2019<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2020<td style="text-align:left"><code>HONO_COAP_MAX_PAYLOAD_SIZE</code><br><code>--hono.coap.maxPayloadSize</code></td>
2021<td style="text-align:center">no</td>
2022<td style="text-align:left"><code>2048</code></td>
2023<td style="text-align:left">The maximum allowed size of an incoming CoAP request&rsquo;s body in bytes. Requests with a larger body size are rejected with a 4.13 <code>Request entity too large</code> response.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2024</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2025<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2026<td style="text-align:left"><code>HONO_COAP_MESSAGE_OFFLOADING_ENABLED</code><br><code>--hono.coap.messageOffloadingEnabled</code></td>
2027<td style="text-align:center">no</td>
2028<td style="text-align:left">true</td>
2029<td style="text-align:left">Enables to clear payload and serialized messages kept for deduplication in order to reduce the heap consumption. Experimental.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2030</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2031<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2032<td style="text-align:left"><code>HONO_COAP_NETWORK_CONFIG</code><br><code>--hono.coap.networkConfig</code></td>
2033<td style="text-align:center">no</td>
2034<td style="text-align:left">-</td>
2035<td style="text-align:left">The absolute path to a Californium properties file containing network configuration properties that should be used for the secure CoAP port. If not set, Californium&rsquo;s default properties will be used.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2036</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2037<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2038<td style="text-align:left"><code>HONO_COAP_PORT</code><br><code>--hono.coap.port</code></td>
2039<td style="text-align:center">no</td>
2040<td style="text-align:left">-</td>
2041<td style="text-align:left">The secure port that the protocol adapter should listen on.<br>See <a href="#port-configuration">Port Configuration</a> below for details.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2042</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2043<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2044<td style="text-align:left"><code>HONO_COAP_TENANT_IDLE_TIMEOUT</code><br><code>--hono.coap.tenantIdleTimeout</code></td>
2045<td style="text-align:center">no</td>
2046<td style="text-align:left"><code>0ms</code></td>
2047<td style="text-align:left">The duration after which the protocol adapter removes local state of the tenant (e.g. open AMQP links) with an amount and a unit, e.g. <code>2h</code> for 2 hours. See the <a href="https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-conversion-duration">Spring Boot documentation</a> for an explanation of the format. The value <code>0ms</code> disables the timeout.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2048</tr>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2049<tr>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2050<td style="text-align:left"><code>HONO_COAP_TIMEOUT_TO_ACK</code><br><code>--hono.coap.timeoutToAck</code></td>
2051<td style="text-align:center">no</td>
2052<td style="text-align:left">500</td>
2053<td style="text-align:left">Timeout in milliseconds to send an ACK for a CoAP CON request. If the response is available before that timeout, a more efficient piggybacked response is used. If the timeout is reached without having received a response, an empty ACK is sent back to the client and the response is sent in a separate CON once it becomes available. Special values: <code>-1</code> means to always piggyback the response in an ACK and never send a separate CON; <code>0</code> means to always send an ACK immediately and include the response in a separate CON.</td>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2054</tr>
2055</tbody>
2056</table>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2057<p>The variables only need to be set if the default value needs to be changed.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2058<h2 id="port-configuration">Port Configuration</h2>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2059<p>The CoAP protocol adapter can be configured to listen for connections on</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2060<ul>
2061<li>a secure port only (default) or</li>
2062<li>an insecure port only or</li>
2063<li>both a secure and an insecure port (dual port configuration)</li>
2064</ul>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2065<p>The CoAP protocol adapter will fail to start if none of the ports is configured properly.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2066<h3 id="secure-port-only">Secure Port Only</h3>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2067<p>The protocol adapter opens a DTLS secured port if any of the following criteria are met</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2068<ul>
2069<li>The <code>HONO_COAP_KEY_STORE_PATH</code> and <code>HONO_COAP_KEY_STORE_PASSWORD</code> environment variables are set in order to load a key and certificate from a password protected key store or</li>
2070<li>the <code>HONO_COAP_KEY_PATH</code> and <code>HONO_COAP_CERT_PATH</code> environment variables are set in order to load a key and certificate from two separate PEM files in PKCS8 format or</li>
2071<li>the <code>HONO_COAP_PORT</code> environment variable is set to a valid port number.</li>
2072</ul>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2073<p>When starting up, the protocol adapter will bind a DTLS secured UDP socket to the configured port. If the port is not set explicitly, the default CoAP secure port 5684 is used.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2074<p>The <code>HONO_COAP_BIND_ADDRESS</code> variable can be used to specify the network interface that the port should be exposed on. By default the port is bound to the <em>loopback device</em> only,
2075i.e. the port will only be accessible from the local host. Setting this variable to <code>0.0.0.0</code> will let the port being bound to <strong>all</strong> network interfaces (be careful not to expose
2076the port unintentionally to the outside world).</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2077<h3 id="insecure-port-only">Insecure Port Only</h3>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2078<p>The secure port will mostly be required for production scenarios. However, it might be desirable to expose a non-DTLS secured port instead, e.g. for testing purposes.
2079In any case, the non-secure port needs to be explicitly enabled by</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2080<ul>
2081<li>explicitly setting <code>HONO_COAP_AUTHENTICATION_REQUIRED</code> to <code>false</code> and either
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2082<ul>
2083<li>explicitly setting <code>HONO_COAP_INSECURE_PORT</code> to a valid port number or</li>
2084<li>implicitly configuring the default insecure CoAP port (5683) by setting <code>HONO_COAP_INSECURE_PORT_ENABLED</code> to <code>true</code>.</li>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2085</ul>
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2086</li>
2087</ul>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2088<p>The protocol adapter issues a warning on the console if <code>HONO_COAP_INSECURE_PORT</code> is set to the default secure CoAP port (5684).</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2089<p>The <code>HONO_COAP_INSECURE_PORT_BIND_ADDRESS</code> variable can be used to specify the network interface that the port should be exposed on. By default the port is bound to the <em>loopback device</em> only,
2090i.e. the port will only be accessible from the local host. This variable might be used to e.g. expose the non-DTLS secured port on a local interface only, thus providing easy access from within
2091the local network, while still requiring encrypted communication when accessed from the outside over public network infrastructure.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2092<p>Setting this variable to <code>0.0.0.0</code> will let the port being bound to <strong>all</strong> network interfaces (be careful not to expose the port unintentionally to the outside world).</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2093<div class="alert alert-notice">
2094 <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Note</h4>
2095 <div>The insecure port will only be bound if the <code>HONO_COAP_AUTHENTICATION_REQUIRED</code> variable is set to <code>false</code> because CoAP authenticates clients (devices) as
2096part of the DTLS handshake. Thus, requiring devices to authenticate effectively rules out setting up a non-DTLS secured port.</div>
2097</div>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2098<h3 id="dual-port">Dual Port</h3>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2099<p>The protocol adapter may be configured to open both a secure and a non-secure port at the same time simply by configuring both ports as described above. For this to work,
2100both ports must be configured to use different port numbers, otherwise startup will fail.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2101<h3 id="ephemeral-ports">Ephemeral Ports</h3>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2102<p>Both the secure as well as the insecure port numbers may be explicitly set to <code>0</code>. The protocol adapter will then use arbitrary (unused) port numbers determined by the operating system during startup.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2103<h2 id="authentication">Authentication</h2>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2104<p>The CoAP protocol is UDP based and as such uses the DTLS protocol to secure the communication between a client (device) and a server (adapter). The CoAP adapter also uses the DTLS handshake
2105to prove its identity to devices and to authenticate the devices themselves. The DTLS protocol allows for different <em>cipher suites</em> to be
Hono Botef930712021-04-08 01:12:09 +0000[diff] [blame]2106used for doing so. These suites mainly differ from each other in the type of secret being used for proving the participants' identity to each other.
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2107One class of suites is based on a secret that is shared between the client and the server, very much like in a username/password based authentication scheme. This class of suites
2108is called <em>pre-shared key</em> or PSK-based and is very popular for use cases where the devices are very constrained regarding CPU and memory. Another class of cipher suites is based
2109on certificates which use asymmetric encryption for proving possession of the secret (the private key). The CoAP adapter supports cipher suites from both classes but only supports
2110<em>elliptic curve cryptography</em> (ECC) based keys for the latter class of cipher suites.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2111<p>When enabling the secure port without configuring an ECC based key and certificate, the adapter will only use PSK based cipher suites for authentication.
2112When configuring an ECC based key and certificate, the adapter will also offer certificate based cipher suites to the client to use for authentication.</p>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2113<p>In any case the device&rsquo;s credentials need to be registered with the device registry. Please refer to the <a href="/hono/docs/1.4/api/credentials/#standard-credential-types">Standard Credential Types</a>
2114and the <a href="/hono/docs/1.4/api/management/">Device Registry Management API</a> for additional information.</p>
2115
Hono Botbf26a122021-02-10 02:11:36 +0000[diff] [blame]2116<footer class="footline">
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2117
2118</footer>
2119
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]2120
2121 </div>
2122
2123
2124 </div>
2125
2126 <div id="navigation">
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103 </div>
3104
3105 </section>
3106
3107 <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
3108 <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
3109 </div>
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]3110 <script src="/hono/docs/js/clipboard.min.js?1627607528"></script>
3111 <script src="/hono/docs/js/perfect-scrollbar.min.js?1627607528"></script>
3112 <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1627607528"></script>
3113 <script src="/hono/docs/js/jquery.sticky.js?1627607528"></script>
3114 <script src="/hono/docs/js/featherlight.min.js?1627607528"></script>
3115 <script src="/hono/docs/js/highlight.pack.js?1627607528"></script>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]3116 <script>hljs.initHighlightingOnLoad();</script>
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]3117 <script src="/hono/docs/js/modernizr.custom-3.6.0.js?1627607528"></script>
3118 <script src="/hono/docs/js/learn.js?1627607528"></script>
3119 <script src="/hono/docs/js/hugo-learn.js?1627607528"></script>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]3120
Hono Bot66149782021-07-30 01:12:32 +0000[diff] [blame^]3121 <link href="/hono/docs/mermaid/mermaid.css?1627607528" rel="stylesheet" />
3122 <script src="/hono/docs/mermaid/mermaid.js?1627607528"></script>
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]3123 <script>
3124 mermaid.initialize({ startOnLoad: true });
3125 </script>
3126
3127
3128
3129
hono Bot01909692020-09-10 21:24:10 -0400[diff] [blame]3130<script>
3131 (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
3132 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
3133 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
3134 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
3135 })(window,document,'script','dataLayer','GTM-5WLCZXC');
3136</script>
3137
3138
3139<script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
3140
3141 </body>
3142</html>
3143