Skip to content

Commit 06f0fe5

Browse files
committed
UniRec output: config file: add structured field examples, align TLS fields
1 parent 87d11c5 commit 06f0fe5

File tree

1 file changed

+38
-30
lines changed

1 file changed

+38
-30
lines changed

extra_plugins/output/unirec/config/unirec-elements.txt

Lines changed: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@
44
# fields. You can change setting by editing this file. Each entry consists
55
# of the following parameters:
66
# - UniRec field name
7-
# - UniRec data type (int{8,16,32,64}, uint{8,16,32,64}, float, double, time,
8-
# ipaddr, macaddr, char, string, bytes)
7+
# - UniRec data type - one of the following:
8+
# int{8,16,32,64}, uint{8,16,32,64},
9+
# float, double, time, ipaddr, macaddr, char, string, bytes
10+
# int{8,16,32,64}*, uint{8,16,32,64}*, // "array of" types
11+
# float*, double*, time*, ipaddr*, macaddr* // "array of" types
12+
# string_trimmed // trimmed string (i.e. no tailing '\0')
913
# - Comma separated list of IPFIX Information Elements identifiers
1014
# ("eXXidYY" where XX is Private Enterprise Number and YY is field ID)
1115
#
@@ -118,32 +122,36 @@ IPV6_TUN_TYPE uint8 e16982id405 # IPv6 tunnel type
118122
APP_ID bytes e0id95 # Application ID from libprotoident / NBAR2 / Flowmon's NBAR plugin
119123

120124
# --- Flowmon TLS fields
121-
TLS_CONTENT_TYPE uint8 flowmon:tlsContentType # tlsContentType
122-
TLS_HANDSHAKE_TYPE uint32 flowmon:tlsHandshakeType # https://tools.ietf.org/html/rfc5246#appendix-A.4
123-
TLS_SETUP_TIME uint64 flowmon:tlsSetupTime # tlsSetupTime
124-
TLS_SERVER_VERSION uint16 flowmon:tlsServerVersion # 8b major and 8b minor, 0x0303 ~ TLS1.2
125-
TLS_SERVER_RANDOM bytes flowmon:tlsServerRandom # tlsServerRandom
126-
TLS_SERVER_SESSIONID bytes flowmon:tlsServerSessionId # tlsServerSessionId
127-
TLS_CIPHER_SUITE uint16 flowmon:tlsCipherSuite # https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4
128-
TLS_ALPN string flowmon:tlsAlpn # TLS Application-Layer Protocol Negotiation https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
129-
TLS_SNI string flowmon:tlsSni # Server Name Indication https://en.wikipedia.org/wiki/Server_Name_Indication
130-
TLS_SNI_LENGTH uint16 flowmon:tlsSniLength # Length of TLS_SNI field
131-
TLS_CLIENT_VERSION uint16 flowmon:tlsClientVersion # tlsClientVersion
132-
TLS_CIPHER_SUITES bytes flowmon:tlsCipherSuites # List of 2B ciphers, beware of network byte order. See https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4
133-
TLS_CLIENT_RANDOM bytes flowmon:tlsClientRandom # tlsClientRandom
134-
TLS_CLIENT_SESSIONID bytes flowmon:tlsClientSessionId # tlsClientSessionId
135-
TLS_EXTENSION_TYPES bytes flowmon:tlsExtensionTypes # tlsExtensionTypes
136-
TLS_EXTENSION_LENGTHS bytes flowmon:tlsExtensionLengths # tlsExtensionLengths
137-
TLS_ELLIPTIC_CURVES bytes flowmon:tlsEllipticCurves # tlsEllipticCurves
138-
TLS_EC_POINTFORMATS bytes flowmon:tlsEcPointFormats # tlsEcPointFormats
139-
TLS_CLIENT_KEYLENGTH int32 flowmon:tlsClientKeyLength # Length of client's key
140-
TLS_ISSUER_CN string flowmon:tlsIssuerCn # Common name of certificate issuer
141-
TLS_SUBJECT_CN string flowmon:tlsSubjectCn # Certificate Common Name
142-
TLS_SUBJECT_ON string flowmon:tlsSubjectOn # Certificate Organization Name
143-
TLS_VALIDITY_NOTBEFORE int64 flowmon:tlsValidityNotBefore # UNIX timestamp of certificate creation
144-
TLS_VALIDITY_NOTAFTER int64 flowmon:tlsValidityNotAfter # UNIX timestamp of certificate expiration
145-
TLS_SIGNATURE_ALG uint16 flowmon:tlsSignatureAlg # tlsSignatureAlg
146-
TLS_PUBLIC_KEYALG uint16 flowmon:tlsPublicKeyAlg # tlsPublicKeyAlg
147-
TLS_PUBLIC_KEYLENGTH int32 flowmon:tlsPublicKeyLength # tlsPublicKeyLength
148-
TLS_JA_3FINGERPRINT bytes flowmon:tlsJa3Fingerprint # tlsJa3Fingerprint
125+
TLS_CONTENT_TYPE uint8 flowmon:tlsContentType # tlsContentType
126+
TLS_HANDSHAKE_TYPE uint32 flowmon:tlsHandshakeType # https://tools.ietf.org/html/rfc5246#appendix-A.4
127+
TLS_SETUP_TIME uint64 flowmon:tlsSetupTime # tlsSetupTime
128+
TLS_SERVER_VERSION uint16 flowmon:tlsServerVersion # 8b major and 8b minor, 0x0303 ~ TLS1.2
129+
TLS_SERVER_RANDOM bytes flowmon:tlsServerRandom # tlsServerRandom
130+
TLS_SERVER_SESSIONID bytes flowmon:tlsServerSessionId # tlsServerSessionId
131+
TLS_CIPHER_SUITE uint16 flowmon:tlsCipherSuite # https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4
132+
TLS_ALPN string flowmon:tlsAlpn # TLS Application-Layer Protocol Negotiation https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
133+
TLS_SNI string flowmon:tlsSni # Server Name Indication https://en.wikipedia.org/wiki/Server_Name_Indication
134+
TLS_SNI_LENGTH uint16 flowmon:tlsSniLength # Length of TLS_SNI field
135+
TLS_CLIENT_VERSION uint16 flowmon:tlsClientVersion # tlsClientVersion
136+
TLS_CIPHER_SUITES bytes flowmon:tlsCipherSuites # List of 2B ciphers, beware of network byte order. See https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4
137+
TLS_CLIENT_RANDOM bytes flowmon:tlsClientRandom # tlsClientRandom
138+
TLS_CLIENT_SESSIONID bytes flowmon:tlsClientSessionId # tlsClientSessionId
139+
TLS_EXTENSION_TYPES bytes flowmon:tlsExtensionTypes # tlsExtensionTypes
140+
TLS_EXTENSION_LENGTHS bytes flowmon:tlsExtensionLengths # tlsExtensionLengths
141+
TLS_ELLIPTIC_CURVES bytes flowmon:tlsEllipticCurves # tlsEllipticCurves
142+
TLS_EC_POINTFORMATS bytes flowmon:tlsEcPointFormats # tlsEcPointFormats
143+
TLS_CLIENT_KEYLENGTH int32 flowmon:tlsClientKeyLength # Length of client's key
144+
TLS_ISSUER_CN string flowmon:tlsIssuerCn # Common name of certificate issuer
145+
TLS_SUBJECT_CN string flowmon:tlsSubjectCn # Certificate Common Name
146+
TLS_SUBJECT_ON string flowmon:tlsSubjectOn # Certificate Organization Name
147+
TLS_VALIDITY_NOTBEFORE int64 flowmon:tlsValidityNotBefore # UNIX timestamp of certificate creation
148+
TLS_VALIDITY_NOTAFTER int64 flowmon:tlsValidityNotAfter # UNIX timestamp of certificate expiration
149+
TLS_SIGNATURE_ALG uint16 flowmon:tlsSignatureAlg # tlsSignatureAlg
150+
TLS_PUBLIC_KEYALG uint16 flowmon:tlsPublicKeyAlg # tlsPublicKeyAlg
151+
TLS_PUBLIC_KEYLENGTH int32 flowmon:tlsPublicKeyLength # tlsPublicKeyLength
152+
TLS_JA_3FINGERPRINT bytes flowmon:tlsJa3Fingerprint # tlsJa3Fingerprint
149153

154+
# --- Cisco Joy exporter ---
155+
JOY_TLS_RECORD_LENGTHS int16* e0id291/e9id12188 # basicList of packet lengths
156+
JOY_TLS_RECORD_TIMES uint16* e0id291/e9id12189 # basicList of packet timestamps
157+
JOY_TLS_CONTENT_TYPES uint8* e0id291/e9id12190 # basicList of packet types

0 commit comments

Comments
 (0)