xref: /freebsd/lib/libc/rpc/getnetpath.c (revision 8d20be1e22095c27faf8fe8b2f0d089739cc742e)
1 /*	$NetBSD: getnetpath.c,v 1.3 2000/07/06 03:10:34 christos Exp $	*/
2 
3 /*
4  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5  * unrestricted use provided that this legend is included on all tape
6  * media and as a part of the software program in whole or part.  Users
7  * may copy or modify Sun RPC without charge, but are not authorized
8  * to license or distribute it to anyone else except as part of a product or
9  * program developed by the user or with the express written consent of
10  * Sun Microsystems, Inc.
11  *
12  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
13  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
14  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
15  *
16  * Sun RPC is provided with no support and without any obligation on the
17  * part of Sun Microsystems, Inc. to assist in its use, correction,
18  * modification or enhancement.
19  *
20  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
21  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
22  * OR ANY PART THEREOF.
23  *
24  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
25  * or profits or other special, indirect and consequential damages, even if
26  * Sun has been advised of the possibility of such damages.
27  *
28  * Sun Microsystems, Inc.
29  * 2550 Garcia Avenue
30  * Mountain View, California  94043
31  */
32 
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char sccsid[] = "@(#)getnetpath.c	1.11 91/12/19 SMI";
35 #endif
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
38 
39 /*
40  * Copyright (c) 1989 by Sun Microsystems, Inc.
41  */
42 
43 #include "namespace.h"
44 #include <stdio.h>
45 #include <errno.h>
46 #include <netconfig.h>
47 #include <stdlib.h>
48 #include <string.h>
49 #include <syslog.h>
50 #include "un-namespace.h"
51 
52 /*
53  * internal structure to keep track of a netpath "session"
54  */
55 struct netpath_chain {
56     struct netconfig *ncp;  /* an nconf entry */
57     struct netpath_chain *nchain_next;	/* next nconf entry allocated */
58 };
59 
60 
61 struct netpath_vars {
62     int   valid;	    /* token that indicates a valid netpath_vars */
63     void *nc_handlep;	    /* handle for current netconfig "session" */
64     char *netpath;	    /* pointer to current view-point in NETPATH */
65     char *netpath_start;    /* pointer to start of our copy of NETPATH */
66     struct netpath_chain *ncp_list;  /* list of nconfs allocated this session*/
67 };
68 
69 #define NP_VALID	0xf00d
70 #define NP_INVALID	0
71 
72 char *_get_next_token(char *, int);
73 
74 
75 /*
76  * A call to setnetpath() establishes a NETPATH "session".  setnetpath()
77  * must be called before the first call to getnetpath().  A "handle" is
78  * returned to distinguish the session; this handle should be passed
79  * subsequently to getnetpath().  (Handles are used to allow for nested calls
80  * to setnetpath()).
81  * If setnetpath() is unable to establish a session (due to lack of memory
82  * resources, or the absence of the /etc/netconfig file), a NULL pointer is
83  * returned.
84  */
85 
86 void *
87 setnetpath()
88 {
89 
90     struct netpath_vars *np_sessionp;   /* this session's variables */
91     char *npp;				/* NETPATH env variable */
92 
93 #ifdef MEM_CHK
94     malloc_debug(1);
95 #endif
96 
97     if ((np_sessionp =
98 	(struct netpath_vars *)malloc(sizeof (struct netpath_vars))) == NULL) {
99 	return (NULL);
100     }
101     if ((np_sessionp->nc_handlep = setnetconfig()) == NULL) {
102 	syslog (LOG_ERR, "rpc: failed to open " NETCONFIG);
103 	goto failed;
104     }
105     np_sessionp->valid = NP_VALID;
106     np_sessionp->ncp_list = NULL;
107     if ((npp = getenv(NETPATH)) == NULL) {
108 	np_sessionp->netpath = NULL;
109     } else {
110 	(void) endnetconfig(np_sessionp->nc_handlep);/* won't need nc session*/
111 	np_sessionp->nc_handlep = NULL;
112 	if ((np_sessionp->netpath = malloc(strlen(npp)+1)) == NULL)
113 		goto failed;
114 	else {
115 	    (void) strcpy(np_sessionp->netpath, npp);
116 	}
117     }
118     np_sessionp->netpath_start = np_sessionp->netpath;
119     return ((void *)np_sessionp);
120 
121 failed:
122     free(np_sessionp);
123     return (NULL);
124 }
125 
126 /*
127  * When first called, getnetpath() returns a pointer to the netconfig
128  * database entry corresponding to the first valid NETPATH component.  The
129  * netconfig entry is formatted as a struct netconfig.
130  * On each subsequent call, getnetpath returns a pointer to the netconfig
131  * entry that corresponds to the next valid NETPATH component.  getnetpath
132  * can thus be used to search the netconfig database for all networks
133  * included in the NETPATH variable.
134  * When NETPATH has been exhausted, getnetpath() returns NULL.  It returns
135  * NULL and sets errno in case of an error (e.g., setnetpath was not called
136  * previously).
137  * getnetpath() silently ignores invalid NETPATH components.  A NETPATH
138  * compnent is invalid if there is no corresponding entry in the netconfig
139  * database.
140  * If the NETPATH variable is unset, getnetpath() behaves as if NETPATH
141  * were set to the sequence of default or visible networks in the netconfig
142  * database, in the order in which they are listed.
143  */
144 
145 struct netconfig *
146 getnetpath(handlep)
147     void *handlep;
148 {
149     struct netpath_vars *np_sessionp = (struct netpath_vars *)handlep;
150     struct netconfig *ncp = NULL;   /* temp. holds a netconfig session */
151     struct netpath_chain *chainp;   /* holds chain of ncp's we alloc */
152     char  *npp;		/* holds current NETPATH */
153 
154     if (np_sessionp == NULL || np_sessionp->valid != NP_VALID) {
155 	errno = EINVAL;
156 	return (NULL);
157     }
158     if (np_sessionp->netpath_start == NULL) {	/* NETPATH was not set */
159 	do {                /* select next visible network */
160 	    if (np_sessionp->nc_handlep == NULL) {
161 		np_sessionp->nc_handlep = setnetconfig();
162 		if (np_sessionp->nc_handlep == NULL)
163 		    syslog (LOG_ERR, "rpc: failed to open " NETCONFIG);
164 	    }
165 	    if ((ncp = getnetconfig(np_sessionp->nc_handlep)) == NULL) {
166 		return(NULL);
167 	    }
168 	} while ((ncp->nc_flag & NC_VISIBLE) == 0);
169 	return (ncp);
170     }
171     /*
172      * Find first valid network ID in netpath.
173      */
174     while ((npp = np_sessionp->netpath) != NULL && strlen(npp) != 0) {
175 	np_sessionp->netpath = _get_next_token(npp, ':');
176     	/*
177     	 * npp is a network identifier.
178 	 */
179 	if ((ncp = getnetconfigent(npp)) != NULL) {
180 	    chainp = (struct netpath_chain *)	/* cobble alloc chain entry */
181 		    malloc(sizeof (struct netpath_chain));
182 	    chainp->ncp = ncp;
183 	    chainp->nchain_next = NULL;
184 	    if (np_sessionp->ncp_list == NULL) {
185 		np_sessionp->ncp_list = chainp;
186 	    } else {
187 		np_sessionp->ncp_list->nchain_next = chainp;
188 	    }
189 	    return (ncp);
190 	}
191 	/* couldn't find this token in the database; go to next one. */
192     }
193     return (NULL);
194 }
195 
196 /*
197  * endnetpath() may be called to unbind NETPATH when processing is complete,
198  * releasing resources for reuse.  It returns 0 on success and -1 on failure
199  * (e.g. if setnetpath() was not called previously.
200  */
201 int
202 endnetpath(handlep)
203     void *handlep;
204 {
205     struct netpath_vars *np_sessionp = (struct netpath_vars *)handlep;
206     struct netpath_chain *chainp, *lastp;
207 
208     if (np_sessionp == NULL || np_sessionp->valid != NP_VALID) {
209 	errno = EINVAL;
210 	return (-1);
211     }
212     if (np_sessionp->nc_handlep != NULL)
213 	endnetconfig(np_sessionp->nc_handlep);
214     if (np_sessionp->netpath_start != NULL)
215 	free(np_sessionp->netpath_start);
216     for (chainp = np_sessionp->ncp_list; chainp != NULL;
217 	    lastp=chainp, chainp=chainp->nchain_next, free(lastp)) {
218 	freenetconfigent(chainp->ncp);
219     }
220     free(np_sessionp);
221 #ifdef MEM_CHK
222     if (malloc_verify() == 0) {
223 	fprintf(stderr, "memory heap corrupted in endnetpath\n");
224 	exit(1);
225     }
226 #endif
227     return (0);
228 }
229 
230 
231 
232 /*
233  * Returns pointer to the rest-of-the-string after the current token.
234  * The token itself starts at arg, and we null terminate it.  We return NULL
235  * if either the arg is empty, or if this is the last token.
236  */
237 
238 char *
239 _get_next_token(npp, token)
240 char *npp;		/* string */
241 int token;		/* char to parse string for */
242 {
243     char  *cp;		/* char pointer */
244     char  *np;		/* netpath pointer */
245     char  *ep;		/* escape pointer */
246 
247     if ((cp = strchr(npp, token)) == NULL) {
248 	return (NULL);
249     }
250     /*
251      * did find a token, but it might be escaped.
252      */
253     if ((cp > npp) && (cp[-1] == '\\')) {
254         /* if slash was also escaped, carry on, otherwise find next token */
255 	if ((cp > npp + 1) && (cp[-2] != '\\')) {
256 	    /* shift r-o-s  onto the escaped token */
257 	    strcpy(&cp[-1], cp);    /* XXX: overlapping string copy */
258 	    /*
259 	     * Do a recursive call.
260 	     * We don't know how many escaped tokens there might be.
261 	     */
262 	    return (_get_next_token(cp, token));
263 	}
264     }
265 
266     *cp++ = '\0';		/* null-terminate token */
267     /* get rid of any backslash escapes */
268     ep = npp;
269     while ((np = strchr(ep, '\\')) != 0) {
270 	if (np[1] == '\\')
271 	    np++;
272 	strcpy(np, (ep = &np[1]));  /* XXX: overlapping string copy */
273     }
274     return (cp);		/* return ptr to r-o-s */
275 }
276