[apple/configd.git] / dnsinfo / dnsinfo_create.h

/*
 * Copyright (c) 2004-2006, 2008, 2009, 2011 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 __DNSINFO_CREATE_H__
#define __DNSINFO_CREATE_H__

/*
 * These routines provide access to the systems DNS configuration
 */

#include <TargetConditionals.h>
#include <Availability.h>
#include <sys/cdefs.h>
#include <stdint.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>

#include <dnsinfo.h>

typedef const struct __dns_create_config *      dns_create_config_t;
typedef const struct __dns_create_resolver *    dns_create_resolver_t;

#if	!TARGET_OS_IPHONE
#ifndef _PATH_RESOLVER_DIR
#define _PATH_RESOLVER_DIR "/etc/resolver"
#endif
#endif	/* !TARGET_OS_IPHONE */

__BEGIN_DECLS

/*
 * NOTE: __private_extern__ and __OSX_AVAILABLE_STARTING() cannot be mixed
 *       due to a "visibility" conflict
 */

/*
 * DNS configuration creation APIs
 */
__private_extern__
dns_create_config_t
_dns_configuration_create       (void)						/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_configuration_add_resolver (dns_create_config_t	*_config,
				 dns_create_resolver_t	_resolver)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_configuration_signature	(dns_create_config_t	*_config,
				 unsigned char		*signature,
				 size_t			signature_len)		/*__OSX_AVAILABLE_STARTING(__MAC_10_7+,__IPHONE_5_0)*/;	// signature_len >= CC_SHA1_DIGEST_LENGTH

__private_extern__
_Bool
_dns_configuration_store	(dns_create_config_t	*_config)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_configuration_free		(dns_create_config_t	*_config)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

/*
 * DNS [resolver] configuration creation APIs
 */
__private_extern__
dns_create_resolver_t
_dns_resolver_create		(void)						/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_set_domain	(dns_create_resolver_t	*_resolver,
				 const char		*domain)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_add_nameserver	(dns_create_resolver_t	*_resolver,
				 struct sockaddr	*nameserver)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_add_search	(dns_create_resolver_t	*_resolver,
				 const char		*search)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_add_sortaddr	(dns_create_resolver_t	*_resolver,
				 dns_sortaddr_t		*sortaddr)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_set_flags		(dns_create_resolver_t	*_resolver,
				 uint32_t		flags)			/*__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0)*/;

__private_extern__
void
_dns_resolver_set_if_index	(dns_create_resolver_t	*_resolver,
				 uint32_t		if_index)		/*__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0)*/;

__private_extern__
void
_dns_resolver_set_options	(dns_create_resolver_t	*_resolver,
				 const char		*options)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_set_order		(dns_create_resolver_t	*_resolver,
				 uint32_t		order)			/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_set_port		(dns_create_resolver_t	*_resolver,
				 uint16_t		port)			/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;	// host byte order

__private_extern__
void
_dns_resolver_set_reach_flags	(dns_create_resolver_t	*_resolver,
				 uint32_t		reach_flags)		/*__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0)*/;

__private_extern__
void
_dns_resolver_set_timeout	(dns_create_resolver_t	*_resolver,
				 uint32_t		timeout)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

__private_extern__
void
_dns_resolver_free		(dns_create_resolver_t	*_resolver)		/*__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;

#if	!TARGET_OS_IPHONE
/*
 * DNS [resolver] flat-file configuration creation APIs
 */
__private_extern__
void
_dnsinfo_flatfile_add_resolvers	(dns_create_config_t	*config)		/*__OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_NA)*/;
#endif	// !TARGET_OS_IPHONE

__END_DECLS

#endif	/* __DNSINFO_CREATE_H__ */
Commit	Line	Data
dbf6a266	1	/*
17d3ee29	2	* Copyright (c) 2004-2006, 2008, 2009, 2011 Apple Inc. All rights reserved.
dbf6a266 A	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 __DNSINFO_CREATE_H__
	25	#define __DNSINFO_CREATE_H__
	26
dbf6a266 A	27	/*
	28	* These routines provide access to the systems DNS configuration
	29	*/
	30
a40a14f8 A	31	#include <TargetConditionals.h>
a40a14f8 A	32	#include <Availability.h>
d6c893b2	33	#include <sys/cdefs.h>
dbf6a266 A	34	#include <stdint.h>
	35	#include <sys/types.h>
	36	#include <sys/socket.h>
	37	#include <netinet/in.h>
	38
dbf6a266 A	39	#include <dnsinfo.h>
dbf6a266 A	40
dbf6a266 A	41	typedef const struct __dns_create_config * dns_create_config_t;
	42	typedef const struct __dns_create_resolver * dns_create_resolver_t;
	43
a40a14f8 A	44	#if !TARGET_OS_IPHONE
	45	#ifndef _PATH_RESOLVER_DIR
	46	#define _PATH_RESOLVER_DIR "/etc/resolver"
	47	#endif
	48	#endif /* !TARGET_OS_IPHONE */
	49
dbf6a266 A	50	__BEGIN_DECLS
dbf6a266 A	51
a40a14f8 A	52	/*
	53	* NOTE: __private_extern__ and __OSX_AVAILABLE_STARTING() cannot be mixed
	54	* due to a "visibility" conflict
	55	*/
	56
dbf6a266 A	57	/*
	58	* DNS configuration creation APIs
	59	*/
a40a14f8 A	60	__private_extern__
	61	dns_create_config_t
	62	_dns_configuration_create (void) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)/;
	63
	64	__private_extern__
	65	void
	66	_dns_configuration_add_resolver (dns_create_config_t *_config,
	67	dns_create_resolver_t _resolver) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)/;
	68
17d3ee29 A	69	__private_extern__
	70	void
	71	_dns_configuration_signature (dns_create_config_t *_config,
	72	unsigned char *signature,
	73	size_t signature_len) /__OSX_AVAILABLE_STARTING(__MAC_10_7+,__IPHONE_5_0)/; // signature_len >= CC_SHA1_DIGEST_LENGTH
	74
a40a14f8 A	75	__private_extern__
	76	_Bool
	77	_dns_configuration_store (dns_create_config_t _config) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
	78
	79	__private_extern__
	80	void
	81	_dns_configuration_free (dns_create_config_t _config) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
dbf6a266 A	82
	83	/*
	84	* DNS [resolver] configuration creation APIs
	85	*/
a40a14f8 A	86	__private_extern__
	87	dns_create_resolver_t
	88	_dns_resolver_create (void) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)/;
dbf6a266	89
a40a14f8 A	90	__private_extern__
	91	void
	92	_dns_resolver_set_domain (dns_create_resolver_t *_resolver,
	93	const char domain) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
	94
	95	__private_extern__
	96	void
	97	_dns_resolver_add_nameserver (dns_create_resolver_t *_resolver,
	98	struct sockaddr nameserver) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
	99
a40a14f8 A	100	__private_extern__
	101	void
	102	_dns_resolver_add_search (dns_create_resolver_t *_resolver,
	103	const char search) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
	104
	105	__private_extern__
	106	void
	107	_dns_resolver_add_sortaddr (dns_create_resolver_t *_resolver,
	108	dns_sortaddr_t sortaddr) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
	109
	110	__private_extern__
	111	void
6bb65964 A	112	_dns_resolver_set_flags (dns_create_resolver_t *_resolver,
6bb65964 A	113	uint32_t flags) /__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0)/;
a40a14f8 A	114
	115	__private_extern__
	116	void
6bb65964 A	117	_dns_resolver_set_if_index (dns_create_resolver_t *_resolver,
	118	uint32_t if_index) /__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0)/;
	119
	120	__private_extern__
	121	void
	122	_dns_resolver_set_options (dns_create_resolver_t *_resolver,
	123	const char options) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
a40a14f8 A	124
	125	__private_extern__
	126	void
	127	_dns_resolver_set_order (dns_create_resolver_t *_resolver,
	128	uint32_t order) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)/;
	129
6bb65964 A	130	__private_extern__
	131	void
	132	_dns_resolver_set_port (dns_create_resolver_t *_resolver,
	133	uint16_t port) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)/; // host byte order
	134
17d3ee29 A	135	__private_extern__
	136	void
	137	_dns_resolver_set_reach_flags (dns_create_resolver_t *_resolver,
	138	uint32_t reach_flags) /__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_5_0)/;
	139
6bb65964 A	140	__private_extern__
	141	void
	142	_dns_resolver_set_timeout (dns_create_resolver_t *_resolver,
	143	uint32_t timeout) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)/;
	144
a40a14f8 A	145	__private_extern__
	146	void
	147	_dns_resolver_free (dns_create_resolver_t _resolver) /__OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_2_0)*/;
	148
	149	#if !TARGET_OS_IPHONE
	150	/*
	151	* DNS [resolver] flat-file configuration creation APIs
	152	*/
	153	__private_extern__
	154	void
	155	_dnsinfo_flatfile_add_resolvers (dns_create_config_t config) /__OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_NA)*/;
	156	#endif // !TARGET_OS_IPHONE
	157
	158	__END_DECLS
d6c893b2 A	159
d6c893b2 A	160	#endif /* __DNSINFO_CREATE_H__ */