overby.me
this repo has no description
1/*
2 * Copyright (c) 2009-2016, 2018, 2019 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24#ifndef _CAPTIVENETWORK_H
25#define _CAPTIVENETWORK_H
26
27#include <os/availability.h>
28#include <sys/cdefs.h>
29#include <CoreFoundation/CoreFoundation.h>
30
31CF_IMPLICIT_BRIDGING_ENABLED
32CF_ASSUME_NONNULL_BEGIN
33
34/*!
35 @header CaptiveNetwork
36 @discussion The CaptiveNetwork API allows applications to interact
37 with Captive Network Support. Captive Network Support is a
38 system component responsible for detecting and help users
39 navigate networks that require interaction before providing
40 internet access. The most common Captive Networks are WiFi
41 Hotspots in places like airports, restaurants, and hotels.
42 Captive Network Support will attempt to authenticate if
43 possible or drop a user in to a web sheet if authentication
44 is not possible. In the web sheet the user has an opportunity
45 to authenticate or disassociate from the network.
46
47 The following APIs are designed for third party applications
48 that may handle authentication on these networks on behalf of
49 the user.
50
51 These APIs are treated as advisory only.
52 There is no guarantee or contract that the operating system
53 will take the intended action.
54 */
55
56__BEGIN_DECLS
57
58/*!
59 @function CNSetSupportedSSIDs
60 @discussion Provides Captive Network Support with an updated list of
61 SSIDs that this application will perform authentication on.
62
63 Captive Network Support suppresses showing the Web Sheet
64 for a captive Wi-Fi network if that network's SSID is in the
65 specified list.
66
67 On iOS, the registrations persist until the application is
68 removed from the device.
69
70 On MacOSX, the registrations persist as long as the application
71 is running.
72
73 @param ssidArray A CFArray of CFStrings of the SSIDs.
74 @result Returns TRUE if the operation succeeded, FALSE otherwise.
75 */
76Boolean
77CNSetSupportedSSIDs (CFArrayRef ssidArray)
78 API_AVAILABLE(macos(10.8))
79 API_DEPRECATED_WITH_REPLACEMENT("Replaced by <NetworkExtension/NEHotspotHelper.h>", ios(4.0,9.0))
80 SPI_AVAILABLE(tvos(9.0), watchos(1.0), bridgeos(1.0));
81
82/*!
83 @function CNMarkPortalOnline
84 @discussion Tells Captive Network Support that your application has
85 authenticated the device to the network. Captive Network Support
86 will notify the rest of the system that WiFi is now a viable
87 interface.
88 @param interfaceName Name of the interface that is now online.
89 @result Returns TRUE if the operation succeeded, FALSE otherwise.
90 */
91Boolean
92CNMarkPortalOnline (CFStringRef interfaceName)
93 API_AVAILABLE(macos(10.8))
94 API_DEPRECATED_WITH_REPLACEMENT("Replaced by <NetworkExtension/NEHotspotHelper.h>", ios(4.0,9.0))
95 SPI_AVAILABLE(tvos(9.0), watchos(1.0), bridgeos(1.0));
96
97/*!
98 @function CNMarkPortalOffline
99 @discussion Tells Captive Network Support that the device is not
100 authenticated on the given network interface.
101 @param interfaceName Name of the interface that is still captive.
102 @result Returns TRUE if the operation succeeded, FALSE otherwise.
103 */
104Boolean
105CNMarkPortalOffline (CFStringRef interfaceName)
106 API_AVAILABLE(macos(10.8))
107 API_DEPRECATED_WITH_REPLACEMENT("Replaced by <NetworkExtension/NEHotspotHelper.h>", ios(4.0,9.0))
108 SPI_AVAILABLE(tvos(9.0), watchos(1.0), bridgeos(1.0));
109
110/*!
111 @function CNCopySupportedInterfaces
112 @discussion copies a list of all interfaces CaptiveNetworkSupport is monitoring.
113 @result An array of CFStringRef- BSD interface names.
114 Returns NULL if an error was encountered.
115 You MUST release the returned value.
116 */
117CFArrayRef __nullable
118CNCopySupportedInterfaces (void)
119 API_AVAILABLE(macos(10.8), ios(4.1))
120 SPI_AVAILABLE(tvos(9.0), watchos(1.0), bridgeos(1.0));
121
122/*!
123 @constant kCNNetworkInfoKeySSIDData
124 @discussion NetworkInfo Dictionary key for SSID in CFData format
125 */
126extern const CFStringRef kCNNetworkInfoKeySSIDData
127 API_AVAILABLE(ios(4.1))
128 SPI_AVAILABLE(macos(10.6), tvos(9.0), watchos(1.0), bridgeos(1.0));
129
130/*!
131 @constant kCNNetworkInfoKeySSID
132 @discussion NetworkInfo Dictionary key for SSID in CFString format
133 */
134extern const CFStringRef kCNNetworkInfoKeySSID
135 API_AVAILABLE(ios(4.1))
136 SPI_AVAILABLE(macos(10.6), tvos(9.0), watchos(1.0), bridgeos(1.0));
137
138/*!
139 @constant kCNNetworkInfoKeyBSSID
140 @discussion NetworkInfo Dictionary key for BSSID in CFString format
141 */
142extern const CFStringRef kCNNetworkInfoKeyBSSID
143 API_AVAILABLE(ios(4.1))
144 SPI_AVAILABLE(macos(10.6), tvos(9.0), watchos(1.0), bridgeos(1.0));
145
146/*!
147 @function CNCopyCurrentNetworkInfo
148 @discussion Returns the network information for the specified interface when the requesting application meets one of following 3 requirements -.
149 1. application is using CoreLocation API and has user's authorization to access location.
150 2. application has used NEHotspotConfiguration API to configure the current Wi-Fi network.
151 3. application has active VPN configurations installed.
152
153 - An application that is linked against iOS 12.0 SDK and above must have the "com.apple.developer.networking.wifi-info" entitlement.
154 - An application will receive a pseudo network information if it is linked against an SDK before iOS 13.0, and if it fails to meet any of the
155 above 3 requirements.
156 - An application will receive NULL if it is linked against iOS 13.0 SDK or above, and if it fails to meet any of the above 3 requirements..
157
158 Network Information dictionary will contain the following keys, and values:
159 <pre>
160 @textblock
161 Keys : Values
162 =======================================
163 kCNNetworkInfoKeySSIDData : CFDataRef
164 kCNNetworkInfoKeySSID : CFStringRef
165 kCNNetworkInfoKeyBSSID : CFStringRef
166 @/textblock
167 </pre>
168
169 Pseudo network information will contain "Wi-Fi" SSID and "00:00:00:00:00:00" BSSID. For China region, the SSID will be "WLAN".
170 @param interfaceName Name of the interface you are interested in
171 @result Network Information dictionary associated with the interface.
172 Returns NULL if an error was encountered.
173 You MUST release the returned value.
174 */
175CFDictionaryRef __nullable
176CNCopyCurrentNetworkInfo (CFStringRef interfaceName)
177 API_AVAILABLE(ios(4.1))
178 SPI_AVAILABLE(macos(10.6), tvos(9.0), watchos(1.0), bridgeos(1.0));
179
180__END_DECLS
181
182CF_ASSUME_NONNULL_END
183CF_IMPLICIT_BRIDGING_DISABLED
184
185#endif /* _CAPTIVENETWORK_H */