Skip to content

Commit

Permalink
feat(inputs.gnmi): Add secret store support for username and password (
Browse files Browse the repository at this point in the history
  • Loading branch information
powersj authored Apr 17, 2024
1 parent c443b76 commit 96e7b2b
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 6 deletions.
8 changes: 8 additions & 0 deletions plugins/inputs/gnmi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.

[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins

## Secret-store support

This plugin supports secrets from secret-stores for the `username` and
`password` options. See the [secret-store documentation][SECRETSTORE] for more
details on how to use them.

[SECRETSTORE]: ../../../docs/CONFIGURATION.md#secret-store-secrets

## Configuration

```toml @sample.conf
Expand Down
23 changes: 19 additions & 4 deletions plugins/inputs/gnmi/gnmi.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ type GNMI struct {
Target string `toml:"target"`
UpdatesOnly bool `toml:"updates_only"`
VendorSpecific []string `toml:"vendor_specific"`
Username string `toml:"username"`
Password string `toml:"password"`
Username config.Secret `toml:"username"`
Password config.Secret `toml:"password"`
Redial config.Duration `toml:"redial"`
MaxMsgSize config.Size `toml:"max_msg_size"`
Trace bool `toml:"dump_responses"`
Expand Down Expand Up @@ -214,8 +214,23 @@ func (c *GNMI) Start(acc telegraf.Accumulator) error {
// Prepare the context, optionally with credentials
var ctx context.Context
ctx, c.cancel = context.WithCancel(context.Background())
if len(c.Username) > 0 {
ctx = metadata.AppendToOutgoingContext(ctx, "username", c.Username, "password", c.Password)

if !c.Username.Empty() {
usernameSecret, err := c.Username.Get()
if err != nil {
return fmt.Errorf("getting username failed: %w", err)
}
username := usernameSecret.String()
usernameSecret.Destroy()

passwordSecret, err := c.Password.Get()
if err != nil {
return fmt.Errorf("getting password failed: %w", err)
}
password := passwordSecret.String()
passwordSecret.Destroy()

ctx = metadata.AppendToOutgoingContext(ctx, "username", username, "password", password)
}

// Create a goroutine for each device, dial and subscribe
Expand Down
4 changes: 2 additions & 2 deletions plugins/inputs/gnmi/gnmi_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@ func TestUsernamePassword(t *testing.T) {
plugin := &GNMI{
Log: testutil.Logger{},
Addresses: []string{listener.Addr().String()},
Username: "theusername",
Password: "thepassword",
Username: config.NewSecret([]byte("theusername")),
Password: config.NewSecret([]byte("thepassword")),
Encoding: "proto",
Redial: config.Duration(1 * time.Second),
}
Expand Down

0 comments on commit 96e7b2b

Please sign in to comment.