-
Notifications
You must be signed in to change notification settings - Fork 419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Proposal: TLS related fields #6
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,6 +43,7 @@ ECS defines these fields. | |
* [Process fields](#process) | ||
* [Service fields](#service) | ||
* [Source fields](#source) | ||
* [TLS fields](#tls) | ||
* [URL fields](#url) | ||
* [User fields](#user) | ||
* [User agent fields](#user_agent) | ||
|
@@ -358,6 +359,21 @@ Source fields describe details about the source of the event. | |
| <a name="source.subdomain"></a>`source.subdomain` | Source subdomain. | keyword | | | | ||
|
||
|
||
## <a name="tls"></a> TLS fields | ||
|
||
The tls fields contains the TLS related data about a specific connection. | ||
|
||
As an example in the case of Filebeat and the TCP input, the `version` field would be the version of the TLS protocol in use, the `certificates` would be the chain of certificates provided by the client and the `ciphersuite` is the encryption algorithm used for the communication. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider tagging as |
||
|
||
|
||
| Field | Description | Type | Multi Field | Example | | ||
|---|---|---|---|---| | ||
| <a name="tls.version"></a>`tls.version` | TLS version | keyword | | `TLSv1.2` | | ||
| <a name="tls.certificates"></a>`tls.certificates` | An array of certificates. | keyword | | | | ||
| <a name="tls.servername"></a>`tls.servername` | Server name requested by the client. | keyword | | `localhost` | | ||
| <a name="tls.ciphersuite"></a>`tls.ciphersuite` | Name of the cipher used for the communication. | keyword | | `ECDHE-ECDSA-AES-128-CBC-SHA` | | ||
|
||
|
||
## <a name="url"></a> URL fields | ||
|
||
URL fields provide a complete URL, with scheme, host, and path. The URL object can be reused in other prefixes, such as `host.url.*` for example. Keep the structure consistent whenever you use URL fields. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
- name: tls | ||
title: TLS | ||
group: 2 | ||
description: > | ||
The tls fields contain the TLS related data about a specific connection. | ||
|
||
As an example in the case of Filebeat and the TCP input, the `version` field would be the | ||
version of the TLS protocol in use, the `certificates` would be the chain of certificates | ||
provided by the client and the `ciphersuite` is the encryption algorithm used for the | ||
communication. | ||
fields: | ||
- name: version | ||
type: keyword | ||
description: > | ||
TLS version. | ||
|
||
example: TLSv1.2 | ||
- name: certificates | ||
type: keyword | ||
description: > | ||
An array of certificates. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What would be the format of this field? If one were to use base64-encoded certificates, a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You are absolutely right for the keyword, I’ll update the PR. |
||
ignore_above: -1 | ||
doc_values: false | ||
- name: servername | ||
type: keyword | ||
description: > | ||
Server name requested by the client. | ||
|
||
example: localhost | ||
- name: ciphersuite | ||
type: keyword | ||
description: > | ||
Name of the cipher used for the communication. | ||
|
||
example: ECDHE-ECDSA-AES-128-CBC-SHA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/contains/contain/