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

add new namespace “security_rule.*" #903

Merged
merged 52 commits into from
Dec 8, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
36792a1
add new namespace rule
trisch-me Apr 8, 2024
12dea45
Merge branch 'main' into rule_new
trisch-me Apr 8, 2024
ede2cfb
Merge branch 'main' into rule_new
trisch-me Apr 17, 2024
4dc213c
Merge branch 'main' into rule_new
trisch-me Apr 30, 2024
f775ba5
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me May 7, 2024
ca5b8ea
updated for the weaver
trisch-me May 7, 2024
5400212
Merge branch 'main' into rule_new
trisch-me May 7, 2024
c9f9e98
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me May 10, 2024
d8ce7fa
remove author until further discussion
trisch-me May 10, 2024
84f54a6
Merge branch 'rule_new' of github.com:trisch-me/semantic-conventions …
trisch-me May 10, 2024
6c9c593
fix registry
trisch-me May 10, 2024
b7f73f3
Merge branch 'main' into rule_new
trisch-me May 14, 2024
5c948f7
Merge branch 'main' into rule_new
trisch-me May 22, 2024
749e3ea
Merge branch 'main' into rule_new
trisch-me May 24, 2024
24bfc5a
Merge branch 'main' into rule_new
trisch-me Jun 5, 2024
fef0e7c
Merge branch 'main' into rule_new
trisch-me Jul 2, 2024
6fcc7ce
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Jul 5, 2024
bb8bd05
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Jul 18, 2024
eedc6d0
update rule sub namespace to be security
trisch-me Jul 18, 2024
1404699
Merge branch 'main' into rule_new
trisch-me Jul 22, 2024
6c370f9
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Jul 23, 2024
8560c69
Merge branch 'rule_new' of github.com:trisch-me/semantic-conventions …
trisch-me Jul 23, 2024
7b90fc8
rename rule.security to security_rule
trisch-me Jul 23, 2024
ffc315a
update templates for the new name
trisch-me Jul 23, 2024
1ba6d43
Merge branch 'main' into rule_new
joaopgrassi Jul 29, 2024
e57150c
Merge branch 'main' into rule_new
trisch-me Jul 29, 2024
908b0f2
remove prefix
trisch-me Aug 5, 2024
dc29cad
Merge branch 'rule_new' of github.com:trisch-me/semantic-conventions …
trisch-me Aug 5, 2024
cdf1286
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Aug 5, 2024
95afc21
Merge branch 'main' into rule_new
trisch-me Aug 12, 2024
dd320a9
Merge branch 'main' into rule_new
trisch-me Aug 13, 2024
9ea87ba
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Aug 20, 2024
962a1e7
remove rule.id from namespace
trisch-me Aug 20, 2024
0c5e4b9
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Sep 23, 2024
14ae893
update to the new structure
trisch-me Sep 23, 2024
5409311
Merge branch 'main' into rule_new
trisch-me Sep 23, 2024
1de85cb
Merge branch 'main' into rule_new
trisch-me Sep 30, 2024
31e4ff4
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Sep 30, 2024
1a057d6
Merge branch 'main' into rule_new
trisch-me Oct 7, 2024
a8a7f67
Merge branch 'main' into rule_new
trisch-me Oct 14, 2024
3209ed0
Merge branch 'main' into rule_new
trisch-me Oct 24, 2024
0dcddd5
Merge branch 'rule_new' of github.com:trisch-me/semantic-conventions …
trisch-me Oct 28, 2024
ad27236
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Oct 28, 2024
177e10d
update markdown
trisch-me Oct 28, 2024
baac71b
Merge branch 'main' into rule_new
trisch-me Dec 2, 2024
708971c
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Dec 2, 2024
2e939b1
Merge branch 'rule_new' of github.com:trisch-me/semantic-conventions …
trisch-me Dec 2, 2024
10d488d
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Dec 3, 2024
d6b9721
make ruleset a namespace
trisch-me Dec 3, 2024
ee69dbd
Merge branch 'main' into rule_new
trisch-me Dec 3, 2024
394329c
Merge branch 'main' into rule_new
trisch-me Dec 5, 2024
77f8139
Merge branch 'main' into rule_new
lmolkova Dec 8, 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
22 changes: 22 additions & 0 deletions .chloggen/rule_new.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: new_component

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: rule
trisch-me marked this conversation as resolved.
Show resolved Hide resolved
trisch-me marked this conversation as resolved.
Show resolved Hide resolved

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Introducing a new rule namespace
trisch-me marked this conversation as resolved.
Show resolved Hide resolved

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [903]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ body:
- area:peer
- area:process
- area:rpc
- area:rule
- area:server
- area:service
- area:session
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ body:
- area:peer
- area:process
- area:rpc
- area:rule
- area:server
- area:service
- area:session
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ body:
- area:peer
- area:process
- area:rpc
- area:rule
- area:server
- area:service
- area:session
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ Currently, the following namespaces exist:
- [Peer](peer.md)
- [Process](process.md)
- [RPC](rpc.md)
- [Rule](rule.md)
trisch-me marked this conversation as resolved.
Show resolved Hide resolved
- [Server](server.md)
- [Service](service.md)
- [Session](session.md)
Expand Down
25 changes: 25 additions & 0 deletions docs/attributes-registry/rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!--- Hugo front matter used to generate the website version of this page:
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# Rule

## Rule Attributes

Describes rule attributes. Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events.

| Attribute | Type | Description | Examples | Stability |
| ------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------- |
| `rule.category` | string | A categorization value keyword used by the entity using the rule for detection of this event | `Attempted Information Leak` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `rule.description` | string | The description of the rule generating the event. | `Block requests to public DNS over HTTPS / TLS protocols` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `rule.id` | string | A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. | `101` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `rule.license` | string | Name of the license under which the rule used to generate this event is made available. | `Apache 2.0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `rule.name` | string | The name of the rule or signature generating the event. | `BLOCK_DNS_over_TLS` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `rule.reference` | string | Reference URL to additional information about the rule used to generate this event. [1] | `https://en.wikipedia.org/wiki/DNS_over_TLS` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
lmolkova marked this conversation as resolved.
Show resolved Hide resolved
| `rule.ruleset` | string | Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. | `Standard_Protocol_Filters` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `rule.uuid` | string | A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. | `550e8400-e29b-41d4-a716-446655440000`; `1100110011` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
lmolkova marked this conversation as resolved.
Show resolved Hide resolved
| `rule.version` | string | The version / revision of the rule being used for analysis. | `1.0.0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** The URL can point to the vendor’s documentation about the rule. If that’s not available, it can also be a link to a more general page describing this type of alert.
67 changes: 67 additions & 0 deletions model/registry/rule.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
groups:
- id: registry.rule
prefix: rule
type: attribute_group
brief: >
Describes rule attributes. Rule fields are used to capture the specifics of any observer or agent rules
that generate alerts or other notable events.
attributes:
trisch-me marked this conversation as resolved.
Show resolved Hide resolved
- id: category
type: string
stability: experimental
brief: >
A categorization value keyword used by the entity using the rule for detection of this event
examples: ['Attempted Information Leak']
- id: description
type: string
stability: experimental
brief: >
The description of the rule generating the event.
examples: ['Block requests to public DNS over HTTPS / TLS protocols']
- id: id
type: string
stability: experimental
brief: >
A rule ID that is unique within the scope of an agent, observer,
or other entity using the rule for detection of this event.
examples: ['101']
- id: license
type: string
stability: experimental
brief: >
Name of the license under which the rule used to generate this event is made available.
examples: ['Apache 2.0']
- id: name
type: string
stability: experimental
brief: >
The name of the rule or signature generating the event.
examples: ['BLOCK_DNS_over_TLS']
- id: reference
type: string
stability: experimental
brief: >
Reference URL to additional information about the rule used to generate this event.
note: >
The URL can point to the vendor’s documentation about the rule.
If that’s not available, it can also be a link to a more general page describing this type of alert.
examples: ['https://en.wikipedia.org/wiki/DNS_over_TLS']
- id: ruleset
type: string
stability: experimental
brief: >
Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member.
examples: ['Standard_Protocol_Filters']
- id: uuid
joaopgrassi marked this conversation as resolved.
Show resolved Hide resolved
type: string
stability: experimental
brief: >
A rule ID that is unique within the scope of a set or group of agents, observers, or other entities
using the rule for detection of this event.
examples: ['550e8400-e29b-41d4-a716-446655440000', '1100110011']
- id: version
type: string
stability: experimental
brief: >
The version / revision of the rule being used for analysis.
examples: ['1.0.0']
Loading