xref: /freebsd/lib/libc/rpc/getnetpath.c (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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 	free(np_sessionp);
103 	syslog (LOG_ERR, "rpc: failed to open " NETCONFIG);
104 	goto failed;
105     }
106     np_sessionp->valid = NP_VALID;
107     np_sessionp->ncp_list = NULL;
108     if ((npp = getenv(NETPATH)) == NULL) {
109 	np_sessionp->netpath = NULL;
110     } else {
111 	(void) endnetconfig(np_sessionp->nc_handlep);/* won't need nc session*/
112 	np_sessionp->nc_handlep = NULL;
113 	if ((np_sessionp->netpath = malloc(strlen(npp)+1)) == NULL)
114 		goto failed;
115 	else {
116 	    (void) strcpy(np_sessionp->netpath, npp);
117 	}
118     }
119     np_sessionp->netpath_start = np_sessionp->netpath;
120     return ((void *)np_sessionp);
121 
122 failed:
123     free(np_sessionp);
124     return (NULL);
125 }
126 
127 /*
128  * When first called, getnetpath() returns a pointer to the netconfig
129  * database entry corresponding to the first valid NETPATH component.  The
130  * netconfig entry is formatted as a struct netconfig.
131  * On each subsequent call, getnetpath returns a pointer to the netconfig
132  * entry that corresponds to the next valid NETPATH component.  getnetpath
133  * can thus be used to search the netconfig database for all networks
134  * included in the NETPATH variable.
135  * When NETPATH has been exhausted, getnetpath() returns NULL.  It returns
136  * NULL and sets errno in case of an error (e.g., setnetpath was not called
137  * previously).
138  * getnetpath() silently ignores invalid NETPATH components.  A NETPATH
139  * compnent is invalid if there is no corresponding entry in the netconfig
140  * database.
141  * If the NETPATH variable is unset, getnetpath() behaves as if NETPATH
142  * were set to the sequence of default or visible networks in the netconfig
143  * database, in the order in which they are listed.
144  */
145 
146 struct netconfig *
147 getnetpath(handlep)
148     void *handlep;
149 {
150     struct netpath_vars *np_sessionp = (struct netpath_vars *)handlep;
151     struct netconfig *ncp = NULL;   /* temp. holds a netconfig session */
152     struct netpath_chain *chainp;   /* holds chain of ncp's we alloc */
153     char  *npp;		/* holds current NETPATH */
154 
155     if (np_sessionp == NULL || np_sessionp->valid != NP_VALID) {
156 	errno = EINVAL;
157 	return (NULL);
158     }
159     if (np_sessionp->netpath_start == NULL) {	/* NETPATH was not set */
160 	do {                /* select next visible network */
161 	    if (np_sessionp->nc_handlep == NULL) {
162 		np_sessionp->nc_handlep = setnetconfig();
163 		if (np_sessionp->nc_handlep == NULL)
164 		    syslog (LOG_ERR, "rpc: failed to open " NETCONFIG);
165 	    }
166 	    if ((ncp = getnetconfig(np_sessionp->nc_handlep)) == NULL) {
167 		return(NULL);
168 	    }
169 	} while ((ncp->nc_flag & NC_VISIBLE) == 0);
170 	return (ncp);
171     }
172     /*
173      * Find first valid network ID in netpath.
174      */
175     while ((npp = np_sessionp->netpath) != NULL && strlen(npp) != 0) {
176 	np_sessionp->netpath = _get_next_token(npp, ':');
177     	/*
178     	 * npp is a network identifier.
179 	 */
180 	if ((ncp = getnetconfigent(npp)) != NULL) {
181 	    chainp = (struct netpath_chain *)	/* cobble alloc chain entry */
182 		    malloc(sizeof (struct netpath_chain));
183 	    chainp->ncp = ncp;
184 	    chainp->nchain_next = NULL;
185 	    if (np_sessionp->ncp_list == NULL) {
186 		np_sessionp->ncp_list = chainp;
187 	    } else {
188 		np_sessionp->ncp_list->nchain_next = chainp;
189 	    }
190 	    return (ncp);
191 	}
192 	/* couldn't find this token in the database; go to next one. */
193     }
194     return (NULL);
195 }
196 
197 /*
198  * endnetpath() may be called to unbind NETPATH when processing is complete,
199  * releasing resources for reuse.  It returns 0 on success and -1 on failure
200  * (e.g. if setnetpath() was not called previously.
201  */
202 int
203 endnetpath(handlep)
204     void *handlep;
205 {
206     struct netpath_vars *np_sessionp = (struct netpath_vars *)handlep;
207     struct netpath_chain *chainp, *lastp;
208 
209     if (np_sessionp == NULL || np_sessionp->valid != NP_VALID) {
210 	errno = EINVAL;
211 	return (-1);
212     }
213     if (np_sessionp->nc_handlep != NULL)
214 	endnetconfig(np_sessionp->nc_handlep);
215     if (np_sessionp->netpath_start != NULL)
216 	free(np_sessionp->netpath_start);
217     for (chainp = np_sessionp->ncp_list; chainp != NULL;
218 	    lastp=chainp, chainp=chainp->nchain_next, free(lastp)) {
219 	freenetconfigent(chainp->ncp);
220     }
221     free(np_sessionp);
222 #ifdef MEM_CHK
223     if (malloc_verify() == 0) {
224 	fprintf(stderr, "memory heap corrupted in endnetpath\n");
225 	exit(1);
226     }
227 #endif
228     return (0);
229 }
230 
231 
232 
233 /*
234  * Returns pointer to the rest-of-the-string after the current token.
235  * The token itself starts at arg, and we null terminate it.  We return NULL
236  * if either the arg is empty, or if this is the last token.
237  */
238 
239 char *
240 _get_next_token(npp, token)
241 char *npp;		/* string */
242 int token;		/* char to parse string for */
243 {
244     char  *cp;		/* char pointer */
245     char  *np;		/* netpath pointer */
246     char  *ep;		/* escape pointer */
247 
248     if ((cp = strchr(npp, token)) == NULL) {
249 	return (NULL);
250     }
251     /*
252      * did find a token, but it might be escaped.
253      */
254     if ((cp > npp) && (cp[-1] == '\\')) {
255         /* if slash was also escaped, carry on, otherwise find next token */
256 	if ((cp > npp + 1) && (cp[-2] != '\\')) {
257 	    /* shift r-o-s  onto the escaped token */
258 	    strcpy(&cp[-1], cp);    /* XXX: overlapping string copy */
259 	    /*
260 	     * Do a recursive call.
261 	     * We don't know how many escaped tokens there might be.
262 	     */
263 	    return (_get_next_token(cp, token));
264 	}
265     }
266 
267     *cp++ = '\0';		/* null-terminate token */
268     /* get rid of any backslash escapes */
269     ep = npp;
270     while ((np = strchr(ep, '\\')) != 0) {
271 	if (np[1] == '\\')
272 	    np++;
273 	strcpy(np, (ep = &np[1]));  /* XXX: overlapping string copy */
274     }
275     return (cp);		/* return ptr to r-o-s */
276 }
277