Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / PPP-SEC-MIB
1 PPP-SEC-MIB DEFINITIONS ::= BEGIN
2
3 IMPORTS
4      Counter
5           FROM RFC1155-SMI
6      OBJECT-TYPE
7           FROM RFC-1212
8      ppp
9           FROM PPP-LCP-MIB;
10
11      pppSecurity OBJECT IDENTIFIER ::= { ppp 2 }
12
13      pppSecurityProtocols OBJECT IDENTIFIER ::= { pppSecurity 1 }
14
15 -- The following uniquely identify the various protocols
16 -- used by PPP security. These OBJECT IDENTIFIERS are
17 -- used in the pppSecurityConfigProtocol and
18 -- pppSecuritySecretsProtocol objects to identify to which
19 -- protocols the table entries apply.
20
21      pppSecurityPapProtocol OBJECT IDENTIFIER ::=
22                { pppSecurityProtocols 1 }
23      pppSecurityChapMD5Protocol OBJECT IDENTIFIER ::=
24                { pppSecurityProtocols 2 }
25
26 -- PPP Security Group
27 -- Implementation of this group is optional.
28
29 -- This table allows the network manager to configure
30 -- which security protocols are to be used on which
31 -- link and in what order of preference each is to be tried
32
33
34 pppSecurityConfigTable   OBJECT-TYPE
35      SYNTAX    SEQUENCE OF PppSecurityConfigEntry
36      ACCESS    not-accessible
37      STATUS    mandatory
38      DESCRIPTION
39                "Table containing the configuration and
40                preference parameters for PPP Security."
41      ::= { pppSecurity 2 }
42
43
44 pppSecurityConfigEntry   OBJECT-TYPE
45      SYNTAX    PppSecurityConfigEntry
46      ACCESS    not-accessible
47      STATUS    mandatory
48      DESCRIPTION
49                "Security configuration information for a
50                particular PPP link."
51      INDEX     { pppSecurityConfigLink,
52                pppSecurityConfigPreference }
53      ::= { pppSecurityConfigTable 1 }
54
55
56 PppSecurityConfigEntry ::= SEQUENCE {
57      pppSecurityConfigLink
58           INTEGER,
59      pppSecurityConfigPreference
60           INTEGER,
61      pppSecurityConfigProtocol
62           OBJECT IDENTIFIER,
63      pppSecurityConfigStatus
64           INTEGER
65      }
66
67
68 pppSecurityConfigLink   OBJECT-TYPE
69      SYNTAX    INTEGER(0..2147483647)
70      ACCESS    read-write
71      STATUS    mandatory
72      DESCRIPTION
73                "The value of ifIndex that identifies the entry
74                in the interface table that is associated with
75                the local PPP entity's link for which this
76                particular security algorithm shall be
77                attempted. A value of 0 indicates the default
78                algorithm - i.e., this entry applies to all
79                links for which explicit entries in the table
80                do not exist."
81      ::= { pppSecurityConfigEntry 1 }
82
83
84 pppSecurityConfigPreference   OBJECT-TYPE
85      SYNTAX    INTEGER(0..2147483647)
86      ACCESS    read-write
87      STATUS    mandatory
88      DESCRIPTION
89                "The relative preference of the security
90                protocol identified by
91                pppSecurityConfigProtocol. Security protocols
92                with lower values of
93                pppSecurityConfigPreference are tried before
94                protocols with higher values of
95                pppSecurityConfigPreference."
96      ::= { pppSecurityConfigEntry 2 }
97
98
99 pppSecurityConfigProtocol   OBJECT-TYPE
100      SYNTAX    OBJECT IDENTIFIER
101      ACCESS    read-write
102      STATUS    mandatory
103      DESCRIPTION
104                "Identifies the security protocol to be
105                attempted on the link identified by
106                pppSecurityConfigLink at the preference level
107                identified by pppSecurityConfigPreference. "
108      ::= { pppSecurityConfigEntry 3 }
109
110
111 pppSecurityConfigStatus   OBJECT-TYPE
112      SYNTAX    INTEGER  {
113                invalid(1),
114                valid(2)
115           }
116      ACCESS    read-write
117      STATUS    mandatory
118      DESCRIPTION
119                "Setting this object to the value invalid(1)
120                has the effect of invalidating the
121                corresponding entry in the
122                pppSecurityConfigTable. It is an
123                implementation-specific matter as to whether
124                the agent removes an invalidated entry from the
125                table.  Accordingly, management stations must
126                be prepared to receive tabular information from
127                agents that corresponds to entries not
128                currently in use.  Proper interpretation of
129                such entries requires examination of the
130                relevant pppSecurityConfigStatus object."
131      DEFVAL    { valid }
132      ::= { pppSecurityConfigEntry 4 }
133
134
135 -- This table contains all of the ID/Secret pair information.
136
137
138 pppSecuritySecretsTable   OBJECT-TYPE
139      SYNTAX    SEQUENCE OF PppSecuritySecretsEntry
140      ACCESS    not-accessible
141      STATUS    mandatory
142      DESCRIPTION
143                "Table containing the identities and secrets
144                used by the PPP authentication protocols.  As
145                this table contains secret information, it is
146                expected that access to this table be limited
147                to those SNMP Party-Pairs for which a privacy
148                protocol is in use for all SNMP messages that
149                the parties exchange.  This table contains both
150                the ID and secret pair(s) that the local PPP
151                entity will advertise to the remote entity and
152                the pair(s) that the local entity will expect
153                from the remote entity.  This table allows for
154                multiple id/secret password pairs to be
155                specified for a particular link by using the
156                pppSecuritySecretsIdIndex object."
157      ::= { pppSecurity 3 }
158
159
160 pppSecuritySecretsEntry   OBJECT-TYPE
161      SYNTAX    PppSecuritySecretsEntry
162      ACCESS    not-accessible
163      STATUS    mandatory
164      DESCRIPTION
165                "Secret information."
166      INDEX     { pppSecuritySecretsLink,
167                pppSecuritySecretsIdIndex }
168      ::= { pppSecuritySecretsTable 1 }
169
170 PppSecuritySecretsEntry ::= SEQUENCE {
171      pppSecuritySecretsLink
172           INTEGER,
173      pppSecuritySecretsIdIndex
174           INTEGER,
175      pppSecuritySecretsDirection
176           INTEGER,
177      pppSecuritySecretsProtocol
178           OBJECT IDENTIFIER,
179      pppSecuritySecretsIdentity
180           OCTET STRING,
181      pppSecuritySecretsSecret
182           OCTET STRING,
183      pppSecuritySecretsStatus
184           INTEGER
185 }
186
187 pppSecuritySecretsLink   OBJECT-TYPE
188      SYNTAX    INTEGER(0..2147483647)
189      ACCESS    read-only
190      STATUS    mandatory
191      DESCRIPTION
192                "The link to which this ID/Secret pair applies.
193                By convention, if the value of this object is 0
194                then the ID/Secret pair applies to all links."
195      ::= { pppSecuritySecretsEntry 1 }
196
197
198 pppSecuritySecretsIdIndex   OBJECT-TYPE
199      SYNTAX    INTEGER(0..2147483647)
200      ACCESS    read-only
201      STATUS    mandatory
202      DESCRIPTION
203                "A unique value for each ID/Secret pair that
204                has been defined for use on this link.  This
205                allows multiple ID/Secret pairs to be defined
206                for each link.  How the local entity selects
207                which pair to use is a local implementation
208                decision."
209      ::= { pppSecuritySecretsEntry 2 }
210
211
212 pppSecuritySecretsDirection   OBJECT-TYPE
213      SYNTAX    INTEGER  {
214                local-to-remote(1),
215                remote-to-local(2)
216           }
217      ACCESS    read-write
218      STATUS    mandatory
219      DESCRIPTION
220                "This object defines the direction in which a
221                particular ID/Secret pair is valid.  If this
222                object is local-to-remote then the local PPP
223                entity will use the ID/Secret pair when
224                attempting to authenticate the local PPP entity
225                to the remote PPP entity.  If this object is
226                remote-to-local then the local PPP entity will
227                expect the ID/Secret pair to be used by the
228                remote PPP entity when the remote PPP entity
229                attempts to authenticate itself to the local
230                PPP entity."
231      ::= { pppSecuritySecretsEntry 3 }
232
233
234 pppSecuritySecretsProtocol   OBJECT-TYPE
235      SYNTAX    OBJECT IDENTIFIER
236      ACCESS    read-write
237      STATUS    mandatory
238      DESCRIPTION
239                "The security protocol (e.g. CHAP or PAP) to
240                which this ID/Secret pair applies."
241      ::= { pppSecuritySecretsEntry 4 }
242
243
244 pppSecuritySecretsIdentity   OBJECT-TYPE
245      SYNTAX    OCTET STRING (SIZE(0..255))
246      ACCESS    read-write
247      STATUS    mandatory
248      DESCRIPTION
249                "The Identity of the ID/Secret pair.  The
250                actual format, semantics, and use of
251                pppSecuritySecretsIdentity depends on the
252                actual security protocol used.  For example, if
253                pppSecuritySecretsProtocol is
254                pppSecurityPapProtocol then this object will
255                contain a PAP Peer-ID. If
256                pppSecuritySecretsProtocol is
257                pppSecurityChapMD5Protocol then this object
258                would contain the CHAP NAME parameter."
259      ::= { pppSecuritySecretsEntry 5 }
260
261
262 pppSecuritySecretsSecret   OBJECT-TYPE
263      SYNTAX    OCTET STRING (SIZE(0..255))
264      ACCESS    read-write
265      STATUS    mandatory
266      DESCRIPTION
267                "The secret of the ID/Secret pair.  The actual
268                format, semantics, and use of
269                pppSecuritySecretsSecret depends on the actual
270                security protocol used.  For example, if
271                pppSecuritySecretsProtocol is
272                pppSecurityPapProtocol then this object will
273                contain a PAP Password. If
274                pppSecuritySecretsProtocol is
275                pppSecurityChapMD5Protocol then this object
276                would contain the CHAP MD5 Secret."
277      ::= { pppSecuritySecretsEntry 6 }
278
279
280 pppSecuritySecretsStatus   OBJECT-TYPE
281      SYNTAX    INTEGER  {
282                invalid(1),
283                valid(2)
284           }
285      ACCESS    read-write
286      STATUS    mandatory
287      DESCRIPTION
288                "Setting this object to the value invalid(1)
289                has the effect of invalidating the
290                corresponding entry in the
291                pppSecuritySecretsTable. It is an
292                implementation-specific matter as to whether
293                the agent removes an invalidated entry from the
294                table.  Accordingly, management stations must
295                be prepared to receive tabular information from
296                agents that corresponds to entries not
297                currently in use.  Proper interpretation of
298                such entries requires examination of the
299                relevant pppSecuritySecretsStatus object."
300      DEFVAL    { valid }
301      ::= { pppSecuritySecretsEntry 7 }
302
303
304 END