DOCS-SEC-MIB 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946
  1. DOCS-SEC-MIB DEFINITIONS ::= BEGIN
  2. IMPORTS
  3. MODULE-IDENTITY,
  4. OBJECT-TYPE,
  5. Unsigned32,
  6. Counter32
  7. FROM SNMPv2-SMI -- RFC 2578
  8. TEXTUAL-CONVENTION,
  9. TruthValue,
  10. MacAddress,
  11. RowStatus,
  12. DateAndTime
  13. FROM SNMPv2-TC -- RFC 2579
  14. OBJECT-GROUP,
  15. MODULE-COMPLIANCE
  16. FROM SNMPv2-CONF -- RFC 2580
  17. SnmpAdminString
  18. FROM SNMP-FRAMEWORK-MIB -- RFC 3411
  19. SnmpTagList
  20. FROM SNMP-TARGET-MIB -- RFC 3411
  21. InetAddressType,
  22. InetAddress,
  23. InetAddressPrefixLength
  24. FROM INET-ADDRESS-MIB -- RFC 4001
  25. docsIf3CmtsCmRegStatusEntry,
  26. docsIf3CmtsCmRegStatusId
  27. FROM DOCS-IF3-MIB
  28. clabProjDocsis
  29. FROM CLAB-DEF-MIB
  30. docsBpi2CodeDownloadControl
  31. FROM DOCS-IETF-BPI2-MIB;
  32. docsSecMib MODULE-IDENTITY
  33. LAST-UPDATED "201601130000Z" -- January 13, 2016
  34. ORGANIZATION "Cable Television Laboratories, Inc."
  35. CONTACT-INFO
  36. "
  37. Postal: Cable Television Laboratories, Inc.
  38. 858 Coal Creek Circle
  39. Louisville, Colorado 80027-9750
  40. U.S.A.
  41. Phone: +1 303-661-9100
  42. Fax: +1 303-661-9199
  43. E-mail: mibs@cablelabs.com"
  44. DESCRIPTION
  45. "This MIB module contains the management objects for the
  46. management of the security requirements in the DOCSIS
  47. Security Specification."
  48. REVISION "201601130000Z" -- January 13, 2016
  49. DESCRIPTION
  50. "Modified per CM-OSSIv3.1-N-15.1393-6.
  51. Deprecate docsBpi2CodeUpdateCvcChain for DOCSIS 3.1
  52. that was added earlier ECN CM-OSSIv3.1-N-15.1243-1.
  53. 3.1 PKI MIBs moved to DOCS-BPI2EXT-MIB"
  54. REVISION "201503260000Z" -- March 26, 2015
  55. DESCRIPTION
  56. "Revised Version includes ECN CM-OSSIv3.1-N-15.1243-1
  57. and published as CM-OSSIv3.1-I03, to support
  58. docsBpi2CodeUpdateCvcChain for DOCSIS 3.1."
  59. REVISION "201001150000Z" -- January 15, 2010
  60. DESCRIPTION
  61. "Revised Version includes ECN
  62. OSSIv3.0-N-09.0872-4
  63. and published as I11"
  64. REVISION "200905290000Z" -- May 29, 2009
  65. DESCRIPTION
  66. "Revised Version includes ECNs
  67. OSSIv3.0-N-09.0773-1
  68. OSSIv3.0-N-09.0775-3
  69. OSSIv3.0-N-09.0777-2
  70. and published as I09"
  71. REVISION "200702230000Z" -- February 23, 2007
  72. DESCRIPTION
  73. "Revised Version includes ECN OSSIv3.0-N-06.0357-1
  74. and published as IO2"
  75. REVISION "200612071700Z" -- December 7, 2006
  76. DESCRIPTION
  77. "Initial version, published as part of the CableLabs
  78. OSSIv3.0 specification CM-SP-OSSIv3.0-I01-061207
  79. Copyright 1999-2006 Cable Television Laboratories, Inc.
  80. All rights reserved."
  81. ::= { clabProjDocsis 11}
  82. -- Textual Conventions
  83. DocsCvcCaCertificateChain ::= TEXTUAL-CONVENTION
  84. DISPLAY-HINT "*"
  85. STATUS current
  86. DESCRIPTION
  87. "A degenerate PKCS7 signedData structure that contains the
  88. CVC and the CVC CA certificate chain in the certificates
  89. field."
  90. SYNTAX OCTET STRING (SIZE (0..8192))
  91. -- Object Definitions
  92. docsSecMibObjects OBJECT IDENTIFIER ::= { docsSecMib 1 }
  93. docsSecCmtsServerCfg OBJECT IDENTIFIER ::= { docsSecMibObjects 1 }
  94. docsSecCmtsServerCfgTftpOptions OBJECT-TYPE
  95. SYNTAX BITS {
  96. hwAddr(0),
  97. netAddr(1)
  98. }
  99. MAX-ACCESS read-write
  100. STATUS current
  101. DESCRIPTION
  102. "This attribute instructs the CMTS to insert the source
  103. IP address and/or MAC address of received TFTP packets
  104. into the TFTP option fields before forwarding
  105. the packets to the Config File server.
  106. This attribute is only applicable when the TftpProxyEnabled
  107. attribute of the MdCfg object is 'true'."
  108. REFERENCE
  109. "DOCSIS 3.0 Operations Support System Interface
  110. Specification CM-SP-OSSIv3.0-I01-061207,
  111. MdCfg Object Section in the Media Access Control (MAC)
  112. Requirements Annex."
  113. DEFVAL { { } }
  114. ::= { docsSecCmtsServerCfg 1 }
  115. docsSecCmtsServerCfgConfigFileLearningEnable OBJECT-TYPE
  116. SYNTAX TruthValue
  117. MAX-ACCESS read-write
  118. STATUS current
  119. DESCRIPTION
  120. "This attribute enables and disables Configuration
  121. File Learning functionality.
  122. If this attribute is set to 'true' the CMTS will respond
  123. with Authentication Failure in the REG-RSP message
  124. when there is a mismatch between learned config file
  125. parameters and REG-REQ parameters. If this attribute
  126. is set to 'false', the CMTS will not execute config
  127. file learning and mismatch check.
  128. This attribute is only applicable when the TftpProxyEnabled
  129. attribute of the MdCfg object is 'true'."
  130. REFERENCE
  131. "DOCSIS 3.0 Operations Support System Interface
  132. Specification CM-SP-OSSIv3.0-I01-061207,
  133. MdCfg Object Section in the Media Access Control (MAC)
  134. Requirements Annex.
  135. DOCSIS 3.0 Security Specification
  136. CM-SP-SECv3.0-I01-060804, Secure Provisioning Section.
  137. DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  138. Specification CM-SP-MULPIv3.0-I01-060804."
  139. DEFVAL { true }
  140. ::= { docsSecCmtsServerCfg 2 }
  141. docsSecCmtsEncrypt OBJECT IDENTIFIER ::= { docsSecMibObjects 2 }
  142. docsSecCmtsEncryptEncryptAlgPriority OBJECT-TYPE
  143. SYNTAX SnmpTagList
  144. MAX-ACCESS read-write
  145. STATUS current
  146. DESCRIPTION
  147. "This attribute allows for configuration of a prioritized
  148. list of encryption algorithms the CMTS will
  149. use when selecting the primary SAID encryption algorithm
  150. for a given CM. The CMTS selects the highest priority
  151. encryption algorithm from this list that the CM
  152. supports. By default the following encryption algorithms
  153. are listed from highest to lowest priority (left
  154. being the highest): 128 bit AES, 56 bit DES, 40 bit
  155. DES.
  156. An empty list indicates that the CMTS attempts to use
  157. the latest and robust encryption algorithm supported
  158. by the CM. The CMTS will ignore unknown values or unsupported
  159. algorithms."
  160. DEFVAL { "aes128CbcMode des56CbcMode des40CbcMode" }
  161. ::= { docsSecCmtsEncrypt 1 }
  162. docsSecCmtsCmEaeExclusionTable OBJECT-TYPE
  163. SYNTAX SEQUENCE OF DocsSecCmtsCmEaeExclusionEntry
  164. MAX-ACCESS not-accessible
  165. STATUS current
  166. DESCRIPTION
  167. "This object defines a list of CMs or CM groups to exclude
  168. from Early Authentication and Encryption (EAE).
  169. This object allows overrides to the value of EAE Control
  170. for individual CMs or group of CMs for purposes
  171. such as debugging. The CMTS supports a minimum of
  172. 30 instances of the CmtsCmEaeExclusion object.
  173. This object is only applicable when the EarlyAuthEncryptCtrl
  174. attribute of the MdCfg object is enabled.
  175. This object supports the creation and deletion of multiple
  176. instances."
  177. REFERENCE
  178. "DOCSIS 3.0 Operations Support System Interface
  179. Specification CM-SP-OSSIv3.0-I01-061207,
  180. MdCfg Object Section in the Media Access Control (MAC)
  181. Requirements Annex.
  182. DOCSIS 3.0 Security Specification
  183. CM-SP-SECv3.0-I01-060804, Early Authentication And
  184. Encryption (EAE) Section."
  185. ::= { docsSecMibObjects 3}
  186. docsSecCmtsCmEaeExclusionEntry OBJECT-TYPE
  187. SYNTAX DocsSecCmtsCmEaeExclusionEntry
  188. MAX-ACCESS not-accessible
  189. STATUS current
  190. DESCRIPTION
  191. "The conceptual row of docsSecCmtsCmEaeExclusion.
  192. The CMTS persists all instances of CmtsCmEaeExclusion
  193. across reinitializations."
  194. INDEX {
  195. docsSecCmtsCmEaeExclusionId
  196. }
  197. ::= { docsSecCmtsCmEaeExclusionTable 1 }
  198. DocsSecCmtsCmEaeExclusionEntry ::= SEQUENCE {
  199. docsSecCmtsCmEaeExclusionId
  200. Unsigned32,
  201. docsSecCmtsCmEaeExclusionMacAddr
  202. MacAddress,
  203. docsSecCmtsCmEaeExclusionMacAddrMask
  204. MacAddress,
  205. docsSecCmtsCmEaeExclusionRowStatus
  206. RowStatus
  207. }
  208. docsSecCmtsCmEaeExclusionId OBJECT-TYPE
  209. SYNTAX Unsigned32 (1..4294967295)
  210. MAX-ACCESS not-accessible
  211. STATUS current
  212. DESCRIPTION
  213. "This key uniquely identifies the exclusion MAC address
  214. rule."
  215. ::= { docsSecCmtsCmEaeExclusionEntry 1 }
  216. docsSecCmtsCmEaeExclusionMacAddr OBJECT-TYPE
  217. SYNTAX MacAddress
  218. MAX-ACCESS read-create
  219. STATUS current
  220. DESCRIPTION
  221. "This attribute identifies the CM MAC address. A match
  222. is made when a CM MAC address bitwise ANDed with the
  223. MacAddrMask attribute equals the value of this attribute."
  224. DEFVAL { '000000000000'H }
  225. ::= { docsSecCmtsCmEaeExclusionEntry 2 }
  226. docsSecCmtsCmEaeExclusionMacAddrMask OBJECT-TYPE
  227. SYNTAX MacAddress
  228. MAX-ACCESS read-create
  229. STATUS current
  230. DESCRIPTION
  231. "This attribute identifies the CM MAC address mask
  232. and is used with the MacAddr attribute."
  233. DEFVAL { 'FFFFFFFFFFFF'H }
  234. ::= { docsSecCmtsCmEaeExclusionEntry 3 }
  235. docsSecCmtsCmEaeExclusionRowStatus OBJECT-TYPE
  236. SYNTAX RowStatus
  237. MAX-ACCESS read-create
  238. STATUS current
  239. DESCRIPTION
  240. "Controls and reflects the status of rows in this
  241. table. There is no restriction on changing values in
  242. a row of this table while the row is active."
  243. ::= { docsSecCmtsCmEaeExclusionEntry 4 }
  244. docsSecCmtsSavControl OBJECT IDENTIFIER ::= { docsSecMibObjects 4 }
  245. docsSecCmtsSavControlCmAuthEnable OBJECT-TYPE
  246. SYNTAX TruthValue
  247. MAX-ACCESS read-write
  248. STATUS current
  249. DESCRIPTION
  250. "This attribute enables or disables Source Address
  251. Verification (SAV) for CM configured policies in the
  252. SavCmAuth object. If this attribute is set to 'false',
  253. the CM configured policies in the SavCmAuth object
  254. are ignored.
  255. This attribute is only applicable when the
  256. SrcAddrVerificationEnabled attribute of the MdCfg object is
  257. 'true'."
  258. REFERENCE
  259. "DOCSIS 3.0 Operations Support System Interface
  260. Specification CM-SP-OSSIv3.0-I01-061207,
  261. MdCfg Object Section in the Media Access Control (MAC)
  262. Requirements Annex."
  263. DEFVAL { true }
  264. ::= { docsSecCmtsSavControl 1 }
  265. docsSecSavCmAuthTable OBJECT-TYPE
  266. SYNTAX SEQUENCE OF DocsSecSavCmAuthEntry
  267. MAX-ACCESS not-accessible
  268. STATUS current
  269. DESCRIPTION
  270. "This object defines a read-only set of SAV policies
  271. associated with a CM that the CMTS will use in addition
  272. to the CMTS verification of an operator assigned IP
  273. Address being associated with a CM. When the CMTS has
  274. not resolved a source address of a CM CPE, the CMTS verifies
  275. if the CM CPE is authorized to pass traffic based
  276. on this object. These object policies include a list
  277. of subnet prefixes (defined in the SavStaticList
  278. object) or a SAV Group Name that could reference a CMTS
  279. configured list of subnet prefixes (defined in SavCfgList
  280. object) or vendor-specific policies. The CMTS
  281. populates the attributes of this object for a CM from
  282. that CM's config file.
  283. This object is only applicable when the
  284. SrcAddrVerificationEnabled attribute of the MdCfg object is
  285. 'true' and the CmAuthEnable attribute of the CmtsSavCtrl
  286. object is 'true'.
  287. The CMTS is not required to persist instances of this
  288. object across reinitializations."
  289. REFERENCE
  290. "DOCSIS 3.0 Operations Support System Interface
  291. Specification CM-SP-OSSIv3.0-I01-061207,
  292. MdCfg Object Section in the Media Access Control (MAC)
  293. Requirements Annex.
  294. DOCSIS 3.0 Security Specification
  295. CM-SP-SECv3.0-I01-060804, Secure Provisioning Section.
  296. DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  297. Specification CM-SP-MULPIv3.0-I01-060804,
  298. Common Radio Frequency Interface Encodings Annex."
  299. ::= { docsSecMibObjects 5}
  300. docsSecSavCmAuthEntry OBJECT-TYPE
  301. SYNTAX DocsSecSavCmAuthEntry
  302. MAX-ACCESS not-accessible
  303. STATUS current
  304. DESCRIPTION
  305. "The conceptual row of docsSecSavCmAuth."
  306. INDEX {
  307. docsIf3CmtsCmRegStatusId
  308. }
  309. ::= { docsSecSavCmAuthTable 1 }
  310. DocsSecSavCmAuthEntry ::= SEQUENCE {
  311. docsSecSavCmAuthGrpName
  312. SnmpAdminString,
  313. docsSecSavCmAuthStaticPrefixListId
  314. Unsigned32
  315. }
  316. docsSecSavCmAuthGrpName OBJECT-TYPE
  317. SYNTAX SnmpAdminString
  318. MAX-ACCESS read-only
  319. STATUS current
  320. DESCRIPTION
  321. "This attribute references the Name attribute of the
  322. SavCfgList object of a CM. If the CM signaled group
  323. name is not configured in the CMTS, the CMTS ignores this
  324. attribute value for the purpose of Source Address
  325. Verification. The CMTS must allow the modification
  326. of the GrpName object and use the updated SAV rules for
  327. newly discovered CPEs from CMs. When a source IP address
  328. is claimed by two CMs (e.g., detected as duplicated),
  329. the CMTS must use the current SAV rules defined
  330. for both CMs in case the SAV GrpName rules may have been
  331. updated. In the case of a persisting conflict, it is
  332. up to vendor-implementation to decide what CM should
  333. hold the SAV authorization.
  334. The zero-length string indicates that no SAV Group was
  335. signaled by the CM. The zero-length value or a non-existing
  336. reference in the SavCfgList object means the
  337. SavCfgListName is ignored for the purpose of SAV."
  338. REFERENCE
  339. "DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  340. Specification CM-SP-MULPIv3.0-I01-060804,
  341. Common Radio Frequency Interface Encodings Annex."
  342. ::= { docsSecSavCmAuthEntry 1 }
  343. docsSecSavCmAuthStaticPrefixListId OBJECT-TYPE
  344. SYNTAX Unsigned32
  345. MAX-ACCESS read-only
  346. STATUS current
  347. DESCRIPTION
  348. "This attribute identifies the reference to a CMTS
  349. created subnet prefix list based on the CM signaled static
  350. prefix list TLV elements. The CMTS may reuse this
  351. attribute value to reference more than one CM when
  352. those CMs have signaled the same subnet prefix list to
  353. the CMTS.
  354. The value zero indicates that no SAV static prefix encodings
  355. were signaled by the CM."
  356. ::= { docsSecSavCmAuthEntry 2 }
  357. docsSecSavCfgListTable OBJECT-TYPE
  358. SYNTAX SEQUENCE OF DocsSecSavCfgListEntry
  359. MAX-ACCESS not-accessible
  360. STATUS current
  361. DESCRIPTION
  362. "This object defines the CMTS configured subnet prefix
  363. extension to the SavCmAuth object.
  364. This object supports the creation and deletion of multiple
  365. instances.
  366. Creation of a new instance of this object requires the
  367. PrefixAddrType and PrefixAddr attributes to be set."
  368. ::= { docsSecMibObjects 6}
  369. docsSecSavCfgListEntry OBJECT-TYPE
  370. SYNTAX DocsSecSavCfgListEntry
  371. MAX-ACCESS not-accessible
  372. STATUS current
  373. DESCRIPTION
  374. "The conceptual row of docsSecSavCfgList.
  375. The CMTS persists all instances of SavCfgList
  376. across reinitializations."
  377. INDEX {
  378. docsSecSavCfgListName,
  379. docsSecSavCfgListRuleId
  380. }
  381. ::= { docsSecSavCfgListTable 1 }
  382. DocsSecSavCfgListEntry ::= SEQUENCE {
  383. docsSecSavCfgListName
  384. SnmpAdminString,
  385. docsSecSavCfgListRuleId
  386. Unsigned32,
  387. docsSecSavCfgListPrefixAddrType
  388. InetAddressType,
  389. docsSecSavCfgListPrefixAddr
  390. InetAddress,
  391. docsSecSavCfgListPrefixLen
  392. InetAddressPrefixLength,
  393. docsSecSavCfgListRowStatus
  394. RowStatus
  395. }
  396. docsSecSavCfgListName OBJECT-TYPE
  397. SYNTAX SnmpAdminString (SIZE (1..16))
  398. MAX-ACCESS not-accessible
  399. STATUS current
  400. DESCRIPTION
  401. "This attribute is the key that identifies the instance
  402. of the SavCmAuth object to which this object extension
  403. belongs."
  404. ::= { docsSecSavCfgListEntry 1 }
  405. docsSecSavCfgListRuleId OBJECT-TYPE
  406. SYNTAX Unsigned32 (1..4294967295)
  407. MAX-ACCESS not-accessible
  408. STATUS current
  409. DESCRIPTION
  410. "This attribute is the key that identifies a particular
  411. subnet prefix rule of an instance of this object."
  412. ::= { docsSecSavCfgListEntry 2 }
  413. docsSecSavCfgListPrefixAddrType OBJECT-TYPE
  414. SYNTAX InetAddressType
  415. MAX-ACCESS read-create
  416. STATUS current
  417. DESCRIPTION
  418. "This attribute identifies the IP address type of this
  419. subnet prefix rule."
  420. ::= { docsSecSavCfgListEntry 3 }
  421. docsSecSavCfgListPrefixAddr OBJECT-TYPE
  422. SYNTAX InetAddress
  423. MAX-ACCESS read-create
  424. STATUS current
  425. DESCRIPTION
  426. "This attribute corresponds to the IP address of this
  427. subnet prefix rule in accordance to the PrefixAddrType
  428. attribute."
  429. ::= { docsSecSavCfgListEntry 4 }
  430. docsSecSavCfgListPrefixLen OBJECT-TYPE
  431. SYNTAX InetAddressPrefixLength
  432. MAX-ACCESS read-create
  433. STATUS current
  434. DESCRIPTION
  435. "This attribute defines the length of the subnet prefix
  436. to be matched by this rule."
  437. ::= { docsSecSavCfgListEntry 5 }
  438. docsSecSavCfgListRowStatus OBJECT-TYPE
  439. SYNTAX RowStatus
  440. MAX-ACCESS read-create
  441. STATUS current
  442. DESCRIPTION
  443. "The row creation control of this conceptual row.
  444. An entry in this table can be set to active
  445. only when the following attributes are correctly
  446. assigned:
  447. PrefixAddrType
  448. PrefixAddress
  449. There are no restrictions to modify or delete
  450. entries in this table."
  451. ::= { docsSecSavCfgListEntry 6 }
  452. docsSecSavStaticListTable OBJECT-TYPE
  453. SYNTAX SEQUENCE OF DocsSecSavStaticListEntry
  454. MAX-ACCESS not-accessible
  455. STATUS current
  456. DESCRIPTION
  457. "This object defines a subnet prefix extension to the
  458. SavCmAuth object based on CM statically signaled
  459. subnet prefixes to the CMTS.
  460. When a CM signals to the CMTS static subnet prefixes,
  461. the CMTS must create a List Id to be referenced by the CM
  462. in the SavCmAuth StaticPrefixListId attribute, or
  463. the CMTS may reference an existing List Id associated
  464. to previously registered CMs in case of those subnet
  465. prefixes associated with the List Id match the ones
  466. signaled by the CM."
  467. REFERENCE
  468. "DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  469. Specification CM-SP-MULPIv3.0-I01-060804,
  470. Common Radio Frequency Interface Encodings Annex."
  471. ::= { docsSecMibObjects 7}
  472. docsSecSavStaticListEntry OBJECT-TYPE
  473. SYNTAX DocsSecSavStaticListEntry
  474. MAX-ACCESS not-accessible
  475. STATUS current
  476. DESCRIPTION
  477. "The conceptual row of docsSecSavStaticList.
  478. The CMTS may persist instances of this object
  479. across reinitializations."
  480. INDEX {
  481. docsSecSavStaticListId,
  482. docsSecSavStaticListRuleId
  483. }
  484. ::= { docsSecSavStaticListTable 1 }
  485. DocsSecSavStaticListEntry ::= SEQUENCE {
  486. docsSecSavStaticListId
  487. Unsigned32,
  488. docsSecSavStaticListRuleId
  489. Unsigned32,
  490. docsSecSavStaticListPrefixAddrType
  491. InetAddressType,
  492. docsSecSavStaticListPrefixAddr
  493. InetAddress,
  494. docsSecSavStaticListPrefixLen
  495. InetAddressPrefixLength
  496. }
  497. docsSecSavStaticListId OBJECT-TYPE
  498. SYNTAX Unsigned32 (1..4294967295)
  499. MAX-ACCESS not-accessible
  500. STATUS current
  501. DESCRIPTION
  502. "This key uniquely identifies the index that groups
  503. multiple subnet prefix rules. The CMTS assigns this
  504. value per CM or may reuse it among multiple CMs that share
  505. the same list of subnet prefixes."
  506. ::= { docsSecSavStaticListEntry 1 }
  507. docsSecSavStaticListRuleId OBJECT-TYPE
  508. SYNTAX Unsigned32 (1..4294967295)
  509. MAX-ACCESS not-accessible
  510. STATUS current
  511. DESCRIPTION
  512. "This key identifies a particular static subnet prefix
  513. rule of an instance of this object."
  514. ::= { docsSecSavStaticListEntry 2 }
  515. docsSecSavStaticListPrefixAddrType OBJECT-TYPE
  516. SYNTAX InetAddressType
  517. MAX-ACCESS read-only
  518. STATUS current
  519. DESCRIPTION
  520. "This attribute identifies the IP address type of this
  521. subnet prefix rule."
  522. ::= { docsSecSavStaticListEntry 3 }
  523. docsSecSavStaticListPrefixAddr OBJECT-TYPE
  524. SYNTAX InetAddress
  525. MAX-ACCESS read-only
  526. STATUS current
  527. DESCRIPTION
  528. "This attribute corresponds to the IP address of this
  529. subnet prefix rule in accordance to the PrefixAddrType
  530. attribute."
  531. ::= { docsSecSavStaticListEntry 4 }
  532. docsSecSavStaticListPrefixLen OBJECT-TYPE
  533. SYNTAX InetAddressPrefixLength
  534. MAX-ACCESS read-only
  535. STATUS current
  536. DESCRIPTION
  537. "This attribute defines the length of the subnet prefix
  538. to be matched by this rule."
  539. ::= { docsSecSavStaticListEntry 5 }
  540. docsSecCmtsCmSavStatsTable OBJECT-TYPE
  541. SYNTAX SEQUENCE OF DocsSecCmtsCmSavStatsEntry
  542. MAX-ACCESS not-accessible
  543. STATUS current
  544. DESCRIPTION
  545. "This object provides a read-only list of SAV counters
  546. for different service theft indications."
  547. ::= { docsSecMibObjects 8}
  548. docsSecCmtsCmSavStatsEntry OBJECT-TYPE
  549. SYNTAX DocsSecCmtsCmSavStatsEntry
  550. MAX-ACCESS not-accessible
  551. STATUS current
  552. DESCRIPTION
  553. "The conceptual row of docsSecCmtsCmSavStats."
  554. AUGMENTS { docsIf3CmtsCmRegStatusEntry }
  555. ::= { docsSecCmtsCmSavStatsTable 1 }
  556. DocsSecCmtsCmSavStatsEntry ::= SEQUENCE {
  557. docsSecCmtsCmSavStatsSavDiscards
  558. Counter32
  559. }
  560. docsSecCmtsCmSavStatsSavDiscards OBJECT-TYPE
  561. SYNTAX Counter32
  562. MAX-ACCESS read-only
  563. STATUS current
  564. DESCRIPTION
  565. "This attribute provides the information about number
  566. of dropped upstream packets due to SAV failure."
  567. ::= { docsSecCmtsCmSavStatsEntry 1 }
  568. docsSecCmtsCertificate OBJECT IDENTIFIER ::= { docsSecMibObjects 9 }
  569. docsSecCmtsCertificateCertRevocationMethod OBJECT-TYPE
  570. SYNTAX INTEGER {
  571. none(1),
  572. crl(2),
  573. ocsp(3),
  574. crlAndOcsp(4)
  575. }
  576. MAX-ACCESS read-write
  577. STATUS current
  578. DESCRIPTION
  579. "This attribute identifies which certificate revocation
  580. method is to be used by the CMTS to verify the cable
  581. modem certificate validity. The certificate revocation
  582. methods include Certification Revocation
  583. List (CRL) and Online Certificate Status Protocol
  584. (OCSP).
  585. The following options are available:
  586. The option 'none' indicates that the CMTS does not attempt
  587. to determine the revocation status of a certificate.
  588. The option 'crl' indicates the CMTS uses a Certificate
  589. Revocation List (CRL) as defined by the Url attribute
  590. of the CmtsCertRevocationList object. When the
  591. value of this attribute is changed to 'crl', it triggers
  592. the CMTS to retrieve the CRL from the URL specified
  593. by the Url attribute. If the value of this attribute
  594. is 'crl' when the CMTS starts up, it triggers the CMTS
  595. to retrieve the CRL from the URL specified by the Url attribute.
  596. The option 'ocsp' indicates the CMTS uses the Online
  597. Certificate Status Protocol (OCSP) as defined by the
  598. Url attribute of the CmtsOnlineCertStatusProtocol
  599. object.
  600. The option 'crlAndOcsp' indicates the CMTS uses both
  601. the CRL as defined by the Url attribute in the
  602. CmtsCertRevocationList object and OCSP as defined by the Url
  603. attribute in the CmtsOnlineCertStatusProtocol
  604. object.
  605. The CMTS persists the values of the CertRevocationMethod
  606. attribute across reinitializations."
  607. DEFVAL { none }
  608. ::= { docsSecCmtsCertificate 1 }
  609. docsSecCmtsCertRevocationList OBJECT IDENTIFIER
  610. ::= { docsSecMibObjects 10 }
  611. docsSecCmtsCertRevocationListUrl OBJECT-TYPE
  612. SYNTAX SnmpAdminString
  613. MAX-ACCESS read-write
  614. STATUS current
  615. DESCRIPTION
  616. "This attribute contains the URL from where the CMTS
  617. will retrieve the CRL. When this attribute is set to
  618. a URL value different from the current value, it triggers
  619. the CMTS to retrieve the CRL from that URL. If the
  620. value of this attribute is a zero-length string, the
  621. CMTS does not attempt to retrieve the CRL.
  622. The CMTS persists the value of Url across
  623. reinitializations."
  624. REFERENCE
  625. "DOCSIS 3.0 Security Specification
  626. CM-SP-SECv3.0-I01-060804, BPI+ X.509 Certificate Profile
  627. and Management Section."
  628. DEFVAL { "" }
  629. ::= { docsSecCmtsCertRevocationList 1 }
  630. docsSecCmtsCertRevocationListRefreshInterval OBJECT-TYPE
  631. SYNTAX Unsigned32 (1..524160)
  632. UNITS "minutes"
  633. MAX-ACCESS read-write
  634. STATUS current
  635. DESCRIPTION
  636. "This attribute contains the refresh interval for
  637. the CMTS to retrieve the CRL (referred to in the Url attribute)
  638. with the purpose of updating its Certificate
  639. Revocation List. This attribute is meaningful if
  640. the tbsCertList.nextUpdate attribute does not exist
  641. in the last retrieved CRL, otherwise the value 0 is
  642. returned.
  643. The CMTS persists the value of RefreshInterval across
  644. reinitializations."
  645. REFERENCE
  646. "DOCSIS 3.0 Security Specification
  647. CM-SP-SECv3.0-I01-060804, BPI+ X.509 Certificate Profile
  648. and Management Section."
  649. DEFVAL { 10080 }
  650. ::= { docsSecCmtsCertRevocationList 2 }
  651. docsSecCmtsCertRevocationListLastUpdate OBJECT-TYPE
  652. SYNTAX DateAndTime
  653. MAX-ACCESS read-only
  654. STATUS current
  655. DESCRIPTION
  656. "This attribute contains the last date and time when
  657. the CRL was retrieved by the CMTS.
  658. If the CRL has not been updated, then this variable
  659. shall have the value corresponding to January 1, year
  660. 0000, 00:00:00.0, which is encoded as
  661. (hex)'00 00 01 01 00 00 00 00'."
  662. ::= { docsSecCmtsCertRevocationList 3 }
  663. docsSecCmtsOnlineCertStatusProtocol OBJECT IDENTIFIER
  664. ::= { docsSecMibObjects 11 }
  665. docsSecCmtsOnlineCertStatusProtocolUrl OBJECT-TYPE
  666. SYNTAX SnmpAdminString
  667. MAX-ACCESS read-write
  668. STATUS current
  669. DESCRIPTION
  670. "This attribute contains the URL string to retrieve
  671. OCSP information. If the value of this attribute is
  672. a zero-length string, the CMTS does not attempt to request
  673. the status of a CM certificate.
  674. The CMTS persists the value of Url across
  675. reinitializations."
  676. REFERENCE
  677. "DOCSIS 3.0 Security Specification
  678. CM-SP-SECv3.0-I01-060804, BPI+ X.509 Certificate Profile
  679. and Management Section.
  680. RFC 2560."
  681. DEFVAL { "" }
  682. ::= { docsSecCmtsOnlineCertStatusProtocol 1 }
  683. docsSecCmtsOnlineCertStatusProtocolSignatureBypass OBJECT-TYPE
  684. SYNTAX TruthValue
  685. MAX-ACCESS read-write
  686. STATUS current
  687. DESCRIPTION
  688. "This attribute enables or disables signature checking
  689. on OCSP response messages.
  690. The CMTS persists the value of SignatureBypass across
  691. reinitializations."
  692. REFERENCE
  693. "DOCSIS 3.0 Security Specification
  694. CM-SP-SECv3.0-I01-060804, BPI+ X.509 Certificate Profile
  695. and Management Section.
  696. RFC 2560."
  697. DEFVAL { false }
  698. ::= { docsSecCmtsOnlineCertStatusProtocol 2 }
  699. docsSecCmtsCmBpi2EnforceExclusionTable OBJECT-TYPE
  700. SYNTAX SEQUENCE OF DocsSecCmtsCmBpi2EnforceExclusionEntry
  701. MAX-ACCESS not-accessible
  702. STATUS current
  703. DESCRIPTION
  704. "This object defines a list of CMs or CM groups to exclude from
  705. BPI+ enforcement policies configured within the CMTS. This
  706. object allows overrides to the value of BPI+ enforcement
  707. control for individual CMs or group of CMs for purposes such as
  708. debugging. The CMTS supports a minimum of 30 instances of the
  709. CmtsCmBpi2EnforceExclusion object.
  710. This object supports the creation and deletion of multiple
  711. instances."
  712. REFERENCE
  713. "DOCSIS 3.0 Operations Support System Interface
  714. Specification CM-SP-OSSIv3.0-I11-100115,
  715. MdCfg Object Section in the Media Access Control (MAC)
  716. Requirements Annex.
  717. DOCSIS 3.0 Security Specification
  718. CM-SP-SECv3.0-I12-100115, BPI+ Enforce Section."
  719. ::= { docsSecMibObjects 12}
  720. docsSecCmtsCmBpi2EnforceExclusionEntry OBJECT-TYPE
  721. SYNTAX DocsSecCmtsCmBpi2EnforceExclusionEntry
  722. MAX-ACCESS not-accessible
  723. STATUS current
  724. DESCRIPTION
  725. "The conceptual row of docsSecCmtsCmBpi2EnforceExclusion.
  726. The CMTS persists all instances of CmtsCmBpi2EnforceExclusion
  727. across reinitializations."
  728. INDEX {
  729. docsSecCmtsCmBpi2EnforceExclusionId
  730. }
  731. ::= { docsSecCmtsCmBpi2EnforceExclusionTable 1 }
  732. DocsSecCmtsCmBpi2EnforceExclusionEntry ::= SEQUENCE {
  733. docsSecCmtsCmBpi2EnforceExclusionId
  734. Unsigned32,
  735. docsSecCmtsCmBpi2EnforceExclusionMacAddr
  736. MacAddress,
  737. docsSecCmtsCmBpi2EnforceExclusionMacAddrMask
  738. MacAddress,
  739. docsSecCmtsCmBpi2EnforceExclusionRowStatus
  740. RowStatus
  741. }
  742. docsSecCmtsCmBpi2EnforceExclusionId OBJECT-TYPE
  743. SYNTAX Unsigned32 (1..4294967295)
  744. MAX-ACCESS not-accessible
  745. STATUS current
  746. DESCRIPTION
  747. "This key uniquely identifies the exclusion MAC address
  748. rule."
  749. ::= { docsSecCmtsCmBpi2EnforceExclusionEntry 1 }
  750. docsSecCmtsCmBpi2EnforceExclusionMacAddr OBJECT-TYPE
  751. SYNTAX MacAddress
  752. MAX-ACCESS read-create
  753. STATUS current
  754. DESCRIPTION
  755. "This attribute identifies the CM MAC address. A match
  756. is made when a CM MAC address bitwise ANDed with the
  757. MacAddrMask attribute equals the value of this attribute."
  758. DEFVAL { '000000000000'H }
  759. ::= { docsSecCmtsCmBpi2EnforceExclusionEntry 2 }
  760. docsSecCmtsCmBpi2EnforceExclusionMacAddrMask OBJECT-TYPE
  761. SYNTAX MacAddress
  762. MAX-ACCESS read-create
  763. STATUS current
  764. DESCRIPTION
  765. "This attribute identifies the CM MAC address mask
  766. and is used with the MacAddr attribute."
  767. DEFVAL { 'FFFFFFFFFFFF'H }
  768. ::= { docsSecCmtsCmBpi2EnforceExclusionEntry 3 }
  769. docsSecCmtsCmBpi2EnforceExclusionRowStatus OBJECT-TYPE
  770. SYNTAX RowStatus
  771. MAX-ACCESS read-create
  772. STATUS current
  773. DESCRIPTION
  774. "Controls and reflects the status of rows in this
  775. table. There is no restriction on changing values in
  776. a row of this table while the row is active."
  777. ::= { docsSecCmtsCmBpi2EnforceExclusionEntry 4 }
  778. --
  779. -- DOCS-IETF-BPI2-MIB extension (deprecated)
  780. --
  781. --
  782. docsBpi2CodeUpdateCvcChain OBJECT-TYPE
  783. SYNTAX DocsCvcCaCertificateChain
  784. MAX-ACCESS read-write
  785. STATUS deprecated
  786. DESCRIPTION
  787. "The value of this object is a degenerate PKCS7 signedData
  788. structure that contains the CVC and the CVC CA
  789. certificate chain in the certificates field. Setting
  790. this object triggers the device to verify the CVC and
  791. update the cvcAccessStart values. The content of this
  792. object is then discarded. If the device is not enabled
  793. to upgrade codefiles, or if the CVC verification fails,
  794. the CVC will be rejected. Reading this object always
  795. returns the zero-length OCTET STRING."
  796. REFERENCE
  797. "DOCSIS 3.1 Security Specification, CM-SP-SECv3.1-I02-150326,
  798. Secure Software Download Section"
  799. ::= { docsBpi2CodeDownloadControl 10 }
  800. -- Conformance Definitions
  801. docsSecMibConformance OBJECT IDENTIFIER ::= { docsSecMib 2 }
  802. docsSecMibCompliances OBJECT IDENTIFIER ::= { docsSecMibConformance 1 }
  803. docsSecMibGroups OBJECT IDENTIFIER ::= { docsSecMibConformance 2 }
  804. docsSecCompliance MODULE-COMPLIANCE
  805. STATUS current
  806. DESCRIPTION
  807. "The compliance statement for CMTSs that implement the DOCSIS
  808. Security MIB."
  809. MODULE -- this MODULE
  810. MANDATORY-GROUPS {
  811. docsSecGroup
  812. }
  813. ::= { docsSecMibCompliances 1 }
  814. docsSecCmCompliance MODULE-COMPLIANCE
  815. STATUS deprecated
  816. DESCRIPTION
  817. "The compliance statement for CMs that implement the DOCSIS
  818. Security MIB."
  819. MODULE -- this MODULE
  820. MANDATORY-GROUPS {
  821. docsSecCmGroup
  822. }
  823. ::= { docsSecMibCompliances 2 }
  824. docsSecGroup OBJECT-GROUP
  825. OBJECTS {
  826. docsSecCmtsCertRevocationListUrl,
  827. docsSecCmtsCertRevocationListRefreshInterval,
  828. docsSecCmtsCertRevocationListLastUpdate,
  829. docsSecCmtsOnlineCertStatusProtocolUrl,
  830. docsSecCmtsOnlineCertStatusProtocolSignatureBypass,
  831. docsSecCmtsServerCfgTftpOptions,
  832. docsSecCmtsServerCfgConfigFileLearningEnable,
  833. docsSecCmtsEncryptEncryptAlgPriority,
  834. docsSecCmtsSavControlCmAuthEnable,
  835. docsSecCmtsCmEaeExclusionMacAddr,
  836. docsSecCmtsCmEaeExclusionMacAddrMask,
  837. docsSecCmtsCmEaeExclusionRowStatus,
  838. docsSecSavCmAuthGrpName,
  839. docsSecSavCmAuthStaticPrefixListId,
  840. docsSecSavCfgListPrefixAddrType,
  841. docsSecSavCfgListPrefixAddr,
  842. docsSecSavCfgListPrefixLen,
  843. docsSecSavCfgListRowStatus,
  844. docsSecSavStaticListPrefixAddrType,
  845. docsSecSavStaticListPrefixAddr,
  846. docsSecSavStaticListPrefixLen,
  847. docsSecCmtsCmSavStatsSavDiscards,
  848. docsSecCmtsCertificateCertRevocationMethod,
  849. docsSecCmtsCmBpi2EnforceExclusionMacAddr,
  850. docsSecCmtsCmBpi2EnforceExclusionMacAddrMask,
  851. docsSecCmtsCmBpi2EnforceExclusionRowStatus
  852. }
  853. STATUS current
  854. DESCRIPTION
  855. "Group of objects implemented in the CMTS."
  856. ::= { docsSecMibGroups 1 }
  857. docsSecCmGroup OBJECT-GROUP
  858. OBJECTS {
  859. docsBpi2CodeUpdateCvcChain
  860. }
  861. STATUS deprecated
  862. DESCRIPTION
  863. "Group of objects implemented in the CM."
  864. ::= { docsSecMibGroups 2 }
  865. END