| OID symbolic | OID numeric | Type | Access | Description |
|---|
| snmpTlstmMIB | 1.3.6.1.2.1.198 | | | The TLS Transport Model MIB
Copyright (c) 2010-2011 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info). |
| snmpTlstmNotifications | 1.3.6.1.2.1.198.0 | | | |
| NTF snmpTlstmServerCertificateUnknown | 1.3.6.1.2.1.198.0.1 | | | Notification that the server certificate presented by an SNMP
over (D)TLS server was invalid because no configured
fingerprint or CA was acceptable to validate it. This may be
because there was no entry in the snmpTlstmAddrTable or
because no path could be found to known Certification
Authority.
To avoid notification loops, this notification MUST NOT be
sent to servers that themselves have triggered the
notification. |
| NTF snmpTlstmServerInvalidCertificate | 1.3.6.1.2.1.198.0.2 | | | Notification that the server certificate presented by an SNMP
over (D)TLS server could not be validated even if the
fingerprint or expected validation path was known. That is, a
cryptographic validation error occurred during certificate
validation processing.
To avoid notification loops, this notification MUST NOT be
sent to servers that themselves have triggered the
notification. |
| snmpTlstmIdentities | 1.3.6.1.2.1.198.1 | | | |
| snmpTlstmCertToTSNMIdentities | 1.3.6.1.2.1.198.1.1 | | | |
| snmpTlstmCertSpecified | 1.3.6.1.2.1.198.1.1.1 | | | Directly specifies the tmSecurityName to be used for
this certificate. The value of the tmSecurityName
to use is specified in the snmpTlstmCertToTSNData
column. The snmpTlstmCertToTSNData column must
contain a non-zero length SnmpAdminString compliant
value or the mapping described in this row must be
considered a failure. |
| snmpTlstmCertSANRFC822Name | 1.3.6.1.2.1.198.1.1.2 | | | Maps a subjectAltName's rfc822Name to a
tmSecurityName. The local part of the rfc822Name is
passed unaltered but the host-part of the name must
be passed in lowercase. This mapping results in a
1:1 correspondence between equivalent subjectAltName
rfc822Name values and tmSecurityName values except
that the host-part of the name MUST be passed in
lowercase.
Example rfc822Name Field: FooBar@Example.COM
is mapped to tmSecurityName: FooBar@example.com. |
| snmpTlstmCertSANDNSName | 1.3.6.1.2.1.198.1.1.3 | | | Maps a subjectAltName's dNSName to a
tmSecurityName after first converting it to all
lowercase (RFC 5280 does not specify converting to
lowercase so this involves an extra step). This
mapping results in a 1:1 correspondence between
subjectAltName dNSName values and the tmSecurityName
values. |
| snmpTlstmCertSANIpAddress | 1.3.6.1.2.1.198.1.1.4 | | | Maps a subjectAltName's iPAddress to a
tmSecurityName by transforming the binary encoded
address as follows:
1) for IPv4, the value is converted into a
decimal-dotted quad address (e.g., '192.0.2.1').
2) for IPv6 addresses, the value is converted into a
32-character all lowercase hexadecimal string
without any colon separators.
This mapping results in a 1:1 correspondence between
subjectAltName iPAddress values and the
tmSecurityName values.
The resulting length of an encoded IPv6 address is
the maximum length supported by the View-Based
Access Control Model (VACM). Using both the
Transport Security Model's support for transport
prefixes (see the SNMP-TSM-MIB's
snmpTsmConfigurationUsePrefix object for details)
will result in securityName lengths that exceed what
VACM can handle. |
| snmpTlstmCertSANAny | 1.3.6.1.2.1.198.1.1.5 | | | Maps any of the following fields using the
corresponding mapping algorithms:
|------------+----------------------------|
| Type | Algorithm |
|------------+----------------------------|
| rfc822Name | snmpTlstmCertSANRFC822Name |
| dNSName | snmpTlstmCertSANDNSName |
| iPAddress | snmpTlstmCertSANIpAddress |
|------------+----------------------------|
The first matching subjectAltName value found in the
certificate of the above types MUST be used when
deriving the tmSecurityName. The mapping algorithm
specified in the 'Algorithm' column MUST be used to
derive the tmSecurityName.
This mapping results in a 1:1 correspondence between
subjectAltName values and tmSecurityName values. The
three sub-mapping algorithms produced by this
combined algorithm cannot produce conflicting
results between themselves. |
| snmpTlstmCertCommonName | 1.3.6.1.2.1.198.1.1.6 | | | Maps a certificate's CommonName to a tmSecurityName
after converting it to a UTF-8 encoding. The usage
of CommonNames is deprecated and users are
encouraged to use subjectAltName mapping methods
instead. This mapping results in a 1:1
correspondence between certificate CommonName values
and tmSecurityName values. |
| snmpTlstmObjects | 1.3.6.1.2.1.198.2 | | | |
| snmpTlstmSession | 1.3.6.1.2.1.198.2.1 | | | |
| C32 snmpTlstmSessionOpensEx | 1.3.6.1.2.1.198.2.1.1 | Counter32 | read-only | The number of times an openSession() request has been executed
as a (D)TLS client, regardless of whether it succeeded or
failed. |
| C32 snmpTlstmSessionClientCloses | 1.3.6.1.2.1.198.2.1.2 | Counter32 | read-only | The number of times a closeSession() request has been
executed as a (D)TLS client, regardless of whether it
succeeded or failed. |
| C32 snmpTlstmSessionOpenErrors | 1.3.6.1.2.1.198.2.1.3 | Counter32 | read-only | The number of times an openSession() request failed to open a
session as a (D)TLS client, for any reason. |
| C32 snmpTlstmSessionAccepts | 1.3.6.1.2.1.198.2.1.4 | Counter32 | read-only | The number of times a (D)TLS server has accepted a new
connection from a client and has received at least one SNMP
message through it. |
| C32 snmpTlstmSessionServerCloses | 1.3.6.1.2.1.198.2.1.5 | Counter32 | read-only | The number of times a closeSession() request has been
executed as a (D)TLS server, regardless of whether it
succeeded or failed. |
| C32 snmpTlstmSessionNoSessions | 1.3.6.1.2.1.198.2.1.6 | Counter32 | read-only | The number of times an outgoing message was dropped because
the session associated with the passed tmStateReference was no
longer (or was never) available. |
| C32 snmpTlstmSessionInvalidClientCertificates | 1.3.6.1.2.1.198.2.1.7 | Counter32 | read-only | The number of times an incoming session was not established
on a (D)TLS server because the presented client certificate
was invalid. Reasons for invalidation include, but are not
limited to, cryptographic validation failures or lack of a
suitable mapping row in the snmpTlstmCertToTSNTable. |
| C32 snmpTlstmSessionUnknownServerCertificate | 1.3.6.1.2.1.198.2.1.8 | Counter32 | read-only | The number of times an outgoing session was not established
on a (D)TLS client because the server certificate presented
by an SNMP over (D)TLS server was invalid because no
configured fingerprint or Certification Authority (CA) was
acceptable to validate it.
This may result because there was no entry in the
snmpTlstmAddrTable or because no path could be found to a
known CA. |
| C32 snmpTlstmSessionInvalidServerCertificates | 1.3.6.1.2.1.198.2.1.9 | Counter32 | read-only | The number of times an outgoing session was not established
on a (D)TLS client because the server certificate presented
by an SNMP over (D)TLS server could not be validated even if
the fingerprint or expected validation path was known. That
is, a cryptographic validation error occurred during
certificate validation processing.
Reasons for invalidation include, but are not
limited to, cryptographic validation failures. |
| C32 snmpTlstmSessionInvalidCaches | 1.3.6.1.2.1.198.2.1.10 | Counter32 | read-only | The number of outgoing messages dropped because the
tmStateReference referred to an invalid cache. |
| snmpTlstmConfig | 1.3.6.1.2.1.198.2.2 | | | |
| snmpTlstmCertificateMapping | 1.3.6.1.2.1.198.2.2.1 | | | |
| G32 snmpTlstmCertToTSNCount | 1.3.6.1.2.1.198.2.2.1.1 | Gauge32 | read-only | A count of the number of entries in the
snmpTlstmCertToTSNTable. |
| TIM snmpTlstmCertToTSNTableLastChanged | 1.3.6.1.2.1.198.2.2.1.2 | TimeStamp | read-only | The value of sysUpTime.0 when the snmpTlstmCertToTSNTable was
last modified through any means, or 0 if it has not been
modified since the command responder was started. |
| snmpTlstmCertToTSNTable | 1.3.6.1.2.1.198.2.2.1.3 | | not-accessible | This table is used by a (D)TLS server to map the (D)TLS
client's presented X.509 certificate to a tmSecurityName.
On an incoming (D)TLS/SNMP connection, the client's presented
certificate must either be validated based on an established
trust anchor, or it must directly match a fingerprint in this
table. This table does not provide any mechanisms for
configuring the trust anchors; the transfer of any needed
trusted certificates for path validation is expected to occur
through an out-of-band transfer.
Once the certificate has been found acceptable (either by path
validation or directly matching a fingerprint in this table),
this table is consulted to determine the appropriate
tmSecurityName to identify with the remote connection. This
is done by considering each active row from this table in
prioritized order according to its snmpTlstmCertToTSNID value.
Each row's snmpTlstmCertToTSNFingerprint value determines
whether the row is a match for the incoming connection:
1) If the row's snmpTlstmCertToTSNFingerprint value
identifies the presented certificate, then consider the
row as a successful match.
2) If the row's snmpTlstmCertToTSNFingerprint value
identifies a locally held copy of a trusted CA
certificate and that CA certificate was used to
validate the path to the presented certificate, then
consider the row as a successful match.
Once a matching row has been found, the
snmpTlstmCertToTSNMapType value can be used to determine how
the tmSecurityName to associate with the session should be
determined. See the snmpTlstmCertToTSNMapType column's
DESCRIPTION for details on determining the tmSecurityName
value. If it is impossible to determine a tmSecurityName from
the row's data combined with the data presented in the
certificate, then additional rows MUST be searched looking for
another potential match. If a resulting tmSecurityName mapped
from a given row is not compatible with the needed
requirements of a tmSecurityName (e.g., VACM imposes a
32-octet-maximum length and the certificate derived
securityName could be longer), then it must be considered an
invalid match and additional rows MUST be searched looking for
another potential match.
If no matching and valid row can be found, the connection MUST
be closed and SNMP messages MUST NOT be accepted over it.
Missing values of snmpTlstmCertToTSNID are acceptable and
implementations should continue to the next highest numbered
row. It is recommended that administrators skip index values
to leave room for the insertion of future rows (for example,
use values of 10 and 20 when creating initial rows).
Users are encouraged to make use of certificates with
subjectAltName fields that can be used as tmSecurityNames so
that a single root CA certificate can allow all child
certificate's subjectAltName to map directly to a
tmSecurityName via a 1:1 transformation. However, this table
is flexible to allow for situations where existing deployed
certificate infrastructures do not provide adequate
subjectAltName values for use as tmSecurityNames.
Certificates may also be mapped to tmSecurityNames using the
CommonName portion of the Subject field. However, the usage
of the CommonName field is deprecated and thus this usage is
NOT RECOMMENDED. Direct mapping from each individual
certificate fingerprint to a tmSecurityName is also possible
but requires one entry in the table per tmSecurityName and
requires more management operations to completely configure a
device. |
| snmpTlstmCertToTSNEntry | 1.3.6.1.2.1.198.2.2.1.3.1 | | not-accessible | A row in the snmpTlstmCertToTSNTable that specifies a mapping
for an incoming (D)TLS certificate to a tmSecurityName to use
for a connection. |
| U32 snmpTlstmCertToTSNID | 1.3.6.1.2.1.198.2.2.1.3.1.1 | Unsigned32 | not-accessible | A unique, prioritized index for the given entry. Lower
numbers indicate a higher priority. |
| NUM snmpTlstmCertToTSNFingerprint | 1.3.6.1.2.1.198.2.2.1.3.1.2 | SnmpTLSFingerprint | read-create | A cryptographic hash of an X.509 certificate. The results of
a successful matching fingerprint to either the trusted CA in
the certificate validation path or to the certificate itself
is dictated by the snmpTlstmCertToTSNMapType column. |
| OID snmpTlstmCertToTSNMapType | 1.3.6.1.2.1.198.2.2.1.3.1.3 | AutonomousType | read-create | Specifies the mapping type for deriving a tmSecurityName from
a certificate. Details for mapping of a particular type SHALL
be specified in the DESCRIPTION clause of the OBJECT-IDENTITY
that describes the mapping. If a mapping succeeds it will
return a tmSecurityName for use by the TLSTM model and
processing stops.
If the resulting mapped value is not compatible with the
needed requirements of a tmSecurityName (e.g., VACM imposes a
32-octet-maximum length and the certificate derived
securityName could be longer), then future rows MUST be
searched for additional snmpTlstmCertToTSNFingerprint matches
to look for a mapping that succeeds.
Suitable values for assigning to this object that are defined
within the SNMP-TLS-TM-MIB can be found in the
snmpTlstmCertToTSNMIdentities portion of the MIB tree. |
| OCT snmpTlstmCertToTSNData | 1.3.6.1.2.1.198.2.2.1.3.1.4 | OCTET STRING | read-create | Auxiliary data used as optional configuration information for
a given mapping specified by the snmpTlstmCertToTSNMapType
column. Only some mapping systems will make use of this
column. The value in this column MUST be ignored for any
mapping type that does not require data present in this
column. |
| STO snmpTlstmCertToTSNStorageType | 1.3.6.1.2.1.198.2.2.1.3.1.5 | StorageType | read-create | The storage type for this conceptual row. Conceptual rows
having the value 'permanent' need not allow write-access to
any columnar objects in the row. |
| ROW snmpTlstmCertToTSNRowStatus | 1.3.6.1.2.1.198.2.2.1.3.1.6 | RowStatus | read-create | The status of this conceptual row. This object may be used
to create or remove rows from this table.
To create a row in this table, an administrator must set this
object to either createAndGo(4) or createAndWait(5).
Until instances of all corresponding columns are appropriately
configured, the value of the corresponding instance of the
snmpTlstmParamsRowStatus column is notReady(3).
In particular, a newly created row cannot be made active until
the corresponding snmpTlstmCertToTSNFingerprint,
snmpTlstmCertToTSNMapType, and snmpTlstmCertToTSNData columns
have been set.
The following objects may not be modified while the
value of this object is active(1):
- snmpTlstmCertToTSNFingerprint
- snmpTlstmCertToTSNMapType
- snmpTlstmCertToTSNData
An attempt to set these objects while the value of
snmpTlstmParamsRowStatus is active(1) will result in
an inconsistentValue error. |
| G32 snmpTlstmParamsCount | 1.3.6.1.2.1.198.2.2.1.4 | Gauge32 | read-only | A count of the number of entries in the snmpTlstmParamsTable. |
| TIM snmpTlstmParamsTableLastChanged | 1.3.6.1.2.1.198.2.2.1.5 | TimeStamp | read-only | The value of sysUpTime.0 when the snmpTlstmParamsTable
was last modified through any means, or 0 if it has not been
modified since the command responder was started. |
| snmpTlstmParamsTable | 1.3.6.1.2.1.198.2.2.1.6 | | not-accessible | This table is used by a (D)TLS client when a (D)TLS
connection is being set up using an entry in the
SNMP-TARGET-MIB. It extends the SNMP-TARGET-MIB's
snmpTargetParamsTable with a fingerprint of a certificate to
use when establishing such a (D)TLS connection. |
| snmpTlstmParamsEntry | 1.3.6.1.2.1.198.2.2.1.6.1 | | not-accessible | A conceptual row containing a fingerprint hash of a locally
held certificate for a given snmpTargetParamsEntry. The
values in this row should be ignored if the connection that
needs to be established, as indicated by the SNMP-TARGET-MIB
infrastructure, is not a certificate and (D)TLS based
connection. The connection SHOULD NOT be established if the
certificate fingerprint stored in this entry does not point to
a valid locally held certificate or if it points to an
unusable certificate (such as might happen when the
certificate's expiration date has been reached). |
| NUM snmpTlstmParamsClientFingerprint | 1.3.6.1.2.1.198.2.2.1.6.1.1 | SnmpTLSFingerprint | read-create | This object stores the hash of the public portion of a
locally held X.509 certificate. The X.509 certificate, its
public key, and the corresponding private key will be used
when initiating a (D)TLS connection as a (D)TLS client. |
| STO snmpTlstmParamsStorageType | 1.3.6.1.2.1.198.2.2.1.6.1.2 | StorageType | read-create | The storage type for this conceptual row. Conceptual rows
having the value 'permanent' need not allow write-access to
any columnar objects in the row. |
| ROW snmpTlstmParamsRowStatus | 1.3.6.1.2.1.198.2.2.1.6.1.3 | RowStatus | read-create | The status of this conceptual row. This object may be used
to create or remove rows from this table.
To create a row in this table, an administrator must set this
object to either createAndGo(4) or createAndWait(5).
Until instances of all corresponding columns are appropriately
configured, the value of the corresponding instance of the
snmpTlstmParamsRowStatus column is notReady(3).
In particular, a newly created row cannot be made active until
the corresponding snmpTlstmParamsClientFingerprint column has
been set.
The snmpTlstmParamsClientFingerprint object may not be modified
while the value of this object is active(1).
An attempt to set these objects while the value of
snmpTlstmParamsRowStatus is active(1) will result in
an inconsistentValue error. |
| G32 snmpTlstmAddrCount | 1.3.6.1.2.1.198.2.2.1.7 | Gauge32 | read-only | A count of the number of entries in the snmpTlstmAddrTable. |
| TIM snmpTlstmAddrTableLastChanged | 1.3.6.1.2.1.198.2.2.1.8 | TimeStamp | read-only | The value of sysUpTime.0 when the snmpTlstmAddrTable
was last modified through any means, or 0 if it has not been
modified since the command responder was started. |
| snmpTlstmAddrTable | 1.3.6.1.2.1.198.2.2.1.9 | | not-accessible | This table is used by a (D)TLS client when a (D)TLS
connection is being set up using an entry in the
SNMP-TARGET-MIB. It extends the SNMP-TARGET-MIB's
snmpTargetAddrTable so that the client can verify that the
correct server has been reached. This verification can use
either a certificate fingerprint, or an identity
authenticated via certification path validation.
If there is an active row in this table corresponding to the
entry in the SNMP-TARGET-MIB that was used to establish the
connection, and the row's snmpTlstmAddrServerFingerprint
column has non-empty value, then the server's presented
certificate is compared with the
snmpTlstmAddrServerFingerprint value (and the
snmpTlstmAddrServerIdentity column is ignored). If the
fingerprint matches, the verification has succeeded. If the
fingerprint does not match, then the connection MUST be
closed.
If the server's presented certificate has passed
certification path validation [RFC5280] to a configured
trust anchor, and an active row exists with a zero-length
snmpTlstmAddrServerFingerprint value, then the
snmpTlstmAddrServerIdentity column contains the expected
host name. This expected host name is then compared against
the server's certificate as follows:
- Implementations MUST support matching the expected host
name against a dNSName in the subjectAltName extension
field and MAY support checking the name against the
CommonName portion of the subject distinguished name.
- The '*' (ASCII 0x2a) wildcard character is allowed in the
dNSName of the subjectAltName extension (and in common
name, if used to store the host name), but only as the
left-most (least significant) DNS label in that value.
This wildcard matches any left-most DNS label in the
server name. That is, the subject *.example.com matches
the server names a.example.com and b.example.com, but does
not match example.com or a.b.example.com. Implementations
MUST support wildcards in certificates as specified above,
but MAY provide a configuration option to disable them.
- If the locally configured name is an internationalized
domain name, conforming implementations MUST convert it to
the ASCII Compatible Encoding (ACE) format for performing
comparisons, as specified in Section 7 of [RFC5280].
If the expected host name fails these conditions then the
connection MUST be closed.
If there is no row in this table corresponding to the entry
in the SNMP-TARGET-MIB and the server can be authorized by
another, implementation-dependent means, then the connection
MAY still proceed. |
| snmpTlstmAddrEntry | 1.3.6.1.2.1.198.2.2.1.9.1 | | not-accessible | A conceptual row containing a copy of a certificate's
fingerprint for a given snmpTargetAddrEntry. The values in
this row should be ignored if the connection that needs to be
established, as indicated by the SNMP-TARGET-MIB
infrastructure, is not a (D)TLS based connection. If an
snmpTlstmAddrEntry exists for a given snmpTargetAddrEntry, then
the presented server certificate MUST match or the connection
MUST NOT be established. If a row in this table does not
exist to match an snmpTargetAddrEntry row, then the connection
SHOULD still proceed if some other certificate validation path
algorithm (e.g., RFC 5280) can be used. |
| NUM snmpTlstmAddrServerFingerprint | 1.3.6.1.2.1.198.2.2.1.9.1.1 | SnmpTLSFingerprint | read-create | A cryptographic hash of a public X.509 certificate. This
object should store the hash of the public X.509 certificate
that the remote server should present during the (D)TLS
connection setup. The fingerprint of the presented
certificate and this hash value MUST match exactly or the
connection MUST NOT be established. |
| STR snmpTlstmAddrServerIdentity | 1.3.6.1.2.1.198.2.2.1.9.1.2 | SnmpAdminString | read-create | The reference identity to check against the identity
presented by the remote system. |
| STO snmpTlstmAddrStorageType | 1.3.6.1.2.1.198.2.2.1.9.1.3 | StorageType | read-create | The storage type for this conceptual row. Conceptual rows
having the value 'permanent' need not allow write-access to
any columnar objects in the row. |
| ROW snmpTlstmAddrRowStatus | 1.3.6.1.2.1.198.2.2.1.9.1.4 | RowStatus | read-create | The status of this conceptual row. This object may be used
to create or remove rows from this table.
To create a row in this table, an administrator must set this
object to either createAndGo(4) or createAndWait(5).
Until instances of all corresponding columns are
appropriately configured, the value of the
corresponding instance of the snmpTlstmAddrRowStatus
column is notReady(3).
In particular, a newly created row cannot be made active until
the corresponding snmpTlstmAddrServerFingerprint column has been
set.
Rows MUST NOT be active if the snmpTlstmAddrServerFingerprint
column is blank and the snmpTlstmAddrServerIdentity is set to
'*' since this would insecurely accept any presented
certificate.
The snmpTlstmAddrServerFingerprint object may not be modified
while the value of this object is active(1).
An attempt to set these objects while the value of
snmpTlstmAddrRowStatus is active(1) will result in
an inconsistentValue error. |
| snmpTlstmConformance | 1.3.6.1.2.1.198.3 | | | |
| snmpTlstmCompliances | 1.3.6.1.2.1.198.3.1 | | | |
| snmpTlstmCompliance | 1.3.6.1.2.1.198.3.1.1 | | | The compliance statement for SNMP engines that support the
SNMP-TLS-TM-MIB |
| snmpTlstmGroups | 1.3.6.1.2.1.198.3.2 | | | |
| snmpTlstmStatsGroup | 1.3.6.1.2.1.198.3.2.1 | | | A collection of objects for maintaining
statistical information of an SNMP engine that
implements the SNMP TLS Transport Model. |
| snmpTlstmIncomingGroup | 1.3.6.1.2.1.198.3.2.2 | | | A collection of objects for maintaining
incoming connection certificate mappings to
tmSecurityNames of an SNMP engine that implements the
SNMP TLS Transport Model. |
| snmpTlstmOutgoingGroup | 1.3.6.1.2.1.198.3.2.3 | | | A collection of objects for maintaining
outgoing connection certificates to use when opening
connections as a result of SNMP-TARGET-MIB settings. |
| snmpTlstmNotificationGroup | 1.3.6.1.2.1.198.3.2.4 | | | Notifications |
| snmpTLSTCPDomain | 1.3.6.1.6.1.8 | | | The SNMP over TLS via TCP transport domain. The
corresponding transport address is of type SnmpTLSAddress.
The securityName prefix to be associated with the
snmpTLSTCPDomain is 'tls'. This prefix may be used by
security models or other components to identify which secure
transport infrastructure authenticated a securityName. |
| snmpDTLSUDPDomain | 1.3.6.1.6.1.9 | | | The SNMP over DTLS via UDP transport domain. The
corresponding transport address is of type SnmpTLSAddress.
The securityName prefix to be associated with the
snmpDTLSUDPDomain is 'dtls'. This prefix may be used by
security models or other components to identify which secure
transport infrastructure authenticated a securityName. |
