mirror of
https://github.com/fleetdm/fleet
synced 2026-05-22 00:18:27 +00:00
7e1a808a8c
#24804 # Checklist for submitter - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files) for more information. - [x] Added/updated tests - [x] If database migrations are included, checked table schema to confirm autoupdate - [x] Manual QA for all new/changed functionality
470 lines
15 KiB
Go
470 lines
15 KiB
Go
package apple_mdm
|
|
|
|
import (
|
|
"context"
|
|
"encoding/base64"
|
|
"fmt"
|
|
"net/http"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/fleetdm/fleet/v4/server/contexts/ctxerr"
|
|
"github.com/fleetdm/fleet/v4/server/fleet"
|
|
"github.com/fleetdm/fleet/v4/server/mdm/apple/appmanifest"
|
|
"github.com/fleetdm/fleet/v4/server/mdm/apple/mobileconfig"
|
|
mdmcrypto "github.com/fleetdm/fleet/v4/server/mdm/crypto"
|
|
"github.com/fleetdm/fleet/v4/server/mdm/nanomdm/mdm"
|
|
nanomdm_push "github.com/fleetdm/fleet/v4/server/mdm/nanomdm/push"
|
|
"github.com/groob/plist"
|
|
)
|
|
|
|
// commandPayload is the common structure all MDM commands use
|
|
type commandPayload struct {
|
|
CommandUUID string
|
|
Command any
|
|
}
|
|
|
|
// MDMAppleCommander contains methods to enqueue commands managed by Fleet and
|
|
// send push notifications to hosts.
|
|
//
|
|
// It's intentionally decoupled from fleet.Service so it can be used internally
|
|
// in crons and other services, leaving authentication/permission handling to
|
|
// the caller.
|
|
type MDMAppleCommander struct {
|
|
storage fleet.MDMAppleStore
|
|
pusher nanomdm_push.Pusher
|
|
}
|
|
|
|
// NewMDMAppleCommander creates a new commander instance.
|
|
func NewMDMAppleCommander(mdmStorage fleet.MDMAppleStore, mdmPushService nanomdm_push.Pusher) *MDMAppleCommander {
|
|
return &MDMAppleCommander{
|
|
storage: mdmStorage,
|
|
pusher: mdmPushService,
|
|
}
|
|
}
|
|
|
|
// InstallProfile sends the homonymous MDM command to the given hosts, it also
|
|
// takes care of the base64 encoding of the provided profile bytes.
|
|
func (svc *MDMAppleCommander) InstallProfile(ctx context.Context, hostUUIDs []string, profile mobileconfig.Mobileconfig, uuid string) error {
|
|
raw, err := svc.SignAndEncodeInstallProfile(ctx, profile, uuid)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
err = svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
return ctxerr.Wrap(ctx, err, "commander install profile")
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) SignAndEncodeInstallProfile(ctx context.Context, profile []byte, commandUUID string) (string, error) {
|
|
signedProfile, err := mdmcrypto.Sign(ctx, profile, svc.storage)
|
|
if err != nil {
|
|
return "", ctxerr.Wrap(ctx, err, "signing profile")
|
|
}
|
|
|
|
base64Profile := base64.StdEncoding.EncodeToString(signedProfile)
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>RequestType</key>
|
|
<string>InstallProfile</string>
|
|
<key>Payload</key>
|
|
<data>%s</data>
|
|
</dict>
|
|
</dict>
|
|
</plist>`, commandUUID, base64Profile)
|
|
return raw, nil
|
|
}
|
|
|
|
// RemoveProfile sends the homonymous MDM command to the given hosts.
|
|
func (svc *MDMAppleCommander) RemoveProfile(ctx context.Context, hostUUIDs []string, profileIdentifier string, uuid string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>RequestType</key>
|
|
<string>RemoveProfile</string>
|
|
<key>Identifier</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</dict>
|
|
</plist>`, uuid, profileIdentifier)
|
|
err := svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
return ctxerr.Wrap(ctx, err, "commander remove profile")
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) DeviceLock(ctx context.Context, host *fleet.Host, uuid string) (unlockPIN string, err error) {
|
|
unlockPIN = GenerateRandomPin(6)
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>RequestType</key>
|
|
<string>DeviceLock</string>
|
|
<key>PIN</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</dict>
|
|
</plist>`, uuid, unlockPIN,
|
|
)
|
|
|
|
cmd, err := mdm.DecodeCommand([]byte(raw))
|
|
if err != nil {
|
|
return "", ctxerr.Wrap(ctx, err, "decoding command")
|
|
}
|
|
|
|
if err := svc.storage.EnqueueDeviceLockCommand(ctx, host, cmd, unlockPIN); err != nil {
|
|
return "", ctxerr.Wrap(ctx, err, "enqueuing for DeviceLock")
|
|
}
|
|
|
|
if err := svc.SendNotifications(ctx, []string{host.UUID}); err != nil {
|
|
return "", ctxerr.Wrap(ctx, err, "sending notifications for DeviceLock")
|
|
}
|
|
|
|
return unlockPIN, nil
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) EraseDevice(ctx context.Context, host *fleet.Host, uuid string) error {
|
|
pin := GenerateRandomPin(6)
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>RequestType</key>
|
|
<string>EraseDevice</string>
|
|
<key>PIN</key>
|
|
<string>%s</string>
|
|
<key>ObliterationBehavior</key>
|
|
<string>Default</string>
|
|
</dict>
|
|
</dict>
|
|
</plist>`, uuid, pin)
|
|
|
|
cmd, err := mdm.DecodeCommand([]byte(raw))
|
|
if err != nil {
|
|
return ctxerr.Wrap(ctx, err, "decoding command")
|
|
}
|
|
|
|
if err := svc.storage.EnqueueDeviceWipeCommand(ctx, host, cmd); err != nil {
|
|
return ctxerr.Wrap(ctx, err, "enqueuing for DeviceWipe")
|
|
}
|
|
|
|
if err := svc.SendNotifications(ctx, []string{host.UUID}); err != nil {
|
|
return ctxerr.Wrap(ctx, err, "sending notifications for DeviceWipe")
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) InstallApplication(ctx context.Context, hostUUIDs []string, uuid string, adamID string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>ManagementFlags</key>
|
|
<integer>0</integer>
|
|
<key>Options</key>
|
|
<dict>
|
|
<key>PurchaseMethod</key>
|
|
<integer>1</integer>
|
|
</dict>
|
|
<key>RequestType</key>
|
|
<string>InstallApplication</string>
|
|
<key>iTunesStoreID</key>
|
|
<integer>%s</integer>
|
|
</dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</plist>`, adamID, uuid)
|
|
return svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) InstallEnterpriseApplication(ctx context.Context, hostUUIDs []string, uuid string, manifestURL string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>ManifestURL</key>
|
|
<string>%s</string>
|
|
<key>RequestType</key>
|
|
<string>InstallEnterpriseApplication</string>
|
|
</dict>
|
|
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</plist>`, manifestURL, uuid)
|
|
return svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
}
|
|
|
|
type installEnterpriseApplicationPayload struct {
|
|
Manifest *appmanifest.Manifest
|
|
RequestType string
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) InstallEnterpriseApplicationWithEmbeddedManifest(
|
|
ctx context.Context,
|
|
hostUUIDs []string,
|
|
uuid string,
|
|
manifest *appmanifest.Manifest,
|
|
) error {
|
|
cmd := commandPayload{
|
|
CommandUUID: uuid,
|
|
Command: installEnterpriseApplicationPayload{
|
|
RequestType: "InstallEnterpriseApplication",
|
|
Manifest: manifest,
|
|
},
|
|
}
|
|
|
|
raw, err := plist.Marshal(cmd)
|
|
if err != nil {
|
|
return fmt.Errorf("marshal command payload plist: %w", err)
|
|
}
|
|
|
|
return svc.EnqueueCommand(ctx, hostUUIDs, string(raw))
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) AccountConfiguration(ctx context.Context, hostUUIDs []string, uuid, fullName, userName string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>PrimaryAccountFullName</key>
|
|
<string>%s</string>
|
|
<key>PrimaryAccountUserName</key>
|
|
<string>%s</string>
|
|
<key>LockPrimaryAccountInfo</key>
|
|
<true />
|
|
<key>RequestType</key>
|
|
<string>AccountConfiguration</string>
|
|
</dict>
|
|
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</plist>`, fullName, userName, uuid)
|
|
|
|
return svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
}
|
|
|
|
// DeclarativeManagement sends the homonym [command][1] to the device to enable DDM or start a new DDM session.
|
|
//
|
|
// [1]: https://developer.apple.com/documentation/devicemanagement/declarativemanagementcommand
|
|
func (svc *MDMAppleCommander) DeclarativeManagement(ctx context.Context, hostUUIDs []string, uuid string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>RequestType</key>
|
|
<string>DeclarativeManagement</string>
|
|
</dict>
|
|
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</plist>`, uuid)
|
|
|
|
return svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) DeviceConfigured(ctx context.Context, hostUUID, cmdUUID string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>RequestType</key>
|
|
<string>DeviceConfigured</string>
|
|
</dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</plist>`, cmdUUID)
|
|
|
|
return svc.EnqueueCommand(ctx, []string{hostUUID}, raw)
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) DeviceInformation(ctx context.Context, hostUUIDs []string, cmdUUID string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>Queries</key>
|
|
<array>
|
|
<string>DeviceName</string>
|
|
<string>DeviceCapacity</string>
|
|
<string>AvailableDeviceCapacity</string>
|
|
<string>OSVersion</string>
|
|
<string>WiFiMAC</string>
|
|
<string>ProductName</string>
|
|
</array>
|
|
<key>RequestType</key>
|
|
<string>DeviceInformation</string>
|
|
</dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</plist>`, cmdUUID)
|
|
|
|
return svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) InstalledApplicationList(ctx context.Context, hostUUIDs []string, cmdUUID string) error {
|
|
raw := fmt.Sprintf(`<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
<key>Command</key>
|
|
<dict>
|
|
<key>ManagedAppsOnly</key>
|
|
<false/>
|
|
<key>RequestType</key>
|
|
<string>InstalledApplicationList</string>
|
|
<key>Items</key>
|
|
<array>
|
|
<string>Name</string>
|
|
<string>ShortVersion</string>
|
|
<string>Identifier</string>
|
|
</array>
|
|
</dict>
|
|
<key>CommandUUID</key>
|
|
<string>%s</string>
|
|
</dict>
|
|
</plist>`, cmdUUID)
|
|
|
|
return svc.EnqueueCommand(ctx, hostUUIDs, raw)
|
|
}
|
|
|
|
// EnqueueCommand takes care of enqueuing the commands and sending push
|
|
// notifications to the devices.
|
|
//
|
|
// Always sending the push notification when a command is enqueued was decided
|
|
// internally, leaving making pushes optional as an optimization to be tackled
|
|
// later.
|
|
func (svc *MDMAppleCommander) EnqueueCommand(ctx context.Context, hostUUIDs []string, rawCommand string) error {
|
|
cmd, err := mdm.DecodeCommand([]byte(rawCommand))
|
|
if err != nil {
|
|
return ctxerr.Wrap(ctx, err, "decoding command")
|
|
}
|
|
|
|
return svc.enqueueAndNotify(ctx, hostUUIDs, cmd, mdm.CommandSubtypeNone)
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) enqueueAndNotify(ctx context.Context, hostUUIDs []string, cmd *mdm.Command,
|
|
subtype mdm.CommandSubtype) error {
|
|
if _, err := svc.storage.EnqueueCommand(ctx, hostUUIDs,
|
|
&mdm.CommandWithSubtype{Command: *cmd, Subtype: subtype}); err != nil {
|
|
return ctxerr.Wrap(ctx, err, "enqueuing command")
|
|
}
|
|
|
|
if err := svc.SendNotifications(ctx, hostUUIDs); err != nil {
|
|
return ctxerr.Wrap(ctx, err, "sending notifications")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// EnqueueCommandInstallProfileWithSecrets is a special case of EnqueueCommand that does not expand secret variables.
|
|
// Secret variables are expanded when the command is sent to the device, and secrets are never stored in the database unencrypted.
|
|
func (svc *MDMAppleCommander) EnqueueCommandInstallProfileWithSecrets(ctx context.Context, hostUUIDs []string,
|
|
rawCommand mobileconfig.Mobileconfig, commandUUID string) error {
|
|
cmd := &mdm.Command{
|
|
CommandUUID: commandUUID,
|
|
Raw: []byte(rawCommand),
|
|
}
|
|
cmd.Command.RequestType = "InstallProfile"
|
|
|
|
return svc.enqueueAndNotify(ctx, hostUUIDs, cmd, mdm.CommandSubtypeProfileWithSecrets)
|
|
}
|
|
|
|
func (svc *MDMAppleCommander) SendNotifications(ctx context.Context, hostUUIDs []string) error {
|
|
apnsResponses, err := svc.pusher.Push(ctx, hostUUIDs)
|
|
if err != nil {
|
|
return ctxerr.Wrap(ctx, err, "commander push")
|
|
}
|
|
|
|
// Even if we didn't get an error, some of the APNs
|
|
// responses might have failed, signal that to the caller.
|
|
failed := map[string]error{}
|
|
for uuid, response := range apnsResponses {
|
|
if response.Err != nil {
|
|
failed[uuid] = response.Err
|
|
}
|
|
}
|
|
|
|
if len(failed) > 0 {
|
|
return &APNSDeliveryError{errorsByUUID: failed}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// BulkDeleteHostUserCommandsWithoutResults calls the storage method with the same name.
|
|
func (svc *MDMAppleCommander) BulkDeleteHostUserCommandsWithoutResults(ctx context.Context, commandToIDs map[string][]string) error {
|
|
return svc.storage.BulkDeleteHostUserCommandsWithoutResults(ctx, commandToIDs)
|
|
}
|
|
|
|
// APNSDeliveryError records an error and the associated host UUIDs in which it
|
|
// occurred.
|
|
type APNSDeliveryError struct {
|
|
errorsByUUID map[string]error
|
|
}
|
|
|
|
func (e *APNSDeliveryError) Error() string {
|
|
var uuids []string
|
|
for uuid := range e.errorsByUUID {
|
|
uuids = append(uuids, uuid)
|
|
}
|
|
|
|
// sort UUIDs alphabetically for deterministic output
|
|
sort.Strings(uuids)
|
|
|
|
var errStrings []string
|
|
for _, uuid := range uuids {
|
|
errStrings = append(errStrings, fmt.Sprintf("UUID: %s, Error: %v", uuid, e.errorsByUUID[uuid]))
|
|
}
|
|
|
|
return fmt.Sprintf(
|
|
"APNS delivery failed with the following errors:\n%s",
|
|
strings.Join(errStrings, "\n"),
|
|
)
|
|
}
|
|
|
|
func (e *APNSDeliveryError) FailedUUIDs() []string {
|
|
var uuids []string
|
|
for uuid := range e.errorsByUUID {
|
|
uuids = append(uuids, uuid)
|
|
}
|
|
|
|
// sort UUIDs alphabetically for deterministic output
|
|
sort.Strings(uuids)
|
|
return uuids
|
|
}
|
|
|
|
func (e *APNSDeliveryError) StatusCode() int { return http.StatusBadGateway }
|