SystemConfiguration.fproj/SCNetworkConfigurationPrivate.h

   1 /*
   2  * Copyright (c) 2005-2016 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 _SCNETWORKCONFIGURATIONPRIVATE_H
  25 #define _SCNETWORKCONFIGURATIONPRIVATE_H
  26
  27 #include <Availability.h>
  28 #include <TargetConditionals.h>
  29 #include <sys/cdefs.h>
  30 #include <CoreFoundation/CoreFoundation.h>
  31 #include <SystemConfiguration/SystemConfiguration.h>
  32 #include <SystemConfiguration/SCValidation.h>
  33 #include <IOKit/IOKitLib.h>
  34
  35 /*!
  36         @header SCNetworkConfigurationPrivate
  37  */
  38
  39 __BEGIN_DECLS
  40
  41
  42 /*!
  43         @group Interface configuration
  44  */
  45
  46 #pragma mark -
  47 #pragma mark SCNetworkInterface configuration (typedefs, consts, enums)
  48
  49 /*!
  50         @const kSCNetworkInterfaceTypeBridge
  51  */
  52 extern const CFStringRef kSCNetworkInterfaceTypeBridge                                          __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
  53
  54
  55 /*!
  56         @const kSCNetworkInterfaceTypeLoopback
  57  */
  58 extern const CFStringRef kSCNetworkInterfaceTypeLoopback                                        __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
  59
  60 /*!
  61         @const kSCNetworkInterfaceLoopback
  62         @discussion A network interface representing the loopback
  63                 interface (lo0).
  64  */
  65 extern const SCNetworkInterfaceRef kSCNetworkInterfaceLoopback                                  __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
  66
  67 /*!
  68         @const kSCNetworkInterfaceTypeVPN
  69  */
  70 extern const CFStringRef kSCNetworkInterfaceTypeVPN                                             __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
  71
  72 /*!
  73         @group Interface configuration (Bridge)
  74  */
  75
  76 /*!
  77         @typedef SCBridgeInterfaceRef
  78         @discussion This is the type of a reference to an object that represents
  79                 a bridge interface.
  80  */
  81 typedef SCNetworkInterfaceRef SCBridgeInterfaceRef;
  82
  83 typedef CF_ENUM(uint32_t, SCNetworkServicePrimaryRank) {
  84         kSCNetworkServicePrimaryRankDefault     = 0,
  85         kSCNetworkServicePrimaryRankFirst       = 1,
  86         kSCNetworkServicePrimaryRankLast        = 2,
  87         kSCNetworkServicePrimaryRankNever       = 3,
  88         kSCNetworkServicePrimaryRankScoped      = 4
  89 };
  90
  91 #pragma mark -
  92 #pragma mark SCNetworkInterface configuration (SPI)
  93
  94 /*!
  95         @group Interface configuration
  96  */
  97
  98 static __inline__ CFTypeRef
  99 isA_SCNetworkInterface(CFTypeRef obj)
 100 {
 101         return (isA_CFType(obj, SCNetworkInterfaceGetTypeID()));
 102 }
 103
 104 static __inline__ CFTypeRef
 105 isA_SCBondInterface(CFTypeRef obj)
 106 {
 107         CFStringRef     interfaceType;
 108
 109         if (!isA_SCNetworkInterface(obj)) {
 110                 // if not an SCNetworkInterface
 111                 return NULL;
 112         }
 113
 114         interfaceType = SCNetworkInterfaceGetInterfaceType((SCNetworkInterfaceRef)obj);
 115         if (!CFEqual(interfaceType, kSCNetworkInterfaceTypeBond)) {
 116                 // if not a Bond
 117                 return NULL;
 118         }
 119
 120         return obj;
 121 }
 122
 123 static __inline__ CFTypeRef
 124 isA_SCBridgeInterface(CFTypeRef obj)
 125 {
 126         CFStringRef     interfaceType;
 127
 128         if (!isA_SCNetworkInterface(obj)) {
 129                 // if not an SCNetworkInterface
 130                 return NULL;
 131         }
 132
 133         interfaceType = SCNetworkInterfaceGetInterfaceType((SCNetworkInterfaceRef)obj);
 134         if (!CFEqual(interfaceType, kSCNetworkInterfaceTypeBridge)) {
 135                 // if not a bridge
 136                 return NULL;
 137         }
 138
 139         return obj;
 140 }
 141
 142 static __inline__ CFTypeRef
 143 isA_SCVLANInterface(CFTypeRef obj)
 144 {
 145         CFStringRef     interfaceType;
 146
 147         if (!isA_SCNetworkInterface(obj)) {
 148                 // if not an SCNetworkInterface
 149                 return NULL;
 150         }
 151
 152         interfaceType = SCNetworkInterfaceGetInterfaceType((SCNetworkInterfaceRef)obj);
 153         if (!CFEqual(interfaceType, kSCNetworkInterfaceTypeVLAN)) {
 154                 // if not a VLAN
 155                 return NULL;
 156         }
 157
 158         return obj;
 159 }
 160
 161 /*!
 162         @function _SCNetworkInterfaceCompare
 163         @discussion Compares two SCNetworkInterface objects.
 164         @param val1 The SCNetworkInterface object.
 165         @param val2 The SCNetworkInterface object.
 166         @param context Not used.
 167         @result A comparison result.
 168  */
 169 CFComparisonResult
 170 _SCNetworkInterfaceCompare                              (const void                     *val1,
 171                                                          const void                     *val2,
 172                                                          void                           *context)       __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 173
 174 /*!
 175         @function _SCNetworkInterfaceCopyActive
 176         @discussion Creates an SCNetworkInterface and associated with interface name
 177                 and SCDynamicStoreRef
 178         @param the interface name
 179         @param the SCDynamicStoreRef
 180         @result the SCNetworkInterface
 181  */
 182 SCNetworkInterfaceRef
 183 _SCNetworkInterfaceCopyActive                           (SCDynamicStoreRef              store,
 184                                                          CFStringRef                    bsdName)        __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_5_0);
 185
 186 /*!
 187         @function _SCNetworkInterfaceCopyAllWithPreferences
 188                 Returns all network capable interfaces on the system.
 189         @param prefs The "preferences" session.
 190         @result The list of interfaces on the system.
 191                 You must release the returned value.
 192  */
 193 CFArrayRef /* of SCNetworkInterfaceRef's */
 194 _SCNetworkInterfaceCopyAllWithPreferences               (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0/*SPI*/);
 195
 196 /*!
 197         @function _SCNetworkInterfaceCopyBTPANInterface
 198         @discussion Returns the SCNetworkInterface associated with the BT-PAN interface
 199         @result The BT-PAN interface; NULL if the interface is not (yet) known.
 200  */
 201 SCNetworkInterfaceRef
 202 _SCNetworkInterfaceCopyBTPANInterface                   (void)                                          __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_NA);
 203
 204 /*!
 205         @function _SCNetworkInterfaceCopySlashDevPath
 206         @discussion Returns the /dev pathname for the interface.
 207         @param interface The network interface.
 208         @result The /dev pathname associated with the interface (e.g. "/dev/modem");
 209                 NULL if no path is available.
 210  */
 211 CFStringRef
 212 _SCNetworkInterfaceCopySlashDevPath                     (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0);
 213
 214 #define kIncludeNoVirtualInterfaces     0x0
 215 #define kIncludeVLANInterfaces          0x1
 216 #define kIncludeBondInterfaces          0x2
 217 #define kIncludeBridgeInterfaces        0x4
 218 #define kIncludeAllVirtualInterfaces    0xffffffff
 219
 220 /*!
 221         @function _SCNetworkInterfaceCreateWithBSDName
 222         @discussion Create a new network interface associated with the provided
 223                 BSD interface name.  This API supports Ethernet, FireWire, and
 224                 IEEE 802.11 interfaces.
 225         @param bsdName The BSD interface name.
 226         @param flags Indicates whether virtual (Bond, Bridge, VLAN)
 227                 network interfaces should be included.
 228         @result A reference to the new SCNetworkInterface.
 229                 You must release the returned value.
 230  */
 231 SCNetworkInterfaceRef
 232 _SCNetworkInterfaceCreateWithBSDName                    (CFAllocatorRef                 allocator,
 233                                                          CFStringRef                    bsdName,
 234                                                          UInt32                         flags)          __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 235
 236 /*!
 237         @function _SCNetworkInterfaceCreateWithEntity
 238         @discussion Create a new network interface associated with the provided
 239                 SCDynamicStore service entity dictionary.
 240         @param interface_entity The entity dictionary.
 241         @param service The network service.
 242         @result A reference to the new SCNetworkInterface.
 243                 You must release the returned value.
 244  */
 245 SCNetworkInterfaceRef
 246 _SCNetworkInterfaceCreateWithEntity                     (CFAllocatorRef                 allocator,
 247                                                          CFDictionaryRef                interface_entity,
 248                                                          SCNetworkServiceRef            service)        __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 249
 250 /*!
 251         @function _SCNetworkInterfaceCreateWithIONetworkInterfaceObject
 252         @discussion Create a new network interface associated with the provided
 253                 IORegistry "IONetworkInterface" object.
 254         @param if_obj The IONetworkInterface object.
 255         @result A reference to the new SCNetworkInterface.
 256                 You must release the returned value.
 257  */
 258 SCNetworkInterfaceRef
 259 _SCNetworkInterfaceCreateWithIONetworkInterfaceObject   (io_object_t                    if_obj)         __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 260
 261 /*!
 262         @function SCNetworkInterfaceGetPrimaryRank
 263         @discussion We allow caller to retrieve the rank on an interface.
 264         @param the interface to get the rank
 265         @result SCNetworkServicePrimaryRank
 266  */
 267 SCNetworkServicePrimaryRank
 268 SCNetworkInterfaceGetPrimaryRank                        (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_5_0);
 269
 270 /*!
 271         @function SCNetworkInterfaceSetPrimaryRank
 272         @discussion We allow caller to set an assertion on an interface.
 273                 The rank assertion lives as long as the SCNetworkInterfaceRef
 274                 remains valid.
 275         @param the interface to set the rank assertion
 276         @param the new rank to be set
 277         @result TRUE if operation is successful; FALSE if an error was encountered.
 278  */
 279 Boolean
 280 SCNetworkInterfaceSetPrimaryRank                        (SCNetworkInterfaceRef          interface,
 281                                                          SCNetworkServicePrimaryRank    newRank)        __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_5_0);
 282
 283 #define kSCNetworkInterfaceConfigurationActionKey               CFSTR("New Interface Detected Action")
 284 #define kSCNetworkInterfaceConfigurationActionValueNone         CFSTR("None")
 285 #define kSCNetworkInterfaceConfigurationActionValuePrompt       CFSTR("Prompt")
 286 #define kSCNetworkInterfaceConfigurationActionValueConfigure    CFSTR("Configure")
 287
 288 #define kSCNetworkInterfaceNetworkConfigurationOverridesKey     CFSTR("NetworkConfigurationOverrides")
 289 #define kSCNetworkInterfaceHiddenConfigurationKey               CFSTR("HiddenConfiguration")
 290 #define kSCNetworkInterfaceHiddenPortKey                        CFSTR("HiddenPort") /* for serial ports */
 291 #define kSCNetworkInterfaceHiddenInterfaceKey                   CFSTR("HiddenInterface") /* for network interfaces */
 292
 293 // IORegistry property to indicate that a [WWAN] interface is not yet ready
 294 #define kSCNetworkInterfaceInitializingKey                      CFSTR("Initializing")
 295
 296 /*!
 297         @function _SCNetworkInterfaceCopyInterfaceInfo
 298         @discussion Returns interface details
 299         @param interface The network interface.
 300         @result A dictionary with details about the network interface.
 301  */
 302 CFDictionaryRef
 303 _SCNetworkInterfaceCopyInterfaceInfo                    (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0);
 304
 305 /*!
 306         @function _SCNetworkInterfaceGetConfigurationAction
 307         @discussion Returns a user-notification / auto-configuration action for the interface.
 308         @param interface The network interface.
 309         @result The user-notification / auto-configuration action;
 310                 NULL if the default action should be used.
 311  */
 312 CFStringRef
 313 _SCNetworkInterfaceGetConfigurationAction               (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_0);
 314
 315 /*!
 316         @function _SCNetworkInterfaceGetFamilyType
 317         @discussion Returns the family type for the interface.
 318         @param interface The network interface.
 319         @result The family type (ift_family) associated with the interface;
 320                 NULL if no family type is available.
 321  */
 322 CFNumberRef
 323 _SCNetworkInterfaceGetFamilyType                        (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_12,__IPHONE_10_0);
 324
 325 /*!
 326         @function _SCNetworkInterfaceGetFamilySubType
 327         @discussion Returns the family subtype for the interface.
 328         @param interface The network interface.
 329         @result The family subtype (ift_subfamily) associated with the interface;
 330                 NULL if no family subtype is available.
 331  */
 332 CFNumberRef
 333 _SCNetworkInterfaceGetFamilySubType                     (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_12,__IPHONE_10_0);
 334
 335 /*!
 336         @function _SCNetworkInterfaceGetHardwareAddress
 337         @discussion Returns a link layer address for the interface.
 338         @param interface The network interface.
 339         @result The hardware (MAC) address for the interface.
 340                 NULL if no hardware address is available.
 341  */
 342 CFDataRef
 343 _SCNetworkInterfaceGetHardwareAddress                   (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 344
 345 /*!
 346         @function _SCNetworkInterfaceGetIOInterfaceNamePrefix
 347         @discussion Returns the IOInterfaceNamePrefix for the interface.
 348         @param interface The network interface.
 349         @result The IOInterfaceNamePrefix associated with the interface;
 350                 NULL if no IOInterfaceNamePrefix is available.
 351  */
 352 CFStringRef
 353 _SCNetworkInterfaceGetIOInterfaceNamePrefix             (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0);
 354
 355 /*!
 356         @function _SCNetworkInterfaceGetIOInterfaceType
 357         @discussion Returns the IOInterfaceType for the interface.
 358         @param interface The network interface.
 359         @result The IOInterfaceType associated with the interface
 360  */
 361 CFNumberRef
 362 _SCNetworkInterfaceGetIOInterfaceType                   (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 363
 364 /*!
 365         @function _SCNetworkInterfaceGetIOInterfaceUnit
 366         @discussion Returns the IOInterfaceUnit for the interface.
 367         @param interface The network interface.
 368         @result The IOInterfaceUnit associated with the interface;
 369                 NULL if no IOInterfaceUnit is available.
 370  */
 371 CFNumberRef
 372 _SCNetworkInterfaceGetIOInterfaceUnit                   (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 373
 374 /*!
 375         @function _SCNetworkInterfaceGetIOPath
 376         @discussion Returns the IOPath for the interface.
 377         @param interface The network interface.
 378         @result The IOPath associated with the interface;
 379                 NULL if no IOPath is available.
 380  */
 381 CFStringRef
 382 _SCNetworkInterfaceGetIOPath                            (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 383
 384 /*!
 385         @function _SCNetworkInterfaceGetIORegistryEntryID
 386         @discussion Returns the IORegistry entry ID for the interface.
 387         @param interface The network interface.
 388         @result The IORegistry entry ID associated with the interface;
 389                 Zero if no entry ID is available.
 390  */
 391 uint64_t
 392 _SCNetworkInterfaceGetIORegistryEntryID                 (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_5_0);
 393
 394 /*!
 395         @function _SCNetworkInterfaceIsApplePreconfigured
 396         @discussion Identifies if a network interface is internal/pre-configured.
 397         @param interface The network interface.
 398         @result TRUE if the interface is an internal/pre-configured.
 399  */
 400 Boolean
 401 _SCNetworkInterfaceIsApplePreconfigured                 (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_12,__IPHONE_10_0);
 402
 403 /*!
 404         @function _SCNetworkInterfaceIsBluetoothPAN
 405         @discussion Identifies if a network interface is a Bluetooth PAN (GN) device.
 406         @param interface The network interface.
 407         @result TRUE if the interface is a Bluetooth PAN device.
 408  */
 409 Boolean
 410 _SCNetworkInterfaceIsBluetoothPAN                       (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0);
 411
 412 /*!
 413         @function _SCNetworkInterfaceIsBluetoothPAN_NAP
 414         @discussion Identifies if a network interface is a Bluetooth PAN-NAP device.
 415         @param interface The network interface.
 416         @result TRUE if the interface is a Bluetooth PAN-NAP device.
 417  */
 418 Boolean
 419 _SCNetworkInterfaceIsBluetoothPAN_NAP                   (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0);
 420
 421 /*!
 422         @function _SCNetworkInterfaceIsBluetoothP2P
 423         @discussion Identifies if a network interface is a Bluetooth P2P (PAN-U) device.
 424         @param interface The network interface.
 425         @result TRUE if the interface is a Bluetooth P2P device.
 426  */
 427 Boolean
 428 _SCNetworkInterfaceIsBluetoothP2P                       (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0);
 429
 430 /*!
 431         @function _SCNetworkInterfaceIsBuiltin
 432         @discussion Identifies if a network interface is "built-in".
 433         @param interface The network interface.
 434         @result TRUE if the interface is "built-in".
 435  */
 436 Boolean
 437 _SCNetworkInterfaceIsBuiltin                            (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 438
 439 /*!
 440         @function _SCNetworkInterfaceIsHiddenConfiguration
 441         @discussion Identifies if the configuration of a network interface should be
 442                 hidden from any user interface (e.g. the "Network" pref pane).
 443         @param interface The network interface.
 444         @result TRUE if the interface configuration should be hidden.
 445  */
 446 Boolean
 447 _SCNetworkInterfaceIsHiddenConfiguration                (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0);
 448
 449 /*!
 450         @function _SCNetworkInterfaceIsModemV92
 451         @discussion Identifies if a modem network interface supports
 452                 v.92 (hold).
 453         @param interface The network interface.
 454         @result TRUE if the interface is "v.92" modem.
 455  */
 456 Boolean
 457 _SCNetworkInterfaceIsModemV92                           (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 458
 459 /*!
 460         @function _SCNetworkInterfaceIsTethered
 461         @discussion Identifies if a network interface is an Apple tethered device (e.g. an iPhone).
 462         @param interface The network interface.
 463         @result TRUE if the interface is a tethered device.
 464  */
 465 Boolean
 466 _SCNetworkInterfaceIsTethered                           (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0);
 467
 468 /*!
 469         @function _SCNetworkInterfaceIsThunderbolt
 470         @discussion Identifies if a network interface is a Thunderbolt device
 471         @param interface The network interface.
 472         @result TRUE if the interface is a Thunderbolt device.
 473  */
 474 Boolean
 475 _SCNetworkInterfaceIsThunderbolt                        (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0);
 476
 477 /*!
 478         @function _SCNetworkInterfaceIsPhysicalEthernet
 479         @discussion Indicates whether a network interface is a real ethernet interface i.e. one with an ethernet PHY.
 480         @param interface The network interface.
 481         @result TRUE if the interface is a real ethernet interface.
 482  */
 483 Boolean
 484 _SCNetworkInterfaceIsPhysicalEthernet                   (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0);
 485
 486 /*!
 487         @function _SCNetworkInterfaceForceConfigurationRefresh
 488         @discussion Forces a configuration refresh of the
 489                 specified interface.
 490         @param ifName Network interface name.
 491         @result TRUE if the refresh was successfully posted.
 492  */
 493 Boolean
 494 _SCNetworkInterfaceForceConfigurationRefresh            (CFStringRef                    ifName)         __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 495
 496 /*!
 497         @function SCNetworkInterfaceCopyCapability
 498         @discussion For the specified network interface, returns information
 499                 about the currently requested capabilities, the active capabilities,
 500                 and the capabilities which are available.
 501         @param interface The desired network interface.
 502         @param capability The desired capability;
 503                 NULL to return a CFDictionary of all capabilities.
 504         @result a CFTypeRef representing the current value of requested
 505                 capability;
 506                 NULL if the capability is not available for this
 507                 interface or if an error was encountered.
 508                 You must release the returned value.
 509  */
 510 CFTypeRef
 511 SCNetworkInterfaceCopyCapability                        (SCNetworkInterfaceRef          interface,
 512                                                          CFStringRef                    capability)     __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0/*SPI*/);
 513
 514 /*!
 515         @function SCNetworkInterfaceSetCapability
 516         @discussion For the specified network interface, sets the requested
 517                 capabilities.
 518         @param interface The desired network interface.
 519         @param capability The desired capability.
 520         @param newValue The new requested setting for the capability;
 521                 NULL to restore the default setting.
 522         @result TRUE if the configuration was updated; FALSE if an error was encountered.
 523  */
 524 Boolean
 525 SCNetworkInterfaceSetCapability                         (SCNetworkInterfaceRef          interface,
 526                                                          CFStringRef                    capability,
 527                                                          CFTypeRef                      newValue)       __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0/*SPI*/);
 528
 529 #pragma mark -
 530 #pragma mark SCBondInterface configuration (SPIs)
 531
 532 /*!
 533         @function _SCBondInterfaceCopyActive
 534         @discussion Returns all Ethernet Bond interfaces on the system.
 535         @result The list of SCBondInterface interfaces on the system.
 536                 You must release the returned value.
 537  */
 538 CFArrayRef
 539 _SCBondInterfaceCopyActive                              (void)                                          __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0/*SPI*/);
 540
 541 /*!
 542         @function _SCBondInterfaceUpdateConfiguration
 543         @discussion Updates the bond interface configuration.
 544         @param prefs The "preferences" session.
 545         @result TRUE if the bond interface configuration was updated.; FALSE if the
 546                 an error was encountered.
 547  */
 548 Boolean
 549 _SCBondInterfaceUpdateConfiguration                     (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0/*SPI*/);
 550
 551 /*!
 552         @function SCBondInterfaceGetMode
 553         @discussion Return the mode for the given bond interface.
 554         @param bond The bond interface to get the mode from.
 555         @result A CFNumberRef containing the mode (IF_BOND_MODE_{LACP,STATIC}).
 556  */
 557 CFNumberRef
 558 SCBondInterfaceGetMode                                  (SCBondInterfaceRef             bond)           __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0/*SPI*/);
 559
 560 /*!
 561         @function SCBondInterfaceSetMode
 562         @discussion Set the mode on the bond interface.
 563         @param bond The bond interface on which to adjust the mode.
 564         @param mode The mode value (0=IF_BOND_MODE_LACP,1=IF_BOND_MODE_STATIC)
 565         @result TRUE if operation succeeded.
 566  */
 567 Boolean
 568 SCBondInterfaceSetMode                                  (SCBondInterfaceRef             bond,
 569                                                          CFNumberRef                    mode)           __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0/*SPI*/);
 570
 571 #pragma mark -
 572 #pragma mark SCBridgeInterface configuration (SPIs)
 573
 574 /*!
 575         @function SCBridgeInterfaceCopyAll
 576         @discussion Returns all bridge interfaces on the system.
 577         @param prefs The "preferences" session.
 578         @result The list of bridge interfaces on the system.
 579                 You must release the returned value.
 580  */
 581 CFArrayRef /* of SCBridgeInterfaceRef's */
 582 SCBridgeInterfaceCopyAll                                (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 583
 584 /*!
 585         @function SCBridgeInterfaceCopyAvailableMemberInterfaces
 586         @discussion Returns all network capable devices on the system
 587                 that can be added to an bridge interface.
 588         @param prefs The "preferences" session.
 589         @result The list of interfaces.
 590                 You must release the returned value.
 591  */
 592 CFArrayRef /* of SCNetworkInterfaceRef's */
 593 SCBridgeInterfaceCopyAvailableMemberInterfaces          (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 594
 595 /*!
 596         @function SCBridgeInterfaceCreate
 597         @discussion Create a new SCBridgeInterface interface.
 598         @param prefs The "preferences" session.
 599         @result A reference to the new SCBridgeInterface.
 600                 You must release the returned value.
 601  */
 602 SCBridgeInterfaceRef
 603 SCBridgeInterfaceCreate                                 (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 604
 605 /*!
 606         @function SCBridgeInterfaceRemove
 607         @discussion Removes the SCBridgeInterface from the configuration.
 608         @param bridge The SCBridgeInterface interface.
 609         @result TRUE if the interface was removed; FALSE if an error was encountered.
 610  */
 611 Boolean
 612 SCBridgeInterfaceRemove                                 (SCBridgeInterfaceRef           bridge)         __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 613
 614 /*!
 615         @function SCBridgeInterfaceGetMemberInterfaces
 616         @discussion Returns the member interfaces for the specified bridge interface.
 617         @param bridge The SCBridgeInterface interface.
 618         @result The list of interfaces.
 619  */
 620 CFArrayRef /* of SCNetworkInterfaceRef's */
 621 SCBridgeInterfaceGetMemberInterfaces                    (SCBridgeInterfaceRef           bridge)         __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 622
 623 /*!
 624         @function SCBridgeInterfaceGetOptions
 625         @discussion Returns the configuration settings associated with a bridge interface.
 626         @param bridge The SCBridgeInterface interface.
 627         @result The configuration settings associated with the bridge interface;
 628                 NULL if no changes to the default configuration have been saved.
 629  */
 630 CFDictionaryRef
 631 SCBridgeInterfaceGetOptions                             (SCBridgeInterfaceRef           bridge)         __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 632
 633 /*!
 634         @function SCBridgeInterfaceSetMemberInterfaces
 635         @discussion Sets the member interfaces for the specified bridge interface.
 636         @param bridge The SCBridgeInterface interface.
 637         @param members The desired member interfaces.
 638         @result TRUE if the configuration was stored; FALSE if an error was encountered.
 639  */
 640 Boolean
 641 SCBridgeInterfaceSetMemberInterfaces                    (SCBridgeInterfaceRef           bridge,
 642                                                          CFArrayRef                     members) /* of SCNetworkInterfaceRef's */
 643                                                                                                         __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 644
 645 /*!
 646         @function SCBridgeInterfaceSetLocalizedDisplayName
 647         @discussion Sets the localized display name for the specified bridge interface.
 648         @param bridge The SCBridgeInterface interface.
 649         @param newName The new display name.
 650         @result TRUE if the configuration was stored; FALSE if an error was encountered.
 651  */
 652 Boolean
 653 SCBridgeInterfaceSetLocalizedDisplayName                (SCBridgeInterfaceRef           bridge,
 654                                                          CFStringRef                    newName)        __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 655
 656 /*!
 657         @function SCBridgeInterfaceSetOptions
 658         @discussion Sets the configuration settings for the specified bridge interface.
 659         @param bridge The SCBridgeInterface interface.
 660         @param newOptions The new configuration settings.
 661         @result TRUE if the configuration was stored; FALSE if an error was encountered.
 662  */
 663 Boolean
 664 SCBridgeInterfaceSetOptions                             (SCBridgeInterfaceRef           bridge,
 665                                                          CFDictionaryRef                newOptions)     __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 666
 667 #pragma mark -
 668
 669 /*!
 670         @function _SCBridgeInterfaceCopyActive
 671         @discussion Returns all bridge interfaces on the system.
 672         @result The list of SCBridgeInterface interfaces on the system.
 673                 You must release the returned value.
 674  */
 675 CFArrayRef
 676 _SCBridgeInterfaceCopyActive                            (void)                                          __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 677
 678 /*!
 679         @function _SCBridgeInterfaceUpdateConfiguration
 680         @discussion Updates the bridge interface configuration.
 681         @param prefs The "preferences" session.
 682         @result TRUE if the bridge interface configuration was updated.; FALSE if the
 683                 an error was encountered.
 684  */
 685 Boolean
 686 _SCBridgeInterfaceUpdateConfiguration                   (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0/*SPI*/);
 687
 688
 689 #pragma mark -
 690 #pragma mark SCVLANInterface configuration (SPIs)
 691
 692 /*!
 693         @function _SCVLANInterfaceCopyActive
 694         @discussion Returns all VLAN interfaces on the system.
 695         @result The list of SCVLANInterface interfaces on the system.
 696                 You must release the returned value.
 697  */
 698 CFArrayRef
 699 _SCVLANInterfaceCopyActive                              (void)                                          __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0/*SPI*/);
 700
 701 /*!
 702         @function _SCVLANInterfaceUpdateConfiguration
 703         @discussion Updates the VLAN interface configuration.
 704         @param prefs The "preferences" session.
 705         @result TRUE if the VLAN interface configuration was updated.; FALSE if the
 706                 an error was encountered.
 707  */
 708 Boolean
 709 _SCVLANInterfaceUpdateConfiguration                     (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0/*SPI*/);
 710
 711
 712 #pragma mark -
 713 #pragma mark SCNetworkInterface Password SPIs
 714
 715
 716 enum {
 717         kSCNetworkInterfacePasswordTypePPP              = 1,
 718         kSCNetworkInterfacePasswordTypeIPSecSharedSecret,
 719         kSCNetworkInterfacePasswordTypeEAPOL,
 720         kSCNetworkInterfacePasswordTypeIPSecXAuth,
 721         kSCNetworkInterfacePasswordTypeVPN,
 722 };
 723 typedef uint32_t        SCNetworkInterfacePasswordType;
 724
 725 Boolean
 726 SCNetworkInterfaceCheckPassword                         (SCNetworkInterfaceRef          interface,
 727                                                          SCNetworkInterfacePasswordType passwordType)   __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 728
 729 CFDataRef
 730 SCNetworkInterfaceCopyPassword                          (SCNetworkInterfaceRef          interface,
 731                                                          SCNetworkInterfacePasswordType passwordType)   __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 732
 733 Boolean
 734 SCNetworkInterfaceRemovePassword                        (SCNetworkInterfaceRef          interface,
 735                                                          SCNetworkInterfacePasswordType passwordType)   __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 736
 737 Boolean
 738 SCNetworkInterfaceSetPassword                           (SCNetworkInterfaceRef          interface,
 739                                                          SCNetworkInterfacePasswordType passwordType,
 740                                                          CFDataRef                      password,
 741                                                          CFDictionaryRef                options)        __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 742
 743
 744 Boolean
 745 SCNetworkInterfaceGetDisableUntilNeeded                 (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_11,__IPHONE_9_0);
 746
 747 Boolean
 748 SCNetworkInterfaceSetDisableUntilNeeded                 (SCNetworkInterfaceRef          interface,
 749                                                          Boolean                        disable)        __OSX_AVAILABLE_STARTING(__MAC_10_11,__IPHONE_9_0);
 750
 751
 752 CFDictionaryRef
 753 SCNetworkInterfaceGetQoSMarkingPolicy                   (SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_12,__IPHONE_10_0);
 754
 755 Boolean
 756 SCNetworkInterfaceSetQoSMarkingPolicy                   (SCNetworkInterfaceRef          interface,
 757                                                          CFDictionaryRef                policy)         __OSX_AVAILABLE_STARTING(__MAC_10_12,__IPHONE_10_0);
 758
 759
 760 #pragma mark -
 761 #pragma mark SCNetworkProtocol configuration (SPI)
 762
 763
 764 /*!
 765         @group Protocol configuration
 766  */
 767
 768
 769 static __inline__ CFTypeRef
 770 isA_SCNetworkProtocol(CFTypeRef obj)
 771 {
 772         return (isA_CFType(obj, SCNetworkProtocolGetTypeID()));
 773 }
 774
 775
 776 #pragma mark -
 777 #pragma mark SCNetworkService configuration (SPI)
 778
 779
 780 /*!
 781         @group Service configuration
 782  */
 783
 784
 785 static __inline__ CFTypeRef
 786 isA_SCNetworkService(CFTypeRef obj)
 787 {
 788         return (isA_CFType(obj, SCNetworkServiceGetTypeID()));
 789 }
 790
 791 /*!
 792         @function _SCNetworkServiceCompare
 793         @discussion Compares two SCNetworkService objects.
 794         @param val1 The SCNetworkService object.
 795         @param val2 The SCNetworkService object.
 796         @param context The service order (from SCNetworkSetGetServiceOrder).
 797         @result A comparison result.
 798  */
 799 CFComparisonResult
 800 _SCNetworkServiceCompare                                (const void                     *val1,
 801                                                          const void                     *val2,
 802                                                          void                           *context)       __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0);
 803
 804 /*!
 805         @function _SCNetworkServiceCopyActive
 806         @discussion Returns the network service with the specified identifier.
 807
 808         Note: The service returned by this SPI differs from the SCNetworkServiceCopy
 809               API in that queries and operations interact with the "active" service
 810               represented in the SCDynamicStore.  Only a limited subset of the
 811               SCNetworkService APIs are supported.
 812         @param prefs The dynamic store session.
 813         @param serviceID The unique identifier for the service.
 814         @result A reference to the SCNetworkService represented in the SCDynamicStore;
 815                 NULL if the serviceID does not exist in the SCDynamicStore or if an
 816                 error was encountered.
 817                 You must release the returned value.
 818  */
 819 SCNetworkServiceRef
 820 _SCNetworkServiceCopyActive                             (SCDynamicStoreRef              store,
 821                                                          CFStringRef                    serviceID)      __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_1);
 822
 823 /*!
 824         @function SCNetworkServiceGetPrimaryRank
 825         @discussion Returns the primary service rank associated with a service.
 826         @param service The network service.
 827         @result The primary service rank associated with the specified application;
 828                 kSCNetworkServicePrimaryRankDefault if no rank is associated with the
 829                 application or an error was encountered.
 830  */
 831 SCNetworkServicePrimaryRank
 832 SCNetworkServiceGetPrimaryRank                          (SCNetworkServiceRef            service)        __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_0);
 833
 834 /*!
 835         @function SCNetworkServiceSetPrimaryRank
 836         @discussion Updates the the primary service rank associated with a service.
 837         @param service The network service.
 838         @param newRank The new primary service rank; kSCNetworkServicePrimaryRankDefault
 839                 if the default service rank should be used.
 840         @result TRUE if the rank was stored; FALSE if an error was encountered.
 841
 842         Notes : The kSCNetworkServicePrimaryRankFirst and kSCNetworkServicePrimaryRankLast
 843                 values can only valid as a transient setting.
 844  */
 845 Boolean
 846 SCNetworkServiceSetPrimaryRank                          (SCNetworkServiceRef            service,
 847                                                          SCNetworkServicePrimaryRank    newRank)        __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_0);
 848
 849 /*!
 850         @function _SCNetworkServiceIsVPN
 851         @discussion Identifies a VPN service.
 852         @param service The network service.
 853         @result TRUE if the service is a VPN.
 854  */
 855 Boolean
 856 _SCNetworkServiceIsVPN                                  (SCNetworkServiceRef            service)        __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0);
 857
 858 /*!
 859         @function SCNetworkServiceSetExternalID
 860         @discussion Set the external identifier for a network service.
 861         @param service A reference to the network service.
 862         @param identifierDomain A service can have multiple external identifiers. This string specifies which external identifier to set.
 863         @param identifier The new external identifier to assign to the network service.
 864         @result Returns TRUE if the external identifier was set successfully, FALSE if an error occurred.
 865  */
 866 Boolean
 867 SCNetworkServiceSetExternalID                           (SCNetworkServiceRef            service,
 868                                                          CFStringRef                    identifierDomain,
 869                                                          CFStringRef identifier);
 870
 871 /*!
 872         @function SCNetworkServiceCopyExternalID
 873         @discussion Copy the external identifier for a network service.
 874         @param service The network service.
 875         @param identifierDomain A service can have multiple external identifiers. This string specifies which external identifier to copy.
 876         @result Returns the service's external identifier, or NULL if the service does not have an external identifier in the given domain.
 877 */
 878 CFStringRef
 879 SCNetworkServiceCopyExternalID                          (SCNetworkServiceRef            service,
 880                                                          CFStringRef                    identifierDomain);
 881
 882 /*!
 883         @function _SCNetworkServiceSetServiceID
 884         @discussion Sets serviceID of the service to a different value provided.
 885         @param service The network service
 886         @param newServiceID The new service ID
 887         @result TRUE if new service ID is set successfully.
 888  */
 889 Boolean
 890 _SCNetworkServiceSetServiceID                           (SCNetworkServiceRef            service,
 891                                                          CFStringRef                    newServiceID)   __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
 892
 893 #pragma mark -
 894 #pragma mark SCNetworkSet configuration (SPI)
 895
 896
 897 /*!
 898         @group Set configuration
 899  */
 900
 901
 902 static __inline__ CFTypeRef
 903 isA_SCNetworkSet(CFTypeRef obj)
 904 {
 905         return (isA_CFType(obj, SCNetworkSetGetTypeID()));
 906 }
 907
 908
 909 /*!
 910         @function SCNetworkSetCopyAvailableInterfaces
 911         @discussion Returns all available interfaces for the set.
 912                 The interfaces excludes those of bond and bridge members.
 913         @param set The network set.
 914         @result The list of SCNetworkInterfaces.
 915                 You must release the returned value.
 916  */
 917 CFArrayRef
 918 SCNetworkSetCopyAvailableInterfaces                     (SCNetworkSetRef                set)            __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
 919
 920 /*!
 921         @function _SCNetworkSetCreateDefault
 922         @discussion Create a new [default] set in the configuration.
 923         @param prefs The "preferences" session.
 924         @result A reference to the new SCNetworkSet.
 925                 You must release the returned value.
 926  */
 927 SCNetworkSetRef
 928 _SCNetworkSetCreateDefault                              (SCPreferencesRef               prefs)          __OSX_AVAILABLE_STARTING(__MAC_10_12,__IPHONE_10_0/*SPI*/);
 929
 930 /*!
 931         @function SCNetworkSetEstablishDefaultConfiguration
 932         @discussion Updates a network set by adding services for
 933                 any network interface that is not currently
 934                 represented.
 935                 If the provided set contains one (or more) services, new
 936                 services will only be added for those interfaces that are
 937                 not represented in *any* set.
 938                 Otherwise, new services will be added for those interfaces
 939                 that are not represented in the provided set.
 940                 The new services are established with "default" configuration
 941                 options.
 942         @param set The network set.
 943         @result TRUE if the configuration was updated; FALSE if no
 944                 changes were required or if an error was encountered.
 945 */
 946 Boolean
 947 SCNetworkSetEstablishDefaultConfiguration               (SCNetworkSetRef                set)            __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 948
 949 /*!
 950         @function SCNetworkSetEstablishDefaultInterfaceConfiguration
 951         @discussion Updates a network set by adding services for
 952                 the specified network interface if is not currently
 953                 represented.
 954                 If the provided set contains one (or more) services, new
 955                 services will only be added for interfaces that are not
 956                 represented in *any* set.
 957                 Otherwise, new services will be added for interfaces that
 958                 are not represented in the provided set.
 959                 The new services are established with "default" configuration
 960                 options.
 961         @param set The network set.
 962         @param interface The network interface.
 963         @result TRUE if the configuration was updated; FALSE if no
 964                 changes were required or if an error was encountered.
 965  */
 966 Boolean
 967 SCNetworkSetEstablishDefaultInterfaceConfiguration      (SCNetworkSetRef                set,
 968                                                          SCNetworkInterfaceRef          interface)      __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0);
 969
 970 /*!
 971         @function SCNetworkSetCopySelectedVPNService
 972         @discussion On the iPhone we only allow a single VPN network service
 973                 to be selected at any given time.  This API will identify
 974                 the selected VPN service.
 975         @param set The network set.
 976         @result The selected VPN service; NULL if no service has been
 977                 selected.
 978                 You must release the returned value.
 979  */
 980 SCNetworkServiceRef
 981 SCNetworkSetCopySelectedVPNService                      (SCNetworkSetRef                set)            __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0);
 982
 983 /*!
 984         @function SCNetworkSetSetSelectedVPNService
 985         @discussion On the iPhone we only allow a single VPN network service
 986                 to be selected at any given time.  This API should be used to
 987                 select a VPN service.
 988         @param set The network set.
 989         @param service The VPN service to be selected.
 990         @result TRUE if the name was saved; FALSE if an error was encountered.
 991  */
 992 Boolean
 993 SCNetworkSetSetSelectedVPNService                       (SCNetworkSetRef                set,
 994                                                          SCNetworkServiceRef            service)        __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0);
 995
 996 Boolean
 997 _SCNetworkSetSetSetID                                   (SCNetworkSetRef                set,
 998                                                          CFStringRef                    setID)          __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
 999
1000 /*!
1001         @group VPN Service configuration
1002  */
1003
1004 #pragma mark -
1005 #pragma mark VPN Service configuration
1006
1007 typedef SCNetworkServiceRef VPNServiceRef;
1008
1009 /*!
1010         @function VPNServiceCopyAllMatchingExternalID
1011         @discussion Copy the VPN services with the given external identifier.
1012         @param prefs A reference to the prefs where the VPN services are stored.
1013         @param identifierDomain A service can have multiple external identifiers. This string specifies which one to match with the given identifier.
1014         @param identifier The external identifier of the desired services.
1015         @result A array of references to the VPN services with the given identifier, or NULL if no such service exists
1016  */
1017 CFArrayRef
1018 VPNServiceCopyAllMatchingExternalID             (SCPreferencesRef               prefs,
1019                                                  CFStringRef                    identifierDomain,
1020                                                  CFStringRef identifier)                __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
1021
1022 /*!
1023         @function VPNServiceCopyAll
1024         @discussion Copy all VPN services.
1025         @param prefs A reference to the prefs where the VPN services are stored.
1026         @result An array containing VPNServiceRefs for all the VPN services.
1027  */
1028 CFArrayRef
1029 VPNServiceCopyAll                               (SCPreferencesRef               prefs)  __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
1030
1031 /*!
1032         @function VPNServiceCopyAppRuleIDs
1033         @discussion Copy all the app rule identifiers for a VPN service.
1034         @param service A reference to the VPN service.
1035         @result An array of CFStringRefs, each string containing the identifier of a app rule in the given service.
1036  */
1037 CFArrayRef
1038 VPNServiceCopyAppRuleIDs                        (VPNServiceRef                  service)        __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
1039
1040 /*!
1041         @function VPNServiceSetAppRule
1042         @discussion Add or modify an app rule in a VPN service. The ruleSettings dictionary must contain one of the following keys:
1043                 <pre>kSCValNetVPNAppRuleExecutableMatch</pre>
1044                 <pre>kSCValNetVPNAppRuleAccountIdentifierMatch</pre>
1045         The ruleSettings dictionary may also contain the following keys:
1046                 <pre>kSCValNetVPNAppRuleDNSDomainMatch</pre>
1047         See SCSchemaDefinitionsPrivate.h for more details.
1048         @param service A reference to the VPN service.
1049         @param ruleIdentifier The identifier of the new app rule.
1050         @param ruleSettings The settings for the new app rule. See the dictionary keys defined above.
1051         @result TRUE if the app rule was set successfully, FALSE if an error occurred.
1052  */
1053 Boolean
1054 VPNServiceSetAppRule                            (VPNServiceRef                  service,
1055                                                  CFStringRef                    ruleIdentifier,
1056                                                  CFDictionaryRef                ruleSettings)   __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
1057
1058 /*!
1059         @function VPNServiceCopyAppRule
1060         @discussion Copy the settings for a app rule in a VPN service.
1061         @param service The app tunnel service.
1062         @param ruleIdentifier The ID of the app rule.
1063         @result The rule settings, or NULL if the app rule could not be found.
1064  */
1065 CFDictionaryRef
1066 VPNServiceCopyAppRule                           (VPNServiceRef                  service,
1067                                                  CFStringRef                    ruleIdentifier) __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
1068
1069 /*!
1070         @function VPNServiceRemoveAppRule
1071         @discussion Remove an app rule from a VPN service.
1072         @param service The VPN service.
1073         @param ruleIdentifier The ID of the app rule to remove.
1074         @result Returns TRUE if the app rule was removed successfully; FALSE otherwise.
1075  */
1076 Boolean
1077 VPNServiceRemoveAppRule                         (VPNServiceRef                  service,
1078                                                  CFStringRef                    ruleIdentifier) __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
1079
1080 /*!
1081         @function VPNServiceIsManagedAppVPN
1082         @discussion Check to see if a VPN service is a managed App VPN service
1083         @param service The VPN servie.
1084         @result Returns TRUE if the service is a managed App VPN service; FALSE otherwise.
1085 */
1086 Boolean
1087 VPNServiceIsManagedAppVPN                       (VPNServiceRef                  service)        __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_7_0/*SPI*/);
1088
1089 /*!
1090         @group  Migration SPI
1091  */
1092 #pragma mark -
1093 #pragma mark Migration SPI
1094
1095 extern const CFStringRef kSCNetworkConfigurationRepair                  /* CFBoolean */         __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
1096
1097 extern const CFStringRef kSCNetworkConfigurationMigrationActionKey      /* CFNumber */          __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
1098
1099 typedef CF_ENUM(uint32_t, SCNetworkConfigurationMigrationAction) {
1100         kSCNetworkConfigurationMigrationAction_CleanInstall     = 0,
1101         kSCNetworkConfigurationMigrationAction_Upgrade          = 1,
1102         kSCNetworkConfigurationMigrationAction_Restore          = 2,
1103 };
1104
1105 /*!
1106         @function _SCNetworkConfigurationCopyMigrationPaths
1107         @result Returns an array of paths that we would need from the source
1108  */
1109 CFArrayRef
1110 _SCNetworkConfigurationCopyMigrationPaths(CFDictionaryRef options)                              __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
1111
1112 /*!
1113         @function _SCNetworkConfigurationPerformMigration
1114         @discussion Updates the network configuration of the target system with
1115                 configurations from previous system. Both sourceDir and targetDir
1116                 cannot be NULL, since NULL indicates API to look at the local system
1117         @param sourceDir A reference which points to the root of a directory populated
1118                 with the list of requested directories/path from the "source" volume. Passing NULL
1119                 will indicate that sourceDir should point to local system
1120         @param currentDir A reference which points to the root of a directory populated
1121                 with the list of requested directories/path from the "destination" volume. Passing
1122                 NULL will indicate that currentDir should point to local system.
1123         @param targetDir A reference which points to the root of a directory that we
1124                 will populate (update) with new configuration. Passing NULL will mean that we want to
1125                 migrate to the currentDir. If not NULL, then this path should exist.
1126         @param options Argument which will tell us what action we are supposed to take
1127                 (clean-install, upgrade, migrate/restore settings from another system, ...)
1128         @result Returns array which would consist of those paths that should be moved
1129                 from the "targetDir" directory to destination volume. You must release the returned value.
1130  */
1131
1132 CF_RETURNS_RETAINED
1133 CFArrayRef
1134 _SCNetworkConfigurationPerformMigration(CFURLRef sourceDir,
1135                                         CFURLRef currentDir,
1136                                         CFURLRef targetDir,
1137                                         CFDictionaryRef options)                                __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
1138
1139
1140 /*!
1141         @function _SCNetworkConfigurationCheckValidity
1142         @discussion Verifies whether the configuration files present in the specified
1143                 directory have valid mappings or not
1144         @param configDir A reference which points to the directory where the configuration
1145                 files are present
1146         @result TRUE if valid configurations are found
1147
1148  */
1149
1150 Boolean
1151 _SCNetworkConfigurationCheckValidity(CFURLRef configDir,
1152                                      CFDictionaryRef options)                                   __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
1153
1154
1155 /*!
1156  @function      _SCNetworkConfigurationCheckValidityWithPreferences
1157  @discussion    Validates the specified preferences.plist against NetworkInterfaces.plist
1158  @param prefs   the preferences ref pointing to the said preferences.plist
1159  @param ni_prefs        the preferences ref pointing to the said NetworkInterfaces.plist
1160  @result        TRUE if the configurations are valid against each other
1161
1162  */
1163
1164 Boolean
1165 _SCNetworkConfigurationCheckValidityWithPreferences (SCPreferencesRef prefs,
1166                                                       SCPreferencesRef ni_prefs,
1167                                                       CFDictionaryRef options)                          __OSX_AVAILABLE_STARTING(__MAC_10_11, __IPHONE_9_0);
1168
1169
1170 /*!
1171  @function _SCNetworkMigrationAreConfigurationsIdentical
1172  @discussion Compares the migration output between network configurations
1173                 with the expected output.
1174  @param configPref Preferences pointing toward preferences.plist file to
1175                 be compared with expected file.
1176  @param configNetworkInterfacePref Preferences pointing toward NetworkInterfaces.plist
1177                 file to be compared with expected file.
1178  @param expectedConfigPref Preferences pointing toward preferences.plist file
1179                 which is the expected result.
1180  @param expectedNetworkInterfacePref Preferences pointing toward NetworkInterfaces.plist
1181                 file which is the expected file.
1182  @result TRUE if configurations match with the expected configurations
1183
1184  */
1185
1186 Boolean
1187 _SCNetworkMigrationAreConfigurationsIdentical (CFURLRef configurationURL,
1188                                                CFURLRef expectedConfigurationURL)
1189                                                         __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
1190
1191 /*!
1192  @function      _SCNetworkConfigurationCopyMigrationRemovePaths
1193  @discussion    List of paths to files which we want to be removed from the target filesystem after migration
1194  @param targetPaths     the CFArray returned by _SCNetworkConfigurationPerformMigration
1195  @param targetDir       the CFURL passed to _SCNetworkConfigurationPerformMigration
1196  @result        An array of CFURL's; NULL if no paths need to be removed from the target filesystem
1197
1198 */
1199
1200 CFArrayRef      // of CFURLRef's
1201 _SCNetworkConfigurationCopyMigrationRemovePaths (CFArrayRef     targetPaths,
1202                                                  CFURLRef       targetDir)                              __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0);
1203
1204 __END_DECLS
1205 #endif  /* _SCNETWORKCONFIGURATIONPRIVATE_H */