xref: /freebsd/lib/libc/rpc/getnetpath.c (revision 57718be8fa0bd5edc11ab9a72e68cc71982939a6)
1 /*	$NetBSD: getnetpath.c,v 1.3 2000/07/06 03:10:34 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2009, Sun Microsystems, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * - Redistributions of source code must retain the above copyright notice,
10  *   this list of conditions and the following disclaimer.
11  * - Redistributions in binary form must reproduce the above copyright notice,
12  *   this list of conditions and the following disclaimer in the documentation
13  *   and/or other materials provided with the distribution.
14  * - Neither the name of Sun Microsystems, Inc. nor the names of its
15  *   contributors may be used to endorse or promote products derived
16  *   from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #if defined(LIBC_SCCS) && !defined(lint)
32 static char sccsid[] = "@(#)getnetpath.c	1.11 91/12/19 SMI";
33 #endif
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
36 
37 /*
38  * Copyright (c) 1989 by Sun Microsystems, Inc.
39  */
40 
41 #include "namespace.h"
42 #include <stdio.h>
43 #include <errno.h>
44 #include <netconfig.h>
45 #include <stdlib.h>
46 #include <string.h>
47 #include <syslog.h>
48 #include "un-namespace.h"
49 
50 /*
51  * internal structure to keep track of a netpath "session"
52  */
53 struct netpath_chain {
54     struct netconfig *ncp;  /* an nconf entry */
55     struct netpath_chain *nchain_next;	/* next nconf entry allocated */
56 };
57 
58 
59 struct netpath_vars {
60     int   valid;	    /* token that indicates a valid netpath_vars */
61     void *nc_handlep;	    /* handle for current netconfig "session" */
62     char *netpath;	    /* pointer to current view-point in NETPATH */
63     char *netpath_start;    /* pointer to start of our copy of NETPATH */
64     struct netpath_chain *ncp_list;  /* list of nconfs allocated this session*/
65 };
66 
67 #define NP_VALID	0xf00d
68 #define NP_INVALID	0
69 
70 char *_get_next_token(char *, int);
71 
72 
73 /*
74  * A call to setnetpath() establishes a NETPATH "session".  setnetpath()
75  * must be called before the first call to getnetpath().  A "handle" is
76  * returned to distinguish the session; this handle should be passed
77  * subsequently to getnetpath().  (Handles are used to allow for nested calls
78  * to setnetpath()).
79  * If setnetpath() is unable to establish a session (due to lack of memory
80  * resources, or the absence of the /etc/netconfig file), a NULL pointer is
81  * returned.
82  */
83 
84 void *
85 setnetpath()
86 {
87 
88     struct netpath_vars *np_sessionp;   /* this session's variables */
89     char *npp;				/* NETPATH env variable */
90 
91 #ifdef MEM_CHK
92     malloc_debug(1);
93 #endif
94 
95     if ((np_sessionp =
96 	(struct netpath_vars *)malloc(sizeof (struct netpath_vars))) == NULL) {
97 	return (NULL);
98     }
99     if ((np_sessionp->nc_handlep = setnetconfig()) == NULL) {
100 	syslog (LOG_ERR, "rpc: failed to open " NETCONFIG);
101 	goto failed;
102     }
103     np_sessionp->valid = NP_VALID;
104     np_sessionp->ncp_list = NULL;
105     if ((npp = getenv(NETPATH)) == NULL) {
106 	np_sessionp->netpath = NULL;
107     } else {
108 	(void) endnetconfig(np_sessionp->nc_handlep);/* won't need nc session*/
109 	np_sessionp->nc_handlep = NULL;
110 	if ((np_sessionp->netpath = malloc(strlen(npp)+1)) == NULL)
111 		goto failed;
112 	else {
113 	    (void) strcpy(np_sessionp->netpath, npp);
114 	}
115     }
116     np_sessionp->netpath_start = np_sessionp->netpath;
117     return ((void *)np_sessionp);
118 
119 failed:
120     free(np_sessionp);
121     return (NULL);
122 }
123 
124 /*
125  * When first called, getnetpath() returns a pointer to the netconfig
126  * database entry corresponding to the first valid NETPATH component.  The
127  * netconfig entry is formatted as a struct netconfig.
128  * On each subsequent call, getnetpath returns a pointer to the netconfig
129  * entry that corresponds to the next valid NETPATH component.  getnetpath
130  * can thus be used to search the netconfig database for all networks
131  * included in the NETPATH variable.
132  * When NETPATH has been exhausted, getnetpath() returns NULL.  It returns
133  * NULL and sets errno in case of an error (e.g., setnetpath was not called
134  * previously).
135  * getnetpath() silently ignores invalid NETPATH components.  A NETPATH
136  * compnent is invalid if there is no corresponding entry in the netconfig
137  * database.
138  * If the NETPATH variable is unset, getnetpath() behaves as if NETPATH
139  * were set to the sequence of default or visible networks in the netconfig
140  * database, in the order in which they are listed.
141  */
142 
143 struct netconfig *
144 getnetpath(handlep)
145     void *handlep;
146 {
147     struct netpath_vars *np_sessionp = (struct netpath_vars *)handlep;
148     struct netconfig *ncp = NULL;   /* temp. holds a netconfig session */
149     struct netpath_chain *chainp;   /* holds chain of ncp's we alloc */
150     char  *npp;		/* holds current NETPATH */
151 
152     if (np_sessionp == NULL || np_sessionp->valid != NP_VALID) {
153 	errno = EINVAL;
154 	return (NULL);
155     }
156     if (np_sessionp->netpath_start == NULL) {	/* NETPATH was not set */
157 	do {                /* select next visible network */
158 	    if (np_sessionp->nc_handlep == NULL) {
159 		np_sessionp->nc_handlep = setnetconfig();
160 		if (np_sessionp->nc_handlep == NULL)
161 		    syslog (LOG_ERR, "rpc: failed to open " NETCONFIG);
162 	    }
163 	    if ((ncp = getnetconfig(np_sessionp->nc_handlep)) == NULL) {
164 		return(NULL);
165 	    }
166 	} while ((ncp->nc_flag & NC_VISIBLE) == 0);
167 	return (ncp);
168     }
169     /*
170      * Find first valid network ID in netpath.
171      */
172     while ((npp = np_sessionp->netpath) != NULL && strlen(npp) != 0) {
173 	np_sessionp->netpath = _get_next_token(npp, ':');
174     	/*
175     	 * npp is a network identifier.
176 	 */
177 	if ((ncp = getnetconfigent(npp)) != NULL) {
178 	    chainp = (struct netpath_chain *)	/* cobble alloc chain entry */
179 		    malloc(sizeof (struct netpath_chain));
180 	    chainp->ncp = ncp;
181 	    chainp->nchain_next = NULL;
182 	    if (np_sessionp->ncp_list == NULL) {
183 		np_sessionp->ncp_list = chainp;
184 	    } else {
185 		np_sessionp->ncp_list->nchain_next = chainp;
186 	    }
187 	    return (ncp);
188 	}
189 	/* couldn't find this token in the database; go to next one. */
190     }
191     return (NULL);
192 }
193 
194 /*
195  * endnetpath() may be called to unbind NETPATH when processing is complete,
196  * releasing resources for reuse.  It returns 0 on success and -1 on failure
197  * (e.g. if setnetpath() was not called previously.
198  */
199 int
200 endnetpath(handlep)
201     void *handlep;
202 {
203     struct netpath_vars *np_sessionp = (struct netpath_vars *)handlep;
204     struct netpath_chain *chainp, *lastp;
205 
206     if (np_sessionp == NULL || np_sessionp->valid != NP_VALID) {
207 	errno = EINVAL;
208 	return (-1);
209     }
210     if (np_sessionp->nc_handlep != NULL)
211 	endnetconfig(np_sessionp->nc_handlep);
212     if (np_sessionp->netpath_start != NULL)
213 	free(np_sessionp->netpath_start);
214     for (chainp = np_sessionp->ncp_list; chainp != NULL;
215 	    lastp=chainp, chainp=chainp->nchain_next, free(lastp)) {
216 	freenetconfigent(chainp->ncp);
217     }
218     free(np_sessionp);
219 #ifdef MEM_CHK
220     if (malloc_verify() == 0) {
221 	fprintf(stderr, "memory heap corrupted in endnetpath\n");
222 	exit(1);
223     }
224 #endif
225     return (0);
226 }
227 
228 
229 
230 /*
231  * Returns pointer to the rest-of-the-string after the current token.
232  * The token itself starts at arg, and we null terminate it.  We return NULL
233  * if either the arg is empty, or if this is the last token.
234  */
235 
236 char *
237 _get_next_token(npp, token)
238 char *npp;		/* string */
239 int token;		/* char to parse string for */
240 {
241     char  *cp;		/* char pointer */
242     char  *np;		/* netpath pointer */
243     char  *ep;		/* escape pointer */
244 
245     if ((cp = strchr(npp, token)) == NULL) {
246 	return (NULL);
247     }
248     /*
249      * did find a token, but it might be escaped.
250      */
251     if ((cp > npp) && (cp[-1] == '\\')) {
252         /* if slash was also escaped, carry on, otherwise find next token */
253 	if ((cp > npp + 1) && (cp[-2] != '\\')) {
254 	    /* shift r-o-s  onto the escaped token */
255 	    strcpy(&cp[-1], cp);    /* XXX: overlapping string copy */
256 	    /*
257 	     * Do a recursive call.
258 	     * We don't know how many escaped tokens there might be.
259 	     */
260 	    return (_get_next_token(cp, token));
261 	}
262     }
263 
264     *cp++ = '\0';		/* null-terminate token */
265     /* get rid of any backslash escapes */
266     ep = npp;
267     while ((np = strchr(ep, '\\')) != 0) {
268 	if (np[1] == '\\')
269 	    np++;
270 	strcpy(np, (ep = &np[1]));  /* XXX: overlapping string copy */
271     }
272     return (cp);		/* return ptr to r-o-s */
273 }
274