xref: /freebsd/lib/libc/net/eui64.c (revision 22cf89c938886d14f5796fc49f9f020c23ea8eaf)
1 /*
2  * Copyright 2004 The Aerospace Corporation.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions, and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions, and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  The name of The Aerospace Corporation may not be used to endorse or
14  *     promote products derived from this software.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AEROSPACE CORPORATION "AS IS" AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AEROSPACE CORPORATION BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * Copyright (c) 1995
29  *	Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
30  *
31  * Redistribution and use in source and binary forms, with or without
32  * modification, are permitted provided that the following conditions
33  * are met:
34  * 1. Redistributions of source code must retain the above copyright
35  *    notice, this list of conditions and the following disclaimer.
36  * 2. Redistributions in binary form must reproduce the above copyright
37  *    notice, this list of conditions and the following disclaimer in the
38  *    documentation and/or other materials provided with the distribution.
39  * 3. All advertising materials mentioning features or use of this software
40  *    must display the following acknowledgement:
41  *	This product includes software developed by Bill Paul.
42  * 4. Neither the name of the author nor the names of any co-contributors
43  *    may be used to endorse or promote products derived from this software
44  *    without specific prior written permission.
45  *
46  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56  * SUCH DAMAGE.
57  *
58  * EUI-64 conversion and lookup routines
59  *
60  *
61  * Converted from ether_addr.c rev
62  * FreeBSD: src/lib/libc/net/eui64.c,v 1.15 2002/04/08 07:51:10 ru Exp
63  * by Brooks Davis
64  *
65  * Written by Bill Paul <wpaul@ctr.columbia.edu>
66  * Center for Telecommunications Research
67  * Columbia University, New York City
68  */
69 
70 #include <sys/cdefs.h>
71 #include <stdio.h>
72 #include <paths.h>
73 #include <sys/param.h>
74 #include <sys/eui64.h>
75 #include <string.h>
76 #include <stdlib.h>
77 #ifdef YP
78 #include <rpc/rpc.h>
79 #include <rpcsvc/yp_prot.h>
80 #include <rpcsvc/ypclnt.h>
81 #endif
82 
83 #ifndef _PATH_EUI64
84 #define _PATH_EUI64 "/etc/eui64"
85 #endif
86 
87 static int eui64_line(const char *l, struct eui64 *e, char *hostname,
88     size_t len);
89 
90 /*
91  * Parse a string of text containing an EUI-64 and hostname
92  * and separate it into its component parts.
93  */
94 static int
95 eui64_line(const char *l, struct eui64 *e, char *hostname, size_t len)
96 {
97 	char *line, *linehead, *cur;
98 
99 	linehead = strdup(l);
100 	if (linehead == NULL)
101 		return (-1);
102 	line = linehead;
103 
104 	/* Find and parse the EUI64 */
105 	while ((cur = strsep(&line, " \t\r\n")) != NULL) {
106 		if (*cur != '\0') {
107 			if (eui64_aton(cur, e) == 0)
108 				break;
109 			else
110 				goto bad;
111 		}
112 	}
113 
114 	/* Find the hostname */
115 	while ((cur = strsep(&line, " \t\r\n")) != NULL) {
116 		if (*cur != '\0') {
117 			if (strlcpy(hostname, cur, len) <= len)
118 				break;
119 			else
120 				goto bad;
121 		}
122 	}
123 
124 	/* Make sure what remains is either whitespace or a comment */
125 	while ((cur = strsep(&line, " \t\r\n")) != NULL) {
126 		if (*cur == '#')
127 			break;
128 		if (*cur != '\0')
129 			goto bad;
130 	}
131 
132 	free(linehead);
133 	return (0);
134 
135 bad:
136 	free(linehead);
137 	return (-1);
138 }
139 
140 /*
141  * Convert an ASCII representation of an EUI-64 to binary form.
142  */
143 int
144 eui64_aton(const char *a, struct eui64 *e)
145 {
146 	int i;
147 	unsigned int o0, o1, o2, o3, o4, o5, o6, o7;
148 
149 	/* canonical form */
150 	i = sscanf(a, "%x-%x-%x-%x-%x-%x-%x-%x",
151 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
152 	if (i == EUI64_LEN)
153 		goto good;
154 	/* ethernet form */
155 	i = sscanf(a, "%x:%x:%x:%x:%x:%x:%x:%x",
156 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
157 	if (i == EUI64_LEN)
158 		goto good;
159 	/* classic fwcontrol/dconschat form */
160 	i = sscanf(a, "0x%2x%2x%2x%2x%2x%2x%2x%2x",
161 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
162 	if (i == EUI64_LEN)
163 		goto good;
164 	/* MAC format (-) */
165 	i = sscanf(a, "%x-%x-%x-%x-%x-%x",
166 	    &o0, &o1, &o2, &o5, &o6, &o7);
167 	if (i == 6) {
168 		o3 = 0xff;
169 		o4 = 0xfe;
170 		goto good;
171 	}
172 	/* MAC format (:) */
173 	i = sscanf(a, "%x:%x:%x:%x:%x:%x",
174 	    &o0, &o1, &o2, &o5, &o6, &o7);
175 	if (i == 6) {
176 		o3 = 0xff;
177 		o4 = 0xfe;
178 		goto good;
179 	}
180 
181 	return (-1);
182 
183 good:
184         e->octet[0]=o0;
185 	e->octet[1]=o1;
186 	e->octet[2]=o2;
187 	e->octet[3]=o3;
188 	e->octet[4]=o4;
189 	e->octet[5]=o5;
190 	e->octet[6]=o6;
191 	e->octet[7]=o7;
192 
193         return (0);
194 }
195 
196 /*
197  * Convert a binary representation of an EUI-64 to an ASCII string.
198  */
199 int
200 eui64_ntoa(const struct eui64 *id, char *a, size_t len)
201 {
202         int i;
203 
204         i = snprintf(a, len, "%02x-%02x-%02x-%02x-%02x-%02x-%02x-%02x",
205 	    id->octet[0], id->octet[1], id->octet[2], id->octet[3],
206 	    id->octet[4], id->octet[5], id->octet[6], id->octet[7]);
207         if (i < 23 || i >= len)
208                 return (-1);
209         return (0);
210 }
211 
212 /*
213  * Map an EUI-64 to a hostname. Use either /etc/eui64 or NIS/YP.
214  */
215 int
216 eui64_ntohost(char *hostname, size_t len, const struct eui64 *id)
217 {
218 	FILE *fp;
219 	char buf[BUFSIZ + 2];
220 	struct eui64 local_eui64;
221 	char local_host[MAXHOSTNAMELEN];
222 #ifdef YP
223 	char *result;
224 	int resultlen;
225 	char eui64_a[24];
226 	char *yp_domain;
227 #endif
228 	if ((fp = fopen(_PATH_EUI64, "re")) == NULL)
229 		return (1);
230 
231 	while (fgets(buf,BUFSIZ,fp)) {
232 		if (buf[0] == '#')
233 			continue;
234 #ifdef YP
235 		if (buf[0] == '+') {
236 			if (yp_get_default_domain(&yp_domain))
237 				continue;
238 			eui64_ntoa(id, eui64_a, sizeof(eui64_a));
239 			if (yp_match(yp_domain, "eui64.byid", eui64_a,
240 				strlen(eui64_a), &result, &resultlen)) {
241 				continue;
242 			}
243 			strncpy(buf, result, resultlen);
244 			buf[resultlen] = '\0';
245 			free(result);
246 		}
247 #endif
248 		if (eui64_line(buf, &local_eui64, local_host,
249 		    sizeof(local_host)) == 0) {
250 			if (bcmp(&local_eui64.octet[0],
251 				&id->octet[0], EUI64_LEN) == 0) {
252 			/* We have a match */
253 				strcpy(hostname, local_host);
254 				fclose(fp);
255 				return(0);
256 			}
257 		}
258 	}
259 	fclose(fp);
260 	return (1);
261 }
262 
263 /*
264  * Map a hostname to an EUI-64 using /etc/eui64 or NIS/YP.
265  */
266 int
267 eui64_hostton(const char *hostname, struct eui64 *id)
268 {
269 	FILE *fp;
270 	char buf[BUFSIZ + 2];
271 	struct eui64 local_eui64;
272 	char local_host[MAXHOSTNAMELEN];
273 #ifdef YP
274 	char *result;
275 	int resultlen;
276 	char *yp_domain;
277 #endif
278 	if ((fp = fopen(_PATH_EUI64, "re")) == NULL)
279 		return (1);
280 
281 	while (fgets(buf,BUFSIZ,fp)) {
282 		if (buf[0] == '#')
283 			continue;
284 #ifdef YP
285 		if (buf[0] == '+') {
286 			if (yp_get_default_domain(&yp_domain))
287 				continue;
288 			if (yp_match(yp_domain, "eui64.byname", hostname,
289 				strlen(hostname), &result, &resultlen)) {
290 				continue;
291 			}
292 			strncpy(buf, result, resultlen);
293 			buf[resultlen] = '\0';
294 			free(result);
295 		}
296 #endif
297 		if (eui64_line(buf, &local_eui64, local_host,
298 		    sizeof(local_host)) == 0) {
299 			if (strcmp(hostname, local_host) == 0) {
300 				/* We have a match */
301 				bcopy(&local_eui64, id, sizeof(struct eui64));
302 				fclose(fp);
303 				return(0);
304 			}
305 		}
306 	}
307 	fclose(fp);
308 	return (1);
309 }
310