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