mudler / mudler/yip

MachineID is confidential and should not be exposed on the network

Open
#86 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue help wanted
Dominant language
Go
Stars
113
Forks
34
Avg merge
14h 10m
Merged PRs (30d)
5

Description

The Hostname Plugin allows using MachineID in a template to generate hostname.

Per the manual page and the machine id library used by this project, machine-id is confidential and shouldn't be disclosed in whole or part.

How do we feel about adding "SecuredMachineID" as an available template variable in the hostname plugin to generate a machine-id derived ID using machine.id.ProtectedID("yipCloudInitHostnameConfiguration"), then later deprecating "MachineID" with a warning when its used?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in pkg/plugins/hostname.go and trace how MachineID becomes an available hostname template variable. Review the machine.id ProtectedID("yipCloudInitHostnameConfiguration") call described in the issue, then determine how a deprecation warning for MachineID would fit the plugin. Done means the protected value is available and use of the existing variable is warned about without exposing the raw machine ID.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.