Skip to content
Versionv0.1 ALPHA 2

Enterprise Deployment

The Companion Agent is built to deploy across managed fleets with the MDM tools you already run. This guide covers packaging, configuration, and enrollment for Windows, macOS, and Linux.

Packages

PlatformFormat
WindowsSigned MSI / MSIX for Intune or SCCM.
macOSSigned & notarized .pkg for Jamf or MDM.
Linux.deb and .rpm, plus a tarball for custom config management.

All installers are code-signed; verify checksums against the download center before distribution.

Configuration profile

The Agent reads a managed configuration profile delivered by your MDM. Core keys:

KeyPurpose
tenant_idYour OSDF tenant identifier.
idpIdentity provider (entra, okta, oidc, saml, piv).
origin_allowlistOrigins permitted to call the loopback broker.
policy_endpointURL of the policy decision service.
lease_max_ttlMaximum offline lease lifetime.
require_hardware_keyEnforce TPM / Secure Enclave backing.
card_removal_actionlock or ignore on smart-card removal.
json
{  "tenant_id": "acme-gov",  "idp": "entra",  "origin_allowlist": ["https://viewer.osdfsystems.com", "https://docs.acme.gov"],  "policy_endpoint": "https://policy.osdfsystems.com",  "lease_max_ttl": "300s",  "require_hardware_key": true,  "card_removal_action": "lock"}

Microsoft Intune (Windows)

  1. Upload the signed MSI/MSIX as a Win32 or line-of-business app.
  2. Attach the configuration profile as an OMA-URI or app config policy.
  3. Scope to a device group of TPM-capable, managed endpoints.
  4. Require device compliance (BitLocker on, Defender healthy) as a precondition.

Jamf (macOS)

  1. Upload the notarized .pkg to Jamf Pro.
  2. Deliver the configuration profile and a PPPC/TCC profile granting the Agent the entitlements it needs.
  3. Scope to a smart group of Secure Enclave-capable Macs.

Linux MDM / config management

Distribute the .deb / .rpm via your repository, and the configuration file to /etc/osdf/companion-agent.json using Ansible, Puppet, or your tool of choice. Ensure the TPM 2.0 stack is present.

Enrollment at scale

On first launch under management, each Agent:

  1. generates a hardware-backed device key,
  2. registers its attested public key with the policy plane, and
  3. associates the device with the signed-in user and your device records.

Zero-touch friendly

With MDM-delivered config and pre-staged IdP enrollment, the Agent can reach a Trusted state on first sign-in without manual steps.

Monitoring

Signed decision events stream to your configured audit sink and can be forwarded to a SIEM. See the security model for the audit event schema and integrity guarantees.

Spec status: working draft v0.4 · subject to change before v1.0.