1 tony 1.1 // ===================================================================
2 // Title: Network Filtering 2.8
3 // Filename: Network28_Filtering.mof
4 // Version: 2.8.0
5 // Status: Final
6 // Date: Jan 26, 2004
7 // ===================================================================
8 // Copyright 1998-2003 Distributed Management Task Force, Inc. (DMTF).
9 // All rights reserved.
10 // DMTF is a not-for-profit association of industry members dedicated
11 // to promoting enterprise and systems management and interoperability.
12 // DMTF specifications and documents may be reproduced for uses
13 // consistent with this purpose by members and non-members,
14 // provided that correct attribution is given.
15 // As DMTF specifications may be revised from time to time,
16 // the particular version and release date should always be noted.
17 //
18 // Implementation of certain elements of this standard or proposed
19 // standard may be subject to third party patent rights, including
20 // provisional patent rights (herein "patent rights"). DMTF makes
21 // no representations to users of the standard as to the existence
22 tony 1.1 // of such rights, and is not responsible to recognize, disclose, or
23 // identify any or all such third party patent right, owners or
24 // claimants, nor for any incomplete or inaccurate identification or
25 // disclosure of such rights, owners or claimants. DMTF shall have no
26 // liability to any party, in any manner or circumstance, under any
27 // legal theory whatsoever, for failure to recognize, disclose, or
28 // identify any such third party patent rights, or for such party's
29 // reliance on the standard or incorporation thereof in its product,
30 // protocols or testing procedures. DMTF shall have no liability to
31 // any party implementing such standard, whether such implementation
32 // is foreseeable or not, nor to any patent owner or claimant, and shall
33 // have no liability or responsibility for costs or losses incurred if
34 // a standard is withdrawn or modified after publication, and shall be
35 // indemnified and held harmless by any party implementing the
36 // standard from any and all claims of infringement by a patent owner
37 // for such implementations.
38 //
39 // For information about patents held by third-parties which have
40 // notified the DMTF that, in their opinion, such patent may relate to
41 // or impact implementations of DMTF standards, visit
42 // http://www.dmtf.org/about/policies/disclosures.php.
43 tony 1.1 // ===================================================================
44 // Description: The Network Model extends the management concepts to
45 // represent protocol interfaces and network/protocol
46 // services. This file defines filtering - filter lists
47 // and filter entries.
48 //
49 // The object classes below are listed in an order that
50 // avoids forward references. Required objects, defined
51 // by other working groups, are omitted.
52 // ==================================================================
53 // Change Log for v2.7
54 // CR793 - Add the Abstract qualifier to FilterEntryBase and update
55 // the description
56 // - Update the description for EntriesInFilterList.EntrySequence
57 // - Deprecate FilterEntriesInSystem and FilterListInSystem
58 // - Add HostedFilterEntryBase and HostedFilterList
59 // - Add 8021Filter and PreambleFilter
60 // - FilterEntry.TrafficType needs an Other value in its
61 // enumerated list, and an OtherTrafficType property should be
62 // defined
63 // CR800 - Remove FilterEntry.TrafficClass' ModelCorrespondence
64 tony 1.1 // CR849 - 8021Filter property names must be changed from 8021HdrXXX to
65 // HdrXXX8021 to comply with the CIM Spec
66 // CR867 - Add Override qualifier to FilterEntryBase and
67 // FilterList.Name
68 // CR982 - Removal of Experimental for preliminary to final
69 // CR983 - Deprecations for v2.7 made final
70 // New Log for V2.8
71 // CR1026 - Add class definitions for IPSec
72 // CR1089 - Clarify IsNegated in FilterEntryBase
73 // CR1128 - Change subclassing from CIM_Dependency to
74 // CIM_HostedDependency for identified classes. This is
75 // needed as a result of the introduction of HostedDependency
76 // in SysDev
77 // CR1194 - Classes in the _Filters MOF to be promoted to FINAL status
78 // and their Version qualifiers set to "2.8.0":
79 // X509CredentialFilterEntry
80 // IPSOFilterEntry
81 // PeerIDPayloadFilterEntry
82 //
83 // CR1226 - Change all references to CIM_8021Filter to
84 // CIM_Hdr8021Filter.
85 tony 1.1 // CR1238 - Fix model correspondece reference problems in final version
86 // ===================================================================
87
88 #pragma Locale ("en_US")
89
90
91 // ===================================================================
92 // FilterEntryBase
93 // ===================================================================
94 [Abstract, Version ( "2.7.0" ), Description (
95 "A FilterList aggregates instances of (subclasses of) "
96 "FilterEntryBase via the aggregation EntriesInFilterList. The "
97 "filter entries are always ANDed together when grouped by the "
98 "FilterList. Note that it is possible to aggregate different "
99 "types of filters into a single FilterList - for example, "
100 "packet header filters (represented by the IpHeadersFilter "
101 "class) and IPsec security filters. \n"
102 "\n"
103 "A FilterList is weak to the network device (e.g., the "
104 "ComputerSystem) that contains it. Hence, the ComputerSystem "
105 "keys are propagated to this class.")]
106 tony 1.1 class CIM_FilterEntryBase : CIM_LogicalElement {
107
108 [Key, Propagated ( "CIM_ComputerSystem.CreationClassName" ),
109 Description (
110 "The scoping ComputerSystem's CreationClassName."),
111 MaxLen ( 256 )]
112 string SystemCreationClassName;
113
114 [Key, Propagated ( "CIM_ComputerSystem.Name" ), Description (
115 "The scoping ComputerSystem's Name."),
116 MaxLen ( 256 )]
117 string SystemName;
118
119 [Key, Description (
120 "CreationClassName indicates the name of the class or the "
121 "subclass used in the creation of an instance. When used "
122 "with the other key properties of this class, this property "
123 "allows all instances of this class and its subclasses to be "
124 "uniquely identified."),
125 MaxLen ( 256 )]
126 string CreationClassName;
127 tony 1.1
128 [Key, Override ( "Name" ), Description (
129 "The Name property defines the label by which the Filter "
130 "Entry is known and uniquely identified."),
131 MaxLen ( 256 )]
132 string Name;
133
134 [Description (
135 "Boolean indicating that the match condition described in "
136 "the properties of the FilterEntryBase subclass should be "
137 "negated. This property is defined for ease of use when "
138 "filtering on simple negations - for example, to select all "
139 "source ports except 162. It is not recommended that this "
140 "Boolean be set to True when filtering on multiple criteria, "
141 "such as defining an IPHeadersFilter based on "
142 "source/destination addresses, ports, and DiffServ Code "
143 "Points.")]
144 boolean IsNegated;
145 };
146
147
148 tony 1.1 // ==================================================================
149 // FilterEntry
150 // ==================================================================
151 [Version ( "2.7.0" ), Description (
152 "A FilterEntry is used by network devices to identify traffic "
153 "and either forward it (with possibly further processing) to "
154 "its destination, or to deny its forwarding. It is one of the "
155 "building block of FilterLists. \n"
156 "\n"
157 "This class is oriented towards packet filtering. Other "
158 "subclasses of FilterEntryBase can be defined to do other types "
159 "of filtering. \n"
160 "\n"
161 "A FilterEntry is weak to the network device (i.e., the "
162 "ComputerSystem) that contains it. Hence, the ComputerSystem "
163 "keys are propagated to this class.")]
164 class CIM_FilterEntry : CIM_FilterEntryBase {
165
166 [Description (
167 "This defines the type of traffic that is being filtered. "
168 "This will affect the filtering rules in the MatchCondition "
169 tony 1.1 "property of this class."),
170 ValueMap { "0", "1", "2", "3", "4", "5" },
171 Values { "Unknown", "IPv4", "IPX", "IPv6", "Any", "Other" },
172 ModelCorrespondence { "CIM_FilterEntry.OtherTrafficType" }]
173 uint16 TrafficType;
174
175 [Description (
176 "If the value of the TrafficType property in this class is 5 "
177 "(i.e., \"Other\"), then the specific type of traffic is "
178 "specified in this property."),
179 ModelCorrespondence { "CIM_FilterEntry.TrafficType" }]
180 string OtherTrafficType;
181
182 [Description (
183 "This specifies one of a set of ways to identify traffic. If "
184 "the value is 1 (i.e., \"Other\"), then the specific type of "
185 "filtering is specified in the OtherMatchConditionType "
186 "property of this class."),
187 ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
188 "11", "12", "13" },
189 Values { "Other", "Source Address and Mask",
190 tony 1.1 "Destination Address and Mask", "Source Port",
191 "Source Port Range", "Destination Port",
192 "Destination Port Range", "Protocol Type",
193 "Protocol Type and Option", "DSCP", "ToS Value",
194 "802.1P Priority Value", "Any" },
195 ModelCorrespondence { "CIM_FilterEntry.OtherMatchConditionType"
196 }]
197 uint16 MatchConditionType;
198
199 [Description (
200 "If the value of the MatchConditionType property in this "
201 "class is 1 (i.e., \"Other\"), then the specific type of "
202 "filtering is specified in this property."),
203 ModelCorrespondence { "CIM_FilterEntry.MatchConditionType" }]
204 string OtherMatchConditionType;
205
206 [Description (
207 "This is the value of the condition that filters the "
208 "traffic. It corresponds to the condition specified in the "
209 "MatchConditionType property. If, however, the value of the "
210 "MatchConditionProperty is 1, then it corresponds to the "
211 tony 1.1 "condition specified in the OtherMatchConditionType "
212 "property.")]
213 string MatchConditionValue;
214
215 [Description (
216 "This defines whether the action should be to forward or "
217 "deny traffic meeting the match condition specified in this "
218 "filter."),
219 ValueMap { "1", "2" },
220 Values { "Permit", "Deny" }]
221 uint16 Action;
222
223 [Description (
224 "This defines whether this FilterEntry is the default entry "
225 "to use by its FilterList.")]
226 boolean DefaultFilter;
227
228 [Description (
229 "This defines the traffic class that is being matched by "
230 "this FilterEntry. Note that FilterEntries are aggregated "
231 "into FilterLists by the EntriesInFilterList relationship. "
232 tony 1.1 "If the EntrySequence property of the aggregation is set to "
233 "0, this means that all the Filter Entries should be ANDed "
234 "together. Consequently, the TrafficClass property of each "
235 "of the aggregated Entries should be set to the same value.")]
236 string TrafficClass;
237 };
238
239
240 // ===================================================================
241 // IPHeadersFilter
242 // ===================================================================
243 [Version ( "2.6.0" ), Description (
244 "IPHeadersFilter contains the most commonly required properties "
245 "for performing filtering on IP, TCP or UDP headers. Properties "
246 "not present in an instance of the IPHeadersFilter are treated "
247 "as 'all values'.")]
248 class CIM_IPHeadersFilter : CIM_FilterEntryBase {
249
250 [Description (
251 "HdrIPVersion identifies the version of the IP addresses for "
252 "IP header filters. It is also used to determine the sizes "
253 tony 1.1 "of the OctetStrings in the six properties HdrSrcAddress, "
254 "HdrSrcAddressEndOfRange, HdrSrcMask, HdrDestAddress, "
255 "HdrDestAddressEndOfRange and HdrDestMask, as follows: \n"
256 "ipv4(4): OctetString(SIZE (4)) \n"
257 "ipv6(6): OctetString(SIZE (16|20)), \n"
258 "depending on whether a scope identifier is present. \n"
259 "\n"
260 "If a value for this property is not provided, then the "
261 "filter does not consider IP version in selecting matching "
262 "packets, i.e., IP version matches for all values. In this "
263 "case, the HdrSrcAddress, HdrSrcAddressEndOfRange, "
264 "HdrSrcMask, HdrDestAddress, HdrDestAddressEndOfRange and "
265 "HdrDestMask must also be not present."),
266 ValueMap { "4", "6" },
267 Values { "IPv4", "IPv6" },
268 ModelCorrespondence { "CIM_IPHeadersFilter.HdrSrcAddress",
269 "CIM_IPHeadersFilter.HdrSrcAddressEndOfRange",
270 "CIM_IPHeadersFilter.HdrSrcMask",
271 "CIM_IPHeadersFilter.HdrDestAddress",
272 "CIM_IPHeadersFilter.HdrDestAddressEndOfRange",
273 "CIM_IPHeadersFilter.HdrDestMask" }]
274 tony 1.1 uint8 HdrIPVersion;
275
276 [Description (
277 "HdrSrcAddress is an OctetString, of a size determined by "
278 "the value of the HdrIPVersion property, representing a "
279 "source IP address. When there is no HdrSrcAddressEndOfRange "
280 "value, this value is compared to the source address in the "
281 "IP header, subject to the mask represented in the "
282 "HdrSrcMask property. (Note that the mask is ANDed with the "
283 "address.) When there is a HdrSrcAddressEndOfRange value, "
284 "this value is the start of the specified range (i.e., the "
285 "HdrSrcAddress is lower than the HdrSrcAddressEndOfRange) "
286 "that is compared to the source address in the IP header and "
287 "matches on any value in the range. \n"
288 "\n"
289 "If a value for this property is not provided, then the "
290 "filter does not consider HdrSrcAddress in selecting "
291 "matching packets, i.e., HdrSrcAddress matches for all "
292 "values."),
293 OctetString,
294 ModelCorrespondence { "CIM_IPHeadersFilter.HdrIPVersion" }]
295 tony 1.1 uint8 HdrSrcAddress[];
296
297 [Description (
298 "HdrSrcAddressEndOfRange is an OctetString, of a size "
299 "determined by the value of the HdrIPVersion property, "
300 "representing the end of a range of source IP addresses "
301 "(inclusive), where the start of the range is the "
302 "HdrSrcAddress property value. \n"
303 "\n"
304 "If a value for HdrSrcAddress is not provided, then this "
305 "property also MUST NOT be provided. If a value for this "
306 "property is provided, then HdrSrcMask MUST NOT be provided."),
307 OctetString,
308 ModelCorrespondence { "CIM_IPHeadersFilter.HdrIPVersion" }]
309 uint8 HdrSrcAddressEndOfRange[];
310
311 [Description (
312 "HdrSrcMask is an OctetString, of a size determined by the "
313 "value of the HdrIPVersion property, representing a mask to "
314 "be used in comparing the source address in the IP header "
315 "with the value represented in the HdrSrcAddress property. \n"
316 tony 1.1 "\n"
317 "If a value for this property is not provided, then the "
318 "filter does not consider HdrSrcMask in selecting matching "
319 "packets, i.e., the value of the HdrSrcAddress or the source "
320 "address range must match the source address in the packet "
321 "exactly. If a value for this property is provided, then "
322 "HdrSrcAddressEndOfRange MUST NOT be provided."),
323 OctetString,
324 ModelCorrespondence { "CIM_IPHeadersFilter.HdrIPVersion" }]
325 uint8 HdrSrcMask[];
326
327 [Description (
328 "HdrDestAddress is an OctetString, of a size determined by "
329 "the value of the HdrIPVersion property, representing a "
330 "destination IP address. When there is no "
331 "HdrDestAddressEndOfRange value, this value is compared to "
332 "the destination address in the IP header, subject to the "
333 "mask represented in the HdrDestMask property. (Note that "
334 "the mask is ANDed with the address.) When there is a "
335 "HdrDestAddressEndOfRange value, this value is the start of "
336 "the specified range (i.e., the HdrDestAddress is lower than "
337 tony 1.1 "the HdrDestAddressEndOfRange) that is compared to the "
338 "source address in the IP header and matches on any value in "
339 "the range. \n"
340 "\n"
341 "If a value for this property is not provided, then the "
342 "filter does not consider HdrDestAddress in selecting "
343 "matching packets, i.e., HdrDestAddress matches for all "
344 "values."),
345 OctetString,
346 ModelCorrespondence { "CIM_IPHeadersFilter.HdrIPVersion" }]
347 uint8 HdrDestAddress[];
348
349 [Description (
350 "HdrDestAddressEndOfRange is an OctetString, of a size "
351 "determined by the value of the HdrIPVersion property, "
352 "representing the end of a range of destination IP addresses "
353 "(inclusive), where the start of the range is the "
354 "HdrDestAddress property value. \n"
355 "\n"
356 "If a value for HdrDestAddress is not provided, then this "
357 "property also MUST NOT be provided. If a value for this "
358 tony 1.1 "property is provided, then HdrDestMask MUST NOT be "
359 "provided."),
360 OctetString,
361 ModelCorrespondence { "CIM_IPHeadersFilter.HdrIPVersion" }]
362 uint8 HdrDestAddressEndOfRange[];
363
364 [Description (
365 "HdrDestMask is an OctetString, of a size determined by the "
366 "value of the HdrIPVersion property, representing a mask to "
367 "be used in comparing the destination address in the IP "
368 "header with the value represented in the HdrDestAddress "
369 "property. \n"
370 "\n"
371 "If a value for this property is not provided, then the "
372 "filter does not consider HdrDestMask in selecting matching "
373 "packets, i.e., the value of the HdrDestAddress or the "
374 "destination address range must match the destination "
375 "address in the packet exactly. If a value for this property "
376 "is provided, then HdrDestAddressEndOfRange MUST NOT be "
377 "provided."),
378 OctetString,
379 tony 1.1 ModelCorrespondence { "CIM_IPHeadersFilter.HdrIPVersion" }]
380 uint8 HdrDestMask[];
381
382 [Description (
383 "HdrProtocolID is an 8-bit unsigned integer, representing an "
384 "IP protocol type. This value is compared to the Protocol "
385 "field in the IP header. \n"
386 "\n"
387 "If a value for this property is not provided, then the "
388 "filter does not consider HdrProtocolID in selecting "
389 "matching packets, i.e., HdrProtocolID matches for all "
390 "values.")]
391 uint8 HdrProtocolID;
392
393 [Description (
394 "HdrSrcPortStart represents the lower end of a range of UDP "
395 "or TCP source ports. The upper end of the range is "
396 "represented by the HdrSrcPortEnd property. The value of "
397 "HdrSrcPortStart MUST be no greater than the value of "
398 "HdrSrcPortEnd. \n"
399 "\n"
400 tony 1.1 "A source port filter is evaluated by testing whether the "
401 "source port identified in the IP header falls within the "
402 "range of values between HdrSrcPortStart and HdrSrcPortEnd, "
403 "INCLUDING these two end points. \n"
404 "\n"
405 "If a value for this property is not provided, then the "
406 "filter does not consider HdrSrcPortStart in selecting "
407 "matching packets, i.e., there is no lower bound in matching "
408 "source port values.")]
409 uint16 HdrSrcPortStart;
410
411 [Description (
412 "HdrSrcPortEnd represents the upper end of a range of UDP or "
413 "TCP source ports. The lower end of the range is represented "
414 "by the HdrSrcPortStart property. The value of HdrSrcPortEnd "
415 "MUST be no less than the value of HdrSrcPortStart. A single "
416 "port is indicated by equal values for HdrSrcPortStart and "
417 "HdrSrcPortEnd. \n"
418 "\n"
419 "A source port filter is evaluated by testing whether the "
420 "source port identified in the IP header falls within the "
421 tony 1.1 "range of values between HdrSrcPortStart and HdrSrcPortEnd, "
422 "INCLUDING these two end points. \n"
423 "\n"
424 "If a value for this property is not provided, then the "
425 "filter does not consider HdrSrcPortEnd in selecting "
426 "matching packets, i.e., there is no upper bound in matching "
427 "source port values.")]
428 uint16 HdrSrcPortEnd;
429
430 [Description (
431 "HdrDestPortStart represents the lower end of a range of UDP "
432 "or TCP destination ports. The upper end of the range is "
433 "represented by the HdrDestPortEnd property. The value of "
434 "HdrDestPortStart MUST be no greater than the value of "
435 "HdrDestPortEnd. A single port is indicated by equal values "
436 "for HdrDestPortStart and HdrDestPortEnd. \n"
437 "\n"
438 "A destination port filter is evaluated by testing whether "
439 "the destination port identified in the IP header falls "
440 "within the range of values between HdrDestPortStart and "
441 "HdrDestPortEnd, INCLUDING these two end points. \n"
442 tony 1.1 "\n"
443 "If a value for this property is not provided, then the "
444 "filter does not consider HdrDestPortStart in selecting "
445 "matching packets, i.e., there is no lower bound in matching "
446 "destination port values.")]
447 uint16 HdrDestPortStart;
448
449 [Description (
450 "HdrDestPortEnd represents the upper end of a range of UDP "
451 "or TCP destination ports. The lower end of the range is "
452 "represented by the HdrDestPortStart property. The value of "
453 "HdrDestPortEnd MUST be no less than the value of "
454 "HdrDestPortStart. A single port is indicated by equal "
455 "values for HdrDestPortStart and HdrDestPortEnd. \n"
456 "\n"
457 "A destination port filter is evaluated by testing whether "
458 "the destination port identified in the IP header falls "
459 "within the range of values between HdrDestPortStart and "
460 "HdrDestPortEnd, INCLUDING these two end points. \n"
461 "\n"
462 "If a value for this property is not provided, then the "
463 tony 1.1 "filter does not consider HdrDestPortEnd in selecting "
464 "matching packets, i.e., there is no upper bound in matching "
465 "destination port values.")]
466 uint16 HdrDestPortEnd;
467
468 [Description (
469 "HdrDSCP is defined as a set of discrete DiffServ code "
470 "points, with no inherent structure. There is no "
471 "semantically significant relationship between different "
472 "HdrDSCPs. Consequently, there is no provision for "
473 "specifying a range of HdrDSCPs. \n"
474 "\n"
475 "Since, in IPv4, the HdrDSCP field may contain bits to be "
476 "interpreted as the TOS IP Precedence, this property is also "
477 "used to filter on IP Precedence. Similarly, the IPv6 "
478 "Traffic Class field is also filtered using the value(s) in "
479 "this property. \n"
480 "\n"
481 "HdrDSCP is defined as an array, to provide the ability to "
482 "specify several discrete DSCPs in a single instance of "
483 "IPHeadersFilter, that would be OR'ed together to define the "
484 tony 1.1 "filter criteria. \n"
485 "\n"
486 "If a value for this property is not provided, then the "
487 "filter does not consider HdrDSCP in selecting matching "
488 "packets, i.e., HdrDSCP matches for all values."),
489 MaxValue ( 63 )]
490 uint8 HdrDSCP[];
491
492 [Description (
493 "The 20-bit Flow Label field in the IPv6 header may be used "
494 "by a source to label sequences of packets for which it "
495 "requests special handling by the IPv6 devices, such as "
496 "non-default quality of service or 'real-time' service. In "
497 "the filter, this 20-bit string is encoded in a 24-bit "
498 "octetstring by right-adjusting the value and padding on the "
499 "left with b'0000'. \n"
500 "\n"
501 "If a value for this property is not provided, then the "
502 "filter does not consider HdrFlowLabel in selecting matching "
503 "packets, i.e., HdrFlowLabel matches for all values."),
504 OctetString]
505 tony 1.1 uint8 HdrFlowLabel[];
506 };
507
508
509 // ==================================================================
510 // Hdr8021Filter
511 // ==================================================================
512 [Version ( "2.7.0" ), Description (
513 "8021Filter allows 802.1.source and destination MAC addresses, "
514 "as well as the 802.1 protocol ID, priority, and VLAN "
515 "identifier fields, to be expressed in a single object to "
516 "classify and identify traffic.")]
517 class CIM_Hdr8021Filter : CIM_FilterEntryBase {
518
519 [Description (
520 "This property is an OctetString of size 6, representing a "
521 "48-bit source MAC address in canonical format. This value "
522 "is compared to the SourceAddress field in the MAC header, "
523 "subject to the mask represented in the 8021HdrSrcMACMask "
524 "property. If a value for this property is not provided, "
525 "then the filter does not consider 8021HdrSrcMACAddr in "
526 tony 1.1 "selecting matching packets, i.e., 8021HdrSrcMACAddr matches "
527 "for all values."),
528 OctetString]
529 uint8 HdrSrcMACAddr8021[6];
530
531 [Description (
532 "This property is an OctetString of size 6, representing a "
533 "48-bit mask to be used in comparing the SourceAddress field "
534 "in the MAC header with the value represented in the "
535 "8021HdrSrcMACAddr property. If a value for this property is "
536 "not provided, then the filter does not consider "
537 "8021HdrSrcMACMask in selecting matching packets, i.e., the "
538 "value of 8021HdrSrcMACAddr must match the source MAC "
539 "address in the packet exactly."),
540 OctetString]
541 uint8 HdrSrcMACMask8021[6];
542
543 [Description (
544 "This property is an OctetString of size 6, representing a "
545 "48-bit destination MAC address in canonical format. This "
546 "value is compared to the DestinationAddress field in the "
547 tony 1.1 "MAC header, subject to the mask represented in the "
548 "8021HdrDestMACMask property. If a value for this property "
549 "is not provided, then the filter does not consider "
550 "8021HdrDestMACAddr in selecting matching packets, i.e., "
551 "8021HdrDestMACAddr matches for all values."),
552 OctetString]
553 uint8 HdrDestMACAddr8021[6];
554
555 [Description (
556 "This property is an OctetString of size 6, representing a "
557 "48-bit mask to be used in comparing the DestinationAddress "
558 "field in the MAC header with the value represented in the "
559 "8021HdrDestMACAddr property. If a value for this property "
560 "is not provided, then the filter does not consider "
561 "8021HdrDestMACMask in selecting matching packets, i.e., the "
562 "value of 8021HdrDestMACAddr must match the destination MAC "
563 "address in the packet exactly."),
564 OctetString]
565 uint8 HdrDestMACMask8021[6];
566
567 [Description (
568 tony 1.1 "This property is a 16-bit unsigned integer, representing an "
569 "Ethernet protocol type. This value is compared to the "
570 "Ethernet Type field in the 802.3 MAC header. If a value for "
571 "this property is not provided, then the filter does not "
572 "consider 8021HdrProtocolID in selecting matching packets, "
573 "i.e., 8021HdrProtocolID matches for all values.")]
574 uint16 HdrProtocolID8021;
575
576 [Description (
577 "This property is an 8-bit unsigned integer, representing an "
578 "802.1Q priority. This value is compared to the Priority "
579 "field in the 802.1Q header. Since the 802.1Q Priority field "
580 "consists of 3 bits, the values for this property are "
581 "limited to the range 0..7. If a value for this property is "
582 "not provided, then the filter does not consider "
583 "8021HdrPriorityValue in selecting matching packets, i.e., "
584 "8021HdrPriorityValue matches for all values."),
585 MinValue ( 0 ), MaxValue ( 7 )]
586 uint8 HdrPriorityValue8021;
587
588 [Description (
589 tony 1.1 "This property is an 32-bit unsigned integer, representing "
590 "an 802.1Q VLAN Identifier. This value is compared to the "
591 "VLAN ID field in the 802.1Q header. Since the 802.1Q VLAN "
592 "ID field consists of 12 bits, the values for this property "
593 "are limited to the range 0..4095. If a value for this "
594 "property is not provided, then the filter does not consider "
595 "8021HdrVLANID in selecting matching packets, i.e., "
596 "8021HdrVLANID matches for all values."),
597 MinValue ( 0 ), MaxValue ( 4095 )]
598 uint32 HdrVLANID8021;
599 };
600
601
602 // ==================================================================
603 // PreambleFilter
604 // ==================================================================
605 [Version ( "2.7.0" ), Description (
606 "PreambleFilter allows the classification of packets using "
607 "traffic-conditioning results (where the results are determined "
608 "by a PreambleMarkerService and stored in a 'packet preamble'). "
609 "This permits information about the treatment that a packet "
610 tony 1.1 "receives on an ingress interface to be communicated along with "
611 "the packet to the egress interface. An instance of "
612 "PreambleFilter selects packets based on a two-part string "
613 "(type and value pair) identifying a specific entry in the "
614 "preamble. The logic for this match is 'at least one.' That is, "
615 "a packet with multiple entries/results in its preamble matches "
616 "a filter if at least one of these matches the filter.")]
617 class CIM_PreambleFilter : CIM_FilterEntryBase {
618
619 [Description (
620 "To foster interoperability, the basic format of the "
621 "information captured by a PreambleMarker is specified. That "
622 "information is contained in the FilterItemList property (an "
623 "ordered, string array). Each entry in the array takes the "
624 "form 'type,value'. When entries are added, they are "
625 "appended to the end of the list. \n"
626 "\n"
627 "A limited set of standardized 'type's exist. They are: \n"
628 "- ConformingFromMeter, NonConformingFromMeter and "
629 "PartConformingFromMeter to convey metering results (where "
630 "the 'value' is the name of the meter) \n"
631 tony 1.1 "- VlanId to describe the traffic's VLAN information (where "
632 "the 'value' is the VLAN ID). \n"
633 "An implementation is free to define and use other preamble "
634 "'types'. \n"
635 "\n"
636 "Note that a wildcard value of \"any\" is allowed to "
637 "indicate that the preamble entry matches for any 'value' of "
638 "the specified 'type'. For example, using the wildcard, an "
639 "administrator can define a filter to select all packets "
640 "that were found to be conforming ('type' = "
641 "\"ConformingFromMeter\") without having to name each meter "
642 "individually."),
643 ArrayType ( "Ordered" )]
644 string FilterItemList[];
645 };
646
647
648 // ==================================================================
649 // FilterList
650 // ==================================================================
651 [Version ( "2.7.0" ), Description (
652 tony 1.1 "A FilterList is used by network devices to identify routes by "
653 "aggregating a set of FilterEntries into a unit, called a "
654 "FilterList. FilterLists can also be used to accept or deny "
655 "routing updates. \n"
656 "\n"
657 "A FilterList is weak to the network device (i.e., the "
658 "ComputerSystem) that contains it. Hence, the ComputerSystem "
659 "keys are propagated to this class.")]
660 class CIM_FilterList : CIM_LogicalElement {
661
662 [Key, Propagated ( "CIM_ComputerSystem.CreationClassName" ),
663 Description (
664 "The scoping ComputerSystem's CreationClassName."),
665 MaxLen ( 256 )]
666 string SystemCreationClassName;
667
668 [Key, Propagated ( "CIM_ComputerSystem.Name" ), Description (
669 "The scoping ComputerSystem's Name."),
670 MaxLen ( 256 )]
671 string SystemName;
672
673 tony 1.1 [Key, Description (
674 "The type of class that this instance is.")]
675 string CreationClassName;
676
677 [Key, Override ( "Name" ), Description (
678 "This is the name of the FilterList."),
679 MaxLen ( 256 )]
680 string Name;
681
682 [Description (
683 "This defines whether the FilterList is used for input, "
684 "output, or both input and output filtering. All values are "
685 "used with respect to the interface for which the FilterList "
686 "applies. \n"
687 "\n"
688 "\"Not Applicable\" (0) is used when there is no direction "
689 "applicable to the FilterList. \"Input\" (1) is used when "
690 "the FilterList applies to packets that are inbound on the "
691 "related interface. \"Output\" (2) is used when the "
692 "FilterList applies to packets that are outbound on the "
693 "related interface. \"Both\" (3) is used to indicate that "
694 tony 1.1 "the direction is immaterial, e.g., to filter on a source "
695 "subnet regardless of whether the flow is inbound or "
696 "outbound. \"Mirrored\" (4) is also applicable to both "
697 "inbound and outbound flow processing, but indicates that "
698 "the filter criteria are applied asymmetrically to traffic "
699 "in both directions and, thus, specifies the reversal of "
700 "source and destination criteria (as opposed to the equality "
701 "of these criteria as indicated by \"Both\"). The match "
702 "conditions in the aggregated FilterEntryBase subclass "
703 "instances are defined from the perspective of outbound "
704 "flows and applied to inbound flows as well by reversing the "
705 "source and destination criteria. So, for example, consider "
706 "a FilterList with 3 FilterEntries indicating destination "
707 "port = 80, and source and destination addresses of a and b, "
708 "respectively. Then, for the outbound direction, the filter "
709 "entries match as specified and the 'mirror' (for the "
710 "inbound direction) matches on source port = 80 and source "
711 "and destination addresses of b and a, respectively."),
712 ValueMap { "0", "1", "2", "3", "4" },
713 Values { "Not Applicable", "Input", "Output", "Both",
714 "Mirrored" }]
715 tony 1.1 uint16 Direction;
716 };
717
718
719 // ==================================================================
720 // FilterEntryInSystem
721 // ==================================================================
722 [Association, Deprecated { "CIM_HostedFilterEntryBase" },
723 Aggregation, Version ( "2.7.0" ), Description (
724 "All filter entries (FilterEntryBase and its subclasses) are "
725 "defined in the context of a ComputerSystem/network device, "
726 "where they are used to identify and act on network traffic. "
727 "Note that this class is deprecated since its subclassing is "
728 "not correct. It subclasses from System Component, but a "
729 "FilterEntryBase is NOT a Component of a System. Instead, it is "
730 "hosted/scoped by the System. In versions up to CIM 2.6, "
731 "FilterEntryInSystem was a mandatory, Weak relationship. This "
732 "is no longer true, beginning with CIM V2.7.")]
733 class CIM_FilterEntryInSystem : CIM_SystemComponent {
734
735 [Deprecated { "CIM_HostedFilterEntryBase.Antecedent" }, Aggregate,
736 tony 1.1 Override ( "GroupComponent" ), Max ( 1 ), Description (
737 "The ComputerSystem/network device that scopes the "
738 "FilterEntryBase.")]
739 CIM_ComputerSystem REF GroupComponent;
740
741 [Deprecated { "CIM_HostedFilterEntryBase.Dependent" },
742 Override ( "PartComponent" ), Description (
743 "The FilterEntryBase on the System.")]
744 CIM_FilterEntryBase REF PartComponent;
745 };
746
747
748 // ==================================================================
749 // FilterListInSystem
750 // ==================================================================
751 [Association, Deprecated { "CIM_HostedFilterList" }, Aggregation,
752 Version ( "2.7.0" ), Description (
753 "FilterLists are defined in the context of a ComputerSystem "
754 "(e.g., a router, firewall or host). Note that this class is "
755 "deprecated since its subclassing is not correct. It subclasses "
756 "from SystemComponent, but a FilterList is NOT a Component of a "
757 tony 1.1 "System. Instead, it is hosted/scoped by the System. In "
758 "versions up to CIM 2.6, FilterListInSystem was a mandatory, "
759 "Weak relationship. This is no longer true, beginning with CIM "
760 "V2.7.")]
761 class CIM_FilterListInSystem : CIM_SystemComponent {
762
763 [Deprecated { "CIM_HostedFilterList.Antecedent" }, Aggregate,
764 Override ( "GroupComponent" ), Max ( 1 ), Description (
765 "The ComputerSystem/network device that scopes the "
766 "FilterList and administers it.")]
767 CIM_ComputerSystem REF GroupComponent;
768
769 [Deprecated { "CIM_HostedFilterList.Dependent" },
770 Override ( "PartComponent" ), Description (
771 "The FilterList on the System.")]
772 CIM_FilterList REF PartComponent;
773 };
774
775
776 // ==================================================================
777 // HostedFilterEntryBase
778 tony 1.1 // ==================================================================
779 [Association, Version ( "2.7.0" ), Description (
780 "All filter entries (FilterEntryBase and its subclasses) are "
781 "defined in the context of a ComputerSystem/network device, "
782 "where the filter entries are used and administered.")]
783 class CIM_HostedFilterEntryBase : CIM_HostedDependency {
784
785 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
786 "The ComputerSystem/network device that scopes the "
787 "FilterEntryBase.")]
788 CIM_ComputerSystem REF Antecedent;
789
790 [Override ( "Dependent" ), Weak, Description (
791 "The FilterEntryBase on the System.")]
792 CIM_FilterEntryBase REF Dependent;
793 };
794
795
796 // ==================================================================
797 // HostedFilterList
798 // ==================================================================
799 tony 1.1 [Association, Version ( "2.7.0" ), Description (
800 "FilterLists are defined in the context of a ComputerSystem/ "
801 "network device, where the list is used and administered.")]
802 class CIM_HostedFilterList : CIM_HostedDependency {
803
804 [Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
805 "The ComputerSystem/network device that scopes the "
806 "FilterList.")]
807 CIM_ComputerSystem REF Antecedent;
808
809 [Override ( "Dependent" ), Weak, Description (
810 "The FilterList on the System.")]
811 CIM_FilterList REF Dependent;
812 };
813
814
815 // ==================================================================
816 // EntriesInFilterList
817 // ==================================================================
818 [Association, Aggregation, Version ( "2.7.0" ), Description (
819 "This is a specialization of the CIM_Component aggregation "
820 tony 1.1 "which is used to define a set of filter entries (subclasses of "
821 "FilterEntryBase) that are aggregated by a particular "
822 "FilterList.")]
823 class CIM_EntriesInFilterList : CIM_Component {
824
825 [Aggregate, Override ( "GroupComponent" ), Max ( 1 ),
826 Description (
827 "The FilterList, which aggregates the set of FilterEntries.")]
828 CIM_FilterList REF GroupComponent;
829
830 [Override ( "PartComponent" ), Description (
831 "Any subclass of FilterEntryBase which is a part of the "
832 "FilterList.")]
833 CIM_FilterEntryBase REF PartComponent;
834
835 [Description (
836 "The order of the Entry relative to all others in the "
837 "FilterList. The only permissible value is zero - indicating "
838 "that all the Entries are ANDed together."),
839 ValueMap { "0" }]
840 uint16 EntrySequence = 0;
841 tony 1.1 };
842
843 // ==================================================================
844 // X509CredentialFilterEntry
845 // ==================================================================
846 [Version ( "2.8.0" ), Description (
847 "An X509CredentialFilterEntry allows filtering on the "
848 "attributes of an X.509 certificate. Each instance includes a "
849 "value for MatchFieldName that specifies the particular X.509 "
850 "attribute that is being matched."),
851 MappingStrings { "IPSP Policy Model.IETF|CredentialFilterEntry" }]
852 class CIM_X509CredentialFilterEntry : CIM_FilterEntryBase {
853
854 [Required, Description (
855 "MatchFieldName specifies the X.509 attribute to match "
856 "against MatchFieldValue. Note that this enumeration is "
857 "modified from the IETF's IPSP Policy Model to explicitly "
858 "list the 'standard' X.509 attributes."),
859 ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
860 "..", "x8000.." },
861 Values { "Other", "Version", "Serial Number",
862 tony 1.1 "Signature Algorithm Identifier", "Issuer Name",
863 "Validity Period", "Subject Name", "Subject Public Key Info",
864 "Key Usage", "Alternate Name", "DMTF Reserved",
865 "Vendor Reserved" },
866 MappingStrings { "IPSP Policy Model.IETF|"
867 "CredentialFilterEntry.MatchFieldName" },
868 ModelCorrespondence {
869 "CIM_X509CredentialFilterEntry.MatchFieldValue" }]
870 string MatchFieldName;
871
872 [Required, Description (
873 "MatchFieldValue specifies the value to compare with the "
874 "credential attribute (defined in MatchFieldName), to "
875 "determine if the credential matches this filter entry. An "
876 "implementation must convert this string to a DER- encoded "
877 "string before matching against the values extracted from "
878 "credentials at runtime. \n"
879 "\n"
880 "Note that a wildcard mechanism may be used when "
881 "MatchFieldName specifies a general character string (for "
882 "example, if MatchFieldName=7, 'Subject Name'). "
883 tony 1.1 "MatchFieldValue may contain a wildcard character, '*', in "
884 "the pattern match specification. For example, for 'Subject "
885 "Name', a MatchFieldValue of "
886 "'cn=*,ou=engineering,o=foo,c=be' will successfully match a "
887 "certificate whose subject attribute is "
888 "'cn=JaneDoe,ou=engineering,o=foo,c=be'. A wildcard can be "
889 "used to represent 0 or more characters as would be "
890 "displayed to the user (i.e., a wildcard pattern match "
891 "operates on displayable character boundaries)."),
892 MappingStrings { "IPSP Policy Model.IETF|"
893 "CredentialFilterEntry.MatchFieldName" },
894 ModelCorrespondence {
895 "CIM_X509CredentialFilterEntry.MatchFieldName" }]
896 string MatchFieldValue;
897 };
898
899 // (Note that the IPSOFilterEntry is changed from the IPSP Model
900 // definition -
901 // since the IPSP class allows matching on either classification level
902 // or
903 // protection authority, but not both - and is confusing wrt the
904 tony 1.1 // enumerated
905 // "values" (combining both classification level and protection
906 // authority into
907 // a single enum). Also, the enumerations start at 1 which is reserved
908 // for 'Other',
909 // and should be an array for ProtectionAuthority. These problems are
910 // corrected
911 // in the class below
912
913 // ==================================================================
914 // IPSOFilterEntry
915 // ==================================================================
916 [Version ( "2.8.0" ), Description (
917 "An IPSOFilterEntry is used to match traffic based on the IP "
918 "Security Options header values (ClassificationLevel and "
919 "ProtectionAuthority) as defined in RFC1108. This type of "
920 "FilterEntry is used to adjust the IPsec encryption level "
921 "according to the IPSO classification of the traffic (e.g., "
922 "secret, confidential, restricted, etc.)."),
923 MappingStrings { "IPSP Policy Model.IETF|IPSOFilterEntry" }]
924 class CIM_IPSOFilterEntry : CIM_FilterEntryBase {
925 tony 1.1
926 [Required, Description (
927 "MatchConditionType specifies whether to match based on "
928 "traffic classification level, protection authority or both. "
929 "Note that this enumeration is modified from its definition "
930 "in the IETF's IPSP Policy Model to allow for both "
931 "classification level and protection authority checking, and "
932 "to allow the enumerated value, \"Other\", to be added in "
933 "the future."),
934 ValueMap { "2", "3", "4" },
935 Values { "Classification Level", "Protection Authority",
936 "Both Classification Level and Protection Authority" },
937 MappingStrings { "IPSP Policy Model.IETF|"
938 "IPSOFilterEntry.MatchConditionType" },
939 ModelCorrespondence { "CIM_IPSOFilterEntry.ClassificationLevel",
940 "CIM_IPSOFilterEntry.ProtectionAuthorities" }]
941 uint16 MatchConditionType;
942
943 [Required, Description (
944 "This is the value to be matched when MatchConditionType is "
945 "1 or 3 - meaning that \"Classification Level\" should be "
946 tony 1.1 "filtered. In RFC1108, the following semantics are "
947 "specified: TopSecret, Secret, Confidential, and "
948 "Unclassified. Note that this enumeration's values are "
949 "different than the RFC list and the IETF's IPSP Policy "
950 "Model since those lists are simply bit maps, and do not "
951 "include specific values for \"Other\" or \"No Filtering\"."),
952 ValueMap { "1", "2", "3", "4", "5", "6", "..", "0x8000.." },
953 Values { "Other", "No Filtering on Classification Level",
954 "Top Secret", "Secret", "Confidential", "Unclassified",
955 "DMTF Reserved", "Vendor Reserved" },
956 MappingStrings { "IPSP Policy Model.IETF|"
957 "IPSOFilterEntry.MatchConditionValue",
958 "RFC1108.IETF|Section 2.3" },
959 ModelCorrespondence { "CIM_IPSOFilterEntry.MatchConditionType",
960 "CIM_IPSOFilterEntry.OtherClassificationLevel" }]
961 uint16 ClassificationLevel;
962
963 [Description (
964 "Description of the level when the value 1 (\"Other\") is "
965 "specified for the property, ClassificationLevel."),
966 ModelCorrespondence { "CIM_IPSOFilterEntry.ClassificationLevel"
967 tony 1.1 }]
968 string OtherClassificationLevel;
969
970 [Required, Description (
971 "These are the values to be matched when MatchConditionType "
972 "is 2 or 3 - meaning that \"Protection Authority\" should be "
973 "filtered. In RFC1108, the following authorities are "
974 "specified: GENSER, SIOP-ESI, SCI, NSA and DOE. Note that "
975 "multiple authorities may be specified. \n"
976 "\n"
977 "This enumeration is modified from its definition in the RFC "
978 "and IETF's IPSP Policy Model. Those lists are simply bit "
979 "maps, and do not include specific values for \"Other\" or "
980 "\"No Filtering\"."),
981 ValueMap { "1", "2", "3", "4", "5", "6", "7", "..", "0x8000.." },
982 Values { "Other", "No Filtering on Protection Authority",
983 "GENSER", "SIOP-ESI", "SCI", "NSA", "DOE", "DMTF Reserved",
984 "Vendor Reserved" },
985 MappingStrings { "IPSP Policy Model.IETF|"
986 "IPSOFilterEntry.MatchConditionValue",
987 "RFC1108.IETF|Section 2.4" },
988 tony 1.1 ModelCorrespondence { "CIM_IPSOFilterEntry.MatchConditionType",
989 "CIM_IPSOFilterEntry.OtherProtectionAuthorities" }]
990 uint16 ProtectionAuthorities[];
991
992 [Description (
993 "Description of the authority when the value 1 (\"Other\") "
994 "is specified for the property, ProtectionAuthorities."),
995 ModelCorrespondence {
996 "CIM_IPSOFilterEntry.ProtectionAuthorities" }]
997 string OtherProtectionAuthorities[];
998 };
999
1000
1001 // Note that the PeerIDPayloadFilterEntry is changed from the IPSP Model
1002 // definition - since the 'Type' enumeration starts at 1 in the IPSP
1003 // draft,
1004 // which is reserved for 'Other'
1005
1006
1007 // ==================================================================
1008 // PeerIDPayloadFilterEntry
1009 tony 1.1 // ==================================================================
1010 [Version ( "2.8.0" ), Description (
1011 "PeerIDPayloadFilterEntry defines filters used to match the "
1012 "Identification Type field in the ID Payload of the IKE "
1013 "protocol exchange. It permits the specification of ID values "
1014 "such as \"*@example.com\" or \"192.0.2.0/24\"."),
1015 MappingStrings { "IPSP Policy Model.IETF|PeerIDPayloadFilterEntry"
1016 }]
1017 class CIM_PeerIDPayloadFilterEntry : CIM_FilterEntryBase {
1018
1019 [Required, Description (
1020 "MatchIdentityType specifies the Identification Type "
1021 "provided by the peer in the payload. The list of identities "
1022 "was generated from Section 4.6.2.1 of RFC2407. Note that "
1023 "the enumeration is different than the RFC list, since the "
1024 "value 'Other' is taken into account."),
1025 ValueMap { "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
1026 "11", "12", "..", "0x8000.." },
1027 Values { "Other", "IPV4 Address", "FQDN", "User FQDN",
1028 "IPV4 Subnet Address", "IPV6 Address", "IPV6 Subnet Address",
1029 "IPV4 Address Range", "IPV6 Address Range", "DER ASN1 DN",
1030 tony 1.1 "DER ASN1 GN", "KEY ID", "DMTF Reserved", "Vendor Reserved" },
1031 MappingStrings { "IPSP Policy Model.IETF|"
1032 "PeerIDPayloadFilterEntry.MatchIdentityType",
1033 "RFC2407.IETF|Section 4.6.2.1" },
1034 ModelCorrespondence {
1035 "CIM_PeerIDPayloadFilterEntry.MatchIdentityValue" }]
1036 uint16 MatchIdentityType;
1037
1038 [Required, Description (
1039 "MatchIdentityValue is the filter value for comparison with "
1040 "the ID payload, e,g, \"*@company.com\". The syntax may need "
1041 "to be converted for comparison. For example, if the type of "
1042 "identity is a DER-encoded distinguished name, (for example, "
1043 "MatchIdentityType = 10, \"DER_ASN1_DN\"), the "
1044 "MatchIdentityValue MUST be converted into a DER-encoded "
1045 "string. This allows it to be matched against the values "
1046 "extracted from the ID payload at runtime. \n"
1047 "\n"
1048 "Note that a wildcard mechanism may be used when "
1049 "MatchIdentityType specifies a general character string (for "
1050 "example, if MatchIdentityType=3, 'FQDN'). MatchFieldValue "
1051 tony 1.1 "may contain a wildcard character, '*', in the pattern match "
1052 "specification. For example, for 'FQDN', a MatchFieldValue "
1053 "of '*@example.com' will successfully match an ID payload of "
1054 "'janedoe@example.com'. A wildcard can be used to represent "
1055 "0 or more characters as is appropriate for the type "
1056 "specified in MatchIdentityType."),
1057 MappingStrings { "IPSP Policy Model.IETF|"
1058 "PeerIDPayloadFilterEntry.MatchIdentityValue" },
1059 ModelCorrespondence {
1060 "CIM_PeerIDPayloadFilterEntry.MatchIdentityType" }]
1061 string MatchIdentityValue;
1062 };
1063
1064 // ===================================================================
1065 // end of file
1066 // ===================================================================
|
Return to
Network28_Filtering.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM28