1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21/*
22 * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
23 */
24
25#ifndef	_LDAP_COMMON_H
26#define	_LDAP_COMMON_H
27
28#ifdef	__cplusplus
29extern "C" {
30#endif
31
32#include <ctype.h>
33#include <nss_dbdefs.h>
34#include <stdlib.h>
35#include <string.h>
36#include <strings.h>
37#include <signal.h>
38#include <lber.h>
39#include <ldap.h>
40#include <pwd.h>
41#include "ns_sldap.h"
42
43#define	_ALIASES		"aliases"
44#define	_AUTOMOUNT		"automount"
45#define	_AUTHATTR		"auth_attr"
46#define	_AUUSER			"audit_user"
47#define	_BOOTPARAMS		"bootparams"
48#define	_DEFAULT		"default"
49#define	_ETHERS			"ethers"
50#define	_EXECATTR		"exec_attr"
51#define	_GROUP			"group"
52#define	_PROJECT		"project"
53#define	_HOSTS			"hosts"
54#define	_HOSTS6			"hosts"
55#define	_NETGROUP		"netgroup"
56#define	_NETMASKS		"netmasks"
57#define	_NETWORKS		"networks"
58#define	_PASSWD			"passwd"
59#define	_PRINTERS		"printers"
60#define	_PROFATTR		"prof_attr"
61#define	_PROTOCOLS		"protocols"
62#define	_PUBLICKEY		"publickey"
63#define	_RPC			"rpc"
64#define	_SERVICES		"services"
65#define	_SHADOW			"shadow"
66#define	_USERATTR		"user_attr"
67#define	_TNRHDB			"tnrhdb"
68#define	_TNRHTP			"tnrhtp"
69
70#define	NSS_STR_PARSE_NO_ADDR	(NSS_STR_PARSE_ERANGE + 100)
71#define	NSS_STR_PARSE_NO_RESULT	(NSS_STR_PARSE_ERANGE + 101)
72
73#define	DOTTEDSUBDOMAIN(string) \
74	((string != NULL) && (strchr(string, '.') != NULL))
75#define	SEARCHFILTERLEN		256
76
77#define	_NO_VALUE		""
78
79#define	TEST_AND_ADJUST(len, buffer, buflen, label) \
80	    /* Use '>=' to ensure there is at least one byte left for '\0' */ \
81	    if (len >= buflen || len < 0) { \
82		nss_result = NSS_STR_PARSE_ERANGE; \
83		goto label; \
84	    } \
85	    /* Adjust pointer and available buffer length */ \
86	    buffer += len; \
87	    buflen -= len;
88
89/*
90 * We need to use UID_NOBODY and GID_NOBODY as strings. Therefore we use
91 * snprintf to convert [U|G]ID_NOBODY into a string. The target buffer
92 * size was chosen as 21 to allow the largest 64-bit number to be stored
93 * as string in it. Right now uid_t and gid_t are 32-bit so we don't
94 * really need 21 characters but it does allow for future expansion
95 * without having to modify this code.
96 */
97#define	NOBODY_STR_LEN	21
98
99
100/*
101 * Superset the nss_backend_t abstract data type. This ADT has
102 * been extended to include ldap associated data structures.
103 */
104
105typedef struct ldap_backend *ldap_backend_ptr;
106typedef nss_status_t (*ldap_backend_op_t)(ldap_backend_ptr, void *);
107typedef int (*fnf)(ldap_backend_ptr be, nss_XbyY_args_t *argp);
108
109typedef enum {
110	NSS_LDAP_DB_NONE	= 0,
111	NSS_LDAP_DB_PUBLICKEY	= 1,
112	NSS_LDAP_DB_ETHERS	= 2
113} nss_ldap_db_type_t;
114
115struct ldap_backend {
116	ldap_backend_op_t	*ops;
117	nss_dbop_t		nops;
118	char			*tablename;
119	void			*enumcookie;
120	char			*filter;
121	char			*sortattr;
122	int			setcalled;
123	const char		**attrs;
124	ns_ldap_result_t	*result;
125	fnf			ldapobj2str;
126	void			*netgroup_cookie;
127	void			*services_cookie;
128	char			*toglue;
129	char			*buffer;
130	int			buflen;
131	nss_ldap_db_type_t	db_type;
132};
133
134extern nss_status_t	_nss_ldap_destr(ldap_backend_ptr be, void *a);
135extern nss_status_t	_nss_ldap_endent(ldap_backend_ptr be, void *a);
136extern nss_status_t	_nss_ldap_setent(ldap_backend_ptr be, void *a);
137extern nss_status_t	_nss_ldap_getent(ldap_backend_ptr be, void *a);
138nss_backend_t		*_nss_ldap_constr(ldap_backend_op_t ops[], int nops,
139			char *tablename, const char **attrs, fnf ldapobj2str);
140extern nss_status_t	_nss_ldap_nocb_lookup(ldap_backend_ptr be,
141			nss_XbyY_args_t *argp, char *database,
142			char *searchfilter, char *domain,
143			int (*init_filter_cb)(
144				const ns_ldap_search_desc_t *desc,
145				char **realfilter, const void *userdata),
146			const void *userdata);
147extern nss_status_t	_nss_ldap_lookup(ldap_backend_ptr be,
148			nss_XbyY_args_t *argp, char *database,
149			char *searchfilter, char *domain,
150			int (*init_filter_cb)(
151				const ns_ldap_search_desc_t *desc,
152				char **realfilter, const void *userdata),
153			const void *userdata);
154extern void		_clean_ldap_backend(ldap_backend_ptr be);
155
156extern ns_ldap_attr_t *getattr(ns_ldap_result_t *result, int i);
157extern const char *_strip_quotes(char *ipaddress);
158extern int __nss2herrno(nss_status_t nsstat);
159extern int propersubdomain(char *domain, char *subdomain);
160extern int chophostdomain(char *string, char *host, char *domain);
161extern char *_get_domain_name(char *cdn);
162extern int _merge_SSD_filter(const ns_ldap_search_desc_t *desc,
163	char **realfilter, const void *userdata);
164extern int _ldap_filter_name(char *filter_name, const char *name,
165	int filter_name_size);
166
167extern void _nss_services_cookie_free(void **cookieP);
168extern nss_status_t switch_err(int rc, ns_ldap_error_t *error);
169
170#ifdef DEBUG
171extern int printresult(ns_ldap_result_t *result);
172#endif /* DEBUG */
173
174#ifdef	__cplusplus
175}
176#endif
177
178#endif	/* _LDAP_COMMON_H */
179