about summary refs log tree commit diff
path: root/nis/rpcsvc/nislib.h
blob: c993bac5e82b316acf95f9721c1b2d7ac74d7fa7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/* Copyright (C) 1997, 1998, 1999, 2006 Free Software Foundation, Inc.
   This file is part of the GNU C Library.
   Contributed by Thorsten Kukuk <kukuk@suse.de>, 1997.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA.  */

#ifndef	__RPCSVC_NISLIB_H__
#define	__RPCSVC_NISLIB_H__

#include <features.h>

__BEGIN_DECLS

typedef const char *const_nis_name;

/* nis_names: These functions are used to locate and manipulate all NIS+
 * objects except the NIS+ entry objects.
 *
 * nis_lookup (name, flags) resolves a NIS+ name and returns a copy of
 *                          that object  from a NIS+ server.
 *    const nis_name name: name of the object to be resolved
 *    unsigned int flags: logically ORing zero or more flags (FOLLOW_LINKS,
 *                          HARD_LOOKUP, [NO_CACHE], MASTER_ONLY, EXPAND_NAME)
 *
 * nis_add (name, obj) adds objects to the NIS+ namespace.
 *    const nis_name name: fully qualified NIS+ name.
 *    const nis_object *obj: object members zo_name and zo_domain will be
 *                           constructed from name.
 *
 * nis_remove (name, obj) removes objects from the NIS+ namespace.
 *    const nis_name name: fully qualified NIS+ name.
 *    const nis_object *obj: if not NULL, it is assumed to point to a copy
 *                           of the object being removed. In this case, if
 *                           the object on the server does not have the same
 *                           object identifier as the  object  being  passed,
 *                           the operation will fail with the NIS_NOTSAMEOBJ
 *                           error.
 *
 * nis_modify (name, obj) can change specific attributes of an object
 *                        that already exists in the namespace.
 */
extern nis_result *nis_lookup (const_nis_name name, unsigned int flags)
     __THROW;
extern nis_result *nis_add (const_nis_name name, const nis_object *obj)
     __THROW;
extern nis_result *nis_remove (const_nis_name name,
			       const nis_object *obj) __THROW;
extern nis_result *nis_modify (const_nis_name name,
			       const nis_object *obj) __THROW;

/* nis_tables: These functions are used to search and modify NIS+ tables.
 *
 * nis_list (table_name, flags, callback(table_name, obj, userdata), userdata)
 *           search a table in the NIS+ namespace.
 *    const nis_name table_name: indexed name ([xx=yy],table.dir)
 *    unsigned int flags: logically ORing one or more flags (FOLLOW_LINKS,
 *                      [FOLLOW_PATH], HARD_LOOKUP, [ALL_RESULTS], [NO_CACHE],
 *                      MASTER_ONLY, EXPAND_NAME, RETURN_RESULT)
 *    callback(): callback is an optional pointer to a function that will
 *                process the ENTRY type objects that are returned from the
 *                search. If this pointer is NULL, then all entries that match
 *                the search criteria are returned in the nis_result structure,
 *                otherwise  this  function  will  be  called once for each
 *                entry returned.
 *    void *userdata: passed to callback function along with the returned
 *                    entry object.
 *
 * nis_add_entry (table_name, obj, flags) will add the NIS+ object to the
 *                                        NIS+ table_name.
 *    const nis_name table_name
 *    const nis_object *obj
 *    unsigned int flags: 0, ADD_OVERWRITE, RETURN_RESULT
 *
 * nis_modify_entry (name, obj, flags) modifies an object identified by name.
 *    const nis_name name: object identifier
 *    const nis_object *obj: should point to an entry with the EN_MODIFIED
 *                           flag set in each column that contains new
 *                           information.
 *    unsigned int flags: 0, MOD_SAMEOBJ, RETURN_RESULT
 *
 * nis_remove_entry (table_name, obj, flags) removes a set of entries
 *                                 identified by table_name from the table.
 *    const nis_name table_name: indexed NIS+ name
 *    const nis_object *obj: if obj is non-null, it is presumed to point to
 *                           a cached copy of the entry. When the removal is
 *                           attempted, and the object that would be removed
 *                           is not the same as the cached object pointed to
 *                           by object then the operation will fail with an
 *                           NIS_NOTSAMEOBJ error
 *    unsigned int flags: 0, REM_MULTIPLE
 *
 * nis_first_entry (table_name) fetches entries from a table one at a time.
 *    const nis_name table_name
 *
 * nis_next_entry (table_name, cookie) retrieves the "next" entry from a
 *                                     table specified by table_name.
 *    const nis_name table_name:
 *    const netobj *cookie: The value of cookie from the nis_result structure
 *                          form the previous call.
 */
extern nis_result *nis_list (const_nis_name name, unsigned int flags,
			     int (*callback)(const_nis_name table_name,
					     const nis_object *obj,
					     const void *userdata),
			     const void *userdata) __THROW;
extern nis_result *nis_add_entry (const_nis_name table_name,
				  const nis_object *obj,
				  unsigned int flags) __THROW;
extern nis_result *nis_modify_entry (const_nis_name name,
				     const nis_object *obj,
				     unsigned int flags) __THROW;
extern nis_result *nis_remove_entry (const_nis_name table_name,
				     const nis_object *obj,
				     unsigned int flags) __THROW;
extern nis_result *nis_first_entry (const_nis_name table_name) __THROW;
extern nis_result *nis_next_entry (const_nis_name table_name,
				   const netobj *cookie) __THROW;
/*
** nis_server
*/
extern nis_error nis_mkdir (const_nis_name dirname,
			    const nis_server *machine) __THROW;
extern nis_error nis_rmdir (const_nis_name dirname,
			    const nis_server *machine) __THROW;
extern nis_error nis_servstate (const nis_server *machine,
				const nis_tag *tags, int numtags,
				nis_tag **result) __THROW;
extern nis_error nis_stats (const nis_server *machine,
			    const nis_tag *tags, int numtags,
			    nis_tag **result) __THROW;
extern void nis_freetags (nis_tag *tags, int numtags) __THROW;
extern nis_server **nis_getservlist (const_nis_name dirname) __THROW;
extern void nis_freeservlist (nis_server **machines) __THROW;

/*
** nis_subr
*/
extern nis_name nis_leaf_of (const_nis_name name) __THROW;
extern nis_name nis_leaf_of_r (const_nis_name name, char *buffer,
			       size_t buflen) __THROW;
extern nis_name nis_name_of (const_nis_name name) __THROW;
extern nis_name nis_name_of_r (const_nis_name name, char *buffer,
			       size_t buflen) __THROW;
extern nis_name nis_domain_of (const_nis_name name) __THROW;
extern nis_name nis_domain_of_r (const_nis_name name, char *buffer,
				 size_t buflen) __THROW;
extern nis_name *nis_getnames (const_nis_name name) __THROW;
extern void nis_freenames (nis_name *namelist) __THROW;
extern name_pos nis_dir_cmp (const_nis_name n1, const_nis_name n2) __THROW;
extern nis_object *nis_clone_object (const nis_object *src,
				     nis_object *dest) __THROW;
extern void nis_destroy_object (nis_object *obj) __THROW;
extern void nis_print_object (const nis_object *obj) __THROW;

/*
** nis_local_names
*/
extern nis_name nis_local_group (void) __THROW;
extern nis_name nis_local_directory (void) __THROW;
extern nis_name nis_local_principal (void) __THROW;
extern nis_name nis_local_host (void) __THROW;

/*
** nis_error
*/
extern const char *nis_sperrno (const nis_error status) __THROW;
extern void nis_perror (const nis_error status, const char *label) __THROW;
extern void nis_lerror (const nis_error status, const char *label) __THROW;
extern char *nis_sperror (const nis_error status, const char *label) __THROW;
extern char *nis_sperror_r (const nis_error status, const char *label,
			    char *buffer, size_t buflen) __THROW;
/*
** nis_groups
*/
extern bool_t nis_ismember (const_nis_name principal,
			    const_nis_name group) __THROW;
extern nis_error nis_addmember (const_nis_name member,
				const_nis_name group) __THROW;
extern nis_error nis_removemember (const_nis_name member,
				   const_nis_name group) __THROW;
extern nis_error nis_creategroup (const_nis_name group,
				  unsigned int flags) __THROW;
extern nis_error nis_destroygroup (const_nis_name group) __THROW;
extern void nis_print_group_entry (const_nis_name group) __THROW;
extern nis_error nis_verifygroup (const_nis_name group) __THROW;

/*
** nis_ping
*/
extern void nis_ping (const_nis_name dirname, uint32_t utime,
		      const nis_object *dirobj) __THROW;
extern nis_result *nis_checkpoint (const_nis_name dirname) __THROW;

/*
** nis_print (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
*/
extern void nis_print_result (const nis_result *result) __THROW;
extern void nis_print_rights (unsigned int rights) __THROW;
extern void nis_print_directory (const directory_obj *dirobj) __THROW;
extern void nis_print_group (const group_obj *grpobj) __THROW;
extern void nis_print_table (const table_obj *tblobj) __THROW;
extern void nis_print_link (const link_obj *lnkobj) __THROW;
extern void nis_print_entry (const entry_obj *enobj) __THROW;

/*
** nis_file (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
*/
extern directory_obj *readColdStartFile (void) __THROW;
extern bool_t writeColdStartFile (const directory_obj *dirobj) __THROW;
extern nis_object *nis_read_obj (const char *obj) __THROW;
extern bool_t nis_write_obj (const char *file, const nis_object *obj) __THROW;

/*
** nis_clone - (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
*/
extern directory_obj *nis_clone_directory (const directory_obj *src,
					   directory_obj *dest) __THROW;
extern nis_result *nis_clone_result (const nis_result *src,
				     nis_result *dest) __THROW;

/* nis_free - nis_freeresult */
extern void nis_freeresult (nis_result *result) __THROW;
/* (XXX THE FOLLOWING ARE INTERNAL FUNCTIONS, SHOULD NOT BE USED !!) */
extern void nis_free_request (ib_request *req) __THROW;
extern void nis_free_directory (directory_obj *dirobj) __THROW;
extern void nis_free_object (nis_object *obj) __THROW;

/* (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!) */
extern nis_name __nis_default_owner (char *) __THROW;
extern nis_name __nis_default_group (char *) __THROW;
extern uint32_t __nis_default_ttl (char *) __THROW;
extern unsigned int __nis_default_access (char *, unsigned int) __THROW;
extern fd_result *__nis_finddirectory (directory_obj *, const_nis_name) __THROW;
extern void __free_fdresult (fd_result *) __THROW;
extern uint32_t __nis_hash (const void *keyarg, register size_t len) __THROW;

/* NIS+ cache locking */
extern int __nis_lock_cache (void) __THROW;
extern int __nis_unlock_cache (void) __THROW;

/* (XXX INTERNAL FUNCTIONS, ONLY FOR rpc.nisd AND glibc !!) */
#if defined (NIS_INTERNAL) || defined (_LIBC)

struct dir_binding
{
  CLIENT *clnt;                  /* RPC CLIENT handle */
  nis_server *server_val;        /* List of servers */
  unsigned int server_len;       /* # of servers */
  unsigned int server_used;      /* Which server we are bind in the moment ? */
  unsigned int current_ep;       /* Which endpoint of the server are in use? */
  unsigned int trys;             /* How many server have we tried ? */
  unsigned int class;            /* From which class is server_val ? */
  bool_t master_only;            /* Is only binded to the master */
  bool_t use_auth;               /* Do we use AUTH ? */
  bool_t use_udp;                /* Do we use UDP ? */
  struct sockaddr_in addr;       /* Server's IP address */
  int socket;                    /* Server's local socket */
};
typedef struct dir_binding dir_binding;

extern nis_error __nisbind_create (dir_binding *, const nis_server *,
				   unsigned int, unsigned int) __THROW;
extern nis_error __nisbind_connect (dir_binding *) __THROW;
extern nis_error __nisbind_next (dir_binding *) __THROW;
extern void __nisbind_destroy (dir_binding *) __THROW;
extern nis_error __nisfind_server (const_nis_name, int, directory_obj **)
     __THROW;

#endif

__END_DECLS

#endif	/* __RPCSVC_NISLIB_H__ */