lookup.subproj/si_module.h

   1 /*
   2  * Copyright (c) 2008-2009 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 __SI_MODULE_H__
  25 #define __SI_MODULE_H__
  26
  27 #include <stdlib.h>
  28 #include <stdint.h>
  29 #include <netinet/in.h>
  30 #include <sys/socket.h>
  31 #include <pwd.h>
  32 #include <grp.h>
  33 #include <netdb.h>
  34 #include <aliasdb.h>
  35 #include <fstab.h>
  36 #include <mach/mach.h>
  37 #include <si_data.h>
  38 #include <ils.h>
  39
  40 #define forever for(;;)
  41 #define string_equal(A,B) (strcmp(A,B)==0)
  42 #define string_not_equal(A,B) (strcmp(A,B)!=0)
  43
  44 #define SI_CALL_USER_BYNAME        0
  45 #define SI_CALL_USER_BYUID         1
  46 #define SI_CALL_USER_ALL           2
  47 #define SI_CALL_GROUP_BYNAME       3
  48 #define SI_CALL_GROUP_BYGID        4
  49 #define SI_CALL_GROUP_ALL          5
  50 #define SI_CALL_NETGROUP_BYNAME    6
  51 #define SI_CALL_IN_NETGROUP        7
  52 #define SI_CALL_GROUPLIST          8
  53 #define SI_CALL_ALIAS_BYNAME       9
  54 #define SI_CALL_ALIAS_ALL         10
  55 #define SI_CALL_HOST_BYNAME       11
  56 #define SI_CALL_HOST_BYADDR       12
  57 #define SI_CALL_HOST_ALL          13
  58 #define SI_CALL_NETWORK_BYNAME    14
  59 #define SI_CALL_NETWORK_BYADDR    15
  60 #define SI_CALL_NETWORK_ALL       16
  61 #define SI_CALL_SERVICE_BYNAME    17
  62 #define SI_CALL_SERVICE_BYPORT    18
  63 #define SI_CALL_SERVICE_ALL       19
  64 #define SI_CALL_PROTOCOL_BYNAME   20
  65 #define SI_CALL_PROTOCOL_BYNUMBER 21
  66 #define SI_CALL_PROTOCOL_ALL      22
  67 #define SI_CALL_RPC_BYNAME        23
  68 #define SI_CALL_RPC_BYNUMBER      24
  69 #define SI_CALL_RPC_ALL           25
  70 #define SI_CALL_FS_BYSPEC         26
  71 #define SI_CALL_FS_BYFILE         27
  72 #define SI_CALL_FS_ALL            28
  73 #define SI_CALL_ADDRINFO          29
  74 #define SI_CALL_NAMEINFO          30
  75 #define SI_CALL_IPNODE_BYNAME     31
  76 #define SI_CALL_MAC_BYNAME        32
  77 #define SI_CALL_MAC_BYMAC         33
  78 #define SI_CALL_MAC_ALL           34
  79 #define SI_CALL_DNS_QUERY         35
  80 #define SI_CALL_DNS_SEARCH        36
  81
  82 #define si_call_returns_list(A) \
  83 ((A==SI_CALL_USER_ALL)||(A==SI_CALL_GROUP_ALL)||(A==SI_CALL_HOST_ALL)||(A==SI_CALL_NETWORK_ALL)||\
  84  (A==SI_CALL_SERVICE_ALL)||(A==SI_CALL_PROTOCOL_ALL)||(A==SI_CALL_RPC_ALL)||(A==SI_CALL_FS_ALL)||\
  85  (A==SI_CALL_ALIAS_ALL)||(A==SI_CALL_NETGROUP_BYNAME)||(A==SI_CALL_ADDRINFO)||(A==SI_CALL_MAC_ALL))
  86
  87 #define si_call_str1_is_buffer(A) \
  88 ((A==SI_CALL_HOST_BYADDR)||(A==SI_CALL_NAMEINFO))
  89
  90 #define CATEGORY_USER       0
  91 #define CATEGORY_GROUP      1
  92 #define CATEGORY_GROUPLIST  2
  93 #define CATEGORY_NETGROUP   3
  94 #define CATEGORY_ALIAS      4
  95 #define CATEGORY_HOST_IPV4  5
  96 #define CATEGORY_HOST_IPV6  6
  97 #define CATEGORY_NETWORK    7
  98 #define CATEGORY_SERVICE    8
  99 #define CATEGORY_PROTOCOL   9
 100 #define CATEGORY_RPC       10
 101 #define CATEGORY_FS        11
 102 #define CATEGORY_MAC       12
 103 #define CATEGORY_NAMEINFO  13
 104 #define CATEGORY_ADDRINFO  14
 105 #define CATEGORY_DNSPACKET 15
 106 #define CATEGORY_SRV       16
 107 #define CATEGORY_COUNT     17
 108
 109 /* convenience */
 110 #define CATEGORY_HOST CATEGORY_HOST_IPV4
 111
 112 #define SEL_ALL 0
 113 #define SEL_NAME 1
 114 #define SEL_NUMBER 2
 115
 116 /* host, getaddrinfo, and getnameinfo status codes */
 117 #define SI_STATUS_NO_ERROR                 0
 118 #define SI_STATUS_H_ERRNO_HOST_NOT_FOUND   1
 119 #define SI_STATUS_H_ERRNO_TRY_AGAIN        2
 120 #define SI_STATUS_H_ERRNO_NO_RECOVERY      3
 121 #define SI_STATUS_H_ERRNO_NO_DATA          4
 122 #define SI_STATUS_INTERNAL                10
 123 #define SI_STATUS_WORKITEM_NOT_FOUND      11
 124 #define SI_STATUS_RETURNS_ITEM            12
 125 #define SI_STATUS_RETURNS_LIST            13
 126 #define SI_STATUS_CALL_IN_PROGRESS        14
 127 #define SI_STATUS_CALL_CANCELLED          15
 128 #define SI_STATUS_EAI_PLUS_100           100
 129 #define SI_STATUS_EAI_ADDRFAMILY         101
 130 #define SI_STATUS_EAI_AGAIN              102
 131 #define SI_STATUS_EAI_BADFLAGS           103
 132 #define SI_STATUS_EAI_FAIL               104
 133 #define SI_STATUS_EAI_FAMILY             105
 134 #define SI_STATUS_EAI_MEMORY             106
 135 #define SI_STATUS_EAI_NODATA             107
 136 #define SI_STATUS_EAI_NONAME             108
 137 #define SI_STATUS_EAI_SERVICE            109
 138 #define SI_STATUS_EAI_SOCKTYPE           110
 139 #define SI_STATUS_EAI_SYSTEM             111
 140 #define SI_STATUS_EAI_BADHINTS           112
 141 #define SI_STATUS_EAI_PROTOCOL           113
 142 #define SI_STATUS_EAI_OVERFLOW           114
 143 #define SI_STATUS_ERRNO_PLUS_200         200
 144
 145 typedef void (*item_async_callback)(si_item_t *, uint32_t, void *);
 146 typedef void (*list_async_callback)(si_list_t *, uint32_t, void *);
 147
 148 typedef struct grouplist_s
 149 {
 150         char *gl_user;
 151         gid_t gl_basegid;
 152         int gl_count;
 153         gid_t **gl_gid;
 154 } si_grouplist_t;
 155
 156 typedef struct addrinfo_s
 157 {
 158         int ai_flags;
 159         int ai_family;
 160         int ai_socktype;
 161         int ai_protocol;
 162         uint32_t ai_addrlen;
 163         socket_data_t ai_addr;
 164         char *ai_canonname;
 165 } si_addrinfo_t;
 166
 167 typedef struct nameinfo_s
 168 {
 169         char *ni_node;
 170         char *ni_serv;
 171 } si_nameinfo_t;
 172
 173 typedef struct mac_s
 174 {
 175         char *host;
 176         char *mac;
 177 } si_mac_t;
 178
 179 typedef struct netgrent_s
 180 {
 181         char *ng_host;
 182         char *ng_user;
 183         char *ng_domain;
 184 } si_netgrent_t;
 185
 186 typedef struct dnspacket_s
 187 {
 188         int dns_packet_len;
 189         char *dns_packet;
 190         int dns_server_len;
 191         struct sockaddr *dns_server;
 192 } si_dnspacket_t;
 193
 194 typedef struct si_srv_s {
 195         uint16_t priority;
 196         uint16_t weight;
 197         uint16_t port;
 198         char *target;
 199 } si_srv_t;
 200
 201 typedef struct si_mod_s
 202 {
 203         char *name;
 204         uint32_t vers;
 205         int32_t refcount;
 206
 207         void *bundle;
 208         void *private;
 209
 210         void (*sim_close)(struct si_mod_s *si);
 211
 212         int (*sim_is_valid)(struct si_mod_s *si, si_item_t *item);
 213
 214         si_item_t *(*sim_user_byname)(struct si_mod_s *si, const char *name);
 215         si_item_t *(*sim_user_byuid)(struct si_mod_s *si, uid_t uid);
 216         si_list_t *(*sim_user_all)(struct si_mod_s *si);
 217
 218         si_item_t *(*sim_group_byname)(struct si_mod_s *si, const char *name);
 219         si_item_t *(*sim_group_bygid)(struct si_mod_s *si, gid_t gid);
 220         si_list_t *(*sim_group_all)(struct si_mod_s *si);
 221
 222         si_item_t *(*sim_grouplist)(struct si_mod_s *si, const char *name);
 223
 224         si_list_t *(*sim_netgroup_byname)(struct si_mod_s *si, const char *name);
 225         int (*sim_in_netgroup)(struct si_mod_s *si, const char *name, const char *host, const char *user, const char *domain);
 226
 227         si_item_t *(*sim_alias_byname)(struct si_mod_s *si, const char *name);
 228         si_list_t *(*sim_alias_all)(struct si_mod_s *si);
 229
 230         si_item_t *(*sim_host_byname)(struct si_mod_s *si, const char *name, int af, uint32_t *err);
 231         si_item_t *(*sim_host_byaddr)(struct si_mod_s *si, const void *addr, int af, uint32_t *err);
 232         si_list_t *(*sim_host_all)(struct si_mod_s *si);
 233
 234         si_item_t *(*sim_network_byname)(struct si_mod_s *si, const char *name);
 235         si_item_t *(*sim_network_byaddr)(struct si_mod_s *si, uint32_t addr);
 236         si_list_t *(*sim_network_all)(struct si_mod_s *si);
 237
 238         si_item_t *(*sim_service_byname)(struct si_mod_s *si, const char *name, const char *proto);
 239         si_item_t *(*sim_service_byport)(struct si_mod_s *si, int port, const char *proto);
 240         si_list_t *(*sim_service_all)(struct si_mod_s *si);
 241
 242         si_item_t *(*sim_protocol_byname)(struct si_mod_s *si, const char *name);
 243         si_item_t *(*sim_protocol_bynumber)(struct si_mod_s *si, int number);
 244         si_list_t *(*sim_protocol_all)(struct si_mod_s *si);
 245
 246         si_item_t *(*sim_rpc_byname)(struct si_mod_s *si, const char *name);
 247         si_item_t *(*sim_rpc_bynumber)(struct si_mod_s *si, int number);
 248         si_list_t *(*sim_rpc_all)(struct si_mod_s *si);
 249
 250         si_item_t *(*sim_fs_byspec)(struct si_mod_s *si, const char *spec);
 251         si_item_t *(*sim_fs_byfile)(struct si_mod_s *si, const char *file);
 252         si_list_t *(*sim_fs_all)(struct si_mod_s *si);
 253
 254         si_item_t *(*sim_mac_byname)(struct si_mod_s *si, const char *name);
 255         si_item_t *(*sim_mac_bymac)(struct si_mod_s *si, const char *mac);
 256         si_list_t *(*sim_mac_all)(struct si_mod_s *si);
 257
 258         si_list_t *(*sim_addrinfo)(struct si_mod_s *si, const void *node, const void *serv, uint32_t family, uint32_t socktype, uint32_t protocol, uint32_t flags, uint32_t *err);
 259         int (*sim_wants_addrinfo)(struct si_mod_s *si);
 260
 261         si_item_t *(*sim_nameinfo)(struct si_mod_s *si, const struct sockaddr *sa, int flags, uint32_t *err);
 262
 263         si_list_t *(*sim_srv_byname)(struct si_mod_s *si, const char *qname, uint32_t *err);
 264
 265         si_item_t *(*sim_item_call)(struct si_mod_s *si, int call, const char *str1, const char *str2, uint32_t num1, uint32_t num2, uint32_t *err);
 266         si_list_t *(*sim_list_call)(struct si_mod_s *si, int call, const char *str1, const char *str2, uint32_t num1, uint32_t num2, uint32_t num3, uint32_t num4, uint32_t *err);
 267
 268         mach_port_t (*sim_async_call)(struct si_mod_s *si, int call, const char *str1, const char *str2, uint32_t num1, uint32_t num2, uint32_t num3, uint32_t num4, void *callback, void *context);
 269         void (*sim_async_cancel)(mach_port_t p);
 270         void (*sim_async_handle_reply)(mach_msg_header_t *msg);
 271 } si_mod_t;
 272
 273 si_mod_t *si_module_with_name(const char *name);
 274 __private_extern__ si_mod_t *si_module_with_path(const char *path, const char *name);
 275 __private_extern__ si_mod_t *si_module_retain(si_mod_t *si);
 276 void si_module_release(si_mod_t *si);
 277 __private_extern__ const char *si_module_name(si_mod_t *si);
 278 __private_extern__ int si_module_vers(si_mod_t *si);
 279
 280 si_mod_t *si_search(void);
 281
 282 __private_extern__ int si_item_match(si_item_t *item, int cat, const void *name, uint32_t num, int which);
 283 __private_extern__ int si_item_is_valid(si_item_t *item);
 284
 285 __private_extern__ si_item_t *si_user_byname(si_mod_t *si, const char *name);
 286 __private_extern__ si_item_t *si_user_byuid(si_mod_t *si, uid_t uid);
 287 __private_extern__ si_list_t *si_user_all(si_mod_t *si);
 288
 289 __private_extern__ si_item_t *si_group_byname(si_mod_t *si, const char *name);
 290 __private_extern__ si_item_t *si_group_bygid(si_mod_t *si, gid_t gid);
 291 __private_extern__ si_list_t *si_group_all(si_mod_t *si);
 292
 293 __private_extern__ si_item_t *si_grouplist(si_mod_t *si, const char *name);
 294
 295 __private_extern__ int si_in_netgroup(struct si_mod_s *si, const char *name, const char *host, const char *user, const char *domain);
 296 __private_extern__ si_list_t *si_netgroup_byname(struct si_mod_s *si, const char *name);
 297
 298 __private_extern__ si_item_t *si_alias_byname(struct si_mod_s *si, const char *name);
 299 __private_extern__ si_list_t *si_alias_all(struct si_mod_s *si);
 300
 301 __private_extern__ si_item_t *si_host_byname(si_mod_t *si, const char *name, int af, uint32_t *err);
 302 __private_extern__ si_item_t *si_host_byaddr(si_mod_t *si, const void *addr, int af, uint32_t *err);
 303 __private_extern__ si_list_t *si_host_all(si_mod_t *si);
 304
 305 __private_extern__ si_item_t *si_mac_byname(struct si_mod_s *si, const char *name);
 306 __private_extern__ si_item_t *si_mac_bymac(struct si_mod_s *si, const char *mac);
 307 __private_extern__ si_list_t *si_mac_all(struct si_mod_s *si);
 308
 309 __private_extern__ si_item_t *si_network_byname(si_mod_t *si, const char *name);
 310 __private_extern__ si_item_t *si_network_byaddr(si_mod_t *si, uint32_t addr);
 311 __private_extern__ si_list_t *si_network_all(si_mod_t *si);
 312
 313 __private_extern__ si_item_t *si_service_byname(si_mod_t *si, const char *name, const char *proto);
 314 __private_extern__ si_item_t *si_service_byport(si_mod_t *si, int port, const char *proto);
 315 __private_extern__ si_list_t *si_service_all(si_mod_t *si);
 316
 317 __private_extern__ si_item_t *si_protocol_byname(si_mod_t *si, const char *name);
 318 __private_extern__ si_item_t *si_protocol_bynumber(si_mod_t *si, uint32_t number);
 319 __private_extern__ si_list_t *si_protocol_all(si_mod_t *si);
 320
 321 __private_extern__ si_item_t *si_rpc_byname(si_mod_t *si, const char *name);
 322 __private_extern__ si_item_t *si_rpc_bynumber(si_mod_t *si, int number);
 323 __private_extern__ si_list_t *si_rpc_all(si_mod_t *si);
 324
 325 __private_extern__ si_item_t *si_fs_byspec(si_mod_t *si, const char *spec);
 326 __private_extern__ si_item_t *si_fs_byfile(si_mod_t *si, const char *file);
 327 __private_extern__ si_list_t *si_fs_all(si_mod_t *si);
 328
 329 __private_extern__ int si_wants_addrinfo(si_mod_t *s);
 330 __private_extern__ si_list_t *si_addrinfo(si_mod_t *si, const char *node, const char *serv, uint32_t family, uint32_t socktype, uint32_t protocol, uint32_t flags, uint32_t *err);
 331
 332 __private_extern__ si_item_t *si_nameinfo(si_mod_t *si, const struct sockaddr *sa, int flags, uint32_t *err);
 333 __private_extern__ si_item_t *si_ipnode_byname(si_mod_t *si, const char *name, int family, int flags, uint32_t *err);
 334
 335 __private_extern__ si_list_t *si_srv_byname(si_mod_t *si, const char *qname, uint32_t *err);
 336
 337 __private_extern__ si_item_t *si_item_call(si_mod_t *si, int call, const char *str1, const char *str2, uint32_t num1, uint32_t num2, uint32_t *err);
 338 __private_extern__ si_list_t *si_list_call(si_mod_t *si, int call, const char *str1, const char *str2, uint32_t num1, uint32_t num2, uint32_t num3, uint32_t num4, uint32_t *err);
 339
 340 extern mach_port_t si_async_call(si_mod_t *si, int call, const char *str1, const char *str2, uint32_t num1, uint32_t num2, uint32_t num3, uint32_t num4, void *callback, void *context);
 341 extern void si_async_cancel(mach_port_t p);
 342 extern void si_async_handle_reply(mach_msg_header_t *msg);
 343
 344 char *si_canonical_mac_address(const char *addr);
 345 si_item_t *si_addrinfo_v4(si_mod_t *si, int32_t flags, int32_t sock, int32_t proto, uint16_t port, struct in_addr *addr, uint16_t iface, const char *cname);
 346 si_item_t *si_addrinfo_v6(si_mod_t *si, int32_t flags, int32_t sock, int32_t proto, uint16_t port, struct in6_addr *addr, uint16_t iface, const char *cname);
 347 si_list_t *si_addrinfo_list(si_mod_t *si, int socktype, int proto, struct in_addr *a4, struct in6_addr *a6, int port, int scopeid, const char *cname4, const char *cname6);
 348 si_list_t *si_addrinfo_list_from_hostent(si_mod_t *si, uint32_t socktype, uint32_t proto, uint16_t port, uint16_t scope, const struct hostent *h4, const struct hostent *h6);
 349
 350 int _gai_serv_to_port(const char *serv, uint32_t proto, uint16_t *port);
 351
 352 #endif /* ! __SI_MODULE_H__ */