moved the protocol documentation into the directory with the
[freeradius.git] / doc / rfc / rfc2620.txt
1
2
3
4
5
6
7 Network Working Group                                             B. Aboba
8 Request for Comments: 2620                                         G. Zorn
9 Category: Informational                                          Microsoft
10                                                                  June 1999
11
12
13                       RADIUS Accounting Client MIB
14
15 Status of this Memo
16
17    This memo provides information for the Internet community.  This memo
18    does not specify an Internet standard of any kind.  Distribution of
19    this memo is unlimited.
20
21 Copyright Notice
22
23    Copyright (C) The Internet Society (1999).  All Rights Reserved.
24
25 Abstract
26
27    This memo defines a set of extensions which instrument RADIUS
28    accounting client 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 IP-based
31    management stations can manage RADIUS accounting clients.
32
33 1.  Introduction
34
35    This memo defines a portion of the Management Information Base (MIB)
36    for use with network management protocols in the Internet community.
37    In particular, it describes managed objects used for managing RADIUS
38    accounting clients.
39
40    Today a wide range of network devices, including routers and NASes,
41    act as RADIUS accounting clients in order to provide accounting
42    services.  As a result, the effective management of RADIUS accounting
43    clients is of considerable importance.
44
45 2.  The SNMP Management Framework
46
47    The SNMP Management Framework presently consists of five major
48    components:
49
50     o   An overall architecture, described in RFC 2571 [1].
51
52     o   Mechanisms for describing and naming objects and events for the
53         purpose of management. The first version of this Structure of
54         Management Information (SMI) is called SMIv1 and described in
55
56
57
58 Aboba & Zorn                 Informational                      [Page 1]
59 \f
60 RFC 2620              RADIUS Accounting Client MIB             June 1999
61
62
63         STD 15, RFC 1155 [2], STD 16, RFC 1212 [3] and RFC 1215 [4].
64         The second version, called SMIv2, is described in STD 58, RFC
65         2578 [5], RFC 2579 [6] and RFC 2580 [7].
66
67     o   Message protocols for transferring management information. The
68         first version of the SNMP message protocol is called SNMPv1 and
69         described in STD 15, RFC 1157 [8]. A second version of the
70         SNMP message protocol, which is not an Internet standards
71         track protocol, is called SNMPv2c and described in RFC 1901
72         [9] and RFC 1906 [10].  The third version of the message
73         protocol is called SNMPv3 and described in RFC 1906 [10], RFC
74         2572 [11] and RFC 2574 [12].
75
76     o   Protocol operations for accessing management information. The
77         first set of protocol operations and associated PDU formats is
78         described in STD 15, RFC 1157 [8]. A second set of protocol
79         operations and associated PDU formats is described in RFC 1905
80         [13].
81
82     o   A set of fundamental applications described in RFC 2573 [14] and
83         the view-based access control mechanism described in RFC 2575
84         [15].
85
86    Managed objects are accessed via a virtual information store, termed
87    the Management Information Base or MIB.  Objects in the MIB are
88    defined using the mechanisms defined in the SMI.
89
90    This memo specifies a MIB module that is compliant to the SMIv2. A
91    MIB conforming to the SMIv1 can be poduced through the appropriate
92    translations. The resulting translated MIB must be semantically
93    equivalent, except where objects or events are omitted because no
94    translation is possible (use of Counter64). Some machine readable
95    information in SMIv2 will be converted into textual descriptions in
96    SMIv1 during the translation process. However, this loss of machine
97    readable information is not considered to change the semantics of the
98    MIB.
99
100 3.  Overview
101
102    The RADIUS accounting protocol, described in [16], distinguishes
103    between the client function and the server function. In RADIUS
104    accounting, clients send Accounting-Requests, and servers reply with
105    Accounting-Responses. Typically NAS devices implement the client
106    function, and thus would be expected to implement the RADIUS
107    accounting client MIB, while RADIUS accounting servers implement the
108    server function, and thus would be expected to implement the RADIUS
109    accounting server MIB.
110
111
112
113
114 Aboba & Zorn                 Informational                      [Page 2]
115 \f
116 RFC 2620              RADIUS Accounting Client MIB             June 1999
117
118
119    However, it is possible for a RADIUS accounting entity to perform
120    both client and server functions. For example, a RADIUS proxy may act
121    as a server to one or more RADIUS accounting clients, while
122    simultaneously acting as an accounting client to one or more
123    accounting servers.  In such situations, it is expected that RADIUS
124    entities combining client and server functionality will support both
125    the client and server MIBs.
126
127 3.1.  Selected objects
128
129    This MIB module contains two scalars as well as a single table:
130
131    (1)  the RADIUS Accounting Server Table contains one row for
132         each RADIUS server that the client shares a secret with.
133
134    Each entry in the RADIUS Accounting Server Table includes thirteen
135    columns presenting a view of the activity of the RADIUS client.
136
137 4.  Definitions
138
139 RADIUS-ACC-CLIENT-MIB DEFINITIONS ::= BEGIN
140
141 IMPORTS
142        MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY,
143        Counter32, Integer32, Gauge32,
144        IpAddress, TimeTicks, mib-2      FROM SNMPv2-SMI
145        SnmpAdminString                  FROM SNMP-FRAMEWORK-MIB
146        MODULE-COMPLIANCE, OBJECT-GROUP  FROM SNMPv2-CONF;
147
148 radiusAccClientMIB MODULE-IDENTITY
149        LAST-UPDATED "9906110000Z" -- 11 Jun 1999
150        ORGANIZATION "IETF RADIUS Working Group."
151        CONTACT-INFO
152           " Bernard Aboba
153             Microsoft
154             One Microsoft Way
155             Redmond, WA  98052
156             US
157
158             Phone: +1 425 936 6605
159             EMail: bernarda@microsoft.com"
160        DESCRIPTION
161              "The MIB module for entities implementing the client side of
162               the Remote Access Dialin User Service (RADIUS) accounting
163               protocol."
164        REVISION "9906110000Z"    -- 11 Jun 1999
165        DESCRIPTION "Initial version as published in RFC 2620"
166        ::= { radiusAccounting 2 }
167
168
169
170 Aboba & Zorn                 Informational                      [Page 3]
171 \f
172 RFC 2620              RADIUS Accounting Client MIB             June 1999
173
174
175 radiusMIB OBJECT-IDENTITY
176        STATUS  current
177        DESCRIPTION
178              "The OID assigned to RADIUS MIB work by the IANA."
179        ::= { mib-2 67 }
180
181 radiusAccounting  OBJECT IDENTIFIER ::= {radiusMIB 2}
182
183 radiusAccClientMIBObjects     OBJECT IDENTIFIER ::=
184                                               { radiusAccClientMIB 1 }
185
186 radiusAccClient  OBJECT IDENTIFIER ::= { radiusAccClientMIBObjects 1 }
187
188 radiusAccClientInvalidServerAddresses OBJECT-TYPE
189       SYNTAX Counter32
190       MAX-ACCESS read-only
191       STATUS current
192       DESCRIPTION
193             "The number of RADIUS Accounting-Response packets
194              received from unknown addresses."
195       ::= { radiusAccClient 1 }
196
197 radiusAccClientIdentifier OBJECT-TYPE
198       SYNTAX SnmpAdminString
199       MAX-ACCESS read-only
200       STATUS current
201       DESCRIPTION
202             "The NAS-Identifier of the RADIUS accounting client. This
203              is not necessarily the same as sysName in MIB II."
204       ::= { radiusAccClient 2 }
205
206 radiusAccServerTable OBJECT-TYPE
207       SYNTAX SEQUENCE OF RadiusAccServerEntry
208       MAX-ACCESS not-accessible
209       STATUS     current
210       DESCRIPTION
211             "The (conceptual) table listing the RADIUS accounting
212              servers with which the client shares a secret."
213       ::= { radiusAccClient 3 }
214
215 radiusAccServerEntry OBJECT-TYPE
216       SYNTAX     RadiusAccServerEntry
217       MAX-ACCESS not-accessible
218       STATUS     current
219       DESCRIPTION
220             "An entry (conceptual row) representing a RADIUS
221              accounting server with which the client shares a secret."
222       INDEX      { radiusAccServerIndex }
223
224
225
226 Aboba & Zorn                 Informational                      [Page 4]
227 \f
228 RFC 2620              RADIUS Accounting Client MIB             June 1999
229
230
231       ::= { radiusAccServerTable 1 }
232
233 RadiusAccServerEntry ::= SEQUENCE {
234       radiusAccServerIndex                           Integer32,
235       radiusAccServerAddress                         IpAddress,
236       radiusAccClientServerPortNumber                Integer32,
237       radiusAccClientRoundTripTime                   TimeTicks,
238       radiusAccClientRequests                        Counter32,
239       radiusAccClientRetransmissions                 Counter32,
240       radiusAccClientResponses                       Counter32,
241       radiusAccClientMalformedResponses              Counter32,
242       radiusAccClientBadAuthenticators               Counter32,
243       radiusAccClientPendingRequests                   Gauge32,
244       radiusAccClientTimeouts                        Counter32,
245       radiusAccClientUnknownTypes                    Counter32,
246       radiusAccClientPacketsDropped                  Counter32
247 }
248
249 radiusAccServerIndex OBJECT-TYPE
250       SYNTAX     Integer32 (1..2147483647)
251       MAX-ACCESS not-accessible
252       STATUS     current
253       DESCRIPTION
254             "A number uniquely identifying each RADIUS
255              Accounting server with which this client
256              communicates."
257       ::= { radiusAccServerEntry 1 }
258
259 radiusAccServerAddress OBJECT-TYPE
260       SYNTAX     IpAddress
261       MAX-ACCESS read-only
262       STATUS     current
263       DESCRIPTION
264             "The IP address of the RADIUS accounting server
265              referred to in this table entry."
266       ::= { radiusAccServerEntry 2 }
267
268 radiusAccClientServerPortNumber  OBJECT-TYPE
269       SYNTAX Integer32 (0..65535)
270       MAX-ACCESS read-only
271       STATUS current
272       DESCRIPTION
273             "The UDP port the client is using to send requests to
274              this server."
275       ::= { radiusAccServerEntry 3 }
276
277 radiusAccClientRoundTripTime  OBJECT-TYPE
278       SYNTAX TimeTicks
279
280
281
282 Aboba & Zorn                 Informational                      [Page 5]
283 \f
284 RFC 2620              RADIUS Accounting Client MIB             June 1999
285
286
287       MAX-ACCESS read-only
288       STATUS current
289       DESCRIPTION
290              "The time interval between the most recent
291              Accounting-Response and the Accounting-Request that
292              matched it from this RADIUS accounting server."
293       ::= { radiusAccServerEntry 4 }
294
295 -- Request/Response statistics
296 --
297 -- Requests = Responses + PendingRequests + ClientTimeouts
298 --
299 -- Responses - MalformedResponses - BadAuthenticators -
300 -- UnknownTypes - PacketsDropped = Successfully received
301
302 radiusAccClientRequests OBJECT-TYPE
303       SYNTAX Counter32
304       MAX-ACCESS read-only
305       STATUS current
306       DESCRIPTION
307             "The number of RADIUS Accounting-Request packets
308              sent. This does not include retransmissions."
309       ::= { radiusAccServerEntry 5 }
310
311 radiusAccClientRetransmissions OBJECT-TYPE
312       SYNTAX Counter32
313       MAX-ACCESS read-only
314       STATUS current
315       DESCRIPTION
316             "The number of RADIUS Accounting-Request packets
317              retransmitted to this RADIUS accounting server.
318              Retransmissions include retries where the
319              Identifier and Acct-Delay have been updated, as
320              well as those in which they remain the same."
321       ::= { radiusAccServerEntry 6 }
322
323 radiusAccClientResponses OBJECT-TYPE
324       SYNTAX Counter32
325       MAX-ACCESS read-only
326       STATUS current
327       DESCRIPTION
328             "The number of RADIUS packets received on the
329              accounting port from this server."
330       ::= { radiusAccServerEntry 7 }
331
332 radiusAccClientMalformedResponses OBJECT-TYPE
333       SYNTAX Counter32
334       MAX-ACCESS read-only
335
336
337
338 Aboba & Zorn                 Informational                      [Page 6]
339 \f
340 RFC 2620              RADIUS Accounting Client MIB             June 1999
341
342
343       STATUS current
344       DESCRIPTION
345              "The number of malformed RADIUS Accounting-Response
346               packets received from this server. Malformed packets
347              include packets with an invalid length. Bad
348              authenticators and unknown types are not included as
349              malformed accounting responses."
350       ::= { radiusAccServerEntry 8 }
351
352 radiusAccClientBadAuthenticators OBJECT-TYPE
353       SYNTAX Counter32
354       MAX-ACCESS read-only
355       STATUS current
356       DESCRIPTION
357             "The number of RADIUS Accounting-Response
358              packets which contained invalid authenticators
359              received from this server."
360       ::= { radiusAccServerEntry 9 }
361
362 radiusAccClientPendingRequests OBJECT-TYPE
363       SYNTAX Gauge32
364       MAX-ACCESS read-only
365       STATUS current
366       DESCRIPTION
367             "The number of RADIUS Accounting-Request packets
368              sent to this server that have not yet timed out or
369              received a response. This variable is incremented when an
370              Accounting-Request is sent and decremented due to
371              receipt of an Accounting-Response, a timeout or
372              a retransmission."
373       ::= { radiusAccServerEntry 10 }
374
375 radiusAccClientTimeouts OBJECT-TYPE
376      SYNTAX Counter32
377      MAX-ACCESS read-only
378      STATUS current
379      DESCRIPTION
380           "The number of accounting timeouts to this server.
381            After a timeout the client may retry to the same
382            server, send to a different server, or give up.
383            A retry to the same server is counted as a
384            retransmit as well as a timeout. A send to a different
385            server is counted as an Accounting-Request as well as
386            a timeout."
387       ::= { radiusAccServerEntry  11 }
388
389 radiusAccClientUnknownTypes OBJECT-TYPE
390       SYNTAX Counter32
391
392
393
394 Aboba & Zorn                 Informational                      [Page 7]
395 \f
396 RFC 2620              RADIUS Accounting Client MIB             June 1999
397
398
399       MAX-ACCESS read-only
400       STATUS current
401       DESCRIPTION
402             "The number of RADIUS packets of unknown type which
403              were received from this server on the accounting port."
404       ::= { radiusAccServerEntry  12 }
405
406 radiusAccClientPacketsDropped OBJECT-TYPE
407       SYNTAX Counter32
408       MAX-ACCESS read-only
409       STATUS current
410       DESCRIPTION
411             "The number of RADIUS packets which were received from
412              this server on the accounting port and dropped for some
413              other reason."
414       ::= { radiusAccServerEntry  13 }
415
416 -- conformance information
417
418 radiusAccClientMIBConformance
419           OBJECT IDENTIFIER ::= { radiusAccClientMIB 2 }
420 radiusAccClientMIBCompliances
421           OBJECT IDENTIFIER ::= { radiusAccClientMIBConformance 1 }
422 radiusAccClientMIBGroups
423           OBJECT IDENTIFIER ::= { radiusAccClientMIBConformance 2 }
424
425 -- compliance statements
426
427 radiusAccClientMIBCompliance MODULE-COMPLIANCE
428      STATUS  current
429      DESCRIPTION
430            "The compliance statement for accounting clients
431             implementing the RADIUS Accounting Client MIB."
432      MODULE  -- this module
433          MANDATORY-GROUPS { radiusAccClientMIBGroup }
434
435      ::= { radiusAccClientMIBCompliances 1 }
436
437
438 -- units of conformance
439
440 radiusAccClientMIBGroup OBJECT-GROUP
441      OBJECTS { radiusAccClientIdentifier,
442                radiusAccClientInvalidServerAddresses,
443                radiusAccServerAddress,
444                radiusAccClientServerPortNumber,
445                radiusAccClientRoundTripTime,
446                radiusAccClientRequests,
447
448
449
450 Aboba & Zorn                 Informational                      [Page 8]
451 \f
452 RFC 2620              RADIUS Accounting Client MIB             June 1999
453
454
455                radiusAccClientRetransmissions,
456                radiusAccClientResponses,
457                radiusAccClientMalformedResponses,
458                radiusAccClientBadAuthenticators,
459                radiusAccClientPendingRequests,
460                radiusAccClientTimeouts,
461                radiusAccClientUnknownTypes,
462                radiusAccClientPacketsDropped
463          }
464      STATUS  current
465      DESCRIPTION
466            "The basic collection of objects providing management of
467             RADIUS Accounting Clients."
468      ::= { radiusAccClientMIBGroups 1 }
469
470 END
471
472 5.  References
473
474    [1]  Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture
475         for Describing SNMP Management Frameworks", RFC 2571, April
476         1999.
477
478    [2]  Rose, M., and K. McCloghrie, "Structure and Identification of
479         Management Information for TCP/IP-based Internets", STD 16, RFC
480         1155, May 1990.
481
482    [3]  Rose, M., and K. McCloghrie, "Concise MIB Definitions", STD 16,
483         RFC 1212, March 1991.
484
485    [4]  Rose, M., "A Convention for Defining Traps for use with the
486         SNMP", RFC 1215, Performance Systems International, March 1991.
487
488    [5]  McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose,
489         M. and S. Waldbusser, "Structure of Management Information
490         Version 2 (SMIv2)", STD 58, RFC 2578, April 1999.
491
492    [6]  McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose,
493         M. and S. Waldbusser, "Textual Conventions for SMIv2", STD 58,
494         RFC 2579, April 1999.
495
496    [7]  McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose,
497         M. and S. Waldbusser, "Conformance Statements for SMIv2", STD
498         58, RFC 2580, April 1999.
499
500    [8]  Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple
501         Network Management Protocol", STD 15, RFC 1157, May 1990.
502
503
504
505
506 Aboba & Zorn                 Informational                      [Page 9]
507 \f
508 RFC 2620              RADIUS Accounting Client MIB             June 1999
509
510
511    [9]  Case, J., McCloghrie, K., Rose, M., and S. Waldbusser,
512         "Introduction to Community-based SNMPv2", RFC 1901, January
513         1996.
514
515    [10] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser,
516         "Transport Mappings for Version 2 of the Simple Network
517         Management Protocol (SNMPv2)", RFC 1906, January 1996.
518
519    [11] Case, J., Harrington D., Presuhn R., and B. Wijnen, "Message
520         Processing and Dispatching for the Simple Network Management
521         Protocol (SNMP)", RFC 2572, April 1999.
522
523    [12] Blumenthal, U., and B. Wijnen, "User-based Security Model for
524         Version 3 of the Simple Network Management Protocol (SNMPv3)",
525         RFC 2574, April 1999.
526
527    [13] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Protocol
528         Operations for Version 2 of the Simple Network Management
529         Protocol (SNMPv2)", RFC 1905, January 1996.
530
531    [14] Levi, D., Meyer, P., and B. Stewart, "SNMP Applications", RFC
532         2573, April 1999.
533
534    [15] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based Access
535         Control Model for the Simple Network Management Protocol
536         (SNMP)", RFC 2575, April 1999.
537
538    [16] Rigney, C., "RADIUS Accounting", RFC 2139, April 1997.
539
540 6.  Security Considerations
541
542    There are no management objects defined in this MIB that have a MAX-
543    ACCESS clause of read-write and/or read-create.  So, if this MIB is
544    implemented correctly, then there is no risk that an intruder can
545    alter or create any management objects of this MIB via direct SNMP
546    SET opertions.
547
548    There are a number of managed objects in this MIB that may contain
549    sensitive information. These are:
550
551
552
553
554
555
556
557
558
559
560
561
562 Aboba & Zorn                 Informational                     [Page 10]
563 \f
564 RFC 2620              RADIUS Accounting Client MIB             June 1999
565
566
567    radiusAccServerAddress
568              This can be used to determine the address of the RADIUS
569              accounting server with which the client is communicating.
570              This information could be useful in mounting an attack on
571              the acounting server, which may contain sensitive financial
572              data.
573
574    radiusAccClientServerPortNumber This can be used to determine the
575              port number on which the RADIUS accounting client is
576              sending. This information could be useful in impersonating
577              the client in order to send fraudulent data to the
578              accounting server.
579
580    It is thus important to control even GET access to these objects and
581    possibly to even encrypt the values of these object when sending them
582    over the network via SNMP.  Not all versions of SNMP provide features
583    for such a secure environment.
584
585    SNMPv1 by itself is not a secure environment. Even if the network
586    itself is secure (for example by using IPSec), there is no control as
587    to who on the secure network is allowed to access and GET/SET
588    (read/change/create/delete) the objects in this MIB.
589
590    It is recommended that the implementers consider the security
591    features as provided by the SNMPv3 framework. Specifically, the use
592    of the User-based Security Model RFC 2574 [12] and the View-based
593    Access Control Model RFC 2575 [15] is recommended.  Using these
594    security features, customer/users can give access to the objects only
595    to those principals (users) that have legitimate rights to GET or SET
596    (change/create/delete) them.
597
598 7.  Acknowledgments
599
600    The authors acknowledge the contributions of the RADIUS Working Group
601    in the development of this MIB.  Thanks to Narendra Gidwani of
602    Microsoft, Allan C. Rubens of MERIT, Carl Rigney of Livingston and
603    Peter Heitman of American Internet Corporation for useful discussions
604    of this problem space.
605
606
607
608
609
610
611
612
613
614
615
616
617
618 Aboba & Zorn                 Informational                     [Page 11]
619 \f
620 RFC 2620              RADIUS Accounting Client MIB             June 1999
621
622
623 8.  Authors' Addresses
624
625    Bernard Aboba
626    Microsoft Corporation
627    One Microsoft Way
628    Redmond, WA 98052
629
630    Phone: 425-936-6605
631    EMail: bernarda@microsoft.com
632
633
634    Glen Zorn
635    Microsoft Corporation
636    One Microsoft Way
637    Redmond, WA 98052
638
639    Phone: 425-703-1559
640    EMail: glennz@microsoft.com
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674 Aboba & Zorn                 Informational                     [Page 12]
675 \f
676 RFC 2620              RADIUS Accounting Client MIB             June 1999
677
678
679 9.  Full Copyright Statement
680
681    Copyright (C) The Internet Society (1999).  All Rights Reserved.
682
683    This document and translations of it may be copied and furnished to
684    others, and derivative works that comment on or otherwise explain it
685    or assist in its implmentation may be prepared, copied, published and
686    distributed, in whole or in part, without restriction of any kind,
687    provided that the above copyright notice and this paragraph are
688    included on all such copies and derivative works.  However, this
689    document itself may not be modified in any way, such as by removing
690    the copyright notice or references to the Internet Society or other
691    Internet organizations, except as needed for the purpose of
692    developing Internet standards in which case the procedures for
693    copyrights defined in the Internet Standards process must be
694    followed, or as required to translate it into languages other than
695    English.
696
697    The limited permissions granted above are perpetual and will not be
698    revoked by the Internet Society or its successors or assigns.
699
700    This document and the information contained herein is provided on an
701    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
702    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
703    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
704    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
705    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
706
707 Acknowledgement
708
709    Funding for the RFC Editor function is currently provided by the
710    Internet Society.
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730 Aboba & Zorn                 Informational                     [Page 13]
731 \f