-
Notifications
You must be signed in to change notification settings - Fork 1
/
draft-iops-idr-advisory.xml
456 lines (420 loc) · 21.1 KB
/
draft-iops-idr-advisory.xml
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
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
<?rfc comments="yes"?>
<?rfc compact="yes"?>
<?rfc inline="yes"?>
<?rfc sortrefs="yes"?>
<?rfc subcompact="yes"?>
<?rfc symrefs="yes"?>
<?rfc toc="yes"?>
<?rfc tocdepth="3"?>
<?rfc tocindent="yes"?>
<?rfc tocompact="yes"?>
<?rfc strict="yes"?>
<rfc category="std"
docName="draft-iops-idr-bgp-advisory-message-00"
ipr="pre5378Trust200902">
<front>
<title>
BGP ADVISORY Message
</title>
<author fullname="Job Snijders" initials="J." surname="Snijders">
<organization abbrev="NTT">NTT Communications</organization>
<address>
<postal>
<street>Theodorus Majofskistraat 100</street>
<code>1065 SZ</code>
<city>Amsterdam</city>
<country>The Netherlands</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="David Freedman" initials="D." surname="Freedman">
<organization abbrev="Claranet">Claranet Limited</organization>
<address>
<postal>
<street>21 Southampton Row, Holborn</street>
<city>London</city>
<code>WC1B 5HA</code>
<country>UK</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Jakob Heitz" initials="J." surname="Heitz">
<organization>Cisco</organization>
<address>
<postal>
<street>170 West Tasman Drive</street>
<city>San Jose</city>
<region>CA</region>
<code>95054</code>
<country>USA</country>
</postal>
<email>[email protected]</email>
</address>
</author>
<author fullname="Donald Sharp" initials="D." surname="Sharp">
<organization abbrev="Cumulus">Cumulus Networks</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<date />
<area>Routing</area>
<workgroup>IDR</workgroup>
<keyword>BGP</keyword>
<keyword>advisory</keyword>
<keyword>message</keyword>
<abstract>
<t>
This document defines the BGP-4 ADVISORY Message and Support for ADVISORY Message Capability to facilitate the exchange of session-specific human-oriented information between network operators.
</t>
</abstract>
<note title="Requirements Language">
<t>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in <xref target="RFC2119"/>.
</t>
</note>
</front>
<middle>
<section anchor="intro" title="Introduction">
<t>
This document defines the <xref target="RFC4271">BGP-4</xref> ADVISORY Message and Support for ADVISORY Message Capability to facilitate the exchange of human-oriented information specific to the BGP session through which the ADVISORY message is transmitted.
ADVISORY messages are intended to aid root cause analysis and bootstrapping of out-of-band communication between operators by allowing them to signal key information over the known (and potentially trusted) in-band communication channel that is an existing BGP session.
</t>
</section>
<section anchor="protextensions" title="Protocol Extensions">
<t>
The BGP protocol extensions introduced in this document include the definition of a new BGP capability, named "Support for ADVISORY Message Capability", and the specification of the ADVISORY message.
</t>
<section anchor="cap" title="Support for ADVISORY Message Capability">
<t>
The "Support for ADVISORY Message Capability" is a new <xref target="RFC5492">BGP capability</xref>.
The Length field of this capability MUST be set to 1.
The Capability value MUST be set to the highest version of the ADVISORY message supported by the BGP speaker.
This document only defines ADVISORY version 1 messages.
</t>
<t>
By advertising this capability to a peer, a BGP speaker conveys to the peer that the speaker supports receiving ADVISORY messages, indicates what version of the ADVISORY message it supports, and indicates that it supports the related procedures described in this document.
</t>
</section>
<section anchor="message" title="ADVISORY Message">
<t>
An ADVISORY message is composed of an optional NOTICE, and optionally one or more ADVISE key-value pairs.
An ADVISORY message MUST NOT contain more than 16 ADVISE key-value pairs.
Each key and each value field MUST be preceded by a 1 octet Length field to indicate the length of the subsequent field.
ADVISE key fields have a REQUIRED maximum length of 32 octets.
ADVISE value fields have a REQUIRED maximum length of 128 octets.
To support international characters, all string fields MUST be encoded using UTF-8.
Fields are not NUL terminated.
There is no significance to the order of key-value pairs.
</t>
<t>
In concept, ADVISE data is similar to the dissemination of plan files.
When sending a new ADVISORY message to transmit a new NOTICE, the sender MUST repeat all configured ADVISE data.
Phrased differently: a new ADVISORY message completely replaces any prior ADVISORY message.
</t>
<t>
A zero-length ADVISORY message can be send to clear any ADVISORY information on the remote side.
</t>
<t>
<figure align="center">
<preamble>ADVISORY message format</preamble>
<artwork><![CDATA[
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| N-length | \
+-+-+-+-+-+-+-+-+ /
/ NOTICE payload (max length 128) \
\ /
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| ADVISE K-len | ADVISE key (max length 32) \
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| ADIVSE V-len | /
+-+-+-+-+-+-+-+-+ \
/ ADVISE value (max length 128) /
\ \
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
\ \
/ ... additional ADVISE key-value pairs ... /
]]></artwork></figure>
</t>
<t>
<list style="hanging">
<t hangText="N-Length:">
This 8-bit field represents the length of the NOTICE payload field in octets.
The length value MUST range from 0 to 128 inclusive.
When the length value is zero, no NOTICE payload field follows.
</t>
<t></t>
<t hangText="NOTICE payload:">
UTF-8, up to 128 octets.
</t>
<t></t>
<t hangText="ADVISE K-len:">
This 8-bit field represents the length of the next ADVISE key field in octets.
The length value MUST range from 0 to 32 inclusive.
</t>
<t></t>
<t hangText="ADVISE key:">
ADVISE key, UTF-8, up to 32 octets.
</t>
<t></t>
<t hangText="ADIVSE V-len:">
This 8-bit field represents the length of the following ADVISE value field for this key, in octets.
The length value MUST range from 0 to 32 inclusive.
</t>
<t></t>
<t hangText="ADVISE value:">
ADVISE value for this key, UTF-8, up to 128 octets.
</t>
</list>
Each ADVISORY message contains either no NOTICE payload, or a single NOTICE payload.
Optionally, up to 16 ADVISE key-value pairs can be encoded in the ADVISORY message.
</t>
<section title="Note on UTF-8">
<t>
To support international characters, fields MUST be encoded using UTF-8.
A receiving BGP speaker MUST NOT interpret invalid UTF-8 sequences.
Note that when a field contains multibyte characters, the number of characters will be less than the length value.
Fields are not NUL terminated.
</t>
</section>
</section>
</section>
<section anchor="ops" title="Operational Considerations">
<section title="CLI / UI Mock-up - RFC EDITOR: REMOVE BEFORE PUBLICATION">
<t>
This section is not meant to drive UI design decisions, but rather as scaffold to further discussion.
</t>
<t>
<figure align="center">
<preamble>Router A</preamble>
<artwork><![CDATA[
RouterA# send neighbor 10.0.0.2 notice "V-NOC-2324248 is starting"
RouterA# send neighbor 10.0.0.2 notice "We are prepending announcements"
RouterA# reload shutdown-message "rebooting, maint V-NOC-2324248"
RouterA# send neighbor 10.0.0.2 notice "Maintenance over, restoring policies"
RouterA# show run router bgp 64496
!
router bgp 64496
bgp router-id 10.0.0.1
neighbor 10.0.0.2 remote-as 64497
neighbor 10.0.0.2 advise "noc email" "[email protected]"
neighbor 10.0.0.2 advise "24/7 phone" "+1 877 688-6625"
neighbor 10.0.0.2 advise "Service ID" "USID 89024294"
address-family ipv4 unicast
neighbor 10.0.0.2 next-hop-self
neighbor 10.0.0.2 route-map export-to-AS64497 out
!
]]></artwork></figure>
<figure align="center">
<preamble>Router B</preamble><artwork><![CDATA[
RouterB# show bgp neighbor 10.0.0.2 advisory
Most recent messages from 10.0.0.2 / AS 64496:
Fri 31 Mar 04:38:00 2017 UTC NOTICE: V-NOC-2324248 is starting
Fri 31 Mar 04:38:10 2017 UTC NOTICE: We are prepending announcements
Fri 31 Mar 04:50:07 2017 UTC SHUTDOWN: rebooting, maint V-NOC-2324248
Fri 31 Mar 05:13:34 2017 UTC NOTICE: Maintenance over, restoring policies
Advise:
noc email : [email protected]
24/7 phone : +1 877 688-6625
Service ID : USID 89024294
ADVISORY Message statistics:
Sent Received
5 15
RouterB#
]]></artwork></figure>
Notice that ADVISORY NOTICE and SHUTDOWN COMMUNICATION messages are brought together in the same view for a coherent storyline.
</t>
</section>
</section>
<section anchor="error" title="Error Handling">
<t>
The following section assumes HARD error failure, but another option is to fail softly. For WG discussion.
</t>
<t>
This document defines a new NOTIFICATION error code: "ADVISORY Message Error".
The following new error subcodes are defined:
</t>
<texttable anchor="error_subcodes" title="ADVISORY Message Error subcodes">
<ttcol>name</ttcol>
<ttcol align="center">value</ttcol>
<c>Invalid ADVISORY Message Length</c><c>TBD</c>
<c>Invalid ADVISORY NOTICE Length</c><c>TBD</c>
<c>Invalid ADVISORY ADVISE Key Length</c><c>TBD</c>
<c>Invalid ADVISORY ADVISE Value Length</c><c>TBD</c>
</texttable>
<t>
The error handling specified in this section is applicable only when a BGP speaker has received the "Support for ADVISORY Message Capability" from a peer.
</t>
<t>
All errors detected while processing the ADVISORY message MUST be indicated by sending the NOTIFICATION message with the Error Code ADVISORY Message Error.
The error subcode elaborates on the specific nature of the error.
</t>
<t>
A zero-length ADVISORY message MUST NOT be considered malformed.
</t>
</section>
<section anchor="iana" title="IANA Considerations">
<t>
IANA is requested to assign value TBD1 (ADVISORY) in the "BGP Message Types" subregistry under the "Border Gateway Protocol (BGP) Parameters" registry.
</t>
<t>
IANA is requested to assign value TBD2 (ADVISORY Message Error) in the "BGP Error (Notification) Codes" subregistry under the "Border Gateway Protocol (BGP) Parameters" registry.
</t>
<t>
IANA is requested to create a new registry "ADVISORY Message Error subcodes" for error subcodes, under the "BGP Error Subcodes" subregistry under the "Border Gateway Protocol (BGP) Parameters" registry.
The Registration Procedure for this new registry is "First Come First Served".
IANA is requested to assign and register the values from <xref target="error_subcodes" /> in this new error subcode registry.
</t>
<t>
IANA is requested to assign value TBD4 (Support for ADVISORY Message Capability) in the "Capability Codes" registry.
</t>
</section>
<section anchor="security" title="Security Considerations">
<t>
This specification uses UTF-8 encoding for certain fields of the ADVISORY message.
Implementers would do well to incorporate recommendations from <xref target="UTR36">UNICODE TR36</xref>.
</t>
<t>
Use of this protocol enhancement has the same security considerations as <xref target="I-D.ietf-idr-shutdown"/>.
</t>
</section>
<!--
<section title="Implementation status - RFC EDITOR: REMOVE BEFORE PUBLICATION">
<t>
This section records the status of known implementations of the
protocol defined by this specification at the time of posting
of this Internet-Draft, and is based on a proposal described in
RFC7942. The description of implementations in this section is
intended to assist the IETF in its decision processes in
progressing drafts to RFCs. Please note that the listing of
any individual implementation here does not imply endorsement
by the IETF. Furthermore, no effort has been spent to verify
the information presented here that was supplied by IETF
contributors. This is not intended as, and must not be
construed to be, a catalog of available implementations or
their features. Readers are advised to note that other
implementations may exist.
</t>
<t>
As of today these vendors have produced an implementation of ADVISORY:
<list style="symbols">
<t>you can be first!</t>
</list>
</t>
</section>
-->
</middle>
<back>
<references title="Normative References">
<?rfc include="reference.RFC.2119"?>
<?rfc include="reference.RFC.4271"?>
<?rfc include="reference.RFC.5492"?>
</references>
<references title="Informative References">
<?rfc include="reference.I-D.draft-ietf-idr-shutdown-07"?>
<reference anchor="UTR36" target="http://unicode.org/reports/tr36/">
<front>
<title>Unicode Security Considerations</title>
<author initials="M." surname="Davis" fullname="Mark Davis"><organization/></author>
<author initials="M." surname="Suignard" fullname="Michel Suignard"><organization/></author>
<date year="2010" month="August" day="4"/>
</front>
<seriesInfo name="Unicode Technical Report" value="#36"/>
</reference>
</references>
<section title="Contributors">
<t>
The following people contributed to this document through their work on draft-ietf-idr-advisory-00 (the original "BGP Advisory Message"):
</t>
<figure>
<artwork>
Tom Scholl
Amazon Web Services
Email: [email protected]
</artwork>
</figure>
<figure>
<artwork>
Richard Turkbergen
PacketFabric, Inc.
Email: [email protected]
</artwork>
</figure>
<figure>
<artwork>
John Scudder
Juniper Networks
Email: [email protected]
</artwork>
</figure>
</section>
<section anchor="acknowledgements" title="Acknowledgements">
<t>
The authors would like to gratefully acknowledge Peter van Dijk.
</t>
</section>
<section title="ADVISORY Message Example">
<t>
An example ADVISORY message:
<figure align="center"><artwork><![CDATA[
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| N-length: 31 | |
+---------------+ +
| |
+ NOTICE payload: "We are prepending announcements" +
| |
+ +
| |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| | A1 length: 9 | |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
| |
+ ADVISE key: "noc email" +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| A-length: 11 | |
+-+-+-+-+-+-+-+-+ +
| |
+ ADVISE value: "[email protected]" +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| A-length: 10 | |
+-+-+-+-+-+-+-+-+ +
| |
+ ADVISE key: "24/7 phone" +-+-+-+-+-+-+-+-+
| | A-length: 15 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| A-length: 15 | |
+-+-+-+-+-+-+-+-+ +
| |
+ ADVISE value: "+1 877 688-6625" +
| |
+ +-+-+-+-+-+-+-+-+
| | A-length: 10 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ ADVISE key: "service ID" +
| |
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| | A-length: 13 | |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +
| |
+ +
| ADVISE value: "USID 89024294" |
+ +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
]]></artwork>
</figure>
</t>
</section>
</back>
</rfc>