Skip to content

New component: scaffolding for trusted platform module extension #38855

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

Merged
merged 11 commits into from
Mar 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 27 additions & 0 deletions .chloggen/tpm-bootstrap.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

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

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: tpmextension

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add scaffolding for Trusted Platform Module extension.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [38682]

# (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:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ extension/storage/dbstorage/ @open-telemetry
extension/storage/filestorage/ @open-telemetry/collector-contrib-approvers @swiatekm @VihasMakwana
extension/storage/redisstorageextension/ @open-telemetry/collector-contrib-approvers @atoulme
extension/sumologicextension/ @open-telemetry/collector-contrib-approvers @rnishtala-sumo @chan-tim-sumo @echlebek @amdprophet
extension/tpmextension/ @open-telemetry/collector-contrib-approvers @pavolloffay
internal/aws/ @open-telemetry/collector-contrib-approvers @Aneurysm9 @mxiamxia
internal/collectd/ @open-telemetry/collector-contrib-approvers @atoulme
internal/common/ @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ body:
- extension/storage/filestorage
- extension/storage/redisstorage
- extension/sumologic
- extension/tpm
- internal/aws
- internal/collectd
- internal/common
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ body:
- extension/storage/filestorage
- extension/storage/redisstorage
- extension/sumologic
- extension/tpm
- internal/aws
- internal/collectd
- internal/common
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/other.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ body:
- extension/storage/filestorage
- extension/storage/redisstorage
- extension/sumologic
- extension/tpm
- internal/aws
- internal/collectd
- internal/common
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/unmaintained.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ body:
- extension/storage/filestorage
- extension/storage/redisstorage
- extension/sumologic
- extension/tpm
- internal/aws
- internal/collectd
- internal/common
Expand Down
1 change: 1 addition & 0 deletions .github/component_labels.txt
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ extension/storage/dbstorage extension/storage/dbstorage
extension/storage/filestorage extension/storage/filestorage
extension/storage/redisstorageextension extension/storage/redisstorage
extension/sumologicextension extension/sumologic
extension/tpmextension extension/tpm
internal/aws internal/aws
internal/collectd internal/collectd
internal/common internal/common
Expand Down
1 change: 1 addition & 0 deletions cmd/otelcontribcol/builder-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ extensions:
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/remotetapextension v0.122.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/sigv4authextension v0.122.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/solarwindsapmsettingsextension v0.122.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/tpmextension v0.122.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage/dbstorage v0.122.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage/filestorage v0.122.0
- gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage/redisstorageextension v0.122.0
Expand Down
1 change: 1 addition & 0 deletions extension/tpmextension/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
include ../../Makefile.Common
26 changes: 26 additions & 0 deletions extension/tpmextension/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Trusted Platform Module (TPM) Extension

<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [development] |
| Distributions | [] |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aextension%2Ftpm%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aextension%2Ftpm) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aextension%2Ftpm%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aextension%2Ftpm) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@pavolloffay](https://www.github.com/pavolloffay) |

[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
<!-- end autogenerated section -->

## Overview

The Trusted Platform Module (TPM) extension retrieves TLS certificates from the TPM device.

## Configuration

Example:

```yaml
extensions:
tpm:
```

18 changes: 18 additions & 0 deletions extension/tpmextension/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package tpmextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/tpmextension"

import (
"go.opentelemetry.io/collector/component"
)

type Config struct{}

func createDefaultConfig() component.Config {
return &Config{}
}

func (cfg *Config) Validate() error {
return nil
}
7 changes: 7 additions & 0 deletions extension/tpmextension/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

//go:generate mdatagen metadata.yaml

// Package tpmextension
package tpmextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/tpmextension"
41 changes: 41 additions & 0 deletions extension/tpmextension/extension.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package tpmextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/tpmextension"

import (
"context"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/extension"
)

type tpmExtension struct {
config *Config
cancel context.CancelFunc
telemetrySettings component.TelemetrySettings
}

var _ extension.Extension = (*tpmExtension)(nil)

func newTPMExtension(extensionCfg *Config, settings extension.Settings) (extension.Extension, error) {
settingsExtension := &tpmExtension{
config: extensionCfg,
telemetrySettings: settings.TelemetrySettings,
}
return settingsExtension, nil
}

func (extension *tpmExtension) Start(_ context.Context, _ component.Host) error {
extension.telemetrySettings.Logger.Info("starting up tpm extension")

return nil
}

func (extension *tpmExtension) Shutdown(_ context.Context) error {
extension.telemetrySettings.Logger.Info("shutting down tmp extension")
if extension.cancel != nil {
extension.cancel()
}
return nil
}
33 changes: 33 additions & 0 deletions extension/tpmextension/factory.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package tpmextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/tpmextension"

import (
"context"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/extension"
)

var (
Type = component.MustNewType("tpm")
ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/extension/tpmextension"
)

const (
ExtensionStability = component.StabilityLevelDevelopment
)

func createExtension(_ context.Context, settings extension.Settings, cfg component.Config) (extension.Extension, error) {
return newTPMExtension(cfg.(*Config), settings)
}

func NewFactory() extension.Factory {
return extension.NewFactory(
Type,
createDefaultConfig,
createExtension,
ExtensionStability,
)
}
52 changes: 52 additions & 0 deletions extension/tpmextension/generated_component_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions extension/tpmextension/generated_package_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 46 additions & 0 deletions extension/tpmextension/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
module github.com/open-telemetry/opentelemetry-collector-contrib/extension/tpmextension

go 1.23.0

require (
github.com/stretchr/testify v1.10.0
go.opentelemetry.io/collector/component v1.28.2-0.20250319144947-41a9ea7f7402
go.opentelemetry.io/collector/component/componenttest v0.122.2-0.20250319144947-41a9ea7f7402
go.opentelemetry.io/collector/confmap v1.28.2-0.20250319144947-41a9ea7f7402
go.opentelemetry.io/collector/extension v1.28.2-0.20250319144947-41a9ea7f7402
go.opentelemetry.io/collector/extension/extensiontest v0.122.2-0.20250319144947-41a9ea7f7402
go.uber.org/goleak v1.3.0
)

require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/go-logr/logr v1.4.2 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/hashicorp/go-version v1.7.0 // indirect
github.com/knadh/koanf/maps v0.1.1 // indirect
github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
github.com/knadh/koanf/v2 v2.1.2 // indirect
github.com/mitchellh/copystructure v1.2.0 // indirect
github.com/mitchellh/reflectwalk v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/auto/sdk v1.1.0 // indirect
go.opentelemetry.io/collector/featuregate v1.28.2-0.20250319144947-41a9ea7f7402 // indirect
go.opentelemetry.io/collector/pdata v1.28.2-0.20250319144947-41a9ea7f7402 // indirect
go.opentelemetry.io/otel v1.35.0 // indirect
go.opentelemetry.io/otel/metric v1.35.0 // indirect
go.opentelemetry.io/otel/sdk v1.35.0 // indirect
go.opentelemetry.io/otel/sdk/metric v1.35.0 // indirect
go.opentelemetry.io/otel/trace v1.35.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0 // indirect
golang.org/x/net v0.37.0 // indirect
golang.org/x/sys v0.31.0 // indirect
golang.org/x/text v0.23.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a // indirect
google.golang.org/grpc v1.71.0 // indirect
google.golang.org/protobuf v1.36.5 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
Loading