micromdm/nanodep

NanoDEP is a set of tools and a Go library powering them for communicating with Apple's Device Enrollment Program (DEP) API servers.

NanoDEP

NanoDEP is a set of tools and a Go library powering them for communicating with Apple's Device Enrollment Program (DEP) API servers.

Getting started & Documentation

• Quickstart
  A guide to get NanoDEP up and running quickly.

• Operations Guide
  A brief overview of the various tools and utilities for working with NanoDEP.

Getting the latest version

• Release .zip files containing the project should be attached to every GitHub release.
  • Release zips are also published for every main branch commit.
• A Docker container is built and published to the GHCR.io registry for every release.
  • docker pull ghcr.io/micromdm/nanodep:latest — docker run ghcr.io/micromdm/nanodep:latest
  • A Docker container is also published for every main branch commit (and tagged with :main)
• If you have a Go toolchain installed you can checkout the source and simply run make.

Tools and utilities

NanoDEP contains a few tools and utilities. At a high level:

• DEP configuration & reverse proxy server. The primary server component, called depserver is used for configuring NanoDEP and talking with Apple's DEP servers. It hosts its own API for configuring MDM server instances used with Apple's servers (called DEP names) and also hosts a transparently authenticating reverse proxy for talking 'directly' to Apple's DEP API endpoints.
• Device sync & assigner. The depsyncer tool handles the device fetch/sync cursor logic to continually retrieve the assigned devices from one or more Apple DEP MDM server instance(s).
• Scripts, tools, and helpers.
  • A set of tools and utilities for talking to the Apple DEP API services — mostly implemented as shell scripts that communicate to the depserver.
  • A stand-alone deptokens tool for locally working with certificate generation for DEP token decryption.

See the Operations Guide for more details and usage documentation.

Go library

NanoDEP is also a Go library for accessing the Apple DEP APIs. There are two components to the Go library:

• The higher-level godep package implements Go methods and structures for talking to the individual DEP API endpoints.
• The lower-level client package implements primitives, helpers, and middleware for authenticating to the DEP API and managing sessions tokens.

See the Go Reference documentation (or the Go source itself, of course) for details on these packages.

nanodep's Issues

MongoDB Support

See micromdm/nanomdm#57

We'd like to implement a mongoDB connector that satisfies the AllStorage interface and maintain support for the connector as this project continues.

depsyncer error: 400 Bad Request: USER_AGENT_INVALID

[root@iZuf64hzarhamgerishd1nZ nanodep]# ./depsyncer-linux-amd64 -debug -limit 1000 -duration 60 dep
2024/01/22 00:55:28 level=debug component=syncer name=dep msg=starting timer duration=1m0s
2024/01/22 00:55:29 level=info component=syncer name=dep msg=error syncing phase=fetch cursor= err=DEP HTTP error: 400 Bad Request: USER_AGENT_INVALID
2024/01/22 00:56:29 level=info component=syncer name=dep msg=error syncing phase=fetch cursor= err=DEP HTTP error: 400 Bad Request: USER_AGENT_INVALID

As a beginner, I am using nanodep, and according to the reference documentation, I have made the settings, but I encountered a problem when enabling depsyncer. Please help me, thank you.

Code reuse for tokens and tokenspki endpoints

Currently there's a bit of code duplication in DecryptTokenPKIHandler and StoreAuthTokensHandler. To de-dupe some of that.

Implement MySQL backend

Currently NanoDEP only has a file storage backend. Implement a MySQL store.

Consider updating default DEP version to 7 from 3

Latest version of DEP protocol is v7 as noted in Apple docs — example 1. While users of NanoDEP can explicitly set any protocol version they like we set default to 3 here:

nanodep/client/transport.go

Line 19 in 3b6c000

DefaultServerProtocolVersion = "3"

Consider upping the default to the current version 7.

depsyncer specifies whether there is a quantity limit for DEP, and what is the impact of a large quantity?

depsyncer specifies whether there is a quantity limit for DEP, and what is the impact of a large quantity?

[BUG]depsyncer callback error dep_name

When multiple DEPNAME are configured, the device_response_event.dep_name in the callback data is always the last one.

example

./nanodep/depsyncer-linux-amd64 -webhook-url "http://webhook" -storage mysql -storage-dsn "root:root@tcp(host:3306)/nanodep" -limit 100 -duration 600 foo bar

device_response_event.dep_name in the callback is always bar

Release new version

#42The issue appears to be working correctly.
Can you release the latest version?
@jessepeterson

file backend will fail with existing file

We check for an existing DSN (directory), but not if it is actually a directory.

Verify matching consumer key

Check previous Consumer Key when uploading the tokens to try to prevent overwriting the wrong tokens.

[depsyncer]memory usage is getting higher and higher

I am using pm2 to deploy depsyncer.
This is my pm2 ecosystem config file

module.exports = {
    apps: [
        {
            "name": "depsyncer",
            "cwd": "/var/www/nanodep",
            "script": "/var/www/nanodep/depsyncer-linux-amd64",
            "args": '-webhook-url "url" -storage mysql -storage-dsn "username:password@tcp(host:3306)/nanodep" -limit 100 -duration 10 DEP_NAME',
            "watch": false,
            "autorestart": true,
            "instances": 1,
            "interpreter": "",
        },
    ]
}

I would like to ask why the memory usage is getting higher and higher? Is this normal? @jessepeterson

support an in-progress certificate update workflow

It's clear that with the MAID jwt (see #24) that the DEP private key that the server holds will need to be used throughout the DEP server operation and not just at OAuth token exchange time. Thus we'd like to be able to have a 'staged' PKI set when we're generating/downloading keys that do not overwrite the primary in-use key when we upload a new one. Perhaps the in-use PKI set are replaced as soon as new OAuth1 tokens are uploaded.

[feature] depsyncer add sync all dep

@jessepeterson
New option --all is added to indicate operating all.
All I can think of is reading the database every time.
Although this may bring additional overhead

DEP ENROLLMENT STATUS

Hello,

Is there a way to check if the device is DEP enrolled?

Consider ability to force CK change

The fix for #1 guarded against uploading tokens with a differing consumer key. However if the CK legitimately changes there may be a need to allow "forcing" replacing the OAuth tokens for a given DEP name.