NEHotspotHelper pseudo API

I’ve been playing around with NEHotspotHelper recently and one of the things I’ve found is that, because the API is effectively parameter-block based, it’s not always clear which commands take which parameters. To get this sorted in my head I created a pseudo API that shows all of the commands with their parameters and function results tightly constrained. The result is pasted in below.

For example, from the NEHotspotHelper documentation and headers, it’s not obvious that the

.Evaluate

.FilterScanList

filter(_:)

context

IMPORTANT This is not meant to be a usable API (for example, in a real app all of the callbacks are asynchronous), but rather a compact representation of the interface between the hotspot subsystem and your helper.

Share and Enjoy
—
Quinn “The Eskimo!”
Apple Developer Relations, Developer Technical Support, Core OS/Hardware

let myEmail = "eskimo" + "1" + "@apple.com"

protocol HotspotDispatcherDelegate {
    func filter(networkList: [NEHotspotNetwork]) -> [FilterResult]
    func evaluate(context context: Context) -> NEHotspotHelperConfidence
        // .High or .Low yields the "Captive" transition in the authentication state machine
        // .None yields the "Not Captive" transition
    func authenticate(context context: Context) -> AuthenticateResult
    func presentUI(context context: Context) -> PresentUIResult
    func maintain(context context: Context) -> MaintainResult
    func logoff(context context: Context)
}

enum FilterConfidence {
    case low
    case high
}

struct FilterResult {
    let network: NEHotspotNetwork
    let confidence: FilterConfidence
    let password: String?
}

enum AuthenticateResult {
    case success
    case failure
    case temporaryFailure
    case uiRequired
    case unsupportedNetwork
}

enum PresentUIResult {
    case success
    case failure
    case temporaryFailure
    case unsupportedNetwork
}

enum MaintainResult {
    case success
    case failure
    case authenticationRequired
}

struct Context {
    func createTCPConnection(endpoint: NWEndpoint) -> NWTCPConnection
    func createUDPSession(endpoint: NWEndpoint) -> NWUDPSession
    func bindRequest(request: NSMutableURLRequest)
}