mdm

type Authenticate ¶

type Authenticate struct {
	Enrollment
	MessageType
	Topic string
	Raw   []byte `plist:"-"` // Original Authenticate XML plist

	// Fields that may be present but are not strictly required for the
	// operation of the MDM protocol. Nice-to-haves.
	SerialNumber string `plist:",omitempty"`
}

Authenticate is a representation of an "Authenticate" check-in message type. See https://developer.apple.com/documentation/devicemanagement/authenticaterequest

type BootstrapToken ¶

type BootstrapToken struct {
	BootstrapToken b64Data
}

func (t *BootstrapToken) SetTokenString(token string) error

type CheckOut ¶

type CheckOut struct {
	Enrollment
	MessageType
	Raw []byte `plist:"-"` // Original CheckOut XML plist
}

CheckOut is a representation of a "CheckOut" check-in message type. See https://developer.apple.com/documentation/devicemanagement/checkoutrequest

type Command ¶

type Command struct {
	CommandUUID string
	Command     struct {
		RequestType string
	}
	Raw []byte `plist:"-"` // Original command XML plist
}

Command represents a generic MDM command without command-specific fields.

func DecodeCommand(rawCommand []byte) (command *Command, err error)

type CommandResults ¶

type CommandResults struct {
	Enrollment
	CommandUUID string `plist:",omitempty"`
	Status      string
	ErrorChain  []ErrorChain `plist:",omitempty"`
	Raw         []byte       `plist:"-"` // Original command result XML plist
}

CommandResults represents a 'command and report results' request. See https://developer.apple.com/documentation/devicemanagement/implementing_device_management/sending_mdm_commands_to_a_device

func DecodeCommandResults(rawResults []byte) (results *CommandResults, err error)

type DeclarativeManagement ¶ added in v0.3.0

type DeclarativeManagement struct {
	Enrollment
	MessageType
	Data     []byte
	Endpoint string
	Raw      []byte `plist:"-"` // Original XML plist
}

DeclarativeManagement is a representation of a "DeclarativeManagement" check-in message type. See https://developer.apple.com/documentation/devicemanagement/declarativemanagementrequest

type EnrollID ¶

type EnrollID struct {
	Type     EnrollType
	ID       string
	ParentID string
}

EnrollID contains the custom enrollment IDs derived from enrollment data. It's populated by services. Usually this is the main/core service so that middleware or storage layers that use the Request are able to use the custom IDs.

Be aware that the identifiers here are what are used for MDM client identification all around: database primary keys, logging, certificate associations, etc. Their format can be changed but it must be consistent across the lifetime of any enrolled device.

func (eid *EnrollID) Validate() error

type EnrollType ¶

type EnrollType uint

EnrollType identifies the type of enrollment.

func (et EnrollType) String() string

func (et EnrollType) Valid() bool

type Enrollment ¶

type Enrollment struct {
	UDID             string `plist:",omitempty"`
	UserID           string `plist:",omitempty"`
	UserShortName    string `plist:",omitempty"`
	UserLongName     string `plist:",omitempty"`
	EnrollmentID     string `plist:",omitempty"`
	EnrollmentUserID string `plist:",omitempty"`
}

Enrollment represents the various enrollment-related data sent with requests.

func (e *Enrollment) Resolved() (r *ResolvedEnrollment)

type ErrorChain ¶

type ErrorChain struct {
	ErrorCode            int
	ErrorDomain          string
	LocalizedDescription string
	USEnglishDescription string
}

ErrorChain represents errors that occured on the client executing an MDM command.

type GetBootstrapToken ¶

type GetBootstrapToken struct {
	Enrollment
	MessageType
	Raw []byte `plist:"-"` // Original XML plist
}

GetBootstrapToken is a representation of a "GetBootstrapToken" check-in message type. See https://developer.apple.com/documentation/devicemanagement/getbootstraptokenrequest

type GetToken ¶ added in v0.7.0

type GetToken struct {
	Enrollment
	MessageType
	TokenServiceType string
	TokenParameters  *TokenParameters `plist:",omitempty"`
	Raw              []byte           `plist:"-"` // Original XML plist
}

GetToken is a representation of a "GetToken" check-in message type. See https://developer.apple.com/documentation/devicemanagement/get_token

func (m *GetToken) Validate() error

type GetTokenResponse ¶ added in v0.7.0

type GetTokenResponse struct {
	TokenData []byte
}

GetTokenResponse is a representation of a "GetTokenResponse" structure. See https://developer.apple.com/documentation/devicemanagement/gettokenresponse

type MessageType ¶

type MessageType struct {
	MessageType string
}

MessageType represents the MessageType of a check-in message

type ParseError ¶ added in v0.4.0

type ParseError struct {
	Err     error
	Content []byte
}

ParseError represents a failure to parse an MDM structure (usually Apple Plist)

func (e *ParseError) Error() string

func (e *ParseError) Unwrap() error

type Push ¶

type Push struct {
	PushMagic string
	Token     hexData
	Topic     string
}

Push contains data needed to send an APNs push to MDM enrollments.

func (p *Push) SetTokenString(token string) (err error)

type Request ¶

type Request struct {
	*EnrollID
	Certificate *x509.Certificate
	Context     context.Context
	Params      map[string]string
}

Request represents an MDM client request.

func (r *Request) Clone() *Request

type ResolvedEnrollment ¶

type ResolvedEnrollment struct {
	Type            EnrollType
	DeviceChannelID string
	UserChannelID   string
	IsUserChannel   bool
}

ResolvedEnrollment is a sort of collapsed form of Enrollment.

func (resolved *ResolvedEnrollment) Validate() error

type SetBootstrapToken ¶

type SetBootstrapToken struct {
	Enrollment
	MessageType
	BootstrapToken
	Raw []byte `plist:"-"` // Original XML plist
}

SetBootstrapToken is a representation of a "SetBootstrapToken" check-in message type. See https://developer.apple.com/documentation/devicemanagement/setbootstraptokenrequest

type TokenParameters ¶ added in v0.7.0

type TokenParameters struct {
	PhoneUDID     string
	SecurityToken string
	WatchUDID     string
}

TokenParameters is a representation of a "GetTokenRequest.TokenParameters" structure. See https://developer.apple.com/documentation/devicemanagement/gettokenrequest/tokenparameters

type TokenUpdate ¶

type TokenUpdate struct {
	Enrollment
	MessageType
	Push
	UnlockToken []byte `plist:",omitempty"`
	Raw         []byte `plist:"-"` // Original TokenUpdate XML plist
}

TokenUpdate is a representation of a "TokenUpdate" check-in message type. See https://developer.apple.com/documentation/devicemanagement/token_update

type UserAuthenticate ¶

type UserAuthenticate struct {
	Enrollment
	MessageType
	DigestResponse string `plist:",omitempty"`
	Raw            []byte `plist:"-"` // Original XML plist
}

UserAuthenticate is a representation of a "UserAuthenticate" check-in message type. https://developer.apple.com/documentation/devicemanagement/userauthenticaterequest