/* * Copyright (c) 2005-2009 Apple Inc. All rights reserved. * * @APPLE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this * file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_LICENSE_HEADER_END@ */ #ifndef _SCNETWORKCONFIGURATIONPRIVATE_H #define _SCNETWORKCONFIGURATIONPRIVATE_H #include <Availability.h> #include <TargetConditionals.h> #include <sys/cdefs.h> #include <CoreFoundation/CoreFoundation.h> #include <SystemConfiguration/SystemConfiguration.h> #include <SystemConfiguration/SCValidation.h> #include <IOKit/IOKitLib.h> /*! @header SCNetworkConfigurationPrivate */ __BEGIN_DECLS #pragma mark - #pragma mark SCNetworkInterface configuration (SPI) /*! @group Interface configuration */ static __inline__ CFTypeRef isA_SCNetworkInterface(CFTypeRef obj) { return (isA_CFType(obj, SCNetworkInterfaceGetTypeID())); } #if !TARGET_OS_IPHONE static __inline__ CFTypeRef isA_SCBondInterface(CFTypeRef obj) { CFStringRef interfaceType; if (!isA_SCNetworkInterface(obj)) { // if not an SCNetworkInterface return NULL; } interfaceType = SCNetworkInterfaceGetInterfaceType((SCNetworkInterfaceRef)obj); if (!CFEqual(interfaceType, kSCNetworkInterfaceTypeBond)) { // if not a Bond return NULL; } return obj; } static __inline__ CFTypeRef isA_SCVLANInterface(CFTypeRef obj) { CFStringRef interfaceType; if (!isA_SCNetworkInterface(obj)) { // if not an SCNetworkInterface return NULL; } interfaceType = SCNetworkInterfaceGetInterfaceType((SCNetworkInterfaceRef)obj); if (!CFEqual(interfaceType, kSCNetworkInterfaceTypeVLAN)) { // if not a VLAN return NULL; } return obj; } #endif // !TARGET_OS_IPHONE /*! @function _SCNetworkInterfaceCompare @discussion Compares two SCNetworkInterface objects. @param val1 The SCNetworkInterface object. @param val2 The SCNetworkInterface object. @param context Not used. @result A comparison result. */ CFComparisonResult _SCNetworkInterfaceCompare (const void *val1, const void *val2, void *context) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceCopySlashDevPath @discussion Returns the /dev pathname for the interface. @param interface The network interface. @result The /dev pathname associated with the interface (e.g. "/dev/modem"); NULL if no path is available. */ CFStringRef _SCNetworkInterfaceCopySlashDevPath (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0); #define kIncludeNoVirtualInterfaces 0x0 #define kIncludeVLANInterfaces 0x1 #define kIncludeBondInterfaces 0x2 #define kIncludeAllVirtualInterfaces 0xffffffff /*! @function _SCNetworkInterfaceCreateWithBSDName @discussion Create a new network interface associated with the provided BSD interface name. This API supports Ethhernet, FireWire, and IEEE 802.11 interfaces. @param bsdName The BSD interface name. @param flags Indicates whether virtual (Bond, VLAN) network interfaces should be included. @result A reference to the new SCNetworkInterface. You must release the returned value. */ SCNetworkInterfaceRef _SCNetworkInterfaceCreateWithBSDName (CFAllocatorRef allocator, CFStringRef bsdName, UInt32 flags) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceCreateWithEntity @discussion Create a new network interface associated with the provided SCDynamicStore service entity dictionary. @param interface_entity The entity dictionary. @param service The network service. @result A reference to the new SCNetworkInterface. You must release the returned value. */ SCNetworkInterfaceRef _SCNetworkInterfaceCreateWithEntity (CFAllocatorRef allocator, CFDictionaryRef interface_entity, SCNetworkServiceRef service) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceCreateWithIONetworkInterfaceObject @discussion Create a new network interface associated with the provided IORegistry "IONetworkInterface" object. @param if_obj The IONetworkInterface object. @result A reference to the new SCNetworkInterface. You must release the returned value. */ SCNetworkInterfaceRef _SCNetworkInterfaceCreateWithIONetworkInterfaceObject (io_object_t if_obj) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); #define kSCNetworkInterfaceConfigurationActionKey CFSTR("New Interface Detected Action") #define kSCNetworkInterfaceConfigurationActionValueNone CFSTR("None") #define kSCNetworkInterfaceConfigurationActionValuePrompt CFSTR("Prompt") #define kSCNetworkInterfaceConfigurationActionValueConfigure CFSTR("Configure") /*! @function _SCNetworkInterfaceCopyInterfaceInfo @discussion Returns interface details @param interface The network interface. @result A dictionary with details about the network interface. */ CFDictionaryRef _SCNetworkInterfaceCopyInterfaceInfo (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0); /*! @function _SCNetworkInterfaceGetConfigurationAction @discussion Returns a user-notification / auto-configuration action for the interface. @param interface The network interface. @result The user-notification / auto-configuration action; NULL if the default action should be used. */ CFStringRef _SCNetworkInterfaceGetConfigurationAction (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_0); /*! @function _SCNetworkInterfaceGetHardwareAddress @discussion Returns a link layer address for the interface. @param interface The network interface. @result The hardware (MAC) address for the interface. NULL if no hardware address is available. */ CFDataRef _SCNetworkInterfaceGetHardwareAddress (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceGetIOInterfaceType @discussion Returns the IOInterfaceType for the interface. @param interface The network interface. @result The IOInterfaceType associated with the interface */ CFNumberRef _SCNetworkInterfaceGetIOInterfaceType (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceGetIOInterfaceUnit @discussion Returns the IOInterfaceUnit for the interface. @param interface The network interface. @result The IOInterfaceUnit associated with the interface; NULL if no IOLocation is available. */ CFNumberRef _SCNetworkInterfaceGetIOInterfaceUnit (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceGetIOPath @discussion Returns the IOPath for the interface. @param interface The network interface. @result The IOPath associated with the interface; NULL if no IOPath is available. */ CFStringRef _SCNetworkInterfaceGetIOPath (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceIsBluetoothPAN @discussion Identifies if a network interface is a Bluetooth PAN device. @param interface The network interface. @result TRUE if the interface is a Bluetooth PAN device. */ Boolean _SCNetworkInterfaceIsBluetoothPAN (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0); /*! @function _SCNetworkInterfaceIsBuiltin @discussion Identifies if a network interface is "built-in". @param interface The network interface. @result TRUE if the interface is "built-in". */ Boolean _SCNetworkInterfaceIsBuiltin (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceIsTethered @discussion Identifies if a network interface is an Apple tethered device (e.g. an iPhone). @param interface The network interface. @result TRUE if the interface is a tethered device. */ Boolean _SCNetworkInterfaceIsTethered (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0); /*! @function _SCNetworkInterfaceIsModemV92 @discussion Identifies if a modem network interface supports v.92 (hold). @param interface The network interface. @result TRUE if the interface is "v.92" modem. */ Boolean _SCNetworkInterfaceIsModemV92 (SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCNetworkInterfaceForceConfigurationRefresh @discussion Forces a configuration refresh of the specified interface. @param ifName Network interface name. @result TRUE if the refresh was successfully posted. */ Boolean _SCNetworkInterfaceForceConfigurationRefresh (CFStringRef ifName) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function _SCBondInterfaceCopyActive @discussion Returns all Ethernet Bond interfaces on the system. @result The list of SCBondInterface interfaces on the system. You must release the returned value. */ CFArrayRef _SCBondInterfaceCopyActive (void) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA); /*! @function _SCBondInterfaceUpdateConfiguration @discussion Updates the bond interface configuration. @param prefs The "preferences" session. @result TRUE if the bond interface configuration was updated.; FALSE if the an error was encountered. */ Boolean _SCBondInterfaceUpdateConfiguration (SCPreferencesRef prefs) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA); /*! @function SCBondInterfaceSetMode @discussion Set the mode on the bond interface. @param bond The bond interface on which to adjust the mode. @param mode The mode value (0=IF_BOND_MODE_LACP,1=IF_BOND_MODE_STATIC) @result TRUE if operation succeeded. */ Boolean SCBondInterfaceSetMode (SCBondInterfaceRef bond, CFNumberRef mode) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA); /*! @function SCBondInterfaceSetMode @discussion Return the mode for the given bond interface. @param bond The bond interface to get the mode from. @result A CFNumberRef containing the mode (IF_BOND_MODE_{LACP,STATIC}). */ CFNumberRef SCBondInterfaceGetMode (SCBondInterfaceRef bond) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA); /*! @function _SCVLANInterfaceCopyActive @discussion Returns all VLAN interfaces on the system. @result The list of SCVLANInterface interfaces on the system. You must release the returned value. */ CFArrayRef _SCVLANInterfaceCopyActive (void) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA); /*! @function _SCVLANInterfaceUpdateConfiguration @discussion Updates the VLAN interface configuration. @param prefs The "preferences" session. @result TRUE if the VLAN interface configuration was updated.; FALSE if the an error was encountered. */ Boolean _SCVLANInterfaceUpdateConfiguration (SCPreferencesRef prefs) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_NA); #pragma mark - #pragma mark SCNetworkInterface Password SPIs enum { kSCNetworkInterfacePasswordTypePPP = 1, kSCNetworkInterfacePasswordTypeIPSecSharedSecret, kSCNetworkInterfacePasswordTypeEAPOL, kSCNetworkInterfacePasswordTypeIPSecXAuth, }; typedef uint32_t SCNetworkInterfacePasswordType; Boolean SCNetworkInterfaceCheckPassword (SCNetworkInterfaceRef interface, SCNetworkInterfacePasswordType passwordType) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); CFDataRef SCNetworkInterfaceCopyPassword (SCNetworkInterfaceRef interface, SCNetworkInterfacePasswordType passwordType) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); Boolean SCNetworkInterfaceRemovePassword (SCNetworkInterfaceRef interface, SCNetworkInterfacePasswordType passwordType) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); Boolean SCNetworkInterfaceSetPassword (SCNetworkInterfaceRef interface, SCNetworkInterfacePasswordType passwordType, CFDataRef password, CFDictionaryRef options) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); #pragma mark - #pragma mark SCNetworkProtocol configuration (SPI) /*! @group Protocol configuration */ static __inline__ CFTypeRef isA_SCNetworkProtocol(CFTypeRef obj) { return (isA_CFType(obj, SCNetworkProtocolGetTypeID())); } #pragma mark - #pragma mark SCNetworkService configuration (SPI) /*! @group Service configuration */ static __inline__ CFTypeRef isA_SCNetworkService(CFTypeRef obj) { return (isA_CFType(obj, SCNetworkServiceGetTypeID())); } enum { kSCNetworkServicePrimaryRankDefault = 0, kSCNetworkServicePrimaryRankFirst = 1, kSCNetworkServicePrimaryRankLast = 2, kSCNetworkServicePrimaryRankNever = 3 }; typedef uint32_t SCNetworkServicePrimaryRank; /*! @function _SCNetworkServiceCopyActive @discussion Returns the network service with the specified identifier. Note: The service returned by this SPI differs from the SCNetworkServiceCopy API in that queries and operations interact with the "active" service represented in the SCDynamicStore. Only a limited subset of the SCNetworkService APIs are supported. @param prefs The dynamic store session. @param serviceID The unique identifier for the service. @result A reference to the SCNetworkService represented in the SCDynamicStore; NULL if the serviceID does not exist in the SCDynamicStore or if an error was encountered. You must release the returned value. */ SCNetworkServiceRef _SCNetworkServiceCopyActive (SCDynamicStoreRef store, CFStringRef serviceID) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_1); /*! @function SCNetworkServiceGetPrimaryRank @discussion Returns the primary service rank associated with a service. @param service The network service. @result The primary service rank associated with the specified application; kSCNetworkServicePrimaryRankDefault if no rank is associated with the application or an error was encountered. */ SCNetworkServicePrimaryRank SCNetworkServiceGetPrimaryRank (SCNetworkServiceRef service) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_0); /*! @function SCNetworkServiceSetPrimaryRank @discussion Updates the the primary service rank associated with a service. @param service The network service. @param newRank The new primary service rank; kSCNetworkServicePrimaryRankDefault if the default service rank should be used. @result TRUE if the rank was stored; FALSE if an error was encountered. Notes : The kSCNetworkServicePrimaryRankFirst and kSCNetworkServicePrimaryRankLast values can only valid as a transient setting. */ Boolean SCNetworkServiceSetPrimaryRank (SCNetworkServiceRef service, SCNetworkServicePrimaryRank newRank) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_2_0); #pragma mark - #pragma mark SCNetworkSet configuration (SPI) /*! @group Set configuration */ static __inline__ CFTypeRef isA_SCNetworkSet(CFTypeRef obj) { return (isA_CFType(obj, SCNetworkSetGetTypeID())); } /*! @function SCNetworkSetEstablishDefaultConfiguration @discussion Updates a network set by adding services for any network interface that is not currently represented. If the provided set contains one (or more) services, new services will only be added for those interfaces that are not represented in *any* set. Otherwise, new services will be added for those interfaces that are not represented in the provided set. The new services are established with "default" configuration options. @param set The network set. @result TRUE if the configuration was updated; FALSE if no changes were required or if an error was encountered. */ Boolean SCNetworkSetEstablishDefaultConfiguration (SCNetworkSetRef set) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); /*! @function SCNetworkSetEstablishDefaultInterfaceConfiguration @discussion Updates a network set by adding services for the specified network interface if is not currently represented. If the provided set contains one (or more) services, new services will only be added for interfaces that are not represented in *any* set. Otherwise, new services will be added for interfaces that are not represented in the provided set. The new services are established with "default" configuration options. @param set The network set. @param interface The network interface. @result TRUE if the configuration was updated; FALSE if no changes were required or if an error was encountered. */ Boolean SCNetworkSetEstablishDefaultInterfaceConfiguration (SCNetworkSetRef set, SCNetworkInterfaceRef interface) __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0); __END_DECLS #endif /* _SCNETWORKCONFIGURATIONPRIVATE_H */