New build path variable
[freeradius.git] / doc / rfc / rfc4671.txt
1
2
3
4
5
6
7 Network Working Group                                          D. Nelson
8 Request for Comments: 4671                            Enterasys Networks
9 Obsoletes: 2621                                              August 2006
10 Category: Informational
11
12
13                  RADIUS Accounting Server MIB for IPv6
14
15 Status of This Memo
16
17    This memo provides information for the Internet community.  It does
18    not specify an Internet standard of any kind.  Distribution of this
19    memo is unlimited.
20
21 Copyright Notice
22
23    Copyright (C) The Internet Society (2006).
24
25 Abstract
26
27    This memo defines a set of extensions that instrument RADIUS
28    accounting server functions.  These extensions represent a portion of
29    the Management Information Base (MIB) for use with network management
30    protocols in the Internet community.  Using these extensions,
31    IP-based management stations can manage RADIUS accounting servers.
32
33    This memo obsoletes RFC 2621 by deprecating the MIB table containing
34    IPv4-only address formats and defining a new table to add support for
35    version-neutral IP address formats.  The remaining MIB objects from
36    RFC 2621 are carried forward into this document.  This memo also adds
37    UNITS and REFERENCE clauses to selected objects.
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58 Nelson                       Informational                      [Page 1]
59 \f
60 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
61
62
63 Table of Contents
64
65    1. Introduction ....................................................3
66    2. Terminology .....................................................3
67    3. The Internet-Standard Management Framework ......................3
68    4. Scope of Changes ................................................3
69    5. Structure of the MIB Module .....................................4
70    6. Deprecated Objects ..............................................5
71    7. Definitions .....................................................5
72    8. Security Considerations ........................................20
73    9. References .....................................................22
74       9.1. Normative References ......................................22
75       9.2. Informative References ....................................22
76    Appendix A. Acknowledgements ......................................23
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 Nelson                       Informational                      [Page 2]
115 \f
116 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
117
118
119 1.  Introduction
120
121    This memo defines a portion of the Management Information Base (MIB)
122    for use with network management protocols in the Internet community.
123    The objects defined within this memo relate to the Remote
124    Authentication Dial-In User Service (RADIUS) Accounting Server as
125    defined in RFC 2866 [RFC2866].
126
127 2.  Terminology
128
129    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
130    "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
131    document are to be interpreted as described in RFC 2119 [RFC2119].
132
133    This document uses terminology from RFC 2865 [RFC2865] and RFC 2866
134    [RFC2866].
135
136    This document uses the word "malformed" with respect to RADIUS
137    packets, particularly in the context of counters of "malformed
138    packets".  While RFC 2866 does not provide an explicit definition of
139    "malformed", malformed generally means that the implementation has
140    determined the packet does not match the format defined in RFC 2866.
141    Those implementations are used in deployments today, and thus set the
142    de facto definition of "malformed".
143
144 3.  The Internet-Standard Management Framework
145
146    For a detailed overview of the documents that describe the current
147    Internet-Standard Management Framework, please refer to section 7 of
148    RFC 3410 [RFC3410].
149
150    Managed objects are accessed via a virtual information store, termed
151    the Management Information Base or MIB.  MIB objects are generally
152    accessed through the Simple Network Management Protocol (SNMP).
153    Objects in the MIB are defined using the mechanisms defined in the
154    Structure of Management Information (SMI).  This memo specifies a MIB
155    module that is compliant to the SMIv2, which is described in STD 58,
156    RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580
157    [RFC2580].
158
159 4.  Scope of Changes
160
161    This document obsoletes RFC 2621 [RFC2621], RADIUS Accounting Server
162    MIB, by deprecating the radiusAccClientTable table and adding a new
163    table, radiusAccClientExtTable, containing
164    radiusAccClientInetAddressType and radiusAccClientInetAddress.  The
165    purpose of these added MIB objects is to support version-neutral IP
166    addressing formats.  The existing table containing
167
168
169
170 Nelson                       Informational                      [Page 3]
171 \f
172 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
173
174
175    radiusAccClientAddress is deprecated.  The remaining MIB objects from
176    RFC 2621 are carried forward into this document.  This memo also adds
177    UNITS and REFERENCE clauses to selected objects.
178
179    RFC 4001 [RFC4001], which defines the SMI Textual Conventions for
180    version-neutral IP addresses, contains the following recommendation.
181
182    'In particular, when revising a MIB module that contains IPv4
183    specific tables, it is suggested to define new tables using the
184    textual conventions defined in this memo [RFC4001] that support all
185    versions of IP.  The status of the new tables SHOULD be "current",
186    whereas the status of the old IP version specific tables SHOULD be
187    changed to "deprecated".  The other approach, of having multiple
188    similar tables for different IP versions, is strongly discouraged.'
189
190 5.  Structure of the MIB Module
191
192    The RADIUS accounting protocol, described in RFC 2866 [RFC2866],
193    distinguishes between the client function and the server function.
194    In RADIUS accounting, clients send Accounting-Requests, and servers
195    reply with Accounting-Responses.  Typically, Network Access Server
196    (NAS) devices implement the client function, and thus would be
197    expected to implement the RADIUS accounting client MIB, while RADIUS
198    accounting servers implement the server function, and thus would be
199    expected to implement the RADIUS accounting server MIB.
200
201    However, it is possible for a RADIUS accounting entity to perform
202    both client and server functions.  For example, a RADIUS proxy may
203    act as a server to one or more RADIUS accounting clients, while
204    simultaneously acting as an accounting client to one or more
205    accounting servers.  In such situations, it is expected that RADIUS
206    entities combining client and server functionality will support both
207    the client and server MIBs.  The server MIB is defined in this
208    document, and the client MIB is defined in [RFC4670].
209
210    This MIB module contains thirteen scalars as well as a single table,
211    the RADIUS Accounting Client Table, which contains one row for each
212    RADIUS accounting client with which the server shares a secret.  Each
213    entry in the RADIUS Accounting Client Table includes twelve columns
214    presenting a view of the activity of the RADIUS accounting server.
215
216    This MIB imports from [RFC2578], [RFC2580], [RFC3411], and [RFC4001].
217
218
219
220
221
222
223
224
225
226 Nelson                       Informational                      [Page 4]
227 \f
228 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
229
230
231 6.  Deprecated Objects
232
233    The deprecated table in this MIB is carried forward from RFC 2621
234    [RFC2621].  There are two conditions under which it MAY be desirable
235    for managed entities to continue to support the deprecated table:
236
237    1.  The managed entity only supports IPv4 address formats.
238
239    2.  The managed entity supports both IPv4 and IPv6 address formats,
240        and the deprecated table is supported for backwards compatibility
241        with older management stations.  This option SHOULD only be used
242        when the IP addresses in the new table are in IPv4 format and can
243        accurately be represented in both the new table and the
244        deprecated table.
245
246    Managed entities SHOULD NOT instantiate row entries in the deprecated
247    table, containing IPv4-only address objects, when the RADIUS
248    accounting client address represented in such a table row is not an
249    IPv4 address.  Managed entities SHOULD NOT return inaccurate values
250    of IP address or SNMP object access errors for IPv4-only address
251    objects in otherwise populated tables.  When row entries exist in
252    both the deprecated IPv4-only table and the new IP-version-neutral
253    table that describe the same RADIUS accounting client, the row
254    indexes SHOULD be the same for the corresponding rows in each table,
255    to facilitate correlation of these related rows by management
256    applications.
257
258 7.  Definitions
259
260    RADIUS-ACC-SERVER-MIB DEFINITIONS ::= BEGIN
261
262    IMPORTS
263           MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY,
264           Counter32, Integer32,
265           IpAddress, TimeTicks, mib-2      FROM SNMPv2-SMI
266           SnmpAdminString                  FROM SNMP-FRAMEWORK-MIB
267           InetAddressType, InetAddress     FROM INET-ADDRESS-MIB
268           MODULE-COMPLIANCE, OBJECT-GROUP  FROM SNMPv2-CONF;
269
270    radiusAccServMIB MODULE-IDENTITY
271           LAST-UPDATED "200608210000Z"  -- 21 August 2006
272           ORGANIZATION "IETF RADIUS Extensions Working Group."
273           CONTACT-INFO
274                  " Bernard Aboba
275                    Microsoft
276                    One Microsoft Way
277                    Redmond, WA  98052
278                    US
279
280
281
282 Nelson                       Informational                      [Page 5]
283 \f
284 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
285
286
287                    Phone: +1 425 936 6605
288                    EMail: bernarda@microsoft.com"
289           DESCRIPTION
290                 "The MIB module for entities implementing the server
291                  side of the Remote Authentication Dial-In User
292                  Service (RADIUS) accounting protocol.  Copyright (C)
293                  The Internet Society (2006).  This version of this
294                  MIB module is part of RFC 4671; see the RFC itself
295                  for full legal notices."
296           REVISION "200608210000Z"  -- 21 August 2006
297           DESCRIPTION
298                 "Revised version as published in RFC 4671.  This
299                  version obsoletes that of RFC 2621 by deprecating
300                  the MIB table containing IPv4-only address formats
301                  and defining a new table to add support for version-
302                  neutral IP address formats.  The remaining MIB objects
303                  from RFC 2621 are carried forward into this version."
304           REVISION "199906110000Z"    -- 11 Jun 1999
305           DESCRIPTION "Initial version as published in RFC 2621."
306           ::= { radiusAccounting 1 }
307
308    radiusMIB  OBJECT-IDENTITY
309           STATUS  current
310           DESCRIPTION
311                 "The OID assigned to RADIUS MIB work by the IANA."
312           ::= { mib-2 67 }
313
314    radiusAccounting  OBJECT IDENTIFIER ::= {radiusMIB 2}
315
316    radiusAccServMIBObjects  OBJECT IDENTIFIER
317          ::= { radiusAccServMIB 1 }
318
319    radiusAccServ  OBJECT IDENTIFIER
320          ::= { radiusAccServMIBObjects 1 }
321
322    radiusAccServIdent OBJECT-TYPE
323           SYNTAX      SnmpAdminString
324           MAX-ACCESS  read-only
325           STATUS      current
326           DESCRIPTION
327                 "The implementation identification string for the
328                  RADIUS accounting server software in use on the
329                  system, for example, 'FNS-2.1'."
330           ::= {radiusAccServ 1}
331
332    radiusAccServUpTime OBJECT-TYPE
333           SYNTAX      TimeTicks
334           MAX-ACCESS  read-only
335
336
337
338 Nelson                       Informational                      [Page 6]
339 \f
340 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
341
342
343           STATUS      current
344           DESCRIPTION
345                 "If the server has a persistent state (e.g., a
346                  process), this value will be the time elapsed (in
347                  hundredths of a second) since the server process was
348                  started.  For software without persistent state, this
349                  value will be zero."
350           ::= {radiusAccServ 2}
351
352    radiusAccServResetTime OBJECT-TYPE
353           SYNTAX      TimeTicks
354           MAX-ACCESS  read-only
355           STATUS      current
356           DESCRIPTION
357                 "If the server has a persistent state (e.g., a process)
358                  and supports a 'reset' operation (e.g., can be told to
359                  re-read configuration files), this value will be the
360                  time elapsed (in hundredths of a second) since the
361                  server was 'reset.'  For software that does not
362                  have persistence or does not support a 'reset'
363                  operation, this value will be zero."
364           ::= {radiusAccServ 3}
365
366    radiusAccServConfigReset OBJECT-TYPE
367           SYNTAX INTEGER { other(1),
368                            reset(2),
369                            initializing(3),
370                            running(4)}
371           MAX-ACCESS  read-write
372           STATUS      current
373           DESCRIPTION
374                  "Status/action object to reinitialize any persistent
375                   server state.  When set to reset(2), any persistent
376                   server state (such as a process) is reinitialized as
377                   if the server had just been started.  This value will
378                   never be returned by a read operation.  When read,
379                   one of the following values will be returned:
380                       other(1) - server in some unknown state;
381                       initializing(3) - server (re)initializing;
382                       running(4) - server currently running."
383           ::= {radiusAccServ 4}
384
385    radiusAccServTotalRequests OBJECT-TYPE
386           SYNTAX Counter32
387           UNITS "packets"
388           MAX-ACCESS read-only
389           STATUS current
390           DESCRIPTION
391
392
393
394 Nelson                       Informational                      [Page 7]
395 \f
396 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
397
398
399                 "The number of packets received on the
400                  accounting port."
401           REFERENCE "RFC 2866 section 4.1"
402           ::= { radiusAccServ 5 }
403
404    radiusAccServTotalInvalidRequests OBJECT-TYPE
405           SYNTAX Counter32
406           UNITS "packets"
407           MAX-ACCESS read-only
408           STATUS current
409           DESCRIPTION
410                 "The number of RADIUS Accounting-Request packets
411                  received from unknown addresses."
412           REFERENCE "RFC 2866 sections 2, 4.1"
413           ::= { radiusAccServ 6 }
414
415    radiusAccServTotalDupRequests OBJECT-TYPE
416           SYNTAX Counter32
417           UNITS "packets"
418           MAX-ACCESS read-only
419           STATUS current
420           DESCRIPTION
421                 "The number of duplicate RADIUS Accounting-Request
422                  packets received."
423           REFERENCE "RFC 2866 section 4.1"
424           ::= { radiusAccServ 7 }
425
426    radiusAccServTotalResponses OBJECT-TYPE
427           SYNTAX Counter32
428           UNITS "packets"
429           MAX-ACCESS read-only
430           STATUS current
431           DESCRIPTION
432                 "The number of RADIUS Accounting-Response packets
433                  sent."
434           REFERENCE "RFC 2866 section 4.2"
435           ::= { radiusAccServ 8 }
436
437    radiusAccServTotalMalformedRequests OBJECT-TYPE
438           SYNTAX Counter32
439           UNITS "packets"
440           MAX-ACCESS read-only
441           STATUS current
442           DESCRIPTION
443                 "The number of malformed RADIUS Accounting-Request
444                  packets received.  Bad authenticators or unknown
445                  types are not included as malformed Access-Requests."
446           REFERENCE "RFC 2866 section 3"
447
448
449
450 Nelson                       Informational                      [Page 8]
451 \f
452 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
453
454
455           ::= { radiusAccServ 9 }
456
457    radiusAccServTotalBadAuthenticators OBJECT-TYPE
458          SYNTAX Counter32
459          UNITS "packets"
460          MAX-ACCESS read-only
461          STATUS current
462          DESCRIPTION
463                "The number of RADIUS Accounting-Request packets
464                 that contained an invalid authenticator."
465          REFERENCE "RFC 2866 section 3"
466          ::= { radiusAccServ 10 }
467
468    radiusAccServTotalPacketsDropped OBJECT-TYPE
469          SYNTAX Counter32
470          UNITS "packets"
471          MAX-ACCESS read-only
472          STATUS current
473          DESCRIPTION
474                "The number of incoming packets silently discarded
475                 for a reason other than malformed, bad authenticators,
476                 or unknown types."
477          REFERENCE "RFC 2866 section 3"
478          ::= { radiusAccServ 11 }
479
480    radiusAccServTotalNoRecords OBJECT-TYPE
481           SYNTAX Counter32
482           UNITS "packets"
483           MAX-ACCESS read-only
484           STATUS current
485           DESCRIPTION
486                 "The number of RADIUS Accounting-Request packets
487                  that were received and responded to but not
488                  recorded."
489           ::= { radiusAccServ 12 }
490
491    radiusAccServTotalUnknownTypes OBJECT-TYPE
492          SYNTAX Counter32
493          UNITS "packets"
494          MAX-ACCESS read-only
495          STATUS current
496          DESCRIPTION
497                "The number of RADIUS packets of unknown type that
498                 were received."
499          REFERENCE "RFC 2866 section 4"
500          ::= { radiusAccServ 13 }
501
502    radiusAccClientTable OBJECT-TYPE
503
504
505
506 Nelson                       Informational                      [Page 9]
507 \f
508 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
509
510
511           SYNTAX     SEQUENCE OF RadiusAccClientEntry
512           MAX-ACCESS not-accessible
513           STATUS     deprecated
514           DESCRIPTION
515                 "The (conceptual) table listing the RADIUS accounting
516                  clients with which the server shares a secret."
517           ::= { radiusAccServ 14 }
518
519    radiusAccClientEntry OBJECT-TYPE
520           SYNTAX     RadiusAccClientEntry
521           MAX-ACCESS not-accessible
522           STATUS     deprecated
523           DESCRIPTION
524                 "An entry (conceptual row) representing a RADIUS
525                  accounting client with which the server shares a
526                  secret."
527           INDEX      { radiusAccClientIndex }
528           ::= { radiusAccClientTable 1 }
529
530    RadiusAccClientEntry ::= SEQUENCE {
531           radiusAccClientIndex                           Integer32,
532           radiusAccClientAddress                         IpAddress,
533           radiusAccClientID                        SnmpAdminString,
534           radiusAccServPacketsDropped                    Counter32,
535           radiusAccServRequests                          Counter32,
536           radiusAccServDupRequests                       Counter32,
537           radiusAccServResponses                         Counter32,
538           radiusAccServBadAuthenticators                 Counter32,
539           radiusAccServMalformedRequests                 Counter32,
540           radiusAccServNoRecords                         Counter32,
541           radiusAccServUnknownTypes                      Counter32
542    }
543
544    radiusAccClientIndex OBJECT-TYPE
545           SYNTAX     Integer32 (1..2147483647)
546           MAX-ACCESS not-accessible
547           STATUS     deprecated
548           DESCRIPTION
549                 "A number uniquely identifying each RADIUS accounting
550                  client with which this server communicates."
551           ::= { radiusAccClientEntry 1 }
552
553    radiusAccClientAddress OBJECT-TYPE
554           SYNTAX     IpAddress
555           MAX-ACCESS read-only
556           STATUS     deprecated
557           DESCRIPTION
558                 "The NAS-IP-Address of the RADIUS accounting client
559
560
561
562 Nelson                       Informational                     [Page 10]
563 \f
564 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
565
566
567                  referred to in this table entry."
568           ::= { radiusAccClientEntry 2 }
569
570    radiusAccClientID OBJECT-TYPE
571           SYNTAX     SnmpAdminString
572           MAX-ACCESS read-only
573           STATUS     deprecated
574           DESCRIPTION
575                 "The NAS-Identifier of the RADIUS accounting client
576                  referred to in this table entry.  This is not
577                  necessarily the same as sysName in MIB II."
578           REFERENCE "RFC 2865 section 5.32"
579           ::= { radiusAccClientEntry 3 }
580
581    -- Server Counters
582    --
583    -- Requests - DupRequests - BadAuthenticators - MalformedRequests -
584    -- UnknownTypes -  PacketsDropped - Responses = Pending
585    --
586    -- Requests - DupRequests - BadAuthenticators - MalformedRequests -
587    -- UnknownTypes - PacketsDropped - NoRecords = entries logged
588
589    radiusAccServPacketsDropped OBJECT-TYPE
590          SYNTAX Counter32
591          UNITS "packets"
592          MAX-ACCESS read-only
593          STATUS deprecated
594          DESCRIPTION
595               "The number of incoming packets received
596                from this client and silently discarded
597                for a reason other than malformed, bad
598                authenticators, or unknown types."
599         REFERENCE "RFC 2866 section 3"
600         ::= { radiusAccClientEntry  4 }
601
602    radiusAccServRequests OBJECT-TYPE
603           SYNTAX Counter32
604           UNITS "packets"
605           MAX-ACCESS read-only
606           STATUS deprecated
607           DESCRIPTION
608                 "The number of packets received from this
609                  client on the accounting port."
610           REFERENCE "RFC 2866 section 4.1"
611           ::= { radiusAccClientEntry  5 }
612
613    radiusAccServDupRequests OBJECT-TYPE
614           SYNTAX Counter32
615
616
617
618 Nelson                       Informational                     [Page 11]
619 \f
620 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
621
622
623           UNITS "packets"
624           MAX-ACCESS read-only
625           STATUS deprecated
626           DESCRIPTION
627                 "The number of duplicate RADIUS Accounting-Request
628                  packets received from this client."
629           REFERENCE "RFC 2866 section 4.1"
630           ::= { radiusAccClientEntry 6 }
631
632    radiusAccServResponses OBJECT-TYPE
633           SYNTAX Counter32
634           UNITS "packets"
635           MAX-ACCESS read-only
636           STATUS deprecated
637           DESCRIPTION
638                 "The number of RADIUS Accounting-Response packets
639                  sent to this client."
640           REFERENCE "RFC 2866 section 4.2"
641           ::= { radiusAccClientEntry  7 }
642
643    radiusAccServBadAuthenticators OBJECT-TYPE
644           SYNTAX Counter32
645           UNITS "packets"
646           MAX-ACCESS read-only
647           STATUS deprecated
648           DESCRIPTION
649                 "The number of RADIUS Accounting-Request packets
650                  that contained invalid authenticators received
651                  from this client."
652           REFERENCE "RFC 2866 section 3"
653           ::= { radiusAccClientEntry  8 }
654
655    radiusAccServMalformedRequests OBJECT-TYPE
656           SYNTAX Counter32
657           UNITS "packets"
658           MAX-ACCESS read-only
659           STATUS deprecated
660           DESCRIPTION
661                 "The number of malformed RADIUS Accounting-Request
662                  packets that were received from this client.
663                  Bad authenticators and unknown types
664                  are not included as malformed Accounting-Requests."
665           REFERENCE "RFC 2866 section 3"
666           ::= { radiusAccClientEntry  9 }
667
668    radiusAccServNoRecords OBJECT-TYPE
669           SYNTAX Counter32
670           UNITS "packets"
671
672
673
674 Nelson                       Informational                     [Page 12]
675 \f
676 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
677
678
679           MAX-ACCESS read-only
680           STATUS deprecated
681           DESCRIPTION
682                 "The number of RADIUS Accounting-Request packets
683                  that were received and responded to but not
684                  recorded."
685           ::= { radiusAccClientEntry  10 }
686
687    radiusAccServUnknownTypes OBJECT-TYPE
688           SYNTAX Counter32
689           UNITS "packets"
690           MAX-ACCESS read-only
691           STATUS deprecated
692           DESCRIPTION
693                 "The number of RADIUS packets of unknown type that
694                  were received from this client."
695           REFERENCE "RFC 2866 section 4"
696           ::= { radiusAccClientEntry  11 }
697
698
699    -- New MIB objects added in this revision
700
701    radiusAccClientExtTable OBJECT-TYPE
702           SYNTAX     SEQUENCE OF RadiusAccClientExtEntry
703           MAX-ACCESS not-accessible
704           STATUS     current
705           DESCRIPTION
706                 "The (conceptual) table listing the RADIUS accounting
707                  clients with which the server shares a secret."
708           ::= { radiusAccServ 15 }
709
710    radiusAccClientExtEntry OBJECT-TYPE
711           SYNTAX     RadiusAccClientExtEntry
712           MAX-ACCESS not-accessible
713           STATUS     current
714           DESCRIPTION
715                 "An entry (conceptual row) representing a RADIUS
716                  accounting client with which the server shares a
717                  secret."
718           INDEX      { radiusAccClientExtIndex }
719           ::= { radiusAccClientExtTable 1 }
720
721    RadiusAccClientExtEntry ::= SEQUENCE {
722           radiusAccClientExtIndex               Integer32,
723           radiusAccClientInetAddressType        InetAddressType,
724           radiusAccClientInetAddress            InetAddress,
725           radiusAccClientExtID                  SnmpAdminString,
726           radiusAccServExtPacketsDropped        Counter32,
727
728
729
730 Nelson                       Informational                     [Page 13]
731 \f
732 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
733
734
735           radiusAccServExtRequests              Counter32,
736           radiusAccServExtDupRequests           Counter32,
737           radiusAccServExtResponses             Counter32,
738           radiusAccServExtBadAuthenticators     Counter32,
739           radiusAccServExtMalformedRequests     Counter32,
740           radiusAccServExtNoRecords             Counter32,
741           radiusAccServExtUnknownTypes          Counter32,
742           radiusAccServerCounterDiscontinuity   TimeTicks
743    }
744
745    radiusAccClientExtIndex OBJECT-TYPE
746           SYNTAX     Integer32 (1..2147483647)
747           MAX-ACCESS not-accessible
748           STATUS     current
749           DESCRIPTION
750                 "A number uniquely identifying each RADIUS accounting
751                  client with which this server communicates."
752           ::= { radiusAccClientExtEntry 1 }
753
754           radiusAccClientInetAddressType OBJECT-TYPE
755             SYNTAX     InetAddressType
756             MAX-ACCESS read-only
757             STATUS     current
758             DESCRIPTION
759                   "The type of address format used for the
760                    radiusAccClientInetAddress object."
761             ::= { radiusAccClientExtEntry 2 }
762
763       radiusAccClientInetAddress OBJECT-TYPE
764             SYNTAX     InetAddress
765             MAX-ACCESS read-only
766             STATUS     current
767             DESCRIPTION
768                   "The IP address of the RADIUS accounting
769                    client referred to in this table entry, using
770                    the IPv6 address format."
771             ::= { radiusAccClientExtEntry 3 }
772
773    radiusAccClientExtID OBJECT-TYPE
774           SYNTAX     SnmpAdminString
775           MAX-ACCESS read-only
776           STATUS     current
777           DESCRIPTION
778                 "The NAS-Identifier of the RADIUS accounting client
779                  referred to in this table entry.  This is not
780                  necessarily the same as sysName in MIB II."
781           REFERENCE "RFC 2865 section 5.32"
782           ::= { radiusAccClientExtEntry 4 }
783
784
785
786 Nelson                       Informational                     [Page 14]
787 \f
788 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
789
790
791    -- Server Counters
792    --
793    -- Requests - DupRequests - BadAuthenticators - MalformedRequests -
794    -- UnknownTypes -  PacketsDropped - Responses = Pending
795    --
796    -- Requests - DupRequests - BadAuthenticators - MalformedRequests -
797    -- UnknownTypes - PacketsDropped - NoRecords = entries logged
798
799    radiusAccServExtPacketsDropped OBJECT-TYPE
800          SYNTAX Counter32
801          UNITS "packets"
802          MAX-ACCESS read-only
803          STATUS current
804          DESCRIPTION
805               "The number of incoming packets received from this
806                client and silently discarded for a reason other
807                than malformed, bad authenticators, or unknown types.
808                This counter may experience a discontinuity when the
809                RADIUS Accounting Server module within the managed
810                entity is reinitialized, as indicated by the current
811                value of radiusAccServerCounterDiscontinuity."
812         REFERENCE "RFC 2866 section 3"
813         ::= { radiusAccClientExtEntry  5 }
814
815    radiusAccServExtRequests OBJECT-TYPE
816           SYNTAX Counter32
817           UNITS "packets"
818           MAX-ACCESS read-only
819           STATUS current
820           DESCRIPTION
821                 "The number of packets received from this
822                  client on the accounting port.  This counter
823                  may experience a discontinuity when the
824                  RADIUS Accounting Server module within the
825                  managed entity is reinitialized, as indicated by
826                  the current value of
827                  radiusAccServerCounterDiscontinuity."
828           REFERENCE "RFC 2866 section 4.1"
829           ::= { radiusAccClientExtEntry  6 }
830
831    radiusAccServExtDupRequests OBJECT-TYPE
832           SYNTAX Counter32
833           UNITS "packets"
834           MAX-ACCESS read-only
835           STATUS current
836           DESCRIPTION
837                 "The number of duplicate RADIUS Accounting-Request
838                  packets received from this client.  This counter
839
840
841
842 Nelson                       Informational                     [Page 15]
843 \f
844 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
845
846
847                  may experience a discontinuity when the RADIUS
848                  Accounting Server module within the managed
849                  entity is reinitialized, as indicated by the
850                  current value of
851                  radiusAccServerCounterDiscontinuity."
852           REFERENCE "RFC 2866 section 4.1"
853           ::= { radiusAccClientExtEntry 7 }
854
855    radiusAccServExtResponses OBJECT-TYPE
856           SYNTAX Counter32
857           UNITS "packets"
858           MAX-ACCESS read-only
859           STATUS current
860           DESCRIPTION
861                 "The number of RADIUS Accounting-Response packets
862                  sent to this client.  This counter may experience
863                  a discontinuity when the RADIUS Accounting Server
864                  module within the managed entity is reinitialized,
865                  as indicated by the current value of
866                  radiusAccServerCounterDiscontinuity."
867           REFERENCE "RFC 2866 section 4.2"
868           ::= { radiusAccClientExtEntry  8 }
869
870    radiusAccServExtBadAuthenticators OBJECT-TYPE
871           SYNTAX Counter32
872           UNITS "packets"
873           MAX-ACCESS read-only
874           STATUS current
875           DESCRIPTION
876                 "The number of RADIUS Accounting-Request packets
877                  that contained invalid authenticators received
878                  from this client.  This counter may experience a
879                  discontinuity when the RADIUS Accounting Server
880                  module within the managed entity is reinitialized,
881                  as indicated by the current value of
882                  radiusAccServerCounterDiscontinuity."
883           REFERENCE "RFC 2866 section 3"
884           ::= { radiusAccClientExtEntry  9 }
885
886    radiusAccServExtMalformedRequests OBJECT-TYPE
887           SYNTAX Counter32
888           UNITS "packets"
889           MAX-ACCESS read-only
890           STATUS current
891           DESCRIPTION
892                 "The number of malformed RADIUS Accounting-Request
893                  packets that were received from this client.
894                  Bad authenticators and unknown types are not
895
896
897
898 Nelson                       Informational                     [Page 16]
899 \f
900 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
901
902
903                  included as malformed Accounting-Requests.  This
904                  counter may experience a discontinuity when the
905                  RADIUS Accounting Server module within the managed
906                  entity is reinitialized, as indicated by the current
907                  value of radiusAccServerCounterDiscontinuity."
908           REFERENCE "RFC 2866 section 3"
909           ::= { radiusAccClientExtEntry  10 }
910
911    radiusAccServExtNoRecords OBJECT-TYPE
912           SYNTAX Counter32
913           UNITS "packets"
914           MAX-ACCESS read-only
915           STATUS current
916           DESCRIPTION
917                 "The number of RADIUS Accounting-Request packets
918                  that were received and responded to but not
919                  recorded.  This counter may experience a
920                  discontinuity when the RADIUS Accounting Server
921                  module within the managed entity is reinitialized,
922                  as indicated by the current value of
923                  radiusAccServerCounterDiscontinuity."
924           ::= { radiusAccClientExtEntry  11 }
925
926    radiusAccServExtUnknownTypes OBJECT-TYPE
927           SYNTAX Counter32
928           UNITS "packets"
929           MAX-ACCESS read-only
930           STATUS current
931           DESCRIPTION
932                 "The number of RADIUS packets of unknown type that
933                  were received from this client.  This counter may
934                  experience a discontinuity when the RADIUS Accounting
935                  Server module within the managed entity is
936                  reinitialized, as indicated by the current value of
937                  radiusAccServerCounterDiscontinuity."
938           REFERENCE "RFC 2866 section 4"
939           ::= { radiusAccClientExtEntry  12 }
940
941    radiusAccServerCounterDiscontinuity OBJECT-TYPE
942             SYNTAX TimeTicks
943             UNITS "centiseconds"
944             MAX-ACCESS read-only
945             STATUS current
946             DESCRIPTION
947                   "The number of centiseconds since the last
948                    discontinuity in the RADIUS Accounting Server
949                    counters.  A discontinuity may be the result of
950                    a reinitialization of the RADIUS Accounting Server
951
952
953
954 Nelson                       Informational                     [Page 17]
955 \f
956 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
957
958
959                    module within the managed entity."
960             ::= { radiusAccClientExtEntry 13 }
961
962
963    -- conformance information
964
965    radiusAccServMIBConformance  OBJECT IDENTIFIER
966           ::= { radiusAccServMIB 2 }
967
968    radiusAccServMIBCompliances  OBJECT IDENTIFIER
969           ::= { radiusAccServMIBConformance 1 }
970
971    radiusAccServMIBGroups  OBJECT IDENTIFIER
972           ::= { radiusAccServMIBConformance 2 }
973
974
975    -- compliance statements
976
977    radiusAccServMIBCompliance MODULE-COMPLIANCE
978           STATUS  deprecated
979           DESCRIPTION
980                "The compliance statement for accounting servers
981                implementing the RADIUS Accounting Server MIB.
982                Implementation of this module is for IPv4-only
983                entities, or for backwards compatibility use with
984                entities that support both IPv4 and IPv6."
985           MODULE  -- this module
986           MANDATORY-GROUPS { radiusAccServMIBGroup }
987
988           OBJECT        radiusAccServConfigReset
989           WRITE-SYNTAX  INTEGER { reset(2) }
990           DESCRIPTION  "The only SETable value is 'reset' (2)."
991
992           ::= { radiusAccServMIBCompliances 1 }
993
994    radiusAccServExtMIBCompliance MODULE-COMPLIANCE
995           STATUS  current
996           DESCRIPTION
997                "The compliance statement for accounting
998                servers implementing the RADIUS Accounting
999                Server IPv6 Extensions MIB.  Implementation of
1000                this module is for entities that support IPv6,
1001                or support IPv4 and IPv6."
1002           MODULE  -- this module
1003           MANDATORY-GROUPS { radiusAccServExtMIBGroup }
1004
1005           OBJECT        radiusAccServConfigReset
1006           WRITE-SYNTAX  INTEGER { reset(2) }
1007
1008
1009
1010 Nelson                       Informational                     [Page 18]
1011 \f
1012 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
1013
1014
1015           DESCRIPTION  "The only SETable value is 'reset' (2)."
1016
1017           OBJECT radiusAccClientInetAddressType
1018            SYNTAX InetAddressType { ipv4(1), ipv6(2) }
1019            DESCRIPTION
1020                  "An implementation is only required to support
1021                   IPv4 and globally unique IPv6 addresses."
1022
1023            OBJECT radiusAccClientInetAddress
1024            SYNTAX InetAddress ( SIZE (4|16) )
1025            DESCRIPTION
1026                  "An implementation is only required to support
1027                   IPv4 and globally unique IPv6 addresses."
1028
1029           ::= { radiusAccServMIBCompliances 2 }
1030
1031
1032    -- units of conformance
1033
1034    radiusAccServMIBGroup OBJECT-GROUP
1035          OBJECTS {radiusAccServIdent,
1036                   radiusAccServUpTime,
1037                   radiusAccServResetTime,
1038                   radiusAccServConfigReset,
1039                   radiusAccServTotalRequests,
1040                   radiusAccServTotalInvalidRequests,
1041                   radiusAccServTotalDupRequests,
1042                   radiusAccServTotalResponses,
1043                   radiusAccServTotalMalformedRequests,
1044                   radiusAccServTotalBadAuthenticators,
1045                   radiusAccServTotalPacketsDropped,
1046                   radiusAccServTotalNoRecords,
1047                   radiusAccServTotalUnknownTypes,
1048                   radiusAccClientAddress,
1049                   radiusAccClientID,
1050                   radiusAccServPacketsDropped,
1051                   radiusAccServRequests,
1052                   radiusAccServDupRequests,
1053                   radiusAccServResponses,
1054                   radiusAccServBadAuthenticators,
1055                   radiusAccServMalformedRequests,
1056                   radiusAccServNoRecords,
1057                   radiusAccServUnknownTypes
1058                  }
1059          STATUS  deprecated
1060          DESCRIPTION
1061                "The collection of objects providing management of
1062                 a RADIUS Accounting Server."
1063
1064
1065
1066 Nelson                       Informational                     [Page 19]
1067 \f
1068 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
1069
1070
1071          ::= { radiusAccServMIBGroups 1 }
1072
1073    radiusAccServExtMIBGroup OBJECT-GROUP
1074          OBJECTS {radiusAccServIdent,
1075                   radiusAccServUpTime,
1076                   radiusAccServResetTime,
1077                   radiusAccServConfigReset,
1078                   radiusAccServTotalRequests,
1079                   radiusAccServTotalInvalidRequests,
1080                   radiusAccServTotalDupRequests,
1081                   radiusAccServTotalResponses,
1082                   radiusAccServTotalMalformedRequests,
1083                   radiusAccServTotalBadAuthenticators,
1084                   radiusAccServTotalPacketsDropped,
1085                   radiusAccServTotalNoRecords,
1086                   radiusAccServTotalUnknownTypes,
1087                   radiusAccClientInetAddressType,
1088                   radiusAccClientInetAddress,
1089                   radiusAccClientExtID,
1090                   radiusAccServExtPacketsDropped,
1091                   radiusAccServExtRequests,
1092                   radiusAccServExtDupRequests,
1093                   radiusAccServExtResponses,
1094                   radiusAccServExtBadAuthenticators,
1095                   radiusAccServExtMalformedRequests,
1096                   radiusAccServExtNoRecords,
1097                   radiusAccServExtUnknownTypes,
1098                   radiusAccServerCounterDiscontinuity
1099                  }
1100          STATUS  current
1101          DESCRIPTION
1102                "The collection of objects providing management of
1103                 a RADIUS Accounting Server."
1104          ::= { radiusAccServMIBGroups 2 }
1105
1106    END
1107
1108 8.  Security Considerations
1109
1110    There are management objects (radiusAccServConfigReset) defined in
1111    this MIB that have a MAX-ACCESS clause of read-write and/or read-
1112    create.  Such objects may be considered sensitive or vulnerable in
1113    some network environments.  The support for SET operations in a non-
1114    secure environment without proper protection can have a negative
1115    effect on network operations.  These are:
1116
1117
1118
1119
1120
1121
1122 Nelson                       Informational                     [Page 20]
1123 \f
1124 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
1125
1126
1127    radiusAccServConfigReset
1128       This object can be used to reinitialize the persistent state of
1129       any server.  When set to reset(2), any persistent server state
1130       (such as a process) is reinitialized as if the server had just
1131       been started.  Depending on the server implementation details,
1132       this action may or may not interrupt the processing of pending
1133       request in the server.  Abuse of this object may lead to a Denial
1134       of Service attack on the server.
1135
1136    There are a number of managed objects in this MIB that may contain
1137    sensitive information.  These are:
1138
1139    radiusAccClientIPAddress
1140       This can be used to determine the address of the RADIUS accounting
1141       client with which the server is communicating.  This information
1142       could be useful in mounting an attack on the accounting client.
1143
1144    radiusAccClientInetAddress
1145       This can be used to determine the address of the RADIUS accounting
1146       client with which the server is communicating.  This information
1147       could be useful in mounting an attack on the accounting client.
1148
1149    It is thus important to control even GET access to these objects and
1150    possibly to even encrypt the values of these object when sending them
1151    over the network via SNMP.  Not all versions of SNMP provide features
1152    for such a secure environment.
1153
1154    SNMP versions prior to SNMPv3 do not provide a secure environment.
1155    Even if the network itself is secure (for example by using IPsec),
1156    there is no control as to who on the secure network is allowed to
1157    access and GET/SET (read/change/create/delete) the objects in this
1158    MIB.
1159
1160    It is RECOMMENDED that implementers consider the security features as
1161    provided by the SNMPv3 framework (see [RFC3410], section 8),
1162    including full support for the SNMPv3 cryptographic mechanisms (for
1163    authentication and privacy).
1164
1165    Further, deployment of SNMP versions prior to SNMPv3 is NOT
1166    RECOMMENDED.  Instead, it is RECOMMENDED to deploy SNMPv3 and to
1167    enable cryptographic security.  It is then a customer/operator
1168    responsibility to ensure that the SNMP entity giving access to an
1169    instance of this MIB module is properly configured to give access to
1170    the objects only to those principals (users) that have legitimate
1171    rights to indeed GET or SET (change/create/delete) them.
1172
1173
1174
1175
1176
1177
1178 Nelson                       Informational                     [Page 21]
1179 \f
1180 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
1181
1182
1183 9.  References
1184
1185 9.1.  Normative References
1186
1187    [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
1188               Requirement Levels", BCP 14, RFC 2119, March 1997.
1189
1190    [RFC2578]  McCloghrie, K., Ed., Perkins, D., Ed., and J.
1191               Schoenwaelder, Ed., "Structure of Management Information
1192               Version 2 (SMIv2)", STD 58, RFC 2578, April 1999.
1193
1194    [RFC2579]  McCloghrie, K., Ed., Perkins, D., Ed., and J.
1195               Schoenwaelder, Ed., "Textual Conventions for SMIv2",
1196               STD 58, RFC 2579, April 1999.
1197
1198    [RFC2580]  McCloghrie, K., Perkins, D., and J. Schoenwaelder,
1199               "Conformance Statements for SMIv2", STD 58, RFC 2580,
1200               April 1999.
1201
1202    [RFC2866]  Rigney, C., "RADIUS Accounting", RFC 2866, June 2000.
1203
1204    [RFC3411]  Harrington, D., Presuhn, R., and B. Wijnen, "An
1205               Architecture for Describing Simple Network Management
1206               Protocol (SNMP) Management Frameworks", STD 62, RFC 3411,
1207               December 2002.
1208
1209    [RFC4001]  Daniele, M., Haberman, B., Routhier, S., and J.
1210               Schoenwaelder, "Textual Conventions for Internet Network
1211               Addresses", RFC 4001, February 2005.
1212
1213 9.2.  Informative References
1214
1215    [RFC2621]  Zorn, G. and B. Aboba, "RADIUS Accounting Server MIB",
1216               RFC 2621, June 1999.
1217
1218    [RFC2865]  Rigney, C., Willens, S., Rubens, A., and W. Simpson,
1219               "Remote Authentication Dial In User Service (RADIUS)",
1220               RFC 2865, June 2000.
1221
1222    [RFC3410]  Case, J., Mundy, R., Partain, D., and B. Stewart,
1223               "Introduction and Applicability Statements for Internet-
1224               Standard Management Framework", RFC 3410, December 2002.
1225
1226    [RFC4670]  Nelson, D., "RADIUS Accounting Client MIB for IPv6", RFC
1227               4670, August 2006.
1228
1229
1230
1231
1232
1233
1234 Nelson                       Informational                     [Page 22]
1235 \f
1236 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
1237
1238
1239 Appendix A.  Acknowledgements
1240
1241    The authors of the original MIB are Bernard Aboba and Glen Zorn.
1242
1243    Many thanks to all reviewers, especially to Dave Harrington, Dan
1244    Romascanu, C.M. Heard, Bruno Pape, Greg Weber, and Bert Wijnen.
1245
1246 Author's Address
1247
1248    David B. Nelson
1249    Enterasys Networks
1250    50 Minuteman Road
1251    Andover, MA  01810
1252    USA
1253
1254    EMail: dnelson@enterasys.com
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290 Nelson                       Informational                     [Page 23]
1291 \f
1292 RFC 4671             RADIUS Acct Server MIB (IPv6)           August 2006
1293
1294
1295 Full Copyright Statement
1296
1297    Copyright (C) The Internet Society (2006).
1298
1299    This document is subject to the rights, licenses and restrictions
1300    contained in BCP 78, and except as set forth therein, the authors
1301    retain all their rights.
1302
1303    This document and the information contained herein are provided on an
1304    "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
1305    OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
1306    ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
1307    INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
1308    INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
1309    WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
1310
1311 Intellectual Property
1312
1313    The IETF takes no position regarding the validity or scope of any
1314    Intellectual Property Rights or other rights that might be claimed to
1315    pertain to the implementation or use of the technology described in
1316    this document or the extent to which any license under such rights
1317    might or might not be available; nor does it represent that it has
1318    made any independent effort to identify any such rights.  Information
1319    on the procedures with respect to rights in RFC documents can be
1320    found in BCP 78 and BCP 79.
1321
1322    Copies of IPR disclosures made to the IETF Secretariat and any
1323    assurances of licenses to be made available, or the result of an
1324    attempt made to obtain a general license or permission for the use of
1325    such proprietary rights by implementers or users of this
1326    specification can be obtained from the IETF on-line IPR repository at
1327    http://www.ietf.org/ipr.
1328
1329    The IETF invites any interested party to bring to its attention any
1330    copyrights, patents or patent applications, or other proprietary
1331    rights that may cover technology that may be required to implement
1332    this standard.  Please address the information to the IETF at
1333    ietf-ipr@ietf.org.
1334
1335 Acknowledgement
1336
1337    Funding for the RFC Editor function is provided by the IETF
1338    Administrative Support Activity (IASA).
1339
1340
1341
1342
1343
1344
1345
1346 Nelson                       Informational                     [Page 24]
1347 \f