2016-09-26 18:48:55 +00:00
package service
2016-08-28 03:59:17 +00:00
import (
2017-03-15 15:55:30 +00:00
"context"
2024-11-22 15:56:36 +00:00
"encoding/json"
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
"errors"
2023-01-16 20:06:30 +00:00
"fmt"
2026-02-26 23:40:46 +00:00
"log/slog"
redirect to correct URL, and allow both URLs for MDM SSO SAML validation if set (#44156)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #41592
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [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/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements), JS
inline code is prevented especially for url redirects, and untrusted
data interpolated into shell scripts/commands is validated against shell
metacharacters.
- [x] Timeouts are implemented and retries are limited to avoid infinite
loops
- [x] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Bug Fixes**
* Fixed SSO failures when a custom Apple MDM URL is configured: callback
requests are now redirected to the configured MDM URL when needed, and
SAML validation correctly considers the configured MDM/server URLs so
authentication succeeds for custom MDM setups.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-29 14:43:58 +00:00
"net"
2016-08-28 03:59:17 +00:00
"net/http"
redirect to correct URL, and allow both URLs for MDM SSO SAML validation if set (#44156)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #41592
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [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/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements), JS
inline code is prevented especially for url redirects, and untrusted
data interpolated into shell scripts/commands is validated against shell
metacharacters.
- [x] Timeouts are implemented and retries are limited to avoid infinite
loops
- [x] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Bug Fixes**
* Fixed SSO failures when a custom Apple MDM URL is configured: callback
requests are now redirected to the configured MDM URL when needed, and
SAML validation correctly considers the configured MDM/server URLs so
authentication succeeds for custom MDM setups.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-29 14:43:58 +00:00
"net/url"
2024-11-11 19:25:21 +00:00
"os"
2022-03-08 16:27:38 +00:00
"regexp"
2024-11-11 19:25:21 +00:00
"strings"
2025-03-14 17:16:51 +00:00
"time"
2016-08-28 03:59:17 +00:00
speed up macOS profile delivery for initial enrollments (#41960)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #34433
It speeds up the cron, meaning fleetd, bootstrap and now profiles should
be sent within 10 seconds of being known to fleet, compared to the
previous 1 minute.
It's heavily based on my last PR, so the structure and changes are close
to identical, with some small differences.
**I did not do the redis key part in this PR, as I think that should
come in it's own PR, to avoid overlooking logic bugs with that code, and
since this one is already quite sized since we're moving core pieces of
code around.**
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Faster macOS onboarding: device profiles are delivered and installed
as part of DEP enrollment, shortening initial setup.
* Improved profile handling: per-host profile preprocessing, secret
detection, and clearer failure marking.
* **Improvements**
* Consolidated SCEP/NDES error messaging for clearer diagnostics.
* Cron/work scheduling tuned to prioritize Apple MDM profile delivery.
* **Tests**
* Expanded MDM unit and integration tests, including
DeclarativeManagement handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-03-19 19:58:10 +00:00
"github.com/fleetdm/fleet/v4/ee/server/service/scep"
2021-06-26 04:46:51 +00:00
"github.com/fleetdm/fleet/v4/server/config"
2026-02-05 18:55:03 +00:00
carvestorectx "github.com/fleetdm/fleet/v4/server/contexts/carvestore"
2022-03-21 16:29:52 +00:00
"github.com/fleetdm/fleet/v4/server/contexts/publicip"
2025-09-26 18:03:50 +00:00
"github.com/fleetdm/fleet/v4/server/datastore/redis"
2021-06-26 04:46:51 +00:00
"github.com/fleetdm/fleet/v4/server/fleet"
2022-10-05 22:53:54 +00:00
apple_mdm "github.com/fleetdm/fleet/v4/server/mdm/apple"
2024-05-30 21:18:42 +00:00
mdmcrypto "github.com/fleetdm/fleet/v4/server/mdm/crypto"
2026-02-05 18:55:03 +00:00
microsoft_mdm "github.com/fleetdm/fleet/v4/server/mdm/microsoft"
2024-11-20 17:47:11 +00:00
"github.com/fleetdm/fleet/v4/server/mdm/nanomdm/cryptoutil"
2024-01-12 02:28:48 +00:00
httpmdm "github.com/fleetdm/fleet/v4/server/mdm/nanomdm/http/mdm"
nanomdm_service "github.com/fleetdm/fleet/v4/server/mdm/nanomdm/service"
"github.com/fleetdm/fleet/v4/server/mdm/nanomdm/service/certauth"
"github.com/fleetdm/fleet/v4/server/mdm/nanomdm/service/multi"
"github.com/fleetdm/fleet/v4/server/mdm/nanomdm/service/nanomdm"
2024-02-22 22:24:11 +00:00
scep_depot "github.com/fleetdm/fleet/v4/server/mdm/scep/depot"
scepserver "github.com/fleetdm/fleet/v4/server/mdm/scep/server"
2026-01-06 20:23:07 +00:00
"github.com/fleetdm/fleet/v4/server/platform/endpointer"
"github.com/fleetdm/fleet/v4/server/platform/middleware/ratelimit"
2025-04-10 19:08:45 +00:00
"github.com/fleetdm/fleet/v4/server/service/contract"
2025-02-03 17:23:26 +00:00
"github.com/fleetdm/fleet/v4/server/service/middleware/auth"
2025-02-26 16:47:05 +00:00
"github.com/fleetdm/fleet/v4/server/service/middleware/log"
2023-03-27 19:30:29 +00:00
"github.com/fleetdm/fleet/v4/server/service/middleware/mdmconfigured"
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
"github.com/fleetdm/fleet/v4/server/service/middleware/otel"
2026-02-05 15:29:53 +00:00
2026-02-05 18:55:03 +00:00
"github.com/docker/go-units"
2016-08-28 03:59:17 +00:00
kithttp "github.com/go-kit/kit/transport/http"
"github.com/gorilla/mux"
2026-02-05 18:55:03 +00:00
"github.com/klauspost/compress/gzhttp"
2024-11-20 17:47:11 +00:00
nanomdm_log "github.com/micromdm/nanolib/log"
2016-12-22 17:39:44 +00:00
"github.com/prometheus/client_golang/prometheus"
2021-12-20 14:20:58 +00:00
"github.com/prometheus/client_golang/prometheus/promhttp"
2021-03-26 18:23:29 +00:00
"github.com/throttled/throttled/v2"
2023-04-24 05:13:15 +00:00
"go.elastic.co/apm/module/apmgorilla/v2"
2022-02-15 17:42:22 +00:00
otmiddleware "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux"
2016-08-28 03:59:17 +00:00
)
2021-08-26 13:28:53 +00:00
func checkLicenseExpiration ( svc fleet . Service ) func ( context . Context , http . ResponseWriter ) context . Context {
return func ( ctx context . Context , w http . ResponseWriter ) context . Context {
license , err := svc . License ( ctx )
if err != nil || license == nil {
return ctx
}
2021-09-03 16:05:23 +00:00
if license . IsPremium ( ) && license . IsExpired ( ) {
2021-08-26 13:28:53 +00:00
w . Header ( ) . Set ( fleet . HeaderLicenseKey , fleet . HeaderLicenseValueExpired )
}
return ctx
}
}
2022-04-19 13:35:53 +00:00
type extraHandlerOpts struct {
2025-05-30 22:34:47 +00:00
loginRateLimit * throttled . Rate
mdmSsoRateLimit * throttled . Rate
2025-07-16 18:08:27 +00:00
httpSigVerifier mux . MiddlewareFunc
2022-04-19 13:35:53 +00:00
}
// ExtraHandlerOption allows adding extra configuration to the HTTP handler.
type ExtraHandlerOption func ( * extraHandlerOpts )
2025-05-30 22:34:47 +00:00
// WithLoginRateLimit configures the rate limit for the login endpoints.
2022-04-19 13:35:53 +00:00
func WithLoginRateLimit ( r throttled . Rate ) ExtraHandlerOption {
return func ( o * extraHandlerOpts ) {
o . loginRateLimit = & r
}
}
2025-05-30 22:34:47 +00:00
// WithMdmSsoRateLimit configures the rate limit for the MDM SSO endpoints (falls back to login rate limit otherwise).
func WithMdmSsoRateLimit ( r throttled . Rate ) ExtraHandlerOption {
return func ( o * extraHandlerOpts ) {
o . mdmSsoRateLimit = & r
}
}
2025-07-16 18:08:27 +00:00
func WithHTTPSigVerifier ( m mux . MiddlewareFunc ) ExtraHandlerOption {
return func ( o * extraHandlerOpts ) {
o . httpSigVerifier = m
}
}
2026-02-05 18:55:03 +00:00
func setCarveStoreInRequestContext ( carveStore fleet . CarveStore ) kithttp . RequestFunc {
return func ( ctx context . Context , r * http . Request ) context . Context {
ctx = carvestorectx . NewContext ( ctx , carveStore )
return ctx
}
}
2019-01-24 17:39:32 +00:00
// MakeHandler creates an HTTP handler for the Fleet server endpoints.
2022-04-19 13:35:53 +00:00
func MakeHandler (
svc fleet . Service ,
config config . FleetConfig ,
2026-02-26 23:40:46 +00:00
logger * slog . Logger ,
2022-04-19 13:35:53 +00:00
limitStore throttled . GCRAStore ,
2025-09-26 18:03:50 +00:00
redisPool fleet . RedisPool ,
2026-02-05 18:55:03 +00:00
carveStore fleet . CarveStore ,
2026-01-06 20:23:07 +00:00
featureRoutes [ ] endpointer . HandlerRoutesFunc ,
2022-04-19 13:35:53 +00:00
extra ... ExtraHandlerOption ,
) http . Handler {
var eopts extraHandlerOpts
for _ , fn := range extra {
fn ( & eopts )
}
2026-01-20 04:13:37 +00:00
// Create the client IP extraction strategy based on config.
ipStrategy , err := endpointer . NewClientIPStrategy ( config . Server . TrustedProxies )
if err != nil {
panic ( fmt . Sprintf ( "invalid server.trusted_proxies configuration: %v" , err ) )
}
2021-06-04 23:51:18 +00:00
fleetAPIOptions := [ ] kithttp . ServerOption {
2016-09-04 19:43:12 +00:00
kithttp . ServerBefore (
2017-12-01 00:52:23 +00:00
kithttp . PopulateRequestContext , // populate the request context with common fields
2025-02-03 17:23:26 +00:00
auth . SetRequestsContexts ( svc ) ,
2026-02-26 04:20:35 +00:00
endpointer . LogDeprecatedPathAlias , // log deprecation warning for deprecated URL path aliases
2026-02-05 18:55:03 +00:00
setCarveStoreInRequestContext ( carveStore ) ,
2016-09-04 19:43:12 +00:00
) ,
2026-02-26 23:40:46 +00:00
kithttp . ServerErrorHandler ( & endpointer . ErrorHandler { Logger : logger } ) ,
2025-12-31 15:12:00 +00:00
kithttp . ServerErrorEncoder ( fleetErrorEncoder ) ,
2016-09-04 19:43:12 +00:00
kithttp . ServerAfter (
kithttp . SetContentType ( "application/json; charset=utf-8" ) ,
2026-02-26 23:40:46 +00:00
log . LogRequestEnd ( logger ) ,
2021-08-26 13:28:53 +00:00
checkLicenseExpiration ( svc ) ,
2016-09-04 19:43:12 +00:00
) ,
}
2016-08-28 03:59:17 +00:00
2016-09-04 19:43:12 +00:00
r := mux . NewRouter ( )
2023-04-24 05:13:15 +00:00
if config . Logging . TracingEnabled {
2026-02-07 00:57:28 +00:00
if config . OTELEnabled ( ) {
OpenTelemetry minor improvements (#32324)
Fixes #32313
OpenTelemetry Tracing
- Added tracing to async task collectors: FlushHostsLastSeen,
collectHostsLastSeen, collectLabelQueryExecutions,
collectPolicyQueryExecutions, collectScheduledQueryStats
- Updated HTTP middleware to use OTEL semantic convention for span names
({method} {route})
- Added OTELEnabled() helper to FleetConfig
Optimizations
- Reduced OTEL batch size from 512 to 256 spans to prevent gRPC message
size errors
- Enabled gzip compression for trace exports
NOTE: I tried to improve OTEL instrumentation for cron jobs, but it got
too complicated due to goroutines in `schedule.go` so that effort should
be separate. We do have SQL instrumentation for cron jobs, but we are
missing root spans for cron jobs as a whole.
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Expanded OpenTelemetry tracing for async tasks (host last seen, label
membership, policy membership, scheduled query stats) to provide richer
observability.
* More descriptive HTTP span names using “METHOD /route” for clearer
trace analysis.
* **Bug Fixes**
* Improved OTLP gRPC exporter reliability by enabling gzip compression
and reducing export batch size, mitigating intermittent gRPC errors.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-08-29 00:32:46 +00:00
r . Use ( otmiddleware . Middleware (
"service" ,
otmiddleware . WithSpanNameFormatter ( func ( route string , r * http . Request ) string {
// Use the guideline for span names: {method} {target}
// See https://opentelemetry.io/docs/specs/semconv/http/http-spans/
return r . Method + " " + route
} ) ) )
2023-04-24 05:13:15 +00:00
} else {
apmgorilla . Instrument ( r )
}
2022-02-15 17:42:22 +00:00
}
2021-02-10 20:13:11 +00:00
2026-01-29 11:21:18 +00:00
if config . Server . GzipResponses {
r . Use ( func ( h http . Handler ) http . Handler {
return gzhttp . GzipHandler ( h )
} )
}
2026-01-20 04:13:37 +00:00
// Add middleware to extract the client IP and set it in the request context.
r . Use ( func ( handler http . Handler ) http . Handler {
return http . HandlerFunc ( func ( w http . ResponseWriter , r * http . Request ) {
ip := ipStrategy . ClientIP ( r . Header , r . RemoteAddr )
if ip != "" {
r . RemoteAddr = ip
}
handler . ServeHTTP ( w , r . WithContext ( publicip . NewContext ( r . Context ( ) , ip ) ) )
} )
} )
2025-07-16 18:08:27 +00:00
if eopts . httpSigVerifier != nil {
r . Use ( eopts . httpSigVerifier )
}
2022-03-21 16:29:52 +00:00
2025-09-26 18:03:50 +00:00
attachFleetAPIRoutes ( r , svc , config , logger , limitStore , redisPool , fleetAPIOptions , eopts )
2025-02-13 20:32:19 +00:00
for _ , featureRoute := range featureRoutes {
featureRoute ( r , fleetAPIOptions )
}
2020-11-13 03:06:56 +00:00
addMetrics ( r )
2016-08-28 03:59:17 +00:00
return r
}
2016-09-26 17:14:39 +00:00
2022-04-07 12:40:53 +00:00
// PrometheusMetricsHandler wraps the provided handler with prometheus metrics
2021-12-20 14:20:58 +00:00
// middleware and returns the resulting handler that should be mounted for that
// route.
2022-04-07 12:40:53 +00:00
func PrometheusMetricsHandler ( name string , handler http . Handler ) http . Handler {
2021-12-20 14:20:58 +00:00
reg := prometheus . DefaultRegisterer
registerOrExisting := func ( coll prometheus . Collector ) prometheus . Collector {
if err := reg . Register ( coll ) ; err != nil {
if are , ok := err . ( prometheus . AlreadyRegisteredError ) ; ok {
return are . ExistingCollector
}
panic ( err )
}
return coll
}
// this configuration is to keep prometheus metrics as close as possible to
// what the v0.9.3 (that we used to use) provided via the now-deprecated
// prometheus.InstrumentHandler.
reqCnt := registerOrExisting ( prometheus . NewCounterVec (
prometheus . CounterOpts {
Subsystem : "http" ,
Name : "requests_total" ,
Help : "Total number of HTTP requests made." ,
ConstLabels : prometheus . Labels { "handler" : name } ,
} ,
[ ] string { "method" , "code" } ,
) ) . ( * prometheus . CounterVec )
reqDur := registerOrExisting ( prometheus . NewHistogramVec (
prometheus . HistogramOpts {
Subsystem : "http" ,
Name : "request_duration_seconds" ,
Help : "The HTTP request latencies in seconds." ,
ConstLabels : prometheus . Labels { "handler" : name } ,
// Use default buckets, as they are suited for durations.
} ,
nil ,
) ) . ( * prometheus . HistogramVec )
// 1KB, 100KB, 1MB, 100MB, 1GB
sizeBuckets := [ ] float64 { 1024 , 100 * 1024 , 1024 * 1024 , 100 * 1024 * 1024 , 1024 * 1024 * 1024 }
resSz := registerOrExisting ( prometheus . NewHistogramVec (
prometheus . HistogramOpts {
Subsystem : "http" ,
Name : "response_size_bytes" ,
Help : "The HTTP response sizes in bytes." ,
ConstLabels : prometheus . Labels { "handler" : name } ,
Buckets : sizeBuckets ,
} ,
nil ,
) ) . ( * prometheus . HistogramVec )
reqSz := registerOrExisting ( prometheus . NewHistogramVec (
prometheus . HistogramOpts {
Subsystem : "http" ,
Name : "request_size_bytes" ,
Help : "The HTTP request sizes in bytes." ,
ConstLabels : prometheus . Labels { "handler" : name } ,
Buckets : sizeBuckets ,
} ,
nil ,
) ) . ( * prometheus . HistogramVec )
return promhttp . InstrumentHandlerDuration ( reqDur ,
promhttp . InstrumentHandlerCounter ( reqCnt ,
promhttp . InstrumentHandlerResponseSize ( resSz ,
promhttp . InstrumentHandlerRequestSize ( reqSz , handler ) ) ) )
}
// addMetrics decorates each handler with prometheus instrumentation
2016-12-22 17:39:44 +00:00
func addMetrics ( r * mux . Router ) {
walkFn := func ( route * mux . Route , router * mux . Router , ancestors [ ] * mux . Route ) error {
2022-04-07 12:40:53 +00:00
route . Handler ( PrometheusMetricsHandler ( route . GetName ( ) , route . GetHandler ( ) ) )
2016-12-22 17:39:44 +00:00
return nil
}
2022-12-05 22:50:49 +00:00
r . Walk ( walkFn ) //nolint:errcheck
2016-12-22 17:39:44 +00:00
}
2023-06-15 19:41:04 +00:00
// These are defined as const so that they can be used in tests.
const (
2025-09-26 18:03:50 +00:00
forgotPasswordRateLimitMaxBurst = 9 // Max burst used for rate limiting on the the forgot_password endpoint.
// Fleet Desktop API endpoints rate limiting:
//
// Allow up to 1_000 consecutive failing requests per minute.
// If the threshold of 1_000 consecutive failures is reached for an IP,
// ban requests from such IP for a duration of 1 minute.
//
deviceIPAllowedConsecutiveFailingRequestsCount = 1_000
deviceIPAllowedConsecutiveFailingRequestsTimeWindow = 1 * time . Minute
deviceIPBanTime = 1 * time . Minute
2023-06-15 19:41:04 +00:00
)
2022-07-18 17:22:49 +00:00
2022-03-08 16:27:38 +00:00
func attachFleetAPIRoutes ( r * mux . Router , svc fleet . Service , config config . FleetConfig ,
2026-02-26 23:40:46 +00:00
logger * slog . Logger , limitStore throttled . GCRAStore , redisPool fleet . RedisPool , opts [ ] kithttp . ServerOption ,
2022-04-19 13:35:53 +00:00
extra extraHandlerOpts ,
Add read replica testing helpers and fix non-sso login bug (#4908)
not set on the INSERT.
- OUT: Only sets the ID on the passed session and returns it. (`CreatedAt`, `AccessedAt`, are not set.)
New version:
```go
func (ds *Datastore) NewSession(ctx context.Context, userID uint, sessionKey string) (*fleet.Session, error) {
sqlStatement := `
INSERT INTO sessions (
user_id,
` + "`key`" + `
)
VALUES(?,?)
`
result, err := ds.writer.ExecContext(ctx, sqlStatement, userID, sessionKey)
if err != nil {
return nil, ctxerr.Wrap(ctx, err, "inserting session")
}
id, _ := result.LastInsertId() // cannot fail with the mysql driver
return ds.sessionByID(ctx, ds.writer, uint(id))
}
```
- IN: Define arguments that are truly used when creating a session.
- OUT: Load and return the fleet.Session struct with all values set (using the `ds.writer` to support read replicas correctly).
PS: The new `NewSession` version mimics what we already do with other entities, like policies (`Datastore.NewGlobalPolicy`).
2022-04-04 23:52:05 +00:00
) {
2022-04-05 15:35:53 +00:00
apiVersions := [ ] string { "v1" , "2022-04" }
2026-02-26 04:20:35 +00:00
registry := endpointer . NewHandlerRegistry ( )
2022-04-05 15:35:53 +00:00
2022-03-07 18:10:55 +00:00
// user-authenticated endpoints
2022-04-05 15:35:53 +00:00
ue := newUserAuthenticatedEndpointer ( svc , opts , r , apiVersions ... )
2026-02-26 04:20:35 +00:00
ue . HandlerRegistry = registry
2022-03-07 18:10:55 +00:00
2022-11-30 17:57:42 +00:00
ue . POST ( "/api/_version_/fleet/trigger" , triggerEndpoint , triggerRequest { } )
2022-11-28 19:28:06 +00:00
2025-01-09 18:04:47 +00:00
ue . GET ( "/api/_version_/fleet/me" , meEndpoint , getMeRequest { } )
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/sessions/{id:[0-9]+}" , getInfoAboutSessionEndpoint , getInfoAboutSessionRequest { } )
ue . DELETE ( "/api/_version_/fleet/sessions/{id:[0-9]+}" , deleteSessionEndpoint , deleteSessionRequest { } )
ue . GET ( "/api/_version_/fleet/config/certificate" , getCertificateEndpoint , nil )
ue . GET ( "/api/_version_/fleet/config" , getAppConfigEndpoint , nil )
ue . PATCH ( "/api/_version_/fleet/config" , modifyAppConfigEndpoint , modifyAppConfigRequest { } )
2026-05-05 12:42:52 +00:00
ue . WithRequestBodySizeLimit ( fleet . OrgLogoMaxFileSize ) . PUT ( "/api/_version_/fleet/logo" , putOrgLogoEndpoint , putOrgLogoRequest { } )
ue . DELETE ( "/api/_version_/fleet/logo" , deleteOrgLogoEndpoint , deleteOrgLogoRequest { } )
2022-03-07 18:10:55 +00:00
ue . POST ( "/api/_version_/fleet/spec/enroll_secret" , applyEnrollSecretSpecEndpoint , applyEnrollSecretSpecRequest { } )
ue . GET ( "/api/_version_/fleet/spec/enroll_secret" , getEnrollSecretSpecEndpoint , nil )
ue . GET ( "/api/_version_/fleet/version" , versionEndpoint , nil )
ue . POST ( "/api/_version_/fleet/users/roles/spec" , applyUserRoleSpecsEndpoint , applyUserRoleSpecsRequest { } )
ue . POST ( "/api/_version_/fleet/translate" , translatorEndpoint , translatorRequest { } )
2026-02-26 04:20:35 +00:00
ue . WithRequestBodySizeLimit ( 5 * units . MiB ) . POST ( "/api/_version_/fleet/spec/fleets" , applyTeamSpecsEndpoint , applyTeamSpecsRequest { } )
ue . PATCH ( "/api/_version_/fleet/fleets/{fleet_id:[0-9]+}/secrets" , modifyTeamEnrollSecretsEndpoint , modifyTeamEnrollSecretsRequest { } )
ue . POST ( "/api/_version_/fleet/fleets" , createTeamEndpoint , createTeamRequest { } )
ue . GET ( "/api/_version_/fleet/fleets" , listTeamsEndpoint , listTeamsRequest { } )
ue . GET ( "/api/_version_/fleet/fleets/{id:[0-9]+}" , getTeamEndpoint , getTeamRequest { } )
ue . PATCH ( "/api/_version_/fleet/fleets/{id:[0-9]+}" , modifyTeamEndpoint , modifyTeamRequest { } )
ue . DELETE ( "/api/_version_/fleet/fleets/{id:[0-9]+}" , deleteTeamEndpoint , deleteTeamRequest { } )
ue . WithRequestBodySizeLimit ( 2 * units . MiB ) . POST ( "/api/_version_/fleet/fleets/{id:[0-9]+}/agent_options" , modifyTeamAgentOptionsEndpoint , modifyTeamAgentOptionsRequest { } )
ue . GET ( "/api/_version_/fleet/fleets/{id:[0-9]+}/users" , listTeamUsersEndpoint , listTeamUsersRequest { } )
ue . PATCH ( "/api/_version_/fleet/fleets/{id:[0-9]+}/users" , addTeamUsersEndpoint , modifyTeamUsersRequest { } )
ue . DELETE ( "/api/_version_/fleet/fleets/{id:[0-9]+}/users" , deleteTeamUsersEndpoint , modifyTeamUsersRequest { } )
ue . GET ( "/api/_version_/fleet/fleets/{id:[0-9]+}/secrets" , teamEnrollSecretsEndpoint , teamEnrollSecretsRequest { } )
2021-12-21 15:23:12 +00:00
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/users" , listUsersEndpoint , listUsersRequest { } )
ue . POST ( "/api/_version_/fleet/users/admin" , createUserEndpoint , createUserRequest { } )
2026-04-16 15:11:39 +00:00
ue . POST ( "/api/_version_/fleet/users/api_only" , createAPIOnlyUserEndpoint , createAPIOnlyUserRequest { } )
ue . PATCH ( "/api/_version_/fleet/users/api_only/{id:[0-9]+}" , modifyAPIOnlyUserEndpoint , modifyAPIOnlyUserRequest { } )
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/users/{id:[0-9]+}" , getUserEndpoint , getUserRequest { } )
ue . PATCH ( "/api/_version_/fleet/users/{id:[0-9]+}" , modifyUserEndpoint , modifyUserRequest { } )
ue . DELETE ( "/api/_version_/fleet/users/{id:[0-9]+}" , deleteUserEndpoint , deleteUserRequest { } )
ue . POST ( "/api/_version_/fleet/users/{id:[0-9]+}/require_password_reset" , requirePasswordResetEndpoint , requirePasswordResetRequest { } )
ue . GET ( "/api/_version_/fleet/users/{id:[0-9]+}/sessions" , getInfoAboutSessionsForUserEndpoint , getInfoAboutSessionsForUserRequest { } )
ue . DELETE ( "/api/_version_/fleet/users/{id:[0-9]+}/sessions" , deleteSessionsForUserEndpoint , deleteSessionsForUserRequest { } )
ue . POST ( "/api/_version_/fleet/change_password" , changePasswordEndpoint , changePasswordRequest { } )
ue . GET ( "/api/_version_/fleet/email/change/{token}" , changeEmailEndpoint , changeEmailRequest { } )
2022-06-10 18:29:45 +00:00
// TODO: searchTargetsEndpoint will be removed in Fleet 5.0
2022-03-07 18:10:55 +00:00
ue . POST ( "/api/_version_/fleet/targets" , searchTargetsEndpoint , searchTargetsRequest { } )
2022-06-10 18:29:45 +00:00
ue . POST ( "/api/_version_/fleet/targets/count" , countTargetsEndpoint , countTargetsRequest { } )
2022-03-07 18:10:55 +00:00
ue . POST ( "/api/_version_/fleet/invites" , createInviteEndpoint , createInviteRequest { } )
ue . GET ( "/api/_version_/fleet/invites" , listInvitesEndpoint , listInvitesRequest { } )
ue . DELETE ( "/api/_version_/fleet/invites/{id:[0-9]+}" , deleteInviteEndpoint , deleteInviteRequest { } )
ue . PATCH ( "/api/_version_/fleet/invites/{id:[0-9]+}" , updateInviteEndpoint , updateInviteRequest { } )
2026-04-07 14:04:08 +00:00
ue . EndingAtVersion ( "v1" ) . POST ( "/api/_version_/fleet/global/policies" , globalPolicyEndpoint , fleet . GlobalPolicyRequest { } )
ue . StartingAtVersion ( "2022-04" ) . POST ( "/api/_version_/fleet/policies" , globalPolicyEndpoint , fleet . GlobalPolicyRequest { } )
ue . EndingAtVersion ( "v1" ) . GET ( "/api/_version_/fleet/global/policies" , listGlobalPoliciesEndpoint , fleet . ListGlobalPoliciesRequest { } )
ue . StartingAtVersion ( "2022-04" ) . GET ( "/api/_version_/fleet/policies" , listGlobalPoliciesEndpoint , fleet . ListGlobalPoliciesRequest { } )
ue . GET ( "/api/_version_/fleet/policies/count" , countGlobalPoliciesEndpoint , fleet . CountGlobalPoliciesRequest { } )
ue . EndingAtVersion ( "v1" ) . GET ( "/api/_version_/fleet/global/policies/{policy_id}" , getPolicyByIDEndpoint , fleet . GetPolicyByIDRequest { } )
ue . StartingAtVersion ( "2022-04" ) . GET ( "/api/_version_/fleet/policies/{policy_id}" , getPolicyByIDEndpoint , fleet . GetPolicyByIDRequest { } )
ue . EndingAtVersion ( "v1" ) . POST ( "/api/_version_/fleet/global/policies/delete" , deleteGlobalPoliciesEndpoint , fleet . DeleteGlobalPoliciesRequest { } )
ue . StartingAtVersion ( "2022-04" ) . POST ( "/api/_version_/fleet/policies/delete" , deleteGlobalPoliciesEndpoint , fleet . DeleteGlobalPoliciesRequest { } )
ue . EndingAtVersion ( "v1" ) . PATCH ( "/api/_version_/fleet/global/policies/{policy_id}" , modifyGlobalPolicyEndpoint , fleet . ModifyGlobalPolicyRequest { } )
ue . StartingAtVersion ( "2022-04" ) . PATCH ( "/api/_version_/fleet/policies/{policy_id}" , modifyGlobalPolicyEndpoint , fleet . ModifyGlobalPolicyRequest { } )
ue . POST ( "/api/_version_/fleet/automations/reset" , resetAutomationEndpoint , fleet . ResetAutomationRequest { } )
ue . POST ( "/api/_version_/fleet/fleets/{fleet_id}/policies" , teamPolicyEndpoint , fleet . TeamPolicyRequest { } )
ue . GET ( "/api/_version_/fleet/fleets/{fleet_id}/policies" , listTeamPoliciesEndpoint , fleet . ListTeamPoliciesRequest { } )
ue . GET ( "/api/_version_/fleet/fleets/{fleet_id}/policies/count" , countTeamPoliciesEndpoint , fleet . CountTeamPoliciesRequest { } )
ue . GET ( "/api/_version_/fleet/fleets/{fleet_id}/policies/{policy_id}" , getTeamPolicyByIDEndpoint , fleet . GetTeamPolicyByIDRequest { } )
ue . POST ( "/api/_version_/fleet/fleets/{fleet_id}/policies/delete" , deleteTeamPoliciesEndpoint , fleet . DeleteTeamPoliciesRequest { } )
ue . PATCH ( "/api/_version_/fleet/fleets/{fleet_id}/policies/{policy_id}" , modifyTeamPolicyEndpoint , fleet . ModifyTeamPolicyRequest { } )
ue . WithRequestBodySizeLimit ( fleet . MaxSpecSize ) . POST ( "/api/_version_/fleet/spec/policies" , applyPolicySpecsEndpoint , fleet . ApplyPolicySpecsRequest { } )
2022-03-07 18:10:55 +00:00
gitops, basic apis, and table for android certificate templates (#35788)
**Related issue:** Resolves #35460, #35462
# 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/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
## Testing
- [x] Added/updated automated tests
- [x] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)
- [x] QA'd all new/changed functionality manually
## Database migrations
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
## Release Notes
* **New Features**
* Added certificate templates for managing Android device certificates
at global and team levels
* Introduced API endpoints to create, list, retrieve, and delete
certificate templates
* Enabled GitOps workflow support for certificate template
specifications
* Implemented automatic variable substitution in certificate subjects
for host identifiers
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Scott Gress <scott@fleetdm.com>
2025-11-24 21:44:06 +00:00
ue . POST ( "/api/_version_/fleet/certificates" , createCertificateTemplateEndpoint , createCertificateTemplateRequest { } )
ue . GET ( "/api/_version_/fleet/certificates" , listCertificateTemplatesEndpoint , listCertificateTemplatesRequest { } )
ue . GET ( "/api/_version_/fleet/certificates/{id:[0-9]+}" , getCertificateTemplateEndpoint , getCertificateTemplateRequest { } )
ue . DELETE ( "/api/_version_/fleet/certificates/{id:[0-9]+}" , deleteCertificateTemplateEndpoint , deleteCertificateTemplateRequest { } )
ue . POST ( "/api/_version_/fleet/spec/certificates" , applyCertificateTemplateSpecsEndpoint , applyCertificateTemplateSpecsRequest { } )
ue . DELETE ( "/api/_version_/fleet/spec/certificates" , deleteCertificateTemplateSpecsEndpoint , deleteCertificateTemplateSpecsRequest { } )
2026-04-13 19:02:23 +00:00
ue . GET ( "/api/_version_/fleet/reports/{id:[0-9]+}" , getQueryEndpoint , fleet . GetQueryRequest { } )
ue . GET ( "/api/_version_/fleet/reports" , listQueriesEndpoint , fleet . ListQueriesRequest { } )
ue . GET ( "/api/_version_/fleet/reports/{id:[0-9]+}/report" , getQueryReportEndpoint , fleet . GetQueryReportRequest { } )
ue . POST ( "/api/_version_/fleet/reports" , createQueryEndpoint , fleet . CreateQueryRequest { } )
ue . PATCH ( "/api/_version_/fleet/reports/{id:[0-9]+}" , modifyQueryEndpoint , fleet . ModifyQueryRequest { } )
ue . DELETE ( "/api/_version_/fleet/reports/{name}" , deleteQueryEndpoint , fleet . DeleteQueryRequest { } )
ue . DELETE ( "/api/_version_/fleet/reports/id/{id:[0-9]+}" , deleteQueryByIDEndpoint , fleet . DeleteQueryByIDRequest { } )
ue . POST ( "/api/_version_/fleet/reports/delete" , deleteQueriesEndpoint , fleet . DeleteQueriesRequest { } )
ue . WithRequestBodySizeLimit ( fleet . MaxSpecSize ) . POST ( "/api/_version_/fleet/spec/reports" , applyQuerySpecsEndpoint , fleet . ApplyQuerySpecsRequest { } )
ue . GET ( "/api/_version_/fleet/spec/reports" , getQuerySpecsEndpoint , fleet . GetQuerySpecsRequest { } )
ue . GET ( "/api/_version_/fleet/spec/reports/{name}" , getQuerySpecEndpoint , fleet . GetQuerySpecRequest { } )
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/packs/{id:[0-9]+}" , getPackEndpoint , getPackRequest { } )
ue . POST ( "/api/_version_/fleet/packs" , createPackEndpoint , createPackRequest { } )
ue . PATCH ( "/api/_version_/fleet/packs/{id:[0-9]+}" , modifyPackEndpoint , modifyPackRequest { } )
ue . GET ( "/api/_version_/fleet/packs" , listPacksEndpoint , listPacksRequest { } )
ue . DELETE ( "/api/_version_/fleet/packs/{name}" , deletePackEndpoint , deletePackRequest { } )
ue . DELETE ( "/api/_version_/fleet/packs/id/{id:[0-9]+}" , deletePackByIDEndpoint , deletePackByIDRequest { } )
2026-02-05 15:29:53 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxSpecSize ) . POST ( "/api/_version_/fleet/spec/packs" , applyPackSpecsEndpoint , applyPackSpecsRequest { } )
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/spec/packs" , getPackSpecsEndpoint , nil )
ue . GET ( "/api/_version_/fleet/spec/packs/{name}" , getPackSpecEndpoint , getGenericSpecRequest { } )
2023-12-06 14:30:49 +00:00
ue . GET ( "/api/_version_/fleet/software/versions" , listSoftwareVersionsEndpoint , listSoftwareRequest { } )
ue . GET ( "/api/_version_/fleet/software/versions/{id:[0-9]+}" , getSoftwareEndpoint , getSoftwareRequest { } )
// DEPRECATED: use /api/_version_/fleet/software/versions instead
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/software" , listSoftwareEndpoint , listSoftwareRequest { } )
2023-12-06 14:30:49 +00:00
// DEPRECATED: use /api/_version_/fleet/software/versions{id:[0-9]+} instead
2022-05-20 16:58:40 +00:00
ue . GET ( "/api/_version_/fleet/software/{id:[0-9]+}" , getSoftwareEndpoint , getSoftwareRequest { } )
2023-12-06 14:30:49 +00:00
// DEPRECATED: software version counts are now included directly in the software version list
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/software/count" , countSoftwareEndpoint , countSoftwareRequest { } )
2023-12-06 18:28:31 +00:00
ue . GET ( "/api/_version_/fleet/software/titles" , listSoftwareTitlesEndpoint , listSoftwareTitlesRequest { } )
ue . GET ( "/api/_version_/fleet/software/titles/{id:[0-9]+}" , getSoftwareTitleEndpoint , getSoftwareTitleRequest { } )
2024-09-09 16:13:20 +00:00
ue . POST ( "/api/_version_/fleet/hosts/{host_id:[0-9]+}/software/{software_title_id:[0-9]+}/install" , installSoftwareTitleEndpoint ,
installSoftwareRequest { } )
2024-09-05 19:20:36 +00:00
ue . POST ( "/api/_version_/fleet/hosts/{host_id:[0-9]+}/software/{software_title_id:[0-9]+}/uninstall" , uninstallSoftwareTitleEndpoint ,
uninstallSoftwareRequest { } )
2023-12-06 18:28:31 +00:00
2024-09-17 13:40:47 +00:00
// Software installers
2024-07-17 18:19:13 +00:00
ue . GET ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/package" , getSoftwareInstallerEndpoint , getSoftwareInstallerRequest { } )
2024-08-20 17:37:29 +00:00
ue . POST ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/package/token" , getSoftwareInstallerTokenEndpoint ,
getSoftwareInstallerRequest { } )
2026-02-05 15:29:53 +00:00
// Software package endpoints are already limited to max installer size in serve.go
ue . SkipRequestBodySizeLimit ( ) . POST ( "/api/_version_/fleet/software/package" , uploadSoftwareInstallerEndpoint , uploadSoftwareInstallerRequest { } )
2025-03-07 17:36:17 +00:00
ue . PATCH ( "/api/_version_/fleet/software/titles/{id:[0-9]+}/name" , updateSoftwareNameEndpoint , updateSoftwareNameRequest { } )
2026-02-05 15:29:53 +00:00
// Software package endpoints are already limited to max installer size in serve.go
ue . SkipRequestBodySizeLimit ( ) . PATCH ( "/api/_version_/fleet/software/titles/{id:[0-9]+}/package" , updateSoftwareInstallerEndpoint , updateSoftwareInstallerRequest { } )
2024-07-17 18:19:13 +00:00
ue . DELETE ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/available_for_install" , deleteSoftwareInstallerEndpoint , deleteSoftwareInstallerRequest { } )
2024-09-09 19:43:52 +00:00
ue . GET ( "/api/_version_/fleet/software/install/{install_uuid}/results" , getSoftwareInstallResultsEndpoint ,
getSoftwareInstallResultsRequest { } )
2024-09-20 14:55:47 +00:00
// POST /api/_version_/fleet/software/batch is asynchronous, meaning it will start the process of software download+upload in the background
// and will return a request UUID to be used in GET /api/_version_/fleet/software/batch/{request_uuid} to query for the status of the operation.
2026-03-17 15:20:09 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxSoftwareBatchSize ) . POST ( "/api/_version_/fleet/software/batch" , batchSetSoftwareInstallersEndpoint , batchSetSoftwareInstallersRequest { } )
2024-09-20 14:55:47 +00:00
ue . GET ( "/api/_version_/fleet/software/batch/{request_uuid}" , batchSetSoftwareInstallersResultEndpoint , batchSetSoftwareInstallersResultRequest { } )
2024-05-02 13:20:54 +00:00
2025-09-05 22:31:03 +00:00
// software title custom icons
ue . GET ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/icon" , getSoftwareTitleIconsEndpoint , getSoftwareTitleIconsRequest { } )
ue . PUT ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/icon" , putSoftwareTitleIconEndpoint , putSoftwareTitleIconRequest { } )
ue . DELETE ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/icon" , deleteSoftwareTitleIconEndpoint , deleteSoftwareTitleIconRequest { } )
2024-07-11 20:09:30 +00:00
// App store software
ue . GET ( "/api/_version_/fleet/software/app_store_apps" , getAppStoreAppsEndpoint , getAppStoreAppsRequest { } )
ue . POST ( "/api/_version_/fleet/software/app_store_apps" , addAppStoreAppEndpoint , addAppStoreAppRequest { } )
2025-02-03 17:16:21 +00:00
ue . PATCH ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/app_store_app" , updateAppStoreAppEndpoint , updateAppStoreAppRequest { } )
2024-07-11 20:09:30 +00:00
2024-10-08 20:41:57 +00:00
// Setup Experience
2025-09-04 15:58:47 +00:00
//
// Setup experience software endpoints:
2024-10-08 20:41:57 +00:00
ue . PUT ( "/api/_version_/fleet/setup_experience/software" , putSetupExperienceSoftware , putSetupExperienceSoftwareRequest { } )
ue . GET ( "/api/_version_/fleet/setup_experience/software" , getSetupExperienceSoftware , getSetupExperienceSoftwareRequest { } )
Add PUT endpoint for setup experience script (#35651)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #35309
Related doc update #35736
Adds a PUT endpoint for setting setup experience scripts, as opposed to
the current POST implementation(which errors if the script is already
set, which is why gitops calls DELETE first every time). If the contents
change, the new endpoint has the same effect as DELETE then POST today,
however if the contents are unchanged no changes occur, allowing gitops
runs to avoid cancelling script executions.
Also switched gitops over to the new PUT endpoint and removed the DELETE
in the "set" path.
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [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/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
## Testing
- [x] Added/updated automated tests
- [x] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)
- [ ] QA'd all new/changed functionality manually
2025-11-14 15:22:36 +00:00
2025-09-04 15:58:47 +00:00
// Setup experience script endpoints:
2024-10-09 16:43:12 +00:00
ue . GET ( "/api/_version_/fleet/setup_experience/script" , getSetupExperienceScriptEndpoint , getSetupExperienceScriptRequest { } )
2026-02-05 15:29:53 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxScriptSize ) . POST ( "/api/_version_/fleet/setup_experience/script" , setSetupExperienceScriptEndpoint , setSetupExperienceScriptRequest { } )
2024-10-09 16:43:12 +00:00
ue . DELETE ( "/api/_version_/fleet/setup_experience/script" , deleteSetupExperienceScriptEndpoint , deleteSetupExperienceScriptRequest { } )
2024-10-08 20:41:57 +00:00
2024-09-18 16:21:53 +00:00
// Fleet-maintained apps
2026-02-05 15:29:53 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxMultiScriptQuerySize ) . POST ( "/api/_version_/fleet/software/fleet_maintained_apps" , addFleetMaintainedAppEndpoint , addFleetMaintainedAppRequest { } )
2024-10-09 14:49:06 +00:00
ue . GET ( "/api/_version_/fleet/software/fleet_maintained_apps" , listFleetMaintainedAppsEndpoint , listFleetMaintainedAppsRequest { } )
2024-09-20 14:42:43 +00:00
ue . GET ( "/api/_version_/fleet/software/fleet_maintained_apps/{app_id}" , getFleetMaintainedApp , getFleetMaintainedAppRequest { } )
2024-09-18 16:21:53 +00:00
2024-02-10 03:54:44 +00:00
// Vulnerabilities
ue . GET ( "/api/_version_/fleet/vulnerabilities" , listVulnerabilitiesEndpoint , listVulnerabilitiesRequest { } )
2024-02-14 21:42:16 +00:00
ue . GET ( "/api/_version_/fleet/vulnerabilities/{cve}" , getVulnerabilityEndpoint , getVulnerabilityRequest { } )
2024-02-10 03:54:44 +00:00
// Hosts
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/host_summary" , getHostSummaryEndpoint , getHostSummaryRequest { } )
ue . GET ( "/api/_version_/fleet/hosts" , listHostsEndpoint , listHostsRequest { } )
ue . POST ( "/api/_version_/fleet/hosts/delete" , deleteHostsEndpoint , deleteHostsRequest { } )
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}" , getHostEndpoint , getHostRequest { } )
ue . GET ( "/api/_version_/fleet/hosts/count" , countHostsEndpoint , countHostsRequest { } )
2022-06-10 18:29:45 +00:00
ue . POST ( "/api/_version_/fleet/hosts/search" , searchHostsEndpoint , searchHostsRequest { } )
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/hosts/identifier/{identifier}" , hostByIdentifierEndpoint , hostByIdentifierRequest { } )
2024-02-14 04:45:07 +00:00
ue . POST ( "/api/_version_/fleet/hosts/identifier/{identifier}/query" , runLiveQueryOnHostEndpoint , runLiveQueryOnHostRequest { } )
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/query" , runLiveQueryOnHostByIDEndpoint , runLiveQueryOnHostByIDRequest { } )
2022-03-07 18:10:55 +00:00
ue . DELETE ( "/api/_version_/fleet/hosts/{id:[0-9]+}" , deleteHostEndpoint , deleteHostRequest { } )
ue . POST ( "/api/_version_/fleet/hosts/transfer" , addHostsToTeamEndpoint , addHostsToTeamRequest { } )
ue . POST ( "/api/_version_/fleet/hosts/transfer/filter" , addHostsToTeamByFilterEndpoint , addHostsToTeamByFilterRequest { } )
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/refetch" , refetchHostEndpoint , refetchHostRequest { } )
2025-10-21 18:02:25 +00:00
// Deprecated: Device mappings are included in the host details endpoint: /api/_version_/fleet/hosts/{id}
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/device_mapping" , listHostDeviceMappingEndpoint , listHostDeviceMappingRequest { } )
2023-12-21 17:21:39 +00:00
ue . PUT ( "/api/_version_/fleet/hosts/{id:[0-9]+}/device_mapping" , putHostDeviceMappingEndpoint , putHostDeviceMappingRequest { } )
2025-11-13 17:05:40 +00:00
ue . DELETE ( "/api/_version_/fleet/hosts/{id:[0-9]+}/device_mapping/idp" , deleteHostIDPEndpoint , deleteHostIDPRequest { } )
2022-03-15 19:14:42 +00:00
ue . GET ( "/api/_version_/fleet/hosts/report" , hostsReportEndpoint , hostsReportRequest { } )
2022-03-28 15:15:45 +00:00
ue . GET ( "/api/_version_/fleet/os_versions" , osVersionsEndpoint , osVersionsRequest { } )
2024-01-31 17:14:24 +00:00
ue . GET ( "/api/_version_/fleet/os_versions/{id:[0-9]+}" , getOSVersionEndpoint , getOSVersionRequest { } )
2026-02-26 04:20:35 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/reports/{report_id:[0-9]+}" , getHostQueryReportEndpoint , getHostQueryReportRequest { } )
2026-03-18 15:03:48 +00:00
ue . WithAltPaths ( "/api/_version_/fleet/hosts/{id:[0-9]+}/queries" ) . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/reports" , listHostReportsEndpoint , listHostReportsRequest { } )
2023-12-06 19:42:29 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/health" , getHostHealthEndpoint , getHostHealthRequest { } )
2024-04-16 09:37:58 +00:00
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/labels" , addLabelsToHostEndpoint , addLabelsToHostRequest { } )
2026-04-08 14:07:06 +00:00
ue . DELETE ( "/api/_version_/fleet/hosts/{id:[0-9]+}/labels" , removeLabelsFromHostEndpoint , fleet . RemoveLabelsFromHostRequest { } )
2024-05-01 18:37:52 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/software" , getHostSoftwareEndpoint , getHostSoftwareRequest { } )
2025-02-24 17:52:39 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/certificates" , listHostCertificatesEndpoint , listHostCertificatesRequest { } )
2026-03-23 21:01:52 +00:00
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/certificates/{template_id:[0-9]+}/resend" , resendHostCertificateTemplateEndpoint , resendHostCertificateTemplateRequest { } )
2026-03-16 19:48:26 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/recovery_lock_password" , getHostRecoveryLockPasswordEndpoint , getHostRecoveryLockPasswordRequest { } )
2022-03-07 18:10:55 +00:00
2022-11-01 17:22:07 +00:00
ue . GET ( "/api/_version_/fleet/hosts/summary/mdm" , getHostMDMSummary , getHostMDMSummaryRequest { } )
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/mdm" , getHostMDM , getHostMDMRequest { } )
2026-03-24 13:49:26 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/dep_assignment" , getHostDEPAssignmentEndpoint , getHostDEPAssignmentRequest { } )
2026-04-08 14:07:06 +00:00
ue . POST ( "/api/_version_/fleet/labels" , createLabelEndpoint , fleet . CreateLabelRequest { } )
ue . PATCH ( "/api/_version_/fleet/labels/{id:[0-9]+}" , modifyLabelEndpoint , fleet . ModifyLabelRequest { } )
ue . GET ( "/api/_version_/fleet/labels/{id:[0-9]+}" , getLabelEndpoint , fleet . GetLabelRequest { } )
ue . GET ( "/api/_version_/fleet/labels" , listLabelsEndpoint , fleet . ListLabelsRequest { } )
ue . GET ( "/api/_version_/fleet/labels/summary" , getLabelsSummaryEndpoint , fleet . GetLabelsSummaryRequest { } )
ue . GET ( "/api/_version_/fleet/labels/{id:[0-9]+}/hosts" , listHostsInLabelEndpoint , fleet . ListHostsInLabelRequest { } )
ue . DELETE ( "/api/_version_/fleet/labels/{name}" , deleteLabelEndpoint , fleet . DeleteLabelRequest { } )
ue . DELETE ( "/api/_version_/fleet/labels/id/{id:[0-9]+}" , deleteLabelByIDEndpoint , fleet . DeleteLabelByIDRequest { } )
ue . WithRequestBodySizeLimit ( fleet . MaxSpecSize ) . POST ( "/api/_version_/fleet/spec/labels" , applyLabelSpecsEndpoint , fleet . ApplyLabelSpecsRequest { } )
ue . GET ( "/api/_version_/fleet/spec/labels" , getLabelSpecsEndpoint , fleet . GetLabelSpecsRequest { } )
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/spec/labels/{name}" , getLabelSpecEndpoint , getGenericSpecRequest { } )
2024-01-03 15:39:16 +00:00
// This endpoint runs live queries synchronously (with a configured timeout).
2026-02-26 04:20:35 +00:00
ue . POST ( "/api/_version_/fleet/reports/{id:[0-9]+}/run" , runOneLiveQueryEndpoint , runOneLiveQueryRequest { } )
2024-01-03 15:39:16 +00:00
// Old endpoint, removed from docs. This GET endpoint runs live queries synchronously (with a configured timeout).
2026-02-26 04:20:35 +00:00
ue . GET ( "/api/_version_/fleet/reports/run" , runLiveQueryEndpoint , runLiveQueryRequest { } )
2023-01-30 21:35:56 +00:00
// The following two POST APIs are the asynchronous way to run live queries.
// The live queries are created with these two endpoints and their results can be queried via
// websockets via the `GET /api/_version_/fleet/results/` endpoint.
2026-02-26 04:20:35 +00:00
ue . POST ( "/api/_version_/fleet/reports/run" , createDistributedQueryCampaignEndpoint , createDistributedQueryCampaignRequest { } )
ue . POST ( "/api/_version_/fleet/reports/run_by_identifiers" , createDistributedQueryCampaignByIdentifierEndpoint , createDistributedQueryCampaignByIdentifierRequest { } )
2024-07-09 17:25:01 +00:00
// This endpoint is deprecated and maintained for backwards compatibility. This and above endpoint are functionally equivalent
2026-02-26 04:20:35 +00:00
ue . POST ( "/api/_version_/fleet/reports/run_by_names" , createDistributedQueryCampaignByIdentifierEndpoint , createDistributedQueryCampaignByIdentifierRequest { } )
2022-03-07 18:10:55 +00:00
2026-04-13 19:02:23 +00:00
ue . GET ( "/api/_version_/fleet/packs/{id:[0-9]+}/scheduled" , getScheduledQueriesInPackEndpoint , fleet . GetScheduledQueriesInPackRequest { } )
ue . EndingAtVersion ( "v1" ) . POST ( "/api/_version_/fleet/schedule" , scheduleQueryEndpoint , fleet . ScheduleQueryRequest { } )
ue . StartingAtVersion ( "2022-04" ) . POST ( "/api/_version_/fleet/packs/schedule" , scheduleQueryEndpoint , fleet . ScheduleQueryRequest { } )
ue . GET ( "/api/_version_/fleet/schedule/{id:[0-9]+}" , getScheduledQueryEndpoint , fleet . GetScheduledQueryRequest { } )
ue . EndingAtVersion ( "v1" ) . PATCH ( "/api/_version_/fleet/schedule/{id:[0-9]+}" , modifyScheduledQueryEndpoint , fleet . ModifyScheduledQueryRequest { } )
ue . StartingAtVersion ( "2022-04" ) . PATCH ( "/api/_version_/fleet/packs/schedule/{id:[0-9]+}" , modifyScheduledQueryEndpoint , fleet . ModifyScheduledQueryRequest { } )
ue . EndingAtVersion ( "v1" ) . DELETE ( "/api/_version_/fleet/schedule/{id:[0-9]+}" , deleteScheduledQueryEndpoint , fleet . DeleteScheduledQueryRequest { } )
ue . StartingAtVersion ( "2022-04" ) . DELETE ( "/api/_version_/fleet/packs/schedule/{id:[0-9]+}" , deleteScheduledQueryEndpoint , fleet . DeleteScheduledQueryRequest { } )
2022-04-05 15:35:53 +00:00
ue . EndingAtVersion ( "v1" ) . GET ( "/api/_version_/fleet/global/schedule" , getGlobalScheduleEndpoint , getGlobalScheduleRequest { } )
ue . StartingAtVersion ( "2022-04" ) . GET ( "/api/_version_/fleet/schedule" , getGlobalScheduleEndpoint , getGlobalScheduleRequest { } )
ue . EndingAtVersion ( "v1" ) . POST ( "/api/_version_/fleet/global/schedule" , globalScheduleQueryEndpoint , globalScheduleQueryRequest { } )
ue . StartingAtVersion ( "2022-04" ) . POST ( "/api/_version_/fleet/schedule" , globalScheduleQueryEndpoint , globalScheduleQueryRequest { } )
ue . EndingAtVersion ( "v1" ) . PATCH ( "/api/_version_/fleet/global/schedule/{id:[0-9]+}" , modifyGlobalScheduleEndpoint , modifyGlobalScheduleRequest { } )
ue . StartingAtVersion ( "2022-04" ) . PATCH ( "/api/_version_/fleet/schedule/{id:[0-9]+}" , modifyGlobalScheduleEndpoint , modifyGlobalScheduleRequest { } )
ue . EndingAtVersion ( "v1" ) . DELETE ( "/api/_version_/fleet/global/schedule/{id:[0-9]+}" , deleteGlobalScheduleEndpoint , deleteGlobalScheduleRequest { } )
ue . StartingAtVersion ( "2022-04" ) . DELETE ( "/api/_version_/fleet/schedule/{id:[0-9]+}" , deleteGlobalScheduleEndpoint , deleteGlobalScheduleRequest { } )
2026-02-26 04:20:35 +00:00
ue . GET ( "/api/_version_/fleet/fleets/{fleet_id}/schedule" , getTeamScheduleEndpoint , getTeamScheduleRequest { } )
ue . POST ( "/api/_version_/fleet/fleets/{fleet_id}/schedule" , teamScheduleQueryEndpoint , teamScheduleQueryRequest { } )
ue . PATCH ( "/api/_version_/fleet/fleets/{fleet_id}/schedule/{report_id}" , modifyTeamScheduleEndpoint , modifyTeamScheduleRequest { } )
ue . DELETE ( "/api/_version_/fleet/fleets/{fleet_id}/schedule/{report_id}" , deleteTeamScheduleEndpoint , deleteTeamScheduleRequest { } )
2022-03-07 18:10:55 +00:00
ue . GET ( "/api/_version_/fleet/carves" , listCarvesEndpoint , listCarvesRequest { } )
ue . GET ( "/api/_version_/fleet/carves/{id:[0-9]+}" , getCarveEndpoint , getCarveRequest { } )
ue . GET ( "/api/_version_/fleet/carves/{id:[0-9]+}/block/{block_id}" , getCarveBlockEndpoint , getCarveBlockRequest { } )
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/macadmins" , getMacadminsDataEndpoint , getMacadminsDataRequest { } )
ue . GET ( "/api/_version_/fleet/macadmins" , getAggregatedMacadminsDataEndpoint , getAggregatedMacadminsDataRequest { } )
ue . GET ( "/api/_version_/fleet/status/result_store" , statusResultStoreEndpoint , nil )
ue . GET ( "/api/_version_/fleet/status/live_query" , statusLiveQueryEndpoint , nil )
2026-04-28 12:12:43 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxScriptSize ) . POST ( "/api/_version_/fleet/scripts/run" , runScriptEndpoint , fleet . RunScriptRequest { } )
ue . WithRequestBodySizeLimit ( fleet . MaxScriptSize ) . POST ( "/api/_version_/fleet/scripts/run/sync" , runScriptSyncEndpoint , fleet . RunScriptSyncRequest { } )
ue . POST ( "/api/_version_/fleet/scripts/run/batch" , batchScriptRunEndpoint , fleet . BatchScriptRunRequest { } )
ue . GET ( "/api/_version_/fleet/scripts/results/{execution_id}" , getScriptResultEndpoint , fleet . GetScriptResultRequest { } )
ue . WithRequestBodySizeLimit ( fleet . MaxScriptSize ) . POST ( "/api/_version_/fleet/scripts" , createScriptEndpoint , fleet . CreateScriptRequest { } )
ue . GET ( "/api/_version_/fleet/scripts" , listScriptsEndpoint , fleet . ListScriptsRequest { } )
ue . GET ( "/api/_version_/fleet/scripts/{script_id:[0-9]+}" , getScriptEndpoint , fleet . GetScriptRequest { } )
ue . WithRequestBodySizeLimit ( fleet . MaxScriptSize ) . PATCH ( "/api/_version_/fleet/scripts/{script_id:[0-9]+}" , updateScriptEndpoint , fleet . UpdateScriptRequest { } )
ue . DELETE ( "/api/_version_/fleet/scripts/{script_id:[0-9]+}" , deleteScriptEndpoint , fleet . DeleteScriptRequest { } )
ue . WithRequestBodySizeLimit ( fleet . MaxBatchScriptSize ) . POST ( "/api/_version_/fleet/scripts/batch" , batchSetScriptsEndpoint , fleet . BatchSetScriptsRequest { } )
ue . POST ( "/api/_version_/fleet/scripts/batch/{batch_execution_id:[a-zA-Z0-9-]+}/cancel" , batchScriptCancelEndpoint , fleet . BatchScriptCancelRequest { } )
2025-08-08 18:24:48 +00:00
// Deprecated, will remove in favor of batchScriptExecutionStatusEndpoint when batch script details page is ready.
2026-04-28 12:12:43 +00:00
ue . GET ( "/api/_version_/fleet/scripts/batch/summary/{batch_execution_id:[a-zA-Z0-9-]+}" , batchScriptExecutionSummaryEndpoint , fleet . BatchScriptExecutionSummaryRequest { } )
2026-03-13 18:00:26 +00:00
ue . WithAltPaths ( "/api/_version_/fleet/scripts/batch/{batch_execution_id:[a-zA-Z0-9-]+}/host-results" ) . // .../host-results is DEPRECATED but we need to maintain for backwards compatibility because customers may already be using it
2026-04-28 12:12:43 +00:00
GET ( "/api/_version_/fleet/scripts/batch/{batch_execution_id:[a-zA-Z0-9-]+}/host_results" , batchScriptExecutionHostResultsEndpoint , fleet . BatchScriptExecutionHostResultsRequest { } )
ue . GET ( "/api/_version_/fleet/scripts/batch/{batch_execution_id:[a-zA-Z0-9-]+}" , batchScriptExecutionStatusEndpoint , fleet . BatchScriptExecutionStatusRequest { } )
ue . GET ( "/api/_version_/fleet/scripts/batch" , batchScriptExecutionListEndpoint , fleet . BatchScriptExecutionListRequest { } )
2023-10-10 22:00:45 +00:00
2026-04-28 12:12:43 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/scripts" , getHostScriptDetailsEndpoint , fleet . GetHostScriptDetailsRequest { } )
2024-01-29 14:37:54 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/activities/upcoming" , listHostUpcomingActivitiesEndpoint , listHostUpcomingActivitiesRequest { } )
2025-04-01 18:08:56 +00:00
ue . DELETE ( "/api/_version_/fleet/hosts/{id:[0-9]+}/activities/upcoming/{activity_id}" , cancelHostUpcomingActivityEndpoint , cancelHostUpcomingActivityRequest { } )
2026-04-28 12:12:43 +00:00
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/lock" , lockHostEndpoint , fleet . LockHostRequest { } )
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/unlock" , unlockHostEndpoint , fleet . UnlockHostRequest { } )
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/wipe" , wipeHostEndpoint , fleet . WipeHostRequest { } )
2026-04-07 20:23:59 +00:00
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/clear_passcode" , clearPasscodeEndpoint , clearPasscodeRequest { } )
2026-03-17 22:28:25 +00:00
ue . POST ( "/api/_version_/fleet/hosts/{id:[0-9]+}/recovery_lock_password/rotate" , rotateRecoveryLockPasswordEndpoint , rotateRecoveryLockPasswordRequest { } )
2026-04-22 13:05:07 +00:00
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/managed_account_password" , getHostManagedAccountPasswordEndpoint , getHostManagedAccountPasswordRequest { } )
2023-08-21 18:47:19 +00:00
2024-05-01 22:07:36 +00:00
// Generative AI
2026-04-07 14:04:08 +00:00
ue . POST ( "/api/_version_/fleet/autofill/policy" , autofillPoliciesEndpoint , fleet . AutofillPoliciesRequest { } )
2024-05-01 22:07:36 +00:00
2024-12-10 21:32:51 +00:00
// Secret variables
2025-08-14 22:33:47 +00:00
ue . PUT ( "/api/_version_/fleet/spec/secret_variables" , createSecretVariablesEndpoint , createSecretVariablesRequest { } )
ue . POST ( "/api/_version_/fleet/custom_variables" , createSecretVariableEndpoint , createSecretVariableRequest { } )
ue . GET ( "/api/_version_/fleet/custom_variables" , listSecretVariablesEndpoint , listSecretVariablesRequest { } )
ue . DELETE ( "/api/_version_/fleet/custom_variables/{id:[0-9]+}" , deleteSecretVariableEndpoint , deleteSecretVariableRequest { } )
2024-12-10 21:32:51 +00:00
2026-04-10 15:12:38 +00:00
// API end-points
ue . GET ( "/api/_version_/fleet/rest_api" , listAPIEndpointsEndpoint , listAPIEndpointsRequest { } )
2025-04-10 19:08:45 +00:00
// Scim details
ue . GET ( "/api/_version_/fleet/scim/details" , getScimDetailsEndpoint , nil )
2025-06-11 17:22:46 +00:00
// Microsoft Compliance Partner
ue . POST ( "/api/_version_/fleet/conditional-access/microsoft" , conditionalAccessMicrosoftCreateEndpoint , conditionalAccessMicrosoftCreateRequest { } )
ue . POST ( "/api/_version_/fleet/conditional-access/microsoft/confirm" , conditionalAccessMicrosoftConfirmEndpoint , conditionalAccessMicrosoftConfirmRequest { } )
ue . DELETE ( "/api/_version_/fleet/conditional-access/microsoft" , conditionalAccessMicrosoftDeleteEndpoint , conditionalAccessMicrosoftDeleteRequest { } )
2025-11-07 22:19:25 +00:00
// Okta Conditional Access
ue . GET ( "/api/_version_/fleet/conditional_access/idp/signing_cert" , conditionalAccessGetIdPSigningCertEndpoint , conditionalAccessGetIdPSigningCertRequest { } )
2025-11-14 19:49:08 +00:00
ue . GET ( "/api/_version_/fleet/conditional_access/idp/apple/profile" , conditionalAccessGetIdPAppleProfileEndpoint , nil )
2025-11-07 22:19:25 +00:00
2025-11-21 16:06:30 +00:00
// Deprecated: PATCH /mdm/apple/setup is now deprecated, replaced by the
// PATCH /setup_experience endpoint.
ue . PATCH ( "/api/_version_/fleet/mdm/apple/setup" , updateMDMAppleSetupEndpoint , updateMDMAppleSetupRequest { } )
ue . PATCH ( "/api/_version_/fleet/setup_experience" , updateMDMAppleSetupEndpoint , updateMDMAppleSetupRequest { } )
2023-01-24 16:57:22 +00:00
// Only Fleet MDM specific endpoints should be within the root /mdm/ path.
2023-05-02 13:09:33 +00:00
// NOTE: remember to update
2023-10-09 21:28:35 +00:00
// `service.mdmConfigurationRequiredEndpoints` when you add an
2023-05-02 13:09:33 +00:00
// endpoint that's behind the mdmConfiguredMiddleware, this applies
// both to this set of endpoints and to any public/token-authenticated
// endpoints using `neMDM` below in this file.
2023-06-22 20:31:17 +00:00
mdmConfiguredMiddleware := mdmconfigured . NewMDMConfigMiddleware ( svc )
mdmAppleMW := ue . WithCustomMiddleware ( mdmConfiguredMiddleware . VerifyAppleMDM ( ) )
2023-11-01 14:13:12 +00:00
// Deprecated: POST /mdm/apple/enqueue is now deprecated, replaced by the
// platform-agnostic POST /mdm/commands/run. It is still supported
// indefinitely for backwards compatibility.
2023-06-22 20:31:17 +00:00
mdmAppleMW . POST ( "/api/_version_/fleet/mdm/apple/enqueue" , enqueueMDMAppleCommandEndpoint , enqueueMDMAppleCommandRequest { } )
2023-11-01 14:13:12 +00:00
// Deprecated: POST /mdm/apple/commandresults is now deprecated, replaced by the
// platform-agnostic POST /mdm/commands/commandresults. It is still supported
// indefinitely for backwards compatibility.
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/commandresults" , getMDMAppleCommandResultsEndpoint , getMDMAppleCommandResultsRequest { } )
2023-11-01 14:13:12 +00:00
// Deprecated: POST /mdm/apple/commands is now deprecated, replaced by the
// platform-agnostic POST /mdm/commands/commands. It is still supported
// indefinitely for backwards compatibility.
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/commands" , listMDMAppleCommandsEndpoint , listMDMAppleCommandsRequest { } )
2023-11-15 15:58:59 +00:00
// Deprecated: those /mdm/apple/profiles/... endpoints are now deprecated,
// replaced by the platform-agnostic /mdm/profiles/... It is still supported
// indefinitely for backwards compatibility.
2023-11-08 16:36:57 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/profiles/{profile_id:[0-9]+}" , getMDMAppleConfigProfileEndpoint , getMDMAppleConfigProfileRequest { } )
mdmAppleMW . DELETE ( "/api/_version_/fleet/mdm/apple/profiles/{profile_id:[0-9]+}" , deleteMDMAppleConfigProfileEndpoint , deleteMDMAppleConfigProfileRequest { } )
2026-02-05 15:29:53 +00:00
mdmAppleMW . WithRequestBodySizeLimit ( fleet . MaxProfileSize ) . POST ( "/api/_version_/fleet/mdm/apple/profiles" , newMDMAppleConfigProfileEndpoint , newMDMAppleConfigProfileRequest { } )
2023-11-15 20:36:20 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/profiles" , listMDMAppleConfigProfilesEndpoint , listMDMAppleConfigProfilesRequest { } )
2023-11-01 14:13:12 +00:00
2023-11-17 16:49:30 +00:00
// Deprecated: GET /mdm/apple/filevault/summary is now deprecated, replaced by the
// platform-agnostic GET /mdm/disk_encryption/summary. It is still supported indefinitely
// for backwards compatibility.
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/filevault/summary" , getMdmAppleFileVaultSummaryEndpoint , getMDMAppleFileVaultSummaryRequest { } )
2023-11-17 16:49:30 +00:00
// Deprecated: GET /mdm/apple/profiles/summary is now deprecated, replaced by the
// platform-agnostic GET /mdm/profiles/summary. It is still supported indefinitely
// for backwards compatibility.
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/profiles/summary" , getMDMAppleProfilesSummaryEndpoint , getMDMAppleProfilesSummaryRequest { } )
2023-11-17 16:49:30 +00:00
2024-03-13 14:27:29 +00:00
// Deprecated: POST /mdm/apple/enrollment_profile is now deprecated, replaced by the
// POST /enrollment_profiles/automatic endpoint.
2026-02-05 15:29:53 +00:00
mdmAppleMW . WithRequestBodySizeLimit ( fleet . MaxProfileSize ) . POST ( "/api/_version_/fleet/mdm/apple/enrollment_profile" , createMDMAppleSetupAssistantEndpoint , createMDMAppleSetupAssistantRequest { } )
mdmAppleMW . WithRequestBodySizeLimit ( fleet . MaxProfileSize ) . POST ( "/api/_version_/fleet/enrollment_profiles/automatic" , createMDMAppleSetupAssistantEndpoint , createMDMAppleSetupAssistantRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/apple/enrollment_profile is now deprecated, replaced by the
// GET /enrollment_profiles/automatic endpoint.
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/enrollment_profile" , getMDMAppleSetupAssistantEndpoint , getMDMAppleSetupAssistantRequest { } )
2024-03-13 14:27:29 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/enrollment_profiles/automatic" , getMDMAppleSetupAssistantEndpoint , getMDMAppleSetupAssistantRequest { } )
updated default profile, added endpoint for seeing what default is applied (#44236)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #43789
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [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/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements), JS
inline code is prevented especially for url redirects, and untrusted
data interpolated into shell scripts/commands is validated against shell
metacharacters.
- [x] Timeouts are implemented and retries are limited to avoid infinite
loops
- [x] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* View and download the default automatic MDM (Apple Setup Assistant)
enrollment profile via a new endpoint.
* Shows a last-updated timestamp when present; returns the in‑app
default with no timestamp if none is stored.
* **Access**
* Access follows existing team and global permission rules; not
available on Free-tier licenses.
* **Tests**
* Added unit and integration tests covering endpoint behavior and access
controls.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-28 13:38:15 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/enrollment_profiles/automatic/default" , getDefaultMDMAppleSetupAssistantProfileEndpoint , nil )
2024-03-13 14:27:29 +00:00
// Deprecated: DELETE /mdm/apple/enrollment_profile is now deprecated, replaced by the
// DELETE /enrollment_profiles/automatic endpoint.
2023-06-22 20:31:17 +00:00
mdmAppleMW . DELETE ( "/api/_version_/fleet/mdm/apple/enrollment_profile" , deleteMDMAppleSetupAssistantEndpoint , deleteMDMAppleSetupAssistantRequest { } )
2024-03-13 14:27:29 +00:00
mdmAppleMW . DELETE ( "/api/_version_/fleet/enrollment_profiles/automatic" , deleteMDMAppleSetupAssistantEndpoint , deleteMDMAppleSetupAssistantRequest { } )
2023-03-27 19:30:29 +00:00
2023-04-17 15:45:16 +00:00
// TODO: are those undocumented endpoints still needed? I think they were only used
// by 'fleetctl apple-mdm' sub-commands.
2026-02-05 15:29:53 +00:00
// Generous limit for these unknown old unused endpoints-
mdmAppleMW . WithRequestBodySizeLimit ( 512 * units . MiB ) . POST ( "/api/_version_/fleet/mdm/apple/installers" , uploadAppleInstallerEndpoint , uploadAppleInstallerRequest { } )
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/installers/{installer_id:[0-9]+}" , getAppleInstallerEndpoint , getAppleInstallerDetailsRequest { } )
mdmAppleMW . DELETE ( "/api/_version_/fleet/mdm/apple/installers/{installer_id:[0-9]+}" , deleteAppleInstallerEndpoint , deleteAppleInstallerDetailsRequest { } )
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/installers" , listMDMAppleInstallersEndpoint , listMDMAppleInstallersRequest { } )
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/devices" , listMDMAppleDevicesEndpoint , listMDMAppleDevicesRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/manual_enrollment_profile is now deprecated, replaced by the
// GET /enrollment_profiles/manual endpoint.
2024-10-22 17:05:35 +00:00
// Ref: https://github.com/fleetdm/fleet/issues/16252
2024-01-27 00:57:19 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/manual_enrollment_profile" , getManualEnrollmentProfileEndpoint , getManualEnrollmentProfileRequest { } )
2024-03-13 14:27:29 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/enrollment_profiles/manual" , getManualEnrollmentProfileEndpoint , getManualEnrollmentProfileRequest { } )
2023-04-17 15:45:16 +00:00
2023-04-07 20:31:02 +00:00
// bootstrap-package routes
2024-03-13 14:27:29 +00:00
// Deprecated: POST /mdm/bootstrap is now deprecated, replaced by the
// POST /bootstrap endpoint.
2026-02-05 15:29:53 +00:00
// Bootstrap endpoints are already max size limited to installer size in serve.go
mdmAppleMW . SkipRequestBodySizeLimit ( ) . POST ( "/api/_version_/fleet/mdm/bootstrap" , uploadBootstrapPackageEndpoint , uploadBootstrapPackageRequest { } )
mdmAppleMW . SkipRequestBodySizeLimit ( ) . POST ( "/api/_version_/fleet/bootstrap" , uploadBootstrapPackageEndpoint , uploadBootstrapPackageRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/bootstrap/:team_id/metadata is now deprecated, replaced by the
// GET /bootstrap/:team_id/metadata endpoint.
2026-02-17 16:00:59 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/bootstrap/{fleet_id:[0-9]+}/metadata" , bootstrapPackageMetadataEndpoint , bootstrapPackageMetadataRequest { } )
mdmAppleMW . GET ( "/api/_version_/fleet/bootstrap/{fleet_id:[0-9]+}/metadata" , bootstrapPackageMetadataEndpoint , bootstrapPackageMetadataRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: DELETE /mdm/bootstrap/:team_id is now deprecated, replaced by the
// DELETE /bootstrap/:team_id endpoint.
2026-02-17 16:00:59 +00:00
mdmAppleMW . DELETE ( "/api/_version_/fleet/mdm/bootstrap/{fleet_id:[0-9]+}" , deleteBootstrapPackageEndpoint , deleteBootstrapPackageRequest { } )
mdmAppleMW . DELETE ( "/api/_version_/fleet/bootstrap/{fleet_id:[0-9]+}" , deleteBootstrapPackageEndpoint , deleteBootstrapPackageRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/bootstrap/summary is now deprecated, replaced by the
// GET /bootstrap/summary endpoint.
2024-02-07 12:24:24 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/bootstrap/summary" , getMDMAppleBootstrapPackageSummaryEndpoint , getMDMAppleBootstrapPackageSummaryRequest { } )
2024-03-13 14:27:29 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/bootstrap/summary" , getMDMAppleBootstrapPackageSummaryEndpoint , getMDMAppleBootstrapPackageSummaryRequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: POST /mdm/apple/bootstrap is now deprecated, replaced by the platform agnostic /mdm/bootstrap
2026-02-05 15:29:53 +00:00
// Bootstrap endpoints are already max size limited to installer size in serve.go
mdmAppleMW . SkipRequestBodySizeLimit ( ) . POST ( "/api/_version_/fleet/mdm/apple/bootstrap" , uploadBootstrapPackageEndpoint , uploadBootstrapPackageRequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: GET /mdm/apple/bootstrap/:team_id/metadata is now deprecated, replaced by the platform agnostic /mdm/bootstrap/:team_id/metadata
2026-02-17 16:00:59 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/bootstrap/{fleet_id:[0-9]+}/metadata" , bootstrapPackageMetadataEndpoint , bootstrapPackageMetadataRequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: DELETE /mdm/apple/bootstrap/:team_id is now deprecated, replaced by the platform agnostic /mdm/bootstrap/:team_id
2026-02-17 16:00:59 +00:00
mdmAppleMW . DELETE ( "/api/_version_/fleet/mdm/apple/bootstrap/{fleet_id:[0-9]+}" , deleteBootstrapPackageEndpoint , deleteBootstrapPackageRequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: GET /mdm/apple/bootstrap/summary is now deprecated, replaced by the platform agnostic /mdm/bootstrap/summary
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/bootstrap/summary" , getMDMAppleBootstrapPackageSummaryEndpoint , getMDMAppleBootstrapPackageSummaryRequest { } )
2023-04-07 20:31:02 +00:00
2023-03-27 19:30:29 +00:00
// host-specific mdm routes
2024-03-13 14:27:29 +00:00
2024-06-17 16:30:53 +00:00
// Deprecated: POST /mdm/hosts/:id/lock is now deprecated, replaced by
// POST /hosts/:id/lock.
2023-06-22 20:31:17 +00:00
mdmAppleMW . POST ( "/api/_version_/fleet/mdm/hosts/{id:[0-9]+}/lock" , deviceLockEndpoint , deviceLockRequest { } )
mdmAppleMW . POST ( "/api/_version_/fleet/mdm/hosts/{id:[0-9]+}/wipe" , deviceWipeEndpoint , deviceWipeRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/hosts/:id/profiles is now deprecated, replaced by
// GET /hosts/:id/configuration_profiles.
2023-07-14 15:53:03 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/hosts/{id:[0-9]+}/profiles" , getHostProfilesEndpoint , getHostProfilesRequest { } )
2024-04-12 19:34:54 +00:00
// TODO: Confirm if response should be updated to include Windows profiles and use mdmAnyMW
2024-03-13 14:27:29 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/configuration_profiles" , getHostProfilesEndpoint , getHostProfilesRequest { } )
2023-03-27 19:30:29 +00:00
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/apple is now deprecated, replaced by the
// GET /apns endpoint.
2023-06-22 20:31:17 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple" , getAppleMDMEndpoint , nil )
2024-03-13 14:27:29 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/apns" , getAppleMDMEndpoint , nil )
2023-03-27 19:30:29 +00:00
2024-02-07 12:24:24 +00:00
// EULA routes
2024-03-13 14:27:29 +00:00
// Deprecated: POST /mdm/setup/eula is now deprecated, replaced by the
// POST /setup_experience/eula endpoint.
2026-02-05 15:29:53 +00:00
mdmAppleMW . WithRequestBodySizeLimit ( fleet . MaxEULASize ) . POST ( "/api/_version_/fleet/mdm/setup/eula" , createMDMEULAEndpoint , createMDMEULARequest { } )
mdmAppleMW . WithRequestBodySizeLimit ( fleet . MaxEULASize ) . POST ( "/api/_version_/fleet/setup_experience/eula" , createMDMEULAEndpoint , createMDMEULARequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/setup/eula/metadata is now deprecated, replaced by the
// GET /setup_experience/eula/metadata endpoint.
2024-02-07 12:24:24 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/setup/eula/metadata" , getMDMEULAMetadataEndpoint , getMDMEULAMetadataRequest { } )
2024-03-13 14:27:29 +00:00
mdmAppleMW . GET ( "/api/_version_/fleet/setup_experience/eula/metadata" , getMDMEULAMetadataEndpoint , getMDMEULAMetadataRequest { } )
// Deprecated: DELETE /mdm/setup/eula/:token is now deprecated, replaced by the
// DELETE /setup_experience/eula/:token endpoint.
2024-02-07 12:24:24 +00:00
mdmAppleMW . DELETE ( "/api/_version_/fleet/mdm/setup/eula/{token}" , deleteMDMEULAEndpoint , deleteMDMEULARequest { } )
2024-03-13 14:27:29 +00:00
mdmAppleMW . DELETE ( "/api/_version_/fleet/setup_experience/eula/{token}" , deleteMDMEULAEndpoint , deleteMDMEULARequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: POST /mdm/apple/setup/eula is now deprecated, replaced by the platform agnostic /mdm/setup/eula
2026-02-05 15:29:53 +00:00
mdmAppleMW . WithRequestBodySizeLimit ( fleet . MaxEULASize ) . POST ( "/api/_version_/fleet/mdm/apple/setup/eula" , createMDMEULAEndpoint , createMDMEULARequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: GET /mdm/apple/setup/eula/metadata is now deprecated, replaced by the platform agnostic /mdm/setup/eula/metadata
mdmAppleMW . GET ( "/api/_version_/fleet/mdm/apple/setup/eula/metadata" , getMDMEULAMetadataEndpoint , getMDMEULAMetadataRequest { } )
// Deprecated: DELETE /mdm/apple/setup/eula/:token is now deprecated, replaced by the platform agnostic /mdm/setup/eula/:token
mdmAppleMW . DELETE ( "/api/_version_/fleet/mdm/apple/setup/eula/{token}" , deleteMDMEULAEndpoint , deleteMDMEULARequest { } )
2023-05-02 13:09:33 +00:00
2026-02-05 15:29:53 +00:00
mdmAppleMW . WithRequestBodySizeLimit ( fleet . MaxProfileSize ) . POST ( "/api/_version_/fleet/mdm/apple/profiles/preassign" , preassignMDMAppleProfileEndpoint , preassignMDMAppleProfileRequest { } )
2023-06-22 20:31:17 +00:00
mdmAppleMW . POST ( "/api/_version_/fleet/mdm/apple/profiles/match" , matchMDMApplePreassignmentEndpoint , matchMDMApplePreassignmentRequest { } )
2023-05-31 13:24:22 +00:00
2025-11-17 14:52:59 +00:00
mdmAnyMW := ue . WithCustomMiddleware ( mdmConfiguredMiddleware . VerifyAnyMDM ( ) )
2024-03-13 14:27:29 +00:00
// Deprecated: POST /mdm/commands/run is now deprecated, replaced by the
// POST /commands/run endpoint.
2026-02-05 15:29:53 +00:00
mdmAnyMW . WithRequestBodySizeLimit ( fleet . MaxMDMCommandSize ) . POST ( "/api/_version_/fleet/mdm/commands/run" , runMDMCommandEndpoint , runMDMCommandRequest { } )
mdmAnyMW . WithRequestBodySizeLimit ( fleet . MaxMDMCommandSize ) . POST ( "/api/_version_/fleet/commands/run" , runMDMCommandEndpoint , runMDMCommandRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/commandresults is now deprecated, replaced by the
// GET /commands/results endpoint.
2023-11-01 14:13:12 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/mdm/commandresults" , getMDMCommandResultsEndpoint , getMDMCommandResultsRequest { } )
2024-03-13 14:27:29 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/commands/results" , getMDMCommandResultsEndpoint , getMDMCommandResultsRequest { } )
// Deprecated: GET /mdm/commands is now deprecated, replaced by the
// GET /commands endpoint.
2023-11-01 14:13:12 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/mdm/commands" , listMDMCommandsEndpoint , listMDMCommandsRequest { } )
2024-03-13 14:27:29 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/commands" , listMDMCommandsEndpoint , listMDMCommandsRequest { } )
2025-12-18 19:59:46 +00:00
// Deprecated: PATCH /mdm/hosts/:id/unenroll is now deprecated, replaced by
// DELETE /hosts/:id/mdm.
mdmAnyMW . PATCH ( "/api/_version_/fleet/mdm/hosts/{id:[0-9]+}/unenroll" , mdmUnenrollEndpoint , mdmUnenrollRequest { } )
mdmAnyMW . DELETE ( "/api/_version_/fleet/hosts/{id:[0-9]+}/mdm" , mdmUnenrollEndpoint , mdmUnenrollRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/disk_encryption/summary is now deprecated, replaced by the
// GET /disk_encryption endpoint.
Linux disk encryption: frontend changes, backend missing private key errors, remove disk encryption endpoints dependence on MDM being enabled (#23714)
## Addresses #22702, #23713, #23756, #23746, #23747, and #23876
_-Note that much of this code as is will render as expected only once
integrated with the backend or if manipulated manually for testing
purposes_
**Frontend**:
- Update banners on my device page, tests
- Build new logic for calling endpoint to trigger linux key escrow on
clicking `Create key`
- Add `CreateLinuxKeyModal` to inform user of next steps after clicking
`Create key`
- Update banners on host details page, tests
- Update the Controls > OS settings section with new logic related to
linux disk encryption
- Expect and include counts of Linux hosts in aggregate disk encryption
stats UI
- Add "Linux" column to the disk encryption table
- Show disk encryption related UI for supported Linux platforms
- TODO: confirm platform string matching functionality in manual e2e
testing
- Expand capabilities of `SectionHeader` component, apply to new UI
- Flash "missing private key" error, with clickable link, when trying to
update disk encryption enabled while no server private key is present.
- TODO: QA this once other endpoints on Controls > Disk encryption are
enabled even when MDM not turned on
- Update Disk encryption key modal copy
-Other TODO:
- Confirm when integrated with API:
- Aggregate disk encryption counts
- Disk encryption table Linux column
- Show disk encryption key action on host details page when expected
- Opens Disk encryption key modal, displays key as expected
**Backend**:
- For "No team" and teams, error when trying to update disk encryption
enabled while no server private key is present.
- Remove requirement of mdm being enabled for use of various endpoints
related to Linux disk encryption
- Update tests
_________
**Host details and my device page banners**

**Create key modal**
<img width="1799" alt="create-key-modal"
src="https://github.com/user-attachments/assets/81a55ccb-b6b9-4eb6-b2ff-a463c60724c0">
**Enabling disk encryption**

**Disk encryption: Fleet free**
<img width="1912" alt="free"
src="https://github.com/user-attachments/assets/9f9cace3-8955-47c2-87d9-24ff9387ac1a">
**Custom settings: turn on MDM**
<img width="1912" alt="turn on mdm"
src="https://github.com/user-attachments/assets/4d3ad47b-4035-4d93-86f0-dc2691b38bb4">
**Device status indicators**

**Encryption key action and modal**

- [x] Changes file added for user-visible changes in `changes/`
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
- [ ] Full e2e testing to do when integrated with backend
---------
Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
2024-11-20 19:58:47 +00:00
ue . GET ( "/api/_version_/fleet/mdm/disk_encryption/summary" , getMDMDiskEncryptionSummaryEndpoint , getMDMDiskEncryptionSummaryRequest { } )
ue . GET ( "/api/_version_/fleet/disk_encryption" , getMDMDiskEncryptionSummaryEndpoint , getMDMDiskEncryptionSummaryRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/hosts/:id/encryption_key is now deprecated, replaced by
// GET /hosts/:id/encryption_key.
2024-11-21 00:51:00 +00:00
ue . GET ( "/api/_version_/fleet/mdm/hosts/{id:[0-9]+}/encryption_key" , getHostEncryptionKey , getHostEncryptionKeyRequest { } )
ue . GET ( "/api/_version_/fleet/hosts/{id:[0-9]+}/encryption_key" , getHostEncryptionKey , getHostEncryptionKeyRequest { } )
2023-11-14 13:19:29 +00:00
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/profiles/summary is now deprecated, replaced by the
// GET /configuration_profiles/summary endpoint.
Linux disk encryption: frontend changes, backend missing private key errors, remove disk encryption endpoints dependence on MDM being enabled (#23714)
## Addresses #22702, #23713, #23756, #23746, #23747, and #23876
_-Note that much of this code as is will render as expected only once
integrated with the backend or if manipulated manually for testing
purposes_
**Frontend**:
- Update banners on my device page, tests
- Build new logic for calling endpoint to trigger linux key escrow on
clicking `Create key`
- Add `CreateLinuxKeyModal` to inform user of next steps after clicking
`Create key`
- Update banners on host details page, tests
- Update the Controls > OS settings section with new logic related to
linux disk encryption
- Expect and include counts of Linux hosts in aggregate disk encryption
stats UI
- Add "Linux" column to the disk encryption table
- Show disk encryption related UI for supported Linux platforms
- TODO: confirm platform string matching functionality in manual e2e
testing
- Expand capabilities of `SectionHeader` component, apply to new UI
- Flash "missing private key" error, with clickable link, when trying to
update disk encryption enabled while no server private key is present.
- TODO: QA this once other endpoints on Controls > Disk encryption are
enabled even when MDM not turned on
- Update Disk encryption key modal copy
-Other TODO:
- Confirm when integrated with API:
- Aggregate disk encryption counts
- Disk encryption table Linux column
- Show disk encryption key action on host details page when expected
- Opens Disk encryption key modal, displays key as expected
**Backend**:
- For "No team" and teams, error when trying to update disk encryption
enabled while no server private key is present.
- Remove requirement of mdm being enabled for use of various endpoints
related to Linux disk encryption
- Update tests
_________
**Host details and my device page banners**

**Create key modal**
<img width="1799" alt="create-key-modal"
src="https://github.com/user-attachments/assets/81a55ccb-b6b9-4eb6-b2ff-a463c60724c0">
**Enabling disk encryption**

**Disk encryption: Fleet free**
<img width="1912" alt="free"
src="https://github.com/user-attachments/assets/9f9cace3-8955-47c2-87d9-24ff9387ac1a">
**Custom settings: turn on MDM**
<img width="1912" alt="turn on mdm"
src="https://github.com/user-attachments/assets/4d3ad47b-4035-4d93-86f0-dc2691b38bb4">
**Device status indicators**

**Encryption key action and modal**

- [x] Changes file added for user-visible changes in `changes/`
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
- [ ] Full e2e testing to do when integrated with backend
---------
Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
2024-11-20 19:58:47 +00:00
ue . GET ( "/api/_version_/fleet/mdm/profiles/summary" , getMDMProfilesSummaryEndpoint , getMDMProfilesSummaryRequest { } )
ue . GET ( "/api/_version_/fleet/configuration_profiles/summary" , getMDMProfilesSummaryEndpoint , getMDMProfilesSummaryRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/profiles/:profile_uuid is now deprecated, replaced by
// GET /configuration_profiles/:profile_uuid.
2023-12-04 15:04:06 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/mdm/profiles/{profile_uuid}" , getMDMConfigProfileEndpoint , getMDMConfigProfileRequest { } )
2024-03-13 14:27:29 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/configuration_profiles/{profile_uuid}" , getMDMConfigProfileEndpoint , getMDMConfigProfileRequest { } )
// Deprecated: DELETE /mdm/profiles/:profile_uuid is now deprecated, replaced by
// DELETE /configuration_profiles/:profile_uuid.
2025-12-18 21:14:32 +00:00
ue . DELETE ( "/api/_version_/fleet/mdm/profiles/{profile_uuid}" , deleteMDMConfigProfileEndpoint , deleteMDMConfigProfileRequest { } )
ue . DELETE ( "/api/_version_/fleet/configuration_profiles/{profile_uuid}" , deleteMDMConfigProfileEndpoint , deleteMDMConfigProfileRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/profiles is now deprecated, replaced by the
// GET /configuration_profiles endpoint.
2023-11-29 14:32:42 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/mdm/profiles" , listMDMConfigProfilesEndpoint , listMDMConfigProfilesRequest { } )
2024-03-13 14:27:29 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/configuration_profiles" , listMDMConfigProfilesEndpoint , listMDMConfigProfilesRequest { } )
// Deprecated: POST /mdm/profiles is now deprecated, replaced by the
// POST /configuration_profiles endpoint.
2026-02-05 15:29:53 +00:00
mdmAnyMW . WithRequestBodySizeLimit ( fleet . MaxProfileSize ) . POST ( "/api/_version_/fleet/mdm/profiles" , newMDMConfigProfileEndpoint , newMDMConfigProfileRequest { } )
mdmAnyMW . WithRequestBodySizeLimit ( fleet . MaxProfileSize ) . POST ( "/api/_version_/fleet/configuration_profiles" , newMDMConfigProfileEndpoint , newMDMConfigProfileRequest { } )
2025-12-18 21:14:32 +00:00
// Batch needs to allow being called without any MDM enabled, to support deleting profiles, but will fail later if trying to add
2026-02-05 15:29:53 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxBatchProfileSize ) . POST ( "/api/_version_/fleet/configuration_profiles/batch" , batchModifyMDMConfigProfilesEndpoint , batchModifyMDMConfigProfilesRequest { } )
2024-03-13 14:27:29 +00:00
2024-11-27 20:39:55 +00:00
// Deprecated: POST /hosts/{host_id:[0-9]+}/configuration_profiles/resend/{profile_uuid} is now deprecated, replaced by the
// POST /hosts/{host_id:[0-9]+}/configuration_profiles/{profile_uuid}/resend endpoint.
2024-04-12 19:34:54 +00:00
mdmAnyMW . POST ( "/api/_version_/fleet/hosts/{host_id:[0-9]+}/configuration_profiles/resend/{profile_uuid}" , resendHostMDMProfileEndpoint , resendHostMDMProfileRequest { } )
2024-11-27 20:39:55 +00:00
mdmAnyMW . POST ( "/api/_version_/fleet/hosts/{host_id:[0-9]+}/configuration_profiles/{profile_uuid}/resend" , resendHostMDMProfileEndpoint , resendHostMDMProfileRequest { } )
2025-05-07 20:48:18 +00:00
mdmAnyMW . POST ( "/api/_version_/fleet/configuration_profiles/resend/batch" , batchResendMDMProfileToHostsEndpoint , batchResendMDMProfileToHostsRequest { } )
2025-05-13 12:49:08 +00:00
mdmAnyMW . GET ( "/api/_version_/fleet/configuration_profiles/{profile_uuid}/status" , getMDMConfigProfileStatusEndpoint , getMDMConfigProfileStatusRequest { } )
2024-04-12 19:34:54 +00:00
2024-03-13 14:27:29 +00:00
// Deprecated: PATCH /mdm/apple/settings is deprecated, replaced by POST /disk_encryption.
// It was only used to set disk encryption.
2024-01-03 19:15:09 +00:00
mdmAnyMW . PATCH ( "/api/_version_/fleet/mdm/apple/settings" , updateMDMAppleSettingsEndpoint , updateMDMAppleSettingsRequest { } )
Linux disk encryption: frontend changes, backend missing private key errors, remove disk encryption endpoints dependence on MDM being enabled (#23714)
## Addresses #22702, #23713, #23756, #23746, #23747, and #23876
_-Note that much of this code as is will render as expected only once
integrated with the backend or if manipulated manually for testing
purposes_
**Frontend**:
- Update banners on my device page, tests
- Build new logic for calling endpoint to trigger linux key escrow on
clicking `Create key`
- Add `CreateLinuxKeyModal` to inform user of next steps after clicking
`Create key`
- Update banners on host details page, tests
- Update the Controls > OS settings section with new logic related to
linux disk encryption
- Expect and include counts of Linux hosts in aggregate disk encryption
stats UI
- Add "Linux" column to the disk encryption table
- Show disk encryption related UI for supported Linux platforms
- TODO: confirm platform string matching functionality in manual e2e
testing
- Expand capabilities of `SectionHeader` component, apply to new UI
- Flash "missing private key" error, with clickable link, when trying to
update disk encryption enabled while no server private key is present.
- TODO: QA this once other endpoints on Controls > Disk encryption are
enabled even when MDM not turned on
- Update Disk encryption key modal copy
-Other TODO:
- Confirm when integrated with API:
- Aggregate disk encryption counts
- Disk encryption table Linux column
- Show disk encryption key action on host details page when expected
- Opens Disk encryption key modal, displays key as expected
**Backend**:
- For "No team" and teams, error when trying to update disk encryption
enabled while no server private key is present.
- Remove requirement of mdm being enabled for use of various endpoints
related to Linux disk encryption
- Update tests
_________
**Host details and my device page banners**

**Create key modal**
<img width="1799" alt="create-key-modal"
src="https://github.com/user-attachments/assets/81a55ccb-b6b9-4eb6-b2ff-a463c60724c0">
**Enabling disk encryption**

**Disk encryption: Fleet free**
<img width="1912" alt="free"
src="https://github.com/user-attachments/assets/9f9cace3-8955-47c2-87d9-24ff9387ac1a">
**Custom settings: turn on MDM**
<img width="1912" alt="turn on mdm"
src="https://github.com/user-attachments/assets/4d3ad47b-4035-4d93-86f0-dc2691b38bb4">
**Device status indicators**

**Encryption key action and modal**

- [x] Changes file added for user-visible changes in `changes/`
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
- [ ] Full e2e testing to do when integrated with backend
---------
Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
2024-11-20 19:58:47 +00:00
ue . POST ( "/api/_version_/fleet/disk_encryption" , updateDiskEncryptionEndpoint , updateDiskEncryptionRequest { } )
2023-10-09 21:28:35 +00:00
2023-03-27 19:30:29 +00:00
// the following set of mdm endpoints must always be accessible (even
// if MDM is not configured) as it bootstraps the setup of MDM
// (generates CSR request for APNs, plus the SCEP and ABM keypairs).
2024-05-28 15:10:32 +00:00
// Deprecated: this endpoint shouldn't be used anymore in favor of the
// new flow described in https://github.com/fleetdm/fleet/issues/10383
2023-03-27 19:30:29 +00:00
ue . POST ( "/api/_version_/fleet/mdm/apple/request_csr" , requestMDMAppleCSREndpoint , requestMDMAppleCSRRequest { } )
2024-05-28 15:10:32 +00:00
// Deprecated: this endpoint shouldn't be used anymore in favor of the
// new flow described in https://github.com/fleetdm/fleet/issues/10383
2023-02-03 19:02:50 +00:00
ue . POST ( "/api/_version_/fleet/mdm/apple/dep/key_pair" , newMDMAppleDEPKeyPairEndpoint , nil )
2024-05-28 15:10:32 +00:00
ue . GET ( "/api/_version_/fleet/mdm/apple/abm_public_key" , generateABMKeyPairEndpoint , nil )
2024-08-29 22:51:46 +00:00
ue . POST ( "/api/_version_/fleet/abm_tokens" , uploadABMTokenEndpoint , uploadABMTokenRequest { } )
ue . DELETE ( "/api/_version_/fleet/abm_tokens/{id:[0-9]+}" , deleteABMTokenEndpoint , deleteABMTokenRequest { } )
ue . GET ( "/api/_version_/fleet/abm_tokens" , listABMTokensEndpoint , nil )
2024-12-03 16:12:07 +00:00
ue . GET ( "/api/_version_/fleet/abm_tokens/count" , countABMTokensEndpoint , nil )
2026-02-26 04:20:35 +00:00
ue . PATCH ( "/api/_version_/fleet/abm_tokens/{id:[0-9]+}/fleets" , updateABMTokenTeamsEndpoint , updateABMTokenTeamsRequest { } )
2024-08-29 22:51:46 +00:00
ue . PATCH ( "/api/_version_/fleet/abm_tokens/{id:[0-9]+}/renew" , renewABMTokenEndpoint , renewABMTokenRequest { } )
2024-03-13 14:27:29 +00:00
2024-05-27 14:13:08 +00:00
ue . GET ( "/api/_version_/fleet/mdm/apple/request_csr" , getMDMAppleCSREndpoint , getMDMAppleCSRRequest { } )
ue . POST ( "/api/_version_/fleet/mdm/apple/apns_certificate" , uploadMDMAppleAPNSCertEndpoint , uploadMDMAppleAPNSCertRequest { } )
ue . DELETE ( "/api/_version_/fleet/mdm/apple/apns_certificate" , deleteMDMAppleAPNSCertEndpoint , deleteMDMAppleAPNSCertRequest { } )
2024-03-13 14:27:29 +00:00
2024-08-29 22:51:46 +00:00
// VPP Tokens
ue . GET ( "/api/_version_/fleet/vpp_tokens" , getVPPTokens , getVPPTokensRequest { } )
ue . POST ( "/api/_version_/fleet/vpp_tokens" , uploadVPPTokenEndpoint , uploadVPPTokenRequest { } )
2026-02-26 04:20:35 +00:00
ue . PATCH ( "/api/_version_/fleet/vpp_tokens/{id}/fleets" , patchVPPTokensTeams , patchVPPTokensTeamsRequest { } )
2024-08-29 22:51:46 +00:00
ue . PATCH ( "/api/_version_/fleet/vpp_tokens/{id}/renew" , patchVPPTokenRenewEndpoint , patchVPPTokenRenewRequest { } )
ue . DELETE ( "/api/_version_/fleet/vpp_tokens/{id}" , deleteVPPToken , deleteVPPTokenRequest { } )
// Batch VPP Associations
2024-07-22 17:19:19 +00:00
ue . POST ( "/api/_version_/fleet/software/app_store_apps/batch" , batchAssociateAppStoreAppsEndpoint , batchAssociateAppStoreAppsRequest { } )
2024-07-02 15:46:59 +00:00
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/apple_bm is now deprecated, replaced by the
// GET /abm endpoint.
2022-12-12 20:45:53 +00:00
ue . GET ( "/api/_version_/fleet/mdm/apple_bm" , getAppleBMEndpoint , nil )
2024-08-29 22:51:46 +00:00
// Deprecated: GET /abm is now deprecated, replaced by the GET /abm_tokens endpoint.
2024-03-13 14:27:29 +00:00
ue . GET ( "/api/_version_/fleet/abm" , getAppleBMEndpoint , nil )
2023-11-15 12:37:19 +00:00
// Deprecated: POST /mdm/apple/profiles/batch is now deprecated, replaced by the
2024-03-13 14:27:29 +00:00
// platform-agnostic POST /mdm/profiles/batch. It is still supported
2023-11-15 12:37:19 +00:00
// indefinitely for backwards compatibility.
//
2023-03-27 19:30:29 +00:00
// batch-apply is accessible even though MDM is not enabled, it needs
// to support the case where `fleetctl get config`'s output is used as
// input to `fleetctl apply`
2026-02-05 15:29:53 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxBatchProfileSize ) . POST ( "/api/_version_/fleet/mdm/apple/profiles/batch" , batchSetMDMAppleProfilesEndpoint , batchSetMDMAppleProfilesRequest { } )
2022-10-05 22:53:54 +00:00
2023-11-29 14:32:42 +00:00
// batch-apply is accessible even though MDM is not enabled, it needs
// to support the case where `fleetctl get config`'s output is used as
// input to `fleetctl apply`
2026-02-05 15:29:53 +00:00
ue . WithRequestBodySizeLimit ( fleet . MaxBatchProfileSize ) . POST ( "/api/_version_/fleet/mdm/profiles/batch" , batchSetMDMProfilesEndpoint , batchSetMDMProfilesRequest { } )
2023-11-29 14:32:42 +00:00
2025-09-04 16:39:41 +00:00
// Certificate Authority endpoints
ue . POST ( "/api/_version_/fleet/certificate_authorities" , createCertificateAuthorityEndpoint , createCertificateAuthorityRequest { } )
ue . GET ( "/api/_version_/fleet/certificate_authorities" , listCertificateAuthoritiesEndpoint , listCertificateAuthoritiesRequest { } )
ue . GET ( "/api/_version_/fleet/certificate_authorities/{id:[0-9]+}" , getCertificateAuthorityEndpoint , getCertificateAuthorityRequest { } )
ue . DELETE ( "/api/_version_/fleet/certificate_authorities/{id:[0-9]+}" , deleteCertificateAuthorityEndpoint , deleteCertificateAuthorityRequest { } )
ue . PATCH ( "/api/_version_/fleet/certificate_authorities/{id:[0-9]+}" , updateCertificateAuthorityEndpoint , updateCertificateAuthorityRequest { } )
ue . POST ( "/api/_version_/fleet/certificate_authorities/{id:[0-9]+}/request_certificate" , requestCertificateEndpoint , requestCertificateRequest { } )
ue . POST ( "/api/_version_/fleet/spec/certificate_authorities" , batchApplyCertificateAuthoritiesEndpoint , batchApplyCertificateAuthoritiesRequest { } )
ue . GET ( "/api/_version_/fleet/spec/certificate_authorities" , getCertificateAuthoritiesSpecEndpoint , getCertificateAuthoritiesSpecRequest { } )
2026-03-02 20:14:19 +00:00
mdmAndroidMW := ue . WithCustomMiddleware ( mdmConfiguredMiddleware . VerifyAndroidMDM ( ) )
mdmAndroidMW . POST ( "/api/_version_/fleet/software/web_apps" , createAndroidWebAppEndpoint , createAndroidWebAppRequest { } )
2025-09-26 18:03:50 +00:00
ipBanner := redis . NewIPBanner ( redisPool , "ipbanner::" ,
deviceIPAllowedConsecutiveFailingRequestsCount ,
deviceIPAllowedConsecutiveFailingRequestsTimeWindow ,
deviceIPBanTime ,
)
2026-02-26 23:40:46 +00:00
errorLimiter := ratelimit . NewErrorMiddleware ( ipBanner ) . Limit ( logger )
2022-07-11 13:49:05 +00:00
2025-09-26 18:03:50 +00:00
// Device-authenticated endpoints.
2022-04-05 15:35:53 +00:00
de := newDeviceAuthenticatedEndpointer ( svc , logger , opts , r , apiVersions ... )
2025-09-26 18:03:50 +00:00
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}" , getDeviceHostEndpoint , getDeviceHostRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/desktop" , getFleetDesktopEndpoint , getFleetDesktopRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . HEAD ( "/api/_version_/fleet/device/{token}/ping" , devicePingEndpoint , deviceAuthPingRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/refetch" , refetchDeviceHostEndpoint , refetchDeviceHostRequest { } )
2025-10-21 18:02:25 +00:00
// Deprecated: Device mapping data is now included in host details endpoint
2025-09-26 18:03:50 +00:00
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/device_mapping" , listDeviceHostDeviceMappingEndpoint , listDeviceHostDeviceMappingRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/macadmins" , getDeviceMacadminsDataEndpoint , getDeviceMacadminsDataRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/policies" , listDevicePoliciesEndpoint , listDevicePoliciesRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/transparency" , transparencyURL , transparencyURLRequest { } )
2026-02-05 15:29:53 +00:00
de . WithCustomMiddleware ( errorLimiter ) . WithRequestBodySizeLimit ( fleet . MaxFleetdErrorReportSize ) . POST ( "/api/_version_/fleet/device/{token}/debug/errors" , fleetdError , fleetdErrorRequest { } )
2025-09-26 18:03:50 +00:00
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/software" , getDeviceSoftwareEndpoint , getDeviceSoftwareRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/software/install/{software_title_id}" , submitSelfServiceSoftwareInstall , fleetSelfServiceSoftwareInstallRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/software/uninstall/{software_title_id}" , submitDeviceSoftwareUninstall , fleetDeviceSoftwareUninstallRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/software/install/{install_uuid}/results" , getDeviceSoftwareInstallResultsEndpoint , getDeviceSoftwareInstallResultsRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/software/uninstall/{execution_id}/results" , getDeviceSoftwareUninstallResultsEndpoint , getDeviceSoftwareUninstallResultsRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/certificates" , listDeviceCertificatesEndpoint , listDeviceCertificatesRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/setup_experience/status" , getDeviceSetupExperienceStatusEndpoint , getDeviceSetupExperienceStatusRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/software/titles/{software_title_id}/icon" , getDeviceSoftwareIconEndpoint , getDeviceSoftwareIconRequest { } )
de . WithCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/mdm/linux/trigger_escrow" , triggerLinuxDiskEncryptionEscrowEndpoint , triggerLinuxDiskEncryptionEscrowRequest { } )
2026-01-26 22:58:31 +00:00
de . WithCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/bypass_conditional_access" , bypassConditionalAccessEndpoint , bypassConditionalAccessRequest { } )
2025-09-26 18:03:50 +00:00
// Device authenticated, Apple MDM endpoints.
2023-06-22 20:31:17 +00:00
demdm := de . WithCustomMiddleware ( mdmConfiguredMiddleware . VerifyAppleMDM ( ) )
2025-09-26 18:03:50 +00:00
demdm . AppendCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/mdm/apple/manual_enrollment_profile" , getDeviceMDMManualEnrollProfileEndpoint , getDeviceMDMManualEnrollProfileRequest { } )
demdm . AppendCustomMiddleware ( errorLimiter ) . GET ( "/api/_version_/fleet/device/{token}/software/commands/{command_uuid}/results" , getDeviceMDMCommandResultsEndpoint , getDeviceMDMCommandResultsRequest { } )
demdm . AppendCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/configuration_profiles/{profile_uuid}/resend" , resendDeviceConfigurationProfileEndpoint , resendDeviceConfigurationProfileRequest { } )
demdm . AppendCustomMiddleware ( errorLimiter ) . POST ( "/api/_version_/fleet/device/{token}/migrate_mdm" , migrateMDMDeviceEndpoint , deviceMigrateMDMRequest { } )
2024-11-18 22:44:25 +00:00
2022-03-07 18:10:55 +00:00
// host-authenticated endpoints
2022-04-05 15:35:53 +00:00
he := newHostAuthenticatedEndpointer ( svc , logger , opts , r , apiVersions ... )
// Note that the /osquery/ endpoints are *not* versioned, i.e. there is no
// `_version_` placeholder in the path. This is deliberate, see
// https://github.com/fleetdm/fleet/pull/4731#discussion_r838931732 For now
// we add an alias to `/api/v1/osquery` so that it is backwards compatible,
// but even that `v1` is *not* part of the standard versioning, it will still
// work even after we remove support for the `v1` version for the rest of the
// API. This allows us to deprecate osquery endpoints separately.
he . WithAltPaths ( "/api/v1/osquery/config" ) .
POST ( "/api/osquery/config" , getClientConfigEndpoint , getClientConfigRequest { } )
he . WithAltPaths ( "/api/v1/osquery/distributed/read" ) .
POST ( "/api/osquery/distributed/read" , getDistributedQueriesEndpoint , getDistributedQueriesRequest { } )
2026-03-09 17:49:07 +00:00
distWriteLimit := config . Osquery . MaxDistributedWriteBodySize
if distWriteLimit == 0 {
distWriteLimit = fleet . DefaultMaxOsqueryDistributedWriteSize
}
he . WithRequestBodySizeLimit ( distWriteLimit ) . WithAltPaths ( "/api/v1/osquery/distributed/write" ) .
2022-04-05 15:35:53 +00:00
POST ( "/api/osquery/distributed/write" , submitDistributedQueryResultsEndpoint , submitDistributedQueryResultsRequestShim { } )
he . WithAltPaths ( "/api/v1/osquery/carve/begin" ) .
POST ( "/api/osquery/carve/begin" , carveBeginEndpoint , carveBeginRequest { } )
2026-03-09 17:49:07 +00:00
logWriteLimit := config . Osquery . MaxLogWriteBodySize
if logWriteLimit == 0 {
logWriteLimit = fleet . DefaultMaxOsqueryLogWriteSize
}
he . WithRequestBodySizeLimit ( logWriteLimit ) . WithAltPaths ( "/api/v1/osquery/log" ) .
2022-04-05 15:35:53 +00:00
POST ( "/api/osquery/log" , submitLogsEndpoint , submitLogsRequest { } )
2024-11-13 17:01:08 +00:00
he . WithAltPaths ( "/api/v1/osquery/yara/{name}" ) .
POST ( "/api/osquery/yara/{name}" , getYaraEndpoint , getYaraRequest { } )
2025-12-03 19:42:03 +00:00
// android authenticated end-points
// Authentication is implemented using the orbit_node_key from the 'Authentication' header.
// The 'orbit_node_key' is used because it's the only thing we have available when the device gets enrolled
// after the MDM setup is complete.
androidEndpoints := androidAuthenticatedEndpointer ( svc , logger , opts , r , apiVersions ... )
androidEndpoints . GET ( "/api/fleetd/certificates/{id:[0-9]+}" , getDeviceCertificateTemplateEndpoint , getDeviceCertificateTemplateRequest { } )
androidEndpoints . PUT ( "/api/fleetd/certificates/{id:[0-9]+}/status" , updateCertificateStatusEndpoint , updateCertificateStatusRequest { } )
2022-03-08 16:27:38 +00:00
2022-09-23 19:00:23 +00:00
// orbit authenticated endpoints
oe := newOrbitAuthenticatedEndpointer ( svc , logger , opts , r , apiVersions ... )
2026-03-26 13:59:42 +00:00
oe . POST ( "/api/fleet/orbit/device_token" , setOrUpdateDeviceTokenEndpoint , fleet . SetOrUpdateDeviceTokenRequest { } )
oe . POST ( "/api/fleet/orbit/config" , getOrbitConfigEndpoint , fleet . OrbitGetConfigRequest { } )
2023-08-23 20:47:47 +00:00
// using POST to get a script execution request since all authenticated orbit
// endpoints are POST due to passing the device token in the JSON body.
2026-03-26 13:59:42 +00:00
oe . POST ( "/api/fleet/orbit/scripts/request" , getOrbitScriptEndpoint , fleet . OrbitGetScriptRequest { } )
oe . POST ( "/api/fleet/orbit/scripts/result" , postOrbitScriptResultEndpoint , fleet . OrbitPostScriptResultRequest { } )
oe . PUT ( "/api/fleet/orbit/device_mapping" , putOrbitDeviceMappingEndpoint , fleet . OrbitPutDeviceMappingRequest { } )
oe . WithRequestBodySizeLimit ( fleet . MaxMultiScriptQuerySize ) . POST ( "/api/fleet/orbit/software_install/result" , postOrbitSoftwareInstallResultEndpoint , fleet . OrbitPostSoftwareInstallResultRequest { } )
oe . POST ( "/api/fleet/orbit/software_install/package" , orbitDownloadSoftwareInstallerEndpoint , fleet . OrbitDownloadSoftwareInstallerRequest { } )
oe . POST ( "/api/fleet/orbit/software_install/details" , getOrbitSoftwareInstallDetails , fleet . OrbitGetSoftwareInstallRequest { } )
oe . POST ( "/api/fleet/orbit/setup_experience/init" , orbitSetupExperienceInitEndpoint , fleet . OrbitSetupExperienceInitRequest { } )
2024-05-06 19:19:45 +00:00
2025-09-16 16:26:00 +00:00
// POST /api/fleet/orbit/setup_experience/status is used by macOS and Linux hosts.
// For macOS hosts we verify Apple MDM is enabled and configured.
oeAppleMDM := oe . WithCustomMiddlewareAfterAuth ( mdmConfiguredMiddleware . VerifyAppleMDMOnMacOSHosts ( ) )
2026-03-26 13:59:42 +00:00
oeAppleMDM . POST ( "/api/fleet/orbit/setup_experience/status" , getOrbitSetupExperienceStatusEndpoint , fleet . GetOrbitSetupExperienceStatusRequest { } )
2024-10-07 21:16:32 +00:00
2023-10-09 21:28:35 +00:00
oeWindowsMDM := oe . WithCustomMiddleware ( mdmConfiguredMiddleware . VerifyWindowsMDM ( ) )
2026-03-26 13:59:42 +00:00
oeWindowsMDM . POST ( "/api/fleet/orbit/disk_encryption_key" , postOrbitDiskEncryptionKeyEndpoint , fleet . OrbitPostDiskEncryptionKeyRequest { } )
2023-10-09 21:28:35 +00:00
2026-03-26 13:59:42 +00:00
oe . POST ( "/api/fleet/orbit/luks_data" , postOrbitLUKSEndpoint , fleet . OrbitPostLUKSRequest { } )
2024-11-18 22:44:25 +00:00
2022-03-08 16:27:38 +00:00
// unauthenticated endpoints - most of those are either login-related,
// invite-related or host-enrolling. So they typically do some kind of
// one-time authentication by verifying that a valid secret token is provided
// with the request.
2022-04-05 15:35:53 +00:00
ne := newNoAuthEndpointer ( svc , opts , r , apiVersions ... )
ne . WithAltPaths ( "/api/v1/osquery/enroll" ) .
2025-07-16 18:08:27 +00:00
POST ( "/api/osquery/enroll" , enrollAgentEndpoint , contract . EnrollOsqueryAgentRequest { } )
2022-04-05 15:35:53 +00:00
2023-03-27 19:30:29 +00:00
// These endpoint are token authenticated.
2023-05-02 13:09:33 +00:00
// NOTE: remember to update
2023-10-09 21:28:35 +00:00
// `service.mdmConfigurationRequiredEndpoints` when you add an
2023-05-02 13:09:33 +00:00
// endpoint that's behind the mdmConfiguredMiddleware, this applies
// both to this set of endpoints and to any user authenticated
2023-06-22 20:31:17 +00:00
// endpoints using `mdmAppleMW.*` above in this file.
neAppleMDM := ne . WithCustomMiddleware ( mdmConfiguredMiddleware . VerifyAppleMDM ( ) )
neAppleMDM . GET ( apple_mdm . EnrollPath , mdmAppleEnrollEndpoint , mdmAppleEnrollRequest { } )
2025-05-20 19:50:48 +00:00
neAppleMDM . POST ( apple_mdm . EnrollPath , mdmAppleEnrollEndpoint , mdmAppleEnrollRequest { } )
2025-07-15 19:02:11 +00:00
2023-06-22 20:31:17 +00:00
neAppleMDM . GET ( apple_mdm . InstallerPath , mdmAppleGetInstallerEndpoint , mdmAppleGetInstallerRequest { } )
neAppleMDM . HEAD ( apple_mdm . InstallerPath , mdmAppleHeadInstallerEndpoint , mdmAppleHeadInstallerRequest { } )
2024-09-10 19:52:17 +00:00
neAppleMDM . POST ( "/api/_version_/fleet/ota_enrollment" , mdmAppleOTAEndpoint , mdmAppleOTARequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/bootstrap is now deprecated, replaced by the
// GET /bootstrap endpoint.
2024-02-07 12:24:24 +00:00
neAppleMDM . GET ( "/api/_version_/fleet/mdm/bootstrap" , downloadBootstrapPackageEndpoint , downloadBootstrapPackageRequest { } )
2024-03-13 14:27:29 +00:00
neAppleMDM . GET ( "/api/_version_/fleet/bootstrap" , downloadBootstrapPackageEndpoint , downloadBootstrapPackageRequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: GET /mdm/apple/bootstrap is now deprecated, replaced by the platform agnostic /mdm/bootstrap
2023-06-22 20:31:17 +00:00
neAppleMDM . GET ( "/api/_version_/fleet/mdm/apple/bootstrap" , downloadBootstrapPackageEndpoint , downloadBootstrapPackageRequest { } )
2024-03-13 14:27:29 +00:00
// Deprecated: GET /mdm/setup/eula/:token is now deprecated, replaced by the
// GET /setup_experience/eula/:token endpoint.
2024-02-07 12:24:24 +00:00
neAppleMDM . GET ( "/api/_version_/fleet/mdm/setup/eula/{token}" , getMDMEULAEndpoint , getMDMEULARequest { } )
2024-03-13 14:27:29 +00:00
neAppleMDM . GET ( "/api/_version_/fleet/setup_experience/eula/{token}" , getMDMEULAEndpoint , getMDMEULARequest { } )
2024-02-07 12:24:24 +00:00
// Deprecated: GET /mdm/apple/setup/eula/:token is now deprecated, replaced by the platform agnostic /mdm/setup/eula/:token
neAppleMDM . GET ( "/api/_version_/fleet/mdm/apple/setup/eula/{token}" , getMDMEULAEndpoint , getMDMEULARequest { } )
2023-06-22 20:31:17 +00:00
2024-09-05 11:47:34 +00:00
// Get OTA profile
neAppleMDM . GET ( "/api/_version_/fleet/enrollment_profiles/ota" , getOTAProfileEndpoint , getOTAProfileRequest { } )
2025-07-15 19:02:11 +00:00
// This is the account-driven enrollment endpoint for BYoD Apple devices, also known as User Enrollment.
neAppleMDM . POST ( apple_mdm . AccountDrivenEnrollPath , mdmAppleAccountEnrollEndpoint , mdmAppleAccountEnrollRequest { } )
// This is for OAUTH2 token based auth
// ne.POST(apple_mdm.EnrollPath+"/token", mdmAppleAccountEnrollTokenEndpoint, mdmAppleAccountEnrollTokenRequest{})
2023-06-22 20:31:17 +00:00
// These endpoint are used by Microsoft devices during MDM device enrollment phase
2023-06-27 15:59:33 +00:00
neWindowsMDM := ne . WithCustomMiddleware ( mdmConfiguredMiddleware . VerifyWindowsMDM ( ) )
2023-06-22 20:31:17 +00:00
2023-07-19 16:30:24 +00:00
// Microsoft MS-MDE2 Endpoints
// This endpoint is unauthenticated and is used by Microsoft devices to discover the MDM server endpoints
2026-02-05 15:29:53 +00:00
neWindowsMDM . WithRequestBodySizeLimit ( fleet . MaxMicrosoftMDMSize ) . POST ( microsoft_mdm . MDE2DiscoveryPath , mdmMicrosoftDiscoveryEndpoint , SoapRequestContainer { } )
2023-06-27 15:59:33 +00:00
2023-07-19 16:30:24 +00:00
// This endpoint is unauthenticated and is used by Microsoft devices to retrieve the opaque STS auth token
2026-02-05 15:29:53 +00:00
neWindowsMDM . WithRequestBodySizeLimit ( fleet . MaxMicrosoftMDMSize ) . GET ( microsoft_mdm . MDE2AuthPath , mdmMicrosoftAuthEndpoint , SoapRequestContainer { } )
2023-07-19 16:30:24 +00:00
2023-06-27 15:59:33 +00:00
// This endpoint is authenticated using the BinarySecurityToken header field
2026-02-05 15:29:53 +00:00
neWindowsMDM . WithRequestBodySizeLimit ( fleet . MaxMicrosoftMDMSize ) . POST ( microsoft_mdm . MDE2PolicyPath , mdmMicrosoftPolicyEndpoint , SoapRequestContainer { } )
2022-10-05 22:53:54 +00:00
2023-07-05 13:06:37 +00:00
// This endpoint is authenticated using the BinarySecurityToken header field
2026-02-05 15:29:53 +00:00
neWindowsMDM . WithRequestBodySizeLimit ( fleet . MaxMicrosoftMDMSize ) . POST ( microsoft_mdm . MDE2EnrollPath , mdmMicrosoftEnrollEndpoint , SoapRequestContainer { } )
2023-07-05 13:06:37 +00:00
2023-07-20 14:54:04 +00:00
// This endpoint is unauthenticated for now
// It should be authenticated through TLS headers once proper implementation is in place
2026-02-05 15:29:53 +00:00
neWindowsMDM . WithRequestBodySizeLimit ( fleet . MaxMicrosoftMDMSize ) . POST ( microsoft_mdm . MDE2ManagementPath , mdmMicrosoftManagementEndpoint , SyncMLReqMsgContainer { } )
2023-07-20 14:54:04 +00:00
2023-07-21 17:36:26 +00:00
// This endpoint is unauthenticated and is used by to retrieve the MDM enrollment Terms of Use
2026-02-05 15:29:53 +00:00
neWindowsMDM . WithRequestBodySizeLimit ( fleet . MaxMicrosoftMDMSize ) . GET ( microsoft_mdm . MDE2TOSPath , mdmMicrosoftTOSEndpoint , MDMWebContainer { } )
2023-07-21 17:36:26 +00:00
Make end-user auth check backwards-compatible (#35293)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #35214
# Details
Pursuant to the discussion in
https://fleetdm.slack.com/archives/C084F4MKYSJ/p1762352268815269, this
PR updates the `/orbit/enroll` API handler such that:
* IF end-user auth is configured for the team the host is enrolling to,
* AND the host's user has not completed authentication,
* AND the Orbit version making the enroll request does not support
prompting for end-user authentication,
* THEN the host will not be blocked from enrolling.
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
## Testing
- [ ] Added/updated automated tests
working on this, will post when done
- [X] QA'd all new/changed functionality manually
* Set up my local Fleet instance with end-user auth enabled for setup
experience on a team
* With this branch running as Fleet server, ran Orbit also on this
branch and attempted to enroll to that team
* Verified that the SSO window was opened in my browser
* With Fleet server still running this branch, switched my local working
tree to `rc-minor-fleet-v4.75.0` and ran Orbit again
* Verified that the host enrolled successfully and error messages
appeared in the fleet server logs.
2025-11-06 21:31:05 +00:00
// These endpoints are unauthenticated and made from orbit, and add the orbit capabilities header.
neOrbit := newOrbitNoAuthEndpointer ( svc , opts , r , apiVersions ... )
2026-03-26 13:59:42 +00:00
neOrbit . POST ( "/api/fleet/orbit/enroll" , enrollOrbitEndpoint , fleet . EnrollOrbitRequest { } )
2022-09-23 19:00:23 +00:00
2025-10-28 12:33:58 +00:00
ne . GET ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/in_house_app" , getInHouseAppPackageEndpoint , getInHouseAppPackageRequest { } )
ne . GET ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/in_house_app/manifest" , getInHouseAppManifestEndpoint , getInHouseAppManifestRequest { } )
2022-04-19 13:35:53 +00:00
// For some reason osquery does not provide a node key with the block data.
// Instead the carve session ID should be verified in the service method.
2026-02-05 15:29:53 +00:00
// Since []byte slices is encoded as base64 in JSON, increase the limit to 1.5x
ne . SkipRequestBodySizeLimit ( ) . WithAltPaths ( "/api/v1/osquery/carve/block" ) .
2022-04-05 15:35:53 +00:00
POST ( "/api/osquery/carve/block" , carveBlockEndpoint , carveBlockRequest { } )
2022-03-08 16:27:38 +00:00
2024-08-20 17:37:29 +00:00
ne . GET ( "/api/_version_/fleet/software/titles/{title_id:[0-9]+}/package/token/{token}" , downloadSoftwareInstallerEndpoint ,
downloadSoftwareInstallerRequest { } )
2022-03-08 16:27:38 +00:00
ne . POST ( "/api/_version_/fleet/perform_required_password_reset" , performRequiredPasswordResetEndpoint , performRequiredPasswordResetRequest { } )
ne . POST ( "/api/_version_/fleet/users" , createUserFromInviteEndpoint , createUserRequest { } )
ne . GET ( "/api/_version_/fleet/invites/{token}" , verifyInviteEndpoint , verifyInviteRequest { } )
ne . POST ( "/api/_version_/fleet/reset_password" , resetPasswordEndpoint , resetPasswordRequest { } )
ne . POST ( "/api/_version_/fleet/logout" , logoutEndpoint , nil )
2026-05-05 12:42:52 +00:00
orgLogoLimiter := ratelimit . NewMiddleware ( limitStore ) . Limit (
"org_logo" ,
throttled . RateQuota { MaxRate : throttled . PerMin ( 60 ) , MaxBurst : 20 } ,
)
ne . WithCustomMiddleware ( orgLogoLimiter ) .
GET ( "/api/_version_/fleet/logo" , getOrgLogoEndpoint , getOrgLogoRequest { } )
2022-04-20 16:46:45 +00:00
ne . POST ( "/api/v1/fleet/sso" , initiateSSOEndpoint , initiateSSORequest { } )
ne . POST ( "/api/v1/fleet/sso/callback" , makeCallbackSSOEndpoint ( config . Server . URLPrefix ) , callbackSSORequest { } )
ne . GET ( "/api/v1/fleet/sso" , settingsSSOEndpoint , nil )
2022-07-01 19:52:55 +00:00
2022-04-20 19:57:26 +00:00
// the websocket distributed query results endpoint is a bit different - the
// provided path is a prefix, not an exact match, and it is not a go-kit
// endpoint but a raw http.Handler. It uses the NoAuthEndpointer because
// authentication is done when the websocket session is established, inside
// the handler.
2025-02-18 17:09:43 +00:00
ne . UsePathPrefix ( ) . PathHandler ( "GET" , "/api/_version_/fleet/results/" ,
makeStreamDistributedQueryCampaignResultsHandler ( config . Server , svc , logger ) )
2022-03-08 16:27:38 +00:00
2023-06-15 19:41:04 +00:00
quota := throttled . RateQuota { MaxRate : throttled . PerHour ( 10 ) , MaxBurst : forgotPasswordRateLimitMaxBurst }
2022-03-08 16:27:38 +00:00
limiter := ratelimit . NewMiddleware ( limitStore )
ne .
2022-07-11 13:49:05 +00:00
WithCustomMiddleware ( limiter . Limit ( "forgot_password" , quota ) ) .
2022-03-08 16:27:38 +00:00
POST ( "/api/_version_/fleet/forgot_password" , forgotPasswordEndpoint , forgotPasswordRequest { } )
2025-06-02 22:18:58 +00:00
// By default, MDM SSO shares the login rate limit bucket; if MDM SSO limit is overridden, MDM SSO gets its
// own rate limit bucket.
loginRateLimit := throttled . PerMin ( 10 )
2022-04-19 13:35:53 +00:00
if extra . loginRateLimit != nil {
loginRateLimit = * extra . loginRateLimit
}
2025-06-02 22:18:58 +00:00
loginLimiter := limiter . Limit ( "login" , throttled . RateQuota { MaxRate : loginRateLimit , MaxBurst : 9 } )
mdmSsoLimiter := loginLimiter
2025-05-30 22:34:47 +00:00
if extra . mdmSsoRateLimit != nil {
2025-06-02 22:18:58 +00:00
mdmSsoLimiter = limiter . Limit ( "mdm_sso" , throttled . RateQuota { MaxRate : * extra . mdmSsoRateLimit , MaxBurst : 9 } )
2025-05-30 22:34:47 +00:00
}
2022-04-19 13:35:53 +00:00
2025-06-02 22:18:58 +00:00
ne . WithCustomMiddleware ( loginLimiter ) .
2025-04-10 19:08:45 +00:00
POST ( "/api/_version_/fleet/login" , loginEndpoint , contract . LoginRequest { } )
2024-12-05 14:37:10 +00:00
ne . WithCustomMiddleware ( limiter . Limit ( "mfa" , throttled . RateQuota { MaxRate : loginRateLimit , MaxBurst : 9 } ) ) .
POST ( "/api/_version_/fleet/sessions" , sessionCreateEndpoint , sessionCreateRequest { } )
add headers denoting capabilities between fleet server / desktop / orbit (#7833)
This adds a new mechanism to allow us to handle compatibility issues between Orbit, Fleet Server and Fleet Desktop.
The general idea is to _always_ send a custom header of the form:
```
fleet-capabilities-header = "X-Fleet-Capabilities:" capabilities
capabilities = capability * (,)
capability = string
```
Both from the server to the clients (Orbit, Fleet Desktop) and vice-versa. For an example, see: https://github.com/fleetdm/fleet/commit/8c0bbdd291f54e03e19766bcdfead0fb8067f60c
Also, the following applies:
- Backwards compat: if the header is not present, assume that orbit/fleet doesn't have the capability
- The current capabilities endpoint will be removed
### Motivation
This solution is trying to solve the following problems:
- We have three independent processes communicating with each other (Fleet Desktop, Orbit and Fleet Server). Each process can be updated independently, and therefore we need a way for each process to know what features are supported by its peers.
- We originally implemented a dedicated API endpoint in the server that returned a list of the capabilities (or "features") enabled, we found this, and any other server-only solution (like API versioning) to be insufficient because:
- There are cases in which the server also needs to know which features are supported by its clients
- Clients needed to poll for changes to detect if the capabilities supported by the server change, by sending the capabilities on each request we have a much cleaner way to handling different responses.
- We are also introducing an unauthenticated endpoint to get the server features, this gives us flexibility if we need to implement different authentication mechanisms, and was one of the pitfalls of the first implementation.
Related to https://github.com/fleetdm/fleet/issues/7929
2022-09-26 10:53:53 +00:00
2024-01-25 18:05:52 +00:00
ne . HEAD ( "/api/fleet/device/ping" , devicePingEndpoint , devicePingRequest { } )
add headers denoting capabilities between fleet server / desktop / orbit (#7833)
This adds a new mechanism to allow us to handle compatibility issues between Orbit, Fleet Server and Fleet Desktop.
The general idea is to _always_ send a custom header of the form:
```
fleet-capabilities-header = "X-Fleet-Capabilities:" capabilities
capabilities = capability * (,)
capability = string
```
Both from the server to the clients (Orbit, Fleet Desktop) and vice-versa. For an example, see: https://github.com/fleetdm/fleet/commit/8c0bbdd291f54e03e19766bcdfead0fb8067f60c
Also, the following applies:
- Backwards compat: if the header is not present, assume that orbit/fleet doesn't have the capability
- The current capabilities endpoint will be removed
### Motivation
This solution is trying to solve the following problems:
- We have three independent processes communicating with each other (Fleet Desktop, Orbit and Fleet Server). Each process can be updated independently, and therefore we need a way for each process to know what features are supported by its peers.
- We originally implemented a dedicated API endpoint in the server that returned a list of the capabilities (or "features") enabled, we found this, and any other server-only solution (like API versioning) to be insufficient because:
- There are cases in which the server also needs to know which features are supported by its clients
- Clients needed to poll for changes to detect if the capabilities supported by the server change, by sending the capabilities on each request we have a much cleaner way to handling different responses.
- We are also introducing an unauthenticated endpoint to get the server features, this gives us flexibility if we need to implement different authentication mechanisms, and was one of the pitfalls of the first implementation.
Related to https://github.com/fleetdm/fleet/issues/7929
2022-09-26 10:53:53 +00:00
2026-03-26 13:59:42 +00:00
ne . HEAD ( "/api/fleet/orbit/ping" , orbitPingEndpoint , fleet . OrbitPingRequest { } )
2023-04-27 12:43:20 +00:00
2024-07-08 15:20:03 +00:00
// This is a callback endpoint for calendar integration -- it is called to notify an event change in a user calendar
2024-07-24 11:40:33 +00:00
ne . POST ( "/api/_version_/fleet/calendar/webhook/{event_uuid}" , calendarWebhookEndpoint , calendarWebhookRequest { } )
2024-07-08 15:20:03 +00:00
2025-06-02 22:18:58 +00:00
neAppleMDM . WithCustomMiddleware ( mdmSsoLimiter ) .
2025-08-18 16:31:53 +00:00
POST ( "/api/_version_/fleet/mdm/sso" , initiateMDMSSOEndpoint , initiateMDMSSORequest { } )
ne . WithCustomMiddleware ( mdmSsoLimiter ) .
POST ( "/api/_version_/fleet/mdm/sso/callback" , callbackMDMSSOEndpoint , callbackMDMSSORequest { } )
2026-02-26 04:20:35 +00:00
// Register all deprecated URL path aliases from the declarative table.
endpointer . RegisterDeprecatedPathAliases ( r , apiVersions , registry , deprecatedPathAliases )
2021-07-16 18:28:13 +00:00
}
2020-11-18 19:10:55 +00:00
// WithSetup is an http middleware that checks if setup procedures have been completed.
2017-02-09 18:43:45 +00:00
// If setup hasn't been completed it serves the API with a setup middleware.
2016-11-09 17:19:07 +00:00
// If the server is already configured, the default API handler is exposed.
2026-04-03 14:58:03 +00:00
func WithSetup ( svc fleet . Service , logger * slog . Logger , applyStarterLibrary func ( ctx context . Context , serverURL , token string ) error , next http . Handler ) http . HandlerFunc {
2022-03-08 16:27:38 +00:00
rxOsquery := regexp . MustCompile ( ` ^/api/[^/]+/osquery ` )
2016-12-02 18:46:31 +00:00
return func ( w http . ResponseWriter , r * http . Request ) {
configRouter := http . NewServeMux ( )
2022-04-20 19:57:26 +00:00
srv := kithttp . NewServer (
2026-04-03 14:58:03 +00:00
makeSetupEndpoint ( svc , logger , applyStarterLibrary ) ,
2016-12-02 18:46:31 +00:00
decodeSetupRequest ,
encodeResponse ,
2022-04-20 19:57:26 +00:00
)
// NOTE: support setup on both /v1/ and version-less, in the future /v1/
// will be dropped.
configRouter . Handle ( "/api/v1/setup" , srv )
configRouter . Handle ( "/api/setup" , srv )
2017-01-12 00:40:58 +00:00
// whitelist osqueryd endpoints
2022-03-08 16:27:38 +00:00
if rxOsquery . MatchString ( r . URL . Path ) {
2017-01-12 00:40:58 +00:00
next . ServeHTTP ( w , r )
return
}
2026-02-26 23:40:46 +00:00
ctx := r . Context ( )
requireSetup , err := svc . SetupRequired ( ctx )
2017-02-09 18:43:45 +00:00
if err != nil {
2026-02-26 23:40:46 +00:00
logger . ErrorContext ( ctx , "fetching setup info from db" , "err" , err )
2017-02-09 18:43:45 +00:00
w . WriteHeader ( http . StatusInternalServerError )
return
}
if requireSetup {
2016-12-02 18:46:31 +00:00
configRouter . ServeHTTP ( w , r )
2017-02-09 18:43:45 +00:00
return
2016-12-02 18:46:31 +00:00
}
2017-02-09 18:43:45 +00:00
next . ServeHTTP ( w , r )
2016-11-09 17:19:07 +00:00
}
}
2016-12-29 23:36:36 +00:00
// RedirectLoginToSetup detects if the setup endpoint should be used. If setup is required it redirect all
// frontend urls to /setup, otherwise the frontend router is used.
2026-02-26 23:40:46 +00:00
func RedirectLoginToSetup ( svc fleet . Service , logger * slog . Logger , next http . Handler , urlPrefix string ) http . HandlerFunc {
2016-12-29 23:36:36 +00:00
return func ( w http . ResponseWriter , r * http . Request ) {
redirect := http . HandlerFunc ( func ( w http . ResponseWriter , r * http . Request ) {
2017-09-01 16:42:46 +00:00
if r . URL . Path == "/setup" {
2016-12-29 23:36:36 +00:00
next . ServeHTTP ( w , r )
return
}
newURL := r . URL
2019-10-16 23:40:45 +00:00
newURL . Path = urlPrefix + "/setup"
2016-12-29 23:36:36 +00:00
http . Redirect ( w , r , newURL . String ( ) , http . StatusTemporaryRedirect )
} )
2017-02-09 18:43:45 +00:00
2026-02-26 23:40:46 +00:00
ctx := r . Context ( )
setupRequired , err := svc . SetupRequired ( ctx )
2017-02-09 18:43:45 +00:00
if err != nil {
2026-02-26 23:40:46 +00:00
logger . ErrorContext ( ctx , "fetching setupinfo from db" , "err" , err )
2017-02-09 18:43:45 +00:00
w . WriteHeader ( http . StatusInternalServerError )
return
}
if setupRequired {
2016-12-29 23:36:36 +00:00
redirect . ServeHTTP ( w , r )
2017-02-09 18:43:45 +00:00
return
2016-12-29 23:36:36 +00:00
}
2019-10-16 23:40:45 +00:00
RedirectSetupToLogin ( svc , logger , next , urlPrefix ) . ServeHTTP ( w , r )
2016-11-09 17:19:07 +00:00
}
}
2017-09-01 16:42:46 +00:00
// RedirectSetupToLogin forces the /setup path to be redirected to login. This middleware is used after
2017-01-11 19:05:07 +00:00
// the app has been setup.
2026-02-26 23:40:46 +00:00
func RedirectSetupToLogin ( svc fleet . Service , logger * slog . Logger , next http . Handler , urlPrefix string ) http . HandlerFunc {
2017-01-11 19:05:07 +00:00
return func ( w http . ResponseWriter , r * http . Request ) {
if r . URL . Path == "/setup" {
newURL := r . URL
2019-10-16 23:40:45 +00:00
newURL . Path = urlPrefix + "/login"
2017-01-11 19:05:07 +00:00
http . Redirect ( w , r , newURL . String ( ) , http . StatusTemporaryRedirect )
return
}
next . ServeHTTP ( w , r )
}
}
2023-01-16 20:06:30 +00:00
// RegisterAppleMDMProtocolServices registers the HTTP handlers that serve
// the MDM services to Apple devices.
func RegisterAppleMDMProtocolServices (
mux * http . ServeMux ,
2023-03-23 10:30:28 +00:00
scepConfig config . MDMConfig ,
2024-05-30 21:18:42 +00:00
mdmStorage fleet . MDMAppleStore ,
2023-01-31 14:46:01 +00:00
scepStorage scep_depot . Depot ,
2026-02-26 23:40:46 +00:00
logger * slog . Logger ,
2023-01-16 20:06:30 +00:00
checkinAndCommandService nanomdm_service . CheckinAndCommandService ,
2024-03-15 18:20:15 +00:00
ddmService nanomdm_service . DeclarativeManagement ,
2024-12-20 21:40:23 +00:00
profileService nanomdm_service . ProfileService ,
2025-07-23 11:11:32 +00:00
serverURLPrefix string ,
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
fleetConfig config . FleetConfig ,
2023-01-16 20:06:30 +00:00
) error {
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
if err := registerSCEP ( mux , scepConfig , scepStorage , mdmStorage , logger , fleetConfig ) ; err != nil {
2023-01-16 20:06:30 +00:00
return fmt . Errorf ( "scep: %w" , err )
}
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
if err := registerMDM ( mux , mdmStorage , checkinAndCommandService , ddmService , profileService , logger , fleetConfig ) ; err != nil {
2023-01-16 20:06:30 +00:00
return fmt . Errorf ( "mdm: %w" , err )
}
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
if err := registerMDMServiceDiscovery ( mux , logger , serverURLPrefix , fleetConfig ) ; err != nil {
2025-07-23 11:11:32 +00:00
return fmt . Errorf ( "service discovery: %w" , err )
}
return nil
}
func registerMDMServiceDiscovery (
mux * http . ServeMux ,
2026-02-26 23:40:46 +00:00
logger * slog . Logger ,
2025-07-23 11:11:32 +00:00
serverURLPrefix string ,
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
fleetConfig config . FleetConfig ,
2025-07-23 11:11:32 +00:00
) error {
Changes needed before gokit/log to slog transition. (#39527)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #38889
PLEASE READ BELOW before looking at file changes
Before converting individual files/packages to slog, we generally need
to make these 2 changes to make the conversion easier:
- Replace uses of `kitlog.With` since they are not fully compatible with
our kitlog adapter
- Directly use the kitlog adapter logger type instead of the kitlog
interface, which will let us have direct access to the underlying slog
logger: `*logging.Logger`
Note: that I did not replace absolutely all uses of `kitlog.Logger`, but
I did remove all uses of `kitlog.With` except for these due to
complexity:
- server/logging/filesystem.go and the other log writers (webhook,
firehose, kinesis, lambda, pubsub, nats)
- server/datastore/mysql/nanomdm_storage.go (adapter pattern)
- server/vulnerabilities/nvd/* (cascades to CLI tools)
- server/service/osquery_utils/queries.go (callback type signatures
cascade broadly)
- cmd/maintained-apps/ (standalone, so can be transitioned later all at
once)
Most of the changes in this PR follow these patterns:
- `kitlog.Logger` type → `*logging.Logger`
- `kitlog.With(logger, ...)` → `logger.With(...)`
- `kitlog.NewNopLogger() → logging.NewNopLogger()`, including similar
variations such as `logging.NewLogfmtLogger(w)` and
`logging.NewJSONLogger(w)`
- removed many now-unused kitlog imports
Unique changes that the PR review should focus on:
- server/platform/logging/kitlog_adapter.go: Core adapter changes
- server/platform/logging/logging.go: New convenience functions
- server/service/integration_logger_test.go: Test changes for slog
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- Was added in previous PR
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Refactor**
* Migrated the codebase to a unified internal structured logging system
for more consistent, reliable logs and observability.
* No user-facing functionality changed; runtime behavior and APIs remain
compatible.
* **Tests**
* Updated tests to use the new logging helpers to ensure consistent test
logging and validation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-11 16:08:33 +00:00
serviceDiscoveryLogger := logger . With ( "component" , "mdm-apple-service-discovery" )
2025-07-23 11:11:32 +00:00
fullMDMEnrollmentURL := fmt . Sprintf ( "%s%s" , serverURLPrefix , apple_mdm . AccountDrivenEnrollPath )
serviceDiscoveryHandler := http . HandlerFunc ( func ( w http . ResponseWriter , r * http . Request ) {
2026-02-26 23:40:46 +00:00
ctx := r . Context ( )
serviceDiscoveryLogger . InfoContext ( ctx , "serving MDM service discovery response" , "url" , fullMDMEnrollmentURL )
2025-07-23 11:11:32 +00:00
w . Header ( ) . Set ( "Content-Type" , "application/json" )
w . WriteHeader ( http . StatusOK )
_ , err := fmt . Fprintf ( w , ` { "Servers":[ { "Version": "mdm-byod", "BaseURL": "%s"}]} ` , fullMDMEnrollmentURL )
if err != nil {
2026-02-26 23:40:46 +00:00
serviceDiscoveryLogger . ErrorContext ( ctx , "error writing service discovery response" , "err" , err )
2025-07-23 11:11:32 +00:00
http . Error ( w , "Internal Server Error" , http . StatusInternalServerError )
}
} )
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
mux . Handle ( apple_mdm . ServiceDiscoveryPath , otel . WrapHandler ( serviceDiscoveryHandler , apple_mdm . ServiceDiscoveryPath , fleetConfig ) )
2023-01-16 20:06:30 +00:00
return nil
}
// registerSCEP registers the HTTP handler for SCEP service needed for enrollment to MDM.
// Returns the SCEP CA certificate that can be used by verifiers.
func registerSCEP (
mux * http . ServeMux ,
2023-03-23 10:30:28 +00:00
scepConfig config . MDMConfig ,
2023-01-31 14:46:01 +00:00
scepStorage scep_depot . Depot ,
2024-05-30 21:18:42 +00:00
mdmStorage fleet . MDMAppleStore ,
2026-02-26 23:40:46 +00:00
logger * slog . Logger ,
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
fleetConfig config . FleetConfig ,
2023-01-16 20:06:30 +00:00
) error {
2024-09-27 12:04:11 +00:00
var signer scepserver . CSRSignerContext = scepserver . SignCSRAdapter ( scep_depot . NewSigner (
2023-01-16 20:06:30 +00:00
scepStorage ,
2023-03-23 10:30:28 +00:00
scep_depot . WithValidityDays ( scepConfig . AppleSCEPSignerValidityDays ) ,
2026-03-04 16:53:59 +00:00
// This value was allowed to be configured via --mdm_apple_scep_signer_allow_renewal_days but there was no real use case for
// customizing it and it was confusing for customers, so it has been removed and replaced with the default of 14. For discussion,
// see https://github.com/fleetdm/fleet/issues/38611 and https://github.com/fleetdm/fleet/issues/37880#issuecomment-3805983198
// Fleet has a 180-day renewal cron that is completely unrelated to this or its value
scep_depot . WithAllowRenewalDays ( 14 ) ,
2024-09-27 12:04:11 +00:00
) )
2024-10-09 18:47:27 +00:00
assets , err := mdmStorage . GetAllMDMConfigAssetsByName ( context . Background ( ) , [ ] fleet . MDMAssetName { fleet . MDMAssetSCEPChallenge } , nil )
2024-06-03 21:33:52 +00:00
if err != nil {
return fmt . Errorf ( "retrieving SCEP challenge: %w" , err )
2023-01-16 20:06:30 +00:00
}
2024-06-03 21:33:52 +00:00
scepChallenge := string ( assets [ fleet . MDMAssetSCEPChallenge ] . Value )
2024-09-27 12:04:11 +00:00
signer = scepserver . StaticChallengeMiddleware ( scepChallenge , signer )
2024-05-30 21:18:42 +00:00
scepService := NewSCEPService (
mdmStorage ,
signer ,
Changes needed before gokit/log to slog transition. (#39527)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #38889
PLEASE READ BELOW before looking at file changes
Before converting individual files/packages to slog, we generally need
to make these 2 changes to make the conversion easier:
- Replace uses of `kitlog.With` since they are not fully compatible with
our kitlog adapter
- Directly use the kitlog adapter logger type instead of the kitlog
interface, which will let us have direct access to the underlying slog
logger: `*logging.Logger`
Note: that I did not replace absolutely all uses of `kitlog.Logger`, but
I did remove all uses of `kitlog.With` except for these due to
complexity:
- server/logging/filesystem.go and the other log writers (webhook,
firehose, kinesis, lambda, pubsub, nats)
- server/datastore/mysql/nanomdm_storage.go (adapter pattern)
- server/vulnerabilities/nvd/* (cascades to CLI tools)
- server/service/osquery_utils/queries.go (callback type signatures
cascade broadly)
- cmd/maintained-apps/ (standalone, so can be transitioned later all at
once)
Most of the changes in this PR follow these patterns:
- `kitlog.Logger` type → `*logging.Logger`
- `kitlog.With(logger, ...)` → `logger.With(...)`
- `kitlog.NewNopLogger() → logging.NewNopLogger()`, including similar
variations such as `logging.NewLogfmtLogger(w)` and
`logging.NewJSONLogger(w)`
- removed many now-unused kitlog imports
Unique changes that the PR review should focus on:
- server/platform/logging/kitlog_adapter.go: Core adapter changes
- server/platform/logging/logging.go: New convenience functions
- server/service/integration_logger_test.go: Test changes for slog
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- Was added in previous PR
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Refactor**
* Migrated the codebase to a unified internal structured logging system
for more consistent, reliable logs and observability.
* No user-facing functionality changed; runtime behavior and APIs remain
compatible.
* **Tests**
* Updated tests to use the new logging helpers to ensure consistent test
logging and validation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-11 16:08:33 +00:00
logger . With ( "component" , "mdm-apple-scep" ) ,
2023-01-16 20:06:30 +00:00
)
2024-05-30 21:18:42 +00:00
2026-02-26 23:40:46 +00:00
scepSlogLogger := logger . With ( "component" , "http-mdm-apple-scep" )
2023-01-16 20:06:30 +00:00
e := scepserver . MakeServerEndpoints ( scepService )
2026-02-26 23:40:46 +00:00
e . GetEndpoint = scepserver . EndpointLoggingMiddleware ( scepSlogLogger ) ( e . GetEndpoint )
e . PostEndpoint = scepserver . EndpointLoggingMiddleware ( scepSlogLogger ) ( e . PostEndpoint )
scepHandler := scepserver . MakeHTTPHandler ( e , scepService , scepSlogLogger )
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
mux . Handle ( apple_mdm . SCEPPath , otel . WrapHandler ( scepHandler , apple_mdm . SCEPPath , fleetConfig ) )
2023-01-16 20:06:30 +00:00
return nil
}
2024-10-09 18:47:27 +00:00
func RegisterSCEPProxy (
rootMux * http . ServeMux ,
ds fleet . Datastore ,
2026-02-26 23:40:46 +00:00
logger * slog . Logger ,
2025-03-14 17:16:51 +00:00
timeout * time . Duration ,
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
fleetConfig * config . FleetConfig ,
2024-10-09 18:47:27 +00:00
) error {
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
if fleetConfig == nil {
return errors . New ( "fleet config is nil" )
}
speed up macOS profile delivery for initial enrollments (#41960)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #34433
It speeds up the cron, meaning fleetd, bootstrap and now profiles should
be sent within 10 seconds of being known to fleet, compared to the
previous 1 minute.
It's heavily based on my last PR, so the structure and changes are close
to identical, with some small differences.
**I did not do the redis key part in this PR, as I think that should
come in it's own PR, to avoid overlooking logic bugs with that code, and
since this one is already quite sized since we're moving core pieces of
code around.**
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Faster macOS onboarding: device profiles are delivered and installed
as part of DEP enrollment, shortening initial setup.
* Improved profile handling: per-host profile preprocessing, secret
detection, and clearer failure marking.
* **Improvements**
* Consolidated SCEP/NDES error messaging for clearer diagnostics.
* Cron/work scheduling tuned to prioritize Apple MDM profile delivery.
* **Tests**
* Expanded MDM unit and integration tests, including
DeclarativeManagement handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-03-19 19:58:10 +00:00
scepService := scep . NewSCEPProxyService (
2024-10-09 18:47:27 +00:00
ds ,
Changes needed before gokit/log to slog transition. (#39527)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #38889
PLEASE READ BELOW before looking at file changes
Before converting individual files/packages to slog, we generally need
to make these 2 changes to make the conversion easier:
- Replace uses of `kitlog.With` since they are not fully compatible with
our kitlog adapter
- Directly use the kitlog adapter logger type instead of the kitlog
interface, which will let us have direct access to the underlying slog
logger: `*logging.Logger`
Note: that I did not replace absolutely all uses of `kitlog.Logger`, but
I did remove all uses of `kitlog.With` except for these due to
complexity:
- server/logging/filesystem.go and the other log writers (webhook,
firehose, kinesis, lambda, pubsub, nats)
- server/datastore/mysql/nanomdm_storage.go (adapter pattern)
- server/vulnerabilities/nvd/* (cascades to CLI tools)
- server/service/osquery_utils/queries.go (callback type signatures
cascade broadly)
- cmd/maintained-apps/ (standalone, so can be transitioned later all at
once)
Most of the changes in this PR follow these patterns:
- `kitlog.Logger` type → `*logging.Logger`
- `kitlog.With(logger, ...)` → `logger.With(...)`
- `kitlog.NewNopLogger() → logging.NewNopLogger()`, including similar
variations such as `logging.NewLogfmtLogger(w)` and
`logging.NewJSONLogger(w)`
- removed many now-unused kitlog imports
Unique changes that the PR review should focus on:
- server/platform/logging/kitlog_adapter.go: Core adapter changes
- server/platform/logging/logging.go: New convenience functions
- server/service/integration_logger_test.go: Test changes for slog
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- Was added in previous PR
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Refactor**
* Migrated the codebase to a unified internal structured logging system
for more consistent, reliable logs and observability.
* No user-facing functionality changed; runtime behavior and APIs remain
compatible.
* **Tests**
* Updated tests to use the new logging helpers to ensure consistent test
logging and validation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-11 16:08:33 +00:00
logger . With ( "component" , "scep-proxy-service" ) ,
2025-03-14 17:16:51 +00:00
timeout ,
2024-10-09 18:47:27 +00:00
)
2026-02-26 23:40:46 +00:00
scepProxySlogLogger := logger . With ( "component" , "http-scep-proxy" )
2024-10-09 18:47:27 +00:00
e := scepserver . MakeServerEndpointsWithIdentifier ( scepService )
2026-02-26 23:40:46 +00:00
e . GetEndpoint = scepserver . EndpointLoggingMiddleware ( scepProxySlogLogger ) ( e . GetEndpoint )
e . PostEndpoint = scepserver . EndpointLoggingMiddleware ( scepProxySlogLogger ) ( e . PostEndpoint )
scepHandler := scepserver . MakeHTTPHandlerWithIdentifier ( e , apple_mdm . SCEPProxyPath , scepProxySlogLogger )
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
// Not using OTEL dynamic wrapper so as not to expose {identifier} in the span name
scepHandler = otel . WrapHandler ( scepHandler , apple_mdm . SCEPProxyPath , * fleetConfig )
2024-10-09 18:47:27 +00:00
rootMux . Handle ( apple_mdm . SCEPProxyPath , scepHandler )
return nil
}
2023-01-16 20:06:30 +00:00
// NanoMDMLogger is a logger adapter for nanomdm.
type NanoMDMLogger struct {
2026-02-26 23:40:46 +00:00
logger * slog . Logger
2023-01-16 20:06:30 +00:00
}
2026-02-26 23:40:46 +00:00
func NewNanoMDMLogger ( logger * slog . Logger ) * NanoMDMLogger {
2023-01-16 20:06:30 +00:00
return & NanoMDMLogger {
logger : logger ,
}
}
func ( l * NanoMDMLogger ) Info ( keyvals ... interface { } ) {
2026-02-26 13:16:44 +00:00
l . logger . InfoContext ( context . TODO ( ) , "" , keyvals ... )
2023-01-16 20:06:30 +00:00
}
func ( l * NanoMDMLogger ) Debug ( keyvals ... interface { } ) {
2026-02-26 13:16:44 +00:00
l . logger . DebugContext ( context . TODO ( ) , "" , keyvals ... )
2023-01-16 20:06:30 +00:00
}
func ( l * NanoMDMLogger ) With ( keyvals ... interface { } ) nanomdm_log . Logger {
return & NanoMDMLogger {
Changes needed before gokit/log to slog transition. (#39527)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #38889
PLEASE READ BELOW before looking at file changes
Before converting individual files/packages to slog, we generally need
to make these 2 changes to make the conversion easier:
- Replace uses of `kitlog.With` since they are not fully compatible with
our kitlog adapter
- Directly use the kitlog adapter logger type instead of the kitlog
interface, which will let us have direct access to the underlying slog
logger: `*logging.Logger`
Note: that I did not replace absolutely all uses of `kitlog.Logger`, but
I did remove all uses of `kitlog.With` except for these due to
complexity:
- server/logging/filesystem.go and the other log writers (webhook,
firehose, kinesis, lambda, pubsub, nats)
- server/datastore/mysql/nanomdm_storage.go (adapter pattern)
- server/vulnerabilities/nvd/* (cascades to CLI tools)
- server/service/osquery_utils/queries.go (callback type signatures
cascade broadly)
- cmd/maintained-apps/ (standalone, so can be transitioned later all at
once)
Most of the changes in this PR follow these patterns:
- `kitlog.Logger` type → `*logging.Logger`
- `kitlog.With(logger, ...)` → `logger.With(...)`
- `kitlog.NewNopLogger() → logging.NewNopLogger()`, including similar
variations such as `logging.NewLogfmtLogger(w)` and
`logging.NewJSONLogger(w)`
- removed many now-unused kitlog imports
Unique changes that the PR review should focus on:
- server/platform/logging/kitlog_adapter.go: Core adapter changes
- server/platform/logging/logging.go: New convenience functions
- server/service/integration_logger_test.go: Test changes for slog
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- Was added in previous PR
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Refactor**
* Migrated the codebase to a unified internal structured logging system
for more consistent, reliable logs and observability.
* No user-facing functionality changed; runtime behavior and APIs remain
compatible.
* **Tests**
* Updated tests to use the new logging helpers to ensure consistent test
logging and validation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-11 16:08:33 +00:00
logger : l . logger . With ( keyvals ... ) ,
2023-01-16 20:06:30 +00:00
}
}
// registerMDM registers the HTTP handlers that serve core MDM services (like checking in for MDM commands).
func registerMDM (
mux * http . ServeMux ,
2024-05-30 21:18:42 +00:00
mdmStorage fleet . MDMAppleStore ,
2023-01-16 20:06:30 +00:00
checkinAndCommandService nanomdm_service . CheckinAndCommandService ,
2024-03-15 18:20:15 +00:00
ddmService nanomdm_service . DeclarativeManagement ,
2024-12-20 21:40:23 +00:00
profileService nanomdm_service . ProfileService ,
2026-02-26 23:40:46 +00:00
logger * slog . Logger ,
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
fleetConfig config . FleetConfig ,
2023-01-16 20:06:30 +00:00
) error {
2024-05-30 21:18:42 +00:00
certVerifier := mdmcrypto . NewSCEPVerifier ( mdmStorage )
Changes needed before gokit/log to slog transition. (#39527)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #38889
PLEASE READ BELOW before looking at file changes
Before converting individual files/packages to slog, we generally need
to make these 2 changes to make the conversion easier:
- Replace uses of `kitlog.With` since they are not fully compatible with
our kitlog adapter
- Directly use the kitlog adapter logger type instead of the kitlog
interface, which will let us have direct access to the underlying slog
logger: `*logging.Logger`
Note: that I did not replace absolutely all uses of `kitlog.Logger`, but
I did remove all uses of `kitlog.With` except for these due to
complexity:
- server/logging/filesystem.go and the other log writers (webhook,
firehose, kinesis, lambda, pubsub, nats)
- server/datastore/mysql/nanomdm_storage.go (adapter pattern)
- server/vulnerabilities/nvd/* (cascades to CLI tools)
- server/service/osquery_utils/queries.go (callback type signatures
cascade broadly)
- cmd/maintained-apps/ (standalone, so can be transitioned later all at
once)
Most of the changes in this PR follow these patterns:
- `kitlog.Logger` type → `*logging.Logger`
- `kitlog.With(logger, ...)` → `logger.With(...)`
- `kitlog.NewNopLogger() → logging.NewNopLogger()`, including similar
variations such as `logging.NewLogfmtLogger(w)` and
`logging.NewJSONLogger(w)`
- removed many now-unused kitlog imports
Unique changes that the PR review should focus on:
- server/platform/logging/kitlog_adapter.go: Core adapter changes
- server/platform/logging/logging.go: New convenience functions
- server/service/integration_logger_test.go: Test changes for slog
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- Was added in previous PR
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Refactor**
* Migrated the codebase to a unified internal structured logging system
for more consistent, reliable logs and observability.
* No user-facing functionality changed; runtime behavior and APIs remain
compatible.
* **Tests**
* Updated tests to use the new logging helpers to ensure consistent test
logging and validation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-11 16:08:33 +00:00
mdmLogger := NewNanoMDMLogger ( logger . With ( "component" , "http-mdm-apple-mdm" ) )
2023-01-16 20:06:30 +00:00
// As usual, handlers are applied from bottom to top:
// 1. Extract and verify MDM signature.
// 2. Verify signer certificate with CA.
// 3. Verify new or enrolled certificate (certauth.CertAuth which wraps the MDM service).
// 4. Pass a copy of the request to Fleet middleware that ingests new hosts from pending MDM
// enrollments and updates the Fleet hosts table accordingly with the UDID and serial number of
// the device.
// 5. Run actual MDM service operation (checkin handler or command and results handler).
2024-12-20 21:40:23 +00:00
coreMDMService := nanomdm . New ( mdmStorage , nanomdm . WithLogger ( mdmLogger ) , nanomdm . WithDeclarativeManagement ( ddmService ) ,
2025-09-16 20:04:05 +00:00
nanomdm . WithProfileService ( profileService ) , nanomdm . WithUserAuthenticate ( checkinAndCommandService ) )
2023-03-27 18:43:01 +00:00
// NOTE: it is critical that the coreMDMService runs first, as the first
// service in the multi-service feature is run to completion _before_ running
// the other ones in parallel. This way, subsequent services have access to
// the result of the core service, e.g. the device is enrolled, etc.
2023-01-16 20:06:30 +00:00
var mdmService nanomdm_service . CheckinAndCommandService = multi . New ( mdmLogger , coreMDMService , checkinAndCommandService )
2025-03-28 21:33:22 +00:00
mdmService = certauth . New ( mdmService , mdmStorage , certauth . WithLogger ( mdmLogger . With ( "handler" , "cert-auth" ) ) )
2023-01-16 20:06:30 +00:00
var mdmHandler http . Handler = httpmdm . CheckinAndCommandHandler ( mdmService , mdmLogger . With ( "handler" , "checkin-command" ) )
2024-11-11 19:25:21 +00:00
verifyDisable , exists := os . LookupEnv ( "FLEET_MDM_APPLE_SCEP_VERIFY_DISABLE" )
if exists && ( strings . EqualFold ( verifyDisable , "true" ) || verifyDisable == "1" ) {
2026-02-26 13:16:44 +00:00
logger . InfoContext ( context . TODO ( ) ,
2024-11-11 19:25:21 +00:00
"disabling verification of macOS SCEP certificates as FLEET_MDM_APPLE_SCEP_VERIFY_DISABLE is set to true" )
} else {
mdmHandler = httpmdm . CertVerifyMiddleware ( mdmHandler , certVerifier , mdmLogger . With ( "handler" , "cert-verify" ) )
}
2024-11-20 17:47:11 +00:00
mdmHandler = httpmdm . CertExtractMdmSignatureMiddleware ( mdmHandler , httpmdm . MdmSignatureVerifierFunc ( cryptoutil . VerifyMdmSignature ) ,
httpmdm . SigLogWithLogger ( mdmLogger . With ( "handler" , "cert-extract" ) ) )
Added missing OpenTelemetry instrumentation to several API endpoints. (#32960)
Fixes #32331
Manually tested all paths. `/test` path removed in
https://github.com/fleetdm/fleet/pull/32962
Also added support for sending errors to OpenTelemetry, like we do for
APM/Sentry.
# 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/guides/committing-changes.md#changes-files)
for more information.
## Testing
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **New Features**
* Added OpenTelemetry tracing across core HTTP endpoints (health,
version, assets, metrics, enroll/root, debug, Apple MDM, SCEP, SCIM)
with dynamic per-request route instrumentation.
* Enhanced error reporting to include OpenTelemetry spans/events with
contextual user/host attributes.
* **Tests**
* Added unit tests validating SCIM and error-handling telemetry, span
naming, and sensitive-data redaction.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-16 16:10:33 +00:00
mux . Handle ( apple_mdm . MDMPath , otel . WrapHandler ( mdmHandler , apple_mdm . MDMPath , fleetConfig ) )
2023-01-16 20:06:30 +00:00
return nil
}
2024-11-22 15:56:36 +00:00
redirect to correct URL, and allow both URLs for MDM SSO SAML validation if set (#44156)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #41592
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [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/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements), JS
inline code is prevented especially for url redirects, and untrusted
data interpolated into shell scripts/commands is validated against shell
metacharacters.
- [x] Timeouts are implemented and retries are limited to avoid infinite
loops
- [x] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
## Testing
- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Bug Fixes**
* Fixed SSO failures when a custom Apple MDM URL is configured: callback
requests are now redirected to the configured MDM URL when needed, and
SAML validation correctly considers the configured MDM/server URLs so
authentication succeeds for custom MDM setups.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-29 14:43:58 +00:00
func WithMDMSSOCallbackRedirect ( svc fleet . Service , logger * slog . Logger , next http . Handler ) http . HandlerFunc {
return func ( w http . ResponseWriter , r * http . Request ) {
if ! strings . HasSuffix ( r . URL . Path , "/fleet/mdm/sso/callback" ) {
next . ServeHTTP ( w , r )
return
}
// First check if the cookie is set on the current domain, if it is, just serve as is.
_ , err := r . Cookie ( cookieNameSSOSession )
if err == nil {
next . ServeHTTP ( w , r )
return
}
// Check for custom apple URL set and does not match the current request URL, then do a redirect to the custom URL, where the Cookie is set.
appCfg , err := svc . AppConfigUrls ( r . Context ( ) )
if err != nil {
logger . ErrorContext ( r . Context ( ) , "fetching app config" , "err" , err )
next . ServeHTTP ( w , r )
return
}
parsedUrl , err := url . Parse ( appCfg . MDMUrl ( ) )
if err != nil {
logger . ErrorContext ( r . Context ( ) , "parsing custom Apple MDM URL" , "err" , err )
next . ServeHTTP ( w , r )
return
}
reqHost := r . Host
if h , _ , err := net . SplitHostPort ( reqHost ) ; err == nil {
reqHost = h
}
if ! strings . EqualFold ( parsedUrl . Hostname ( ) , reqHost ) {
target := * parsedUrl
target . Path = r . URL . Path
target . RawQuery = r . URL . RawQuery
logger . InfoContext ( r . Context ( ) , "redirecting to custom Apple MDM URL for SSO callback" )
http . Redirect ( w , r , target . String ( ) , http . StatusTemporaryRedirect )
return
}
next . ServeHTTP ( w , r )
}
}
2026-02-26 23:40:46 +00:00
func WithMDMEnrollmentMiddleware ( svc fleet . Service , logger * slog . Logger , next http . Handler ) http . HandlerFunc {
2024-11-22 15:56:36 +00:00
return func ( w http . ResponseWriter , r * http . Request ) {
2025-07-15 19:02:11 +00:00
if r . URL . Path != "/mdm/sso" && r . URL . Path != "/account_driven_enroll/sso" {
2025-05-19 18:29:46 +00:00
// TODO: redirects for non-SSO config web url?
2024-11-22 15:56:36 +00:00
next . ServeHTTP ( w , r )
return
}
// if x-apple-aspen-deviceinfo custom header is present, we need to check for minimum os version
di := r . Header . Get ( "x-apple-aspen-deviceinfo" )
if di != "" {
parsed , err := apple_mdm . ParseDeviceinfo ( di , false ) // FIXME: use verify=true when we have better parsing for various Apple certs (https://github.com/fleetdm/fleet/issues/20879)
if err != nil {
// just log the error and continue to next
2026-02-26 13:16:44 +00:00
logger . ErrorContext ( r . Context ( ) , "parsing x-apple-aspen-deviceinfo" , "err" , err )
2024-11-22 15:56:36 +00:00
next . ServeHTTP ( w , r )
return
}
2025-05-19 18:29:46 +00:00
// TODO: skip os version check if deviceinfo query param is present? or find another way
// to avoid polling the DB and Apple endpoint twice for each enrollment.
2024-11-22 15:56:36 +00:00
sur , err := svc . CheckMDMAppleEnrollmentWithMinimumOSVersion ( r . Context ( ) , parsed )
if err != nil {
// just log the error and continue to next
2026-02-26 13:16:44 +00:00
logger . ErrorContext ( r . Context ( ) , "checking minimum os version for mdm" , "err" , err )
2024-11-22 15:56:36 +00:00
next . ServeHTTP ( w , r )
return
}
if sur != nil {
w . Header ( ) . Set ( "Content-Type" , "application/json" )
w . WriteHeader ( http . StatusForbidden )
if err := json . NewEncoder ( w ) . Encode ( sur ) ; err != nil {
2026-02-26 13:16:44 +00:00
logger . ErrorContext ( r . Context ( ) , "failed to encode software update required" , "err" , err )
2024-11-22 15:56:36 +00:00
http . Redirect ( w , r , r . URL . String ( ) + "?error=true" , http . StatusSeeOther )
}
return
}
2025-05-19 18:29:46 +00:00
// TODO: Do non-Apple devices ever use this route? If so, we probably need to change the
// approach below so we don't endlessly redirect non-Apple clients to the same URL.
// if we get here, the minimum os version is satisfied, so we continue with SSO flow
q := r . URL . Query ( )
v , ok := q [ "deviceinfo" ]
if ! ok || len ( v ) == 0 {
// If the deviceinfo query param is empty, we add the deviceinfo to the URL and
// redirect.
//
// Note: We'll apply this redirect only if query params are empty because want to
// redirect to the same URL with added query params after parsing the x-apple-aspen-deviceinfo
// header. Whenever we see a request with any query params already present, we'll
// skip this step and just continue to the next handler.
newURL := * r . URL
q . Set ( "deviceinfo" , di )
newURL . RawQuery = q . Encode ( )
2026-02-26 13:16:44 +00:00
logger . InfoContext ( r . Context ( ) , "handling mdm sso: redirect with deviceinfo" , "host_uuid" , parsed . UDID , "serial" , parsed . Serial )
2025-05-19 18:29:46 +00:00
http . Redirect ( w , r , newURL . String ( ) , http . StatusTemporaryRedirect )
return
}
if len ( v ) > 0 && v [ 0 ] != di {
// something is wrong, the device info in the query params does not match
// the one in the header, so we just log the error and continue to next
2026-02-26 13:16:44 +00:00
logger . ErrorContext ( r . Context ( ) , "device info in query params does not match header" , "header" , di , "query" , v [ 0 ] )
2025-05-19 18:29:46 +00:00
}
2026-02-26 13:16:44 +00:00
logger . InfoContext ( r . Context ( ) , "handling mdm sso: proceed to next" , "host_uuid" , parsed . UDID , "serial" , parsed . Serial )
2024-11-22 15:56:36 +00:00
}
next . ServeHTTP ( w , r )
}
}