Skip to content
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

Project Proposal: Security semantic conventions #1838

Merged
merged 23 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
79a26c1
first proposal for security project
trisch-me Dec 19, 2023
884cf2a
fix spell
trisch-me Dec 19, 2023
a2eb9c9
Merge branch 'main' into security_project
trisch-me Jan 8, 2024
a1be073
Update projects/security.md
trisch-me Jan 8, 2024
2abf7b8
Merge branch 'main' into security_project
arminru Feb 9, 2024
83122b1
add more experts
trisch-me Feb 9, 2024
9124b8d
Merge branch 'security_project' of github.com:trisch-me/community int…
trisch-me Feb 9, 2024
bfeea3a
add another expert
trisch-me Feb 12, 2024
7a8dc52
add companies names to the spellcheck
trisch-me Feb 12, 2024
05ed9fb
Merge branch 'main' into security_project
trisch-me Feb 13, 2024
4c4d565
Merge branch 'main' into security_project
trisch-me Mar 5, 2024
dfb701d
Merge branch 'main' of github.com:open-telemetry/community into secur…
trisch-me Apr 15, 2024
5dc4f6c
refine project timeline and description
trisch-me Apr 15, 2024
3d70622
Merge branch 'security_project' of github.com:trisch-me/community int…
trisch-me Apr 15, 2024
556d101
Merge branch 'main' of github.com:open-telemetry/community into secur…
trisch-me Apr 23, 2024
474a6e1
Update projects/security.md
trisch-me Apr 23, 2024
f72d018
update sponsor and meeting time
trisch-me Apr 29, 2024
9a16520
Merge branch 'security_project' of github.com:trisch-me/community int…
trisch-me Apr 29, 2024
3d23d23
Merge branch 'main' of github.com:open-telemetry/community into secur…
trisch-me Apr 29, 2024
ebb55c2
added slack channel
trisch-me Apr 29, 2024
d22854c
add expert
trisch-me Apr 29, 2024
494d26e
update slack name
trisch-me Apr 30, 2024
f7c8baa
Merge branch 'main' into security_project
svrnm May 6, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,18 @@ ignoreRegExpList:
- Google Docs ID
words:
- DASD
- datadog
- dynatrace
- easycla
- eiffel
- elastic
- emea
- faas
- galkleinman
- gitter
- gyliu513
- Hostmetrics
- isovalent
- Liudmila
- Nale
- REXX
Expand Down Expand Up @@ -104,6 +107,7 @@ words:
- kubecon
- kuisathaverat
- lalitb
- lambdanis
- liatrio
- lightstep
- lmolkova
Expand All @@ -116,8 +120,10 @@ words:
- mateuszrzeszutek
- mayur
- mayurkale
- mdelfabro
- mhausenblas
- mirabella
- mjwolf
- molkova
- msomasu
- mtwo
Expand Down Expand Up @@ -148,6 +154,7 @@ words:
- proto
- pyohannes
- pytest
- raesene
- reiley
- reyang
- rrschulze
Expand Down Expand Up @@ -194,6 +201,7 @@ words:
- trendable
- triager
- triagers
- trisch-me
- tsloughter
- tylerbenson
- xibz
Expand Down
82 changes: 82 additions & 0 deletions projects/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Security Semantic Conventions Working Group

## Description

The purpose of this working group is to bring in the security domain for the OpenTelemetry community.
svrnm marked this conversation as resolved.
Show resolved Hide resolved

As outlined in the [ECS OTEP](https://github.com/open-telemetry/oteps/blob/main/text/0199-support-elastic-common-schema-in-opentelemetry.md), the Elastic Common Schema (ECS) is currently being contributed to the semantic conventions schema. Given the significance of security within ECS, establishing this working group is crucial as it will expedite the donation of ECS fields tailored to security use cases. Beyond expanding the schema, our aim is to craft a clear vision for the instrumentation required.
trisch-me marked this conversation as resolved.
Show resolved Hide resolved

## Deliverables

* Our current focus is on defining essential semantic conventions for security use cases.
* This includes but is not limited to the following namespaces:
* [`Code signature`](https://www.elastic.co/guide/en/ecs/current/ecs-code_signature.html)
* [`DLL`](https://www.elastic.co/guide/en/ecs/current/ecs-dll.html)
* [`DNS`](https://www.elastic.co/guide/en/ecs/current/ecs-dns.html)
* [`File`](https://www.elastic.co/guide/en/ecs/current/ecs-file.html)
* [`Group`](https://www.elastic.co/guide/en/ecs/current/ecs-group.html)
* [`Hash`](https://www.elastic.co/guide/en/ecs/current/ecs-hash.html)
* [`Host`](https://www.elastic.co/guide/en/ecs/current/ecs-host.html)
* [`Network`](https://www.elastic.co/guide/en/ecs/current/ecs-network.html)
* [`Operating System`](https://www.elastic.co/guide/en/ecs/current/ecs-os.html)
* [`Package`](https://www.elastic.co/guide/en/ecs/current/ecs-package.html)
* [`Process`](https://www.elastic.co/guide/en/ecs/current/ecs-process.html)
* [`Registry`](https://www.elastic.co/guide/en/ecs/current/ecs-registry.html)
* [`Risk information`](https://www.elastic.co/guide/en/ecs/current/ecs-risk.html)
* [`Rule`](https://www.elastic.co/guide/en/ecs/current/ecs-rule.html)
* [`Threat`](https://www.elastic.co/guide/en/ecs/current/ecs-threat.html)
* [`TLS`](https://www.elastic.co/guide/en/ecs/current/ecs-tls.html)
* [`User`](https://www.elastic.co/guide/en/ecs/current/ecs-user.html)
* [`Vulnerability`](https://www.elastic.co/guide/en/ecs/current/ecs-vulnerability.html)
* Please note that some of the above-mentioned namespaces are already a part of the Semantic Conventions schema. The goal is to expand these namespaces to include additional fields that are relevant to security use cases.

* As new use cases and namespaces are introduced to the semantic conventions, there may be a need for additional instrumentation to accommodate them. It is anticipated that this aspect will expand through an iterative process.

## Staffing / Help Wanted

We are seeking security experts to collaborate with us in expanding the security domain within the community.

### Required staffing

There is an open [PR](https://github.com/open-telemetry/semantic-conventions/issues/580) to create a `semconv-security-approver` group for all PRs related to security fields.

* project lead: @trisch-me (Elastic)
* domain expert: @mjwolf (Elastic)
* domain expert: @raesene (Datadog)
* domain expert: @lambdanis (Isovalent)
* domain expert: @mdelfabro (Dynatrace)

* TC sponsor: @reyang
* TC sponsor: @jsuereth

Need more
- [ ] domain experts
- [ ] TC
- [ ] potentially, maintainers of language-specific instrumentation may be needed if the need arises.


## Meeting Times

There is an allocated time in the Semantic Conventions WG for this project.
- Mondays at 8 AM PST
trisch-me marked this conversation as resolved.
Show resolved Hide resolved

For async conversation please use #otel-semconv-security slack channel from official CNCF slack workspace.

## Timeline

The goal is to have the security semantic conventions implemented by the end of 2024.

The timeline for this project is as follows:
December 2023: Initial Draft
April 2024: Review and Refinement
May 2024-December 2024: Introducing the Security Semantic Conventions


## Labels

* security

## Linked Issues and PRs

* [Donating ECS to OpenTelemetry](https://github.com/open-telemetry/oteps/blob/main/text/0199-support-elastic-common-schema-in-opentelemetry.md)
* [Creation of semconv-security-approver group](https://github.com/open-telemetry/semantic-conventions/issues/580)