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

The elastic-agent upgrade CLI command needs to require an uninstall token when Elastic Defend is installed #6356

Open
cmacknz opened this issue Dec 17, 2024 · 3 comments
Assignees
Labels
Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team

Comments

@cmacknz
Copy link
Member

cmacknz commented Dec 17, 2024

For Fleet managed agents that are running Elastic Defend, upgrading from the CLI does not send a signed upgrade action to Defend which is what allows Defend to upgrade without believing it is being tampered with. The tamper protection feature of Defend is based on all operations requiring a digital signature signed by a private key in Kibana. There is no way to provide a signed token for an upgrade on the CLI, so Defend legitimately believed it was being tampered with and orphaned from agent here.

Specifically using the CLI skips this block

if h.tamperProtectionFn() {
// Find inputs that want to receive UPGRADE action
// Endpoint needs to receive a signed UPGRADE action in order to be able to uncontain itself
state := h.coord.State()
ucs := findMatchingUnitsByActionType(state, a.Type())
if len(ucs) > 0 {
h.log.Debugf("handlerUpgrade: proxy/dispatch action '%+v'", a)
err := notifyUnitsOfProxiedAction(ctx, h.log, action, ucs, h.coord.PerformAction)
h.log.Debugf("handlerUpgrade: after action dispatched '%+v', err: %v", a, err)
if err != nil {
return err
}
} else {
// Log and continue
h.log.Debugf("No components running for %v action type", a.Type())
}
}

To make the upgrade command work with tamper protection properly we'd have to allow it to accept an uninstall token to allow endpoint to unprotect itself for a CLI upgrade.

We could simply block CLI upgrades with endpoint, but we continue to preserve use of the upgrade CLI command as an escape hatch for when fleet upgrades are unavailable or broken for an unforeseen reason, and without making this change this escape hatch does not work properly for agents that run defend.

What is the definition of done?

  • A test exists proving that the elastic-agent upgrade command can be used to upgrade Elastic Defend is installed without disabling tamper protection.
  • The upgrade CLI command refuses to upgrade when defend is install and a tamper protection uninstall token is not provided.
  • The documentation for the CLI is updated to indicate that an uninstall token is required in this situation.
@cmacknz cmacknz added the Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team label Dec 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

@cmacknz
Copy link
Member Author

cmacknz commented Dec 18, 2024

We likely also need to support the uninstall token for the RPM and DEB packages when endpoint is installed.

@cmacknz
Copy link
Member Author

cmacknz commented Dec 18, 2024

Created #6394 to track the RPM and DEB change, which is more critical as Fleet cannot be used to upgrade those package types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team
Projects
None yet
Development

No branches or pull requests

3 participants