xref: /freebsd/lib/libc/net/eui64.c (revision b2d48be1bc7df45ddd13b143a160d0acb5a383c5)
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 __FBSDID("$FreeBSD$");
72 
73 #include <stdio.h>
74 #include <paths.h>
75 #include <sys/types.h>
76 #include <sys/eui64.h>
77 #include <string.h>
78 #include <stdlib.h>
79 #include <sys/param.h>
80 #ifdef YP
81 #include <rpc/rpc.h>
82 #include <rpcsvc/yp_prot.h>
83 #include <rpcsvc/ypclnt.h>
84 #endif
85 
86 #ifndef _PATH_EUI64
87 #define _PATH_EUI64 "/etc/eui64"
88 #endif
89 
90 static int eui64_line(const char *l, struct eui64 *e, char *hostname,
91     size_t len);
92 
93 /*
94  * Parse a string of text containing an EUI-64 and hostname
95  * and separate it into its component parts.
96  */
97 static int
98 eui64_line(const char *l, struct eui64 *e, char *hostname, size_t len)
99 {
100 	char *line, *linehead, *cur;
101 
102 	linehead = strdup(l);
103 	if (linehead == NULL)
104 		return (-1);
105 	line = linehead;
106 
107 	/* Find and parse the EUI64 */
108 	while ((cur = strsep(&line, " \t\r\n")) != NULL) {
109 		if (*cur != '\0') {
110 			if (eui64_aton(cur, e) == 0)
111 				break;
112 			else
113 				goto bad;
114 		}
115 	}
116 
117 	/* Find the hostname */
118 	while ((cur = strsep(&line, " \t\r\n")) != NULL) {
119 		if (*cur != '\0') {
120 			if (strlcpy(hostname, cur, len) <= len)
121 				break;
122 			else
123 				goto bad;
124 		}
125 	}
126 
127 	/* Make sure what remains is either whitespace or a comment */
128 	while ((cur = strsep(&line, " \t\r\n")) != NULL) {
129 		if (*cur == '#')
130 			break;
131 		if (*cur != '\0')
132 			goto bad;
133 	}
134 
135 	free(linehead);
136 	return (0);
137 
138 bad:
139 	free(linehead);
140 	return (-1);
141 }
142 
143 /*
144  * Convert an ASCII representation of an EUI-64 to binary form.
145  */
146 int
147 eui64_aton(const char *a, struct eui64 *e)
148 {
149 	int i;
150 	unsigned int o0, o1, o2, o3, o4, o5, o6, o7;
151 
152 	/* canonical form */
153 	i = sscanf(a, "%x-%x-%x-%x-%x-%x-%x-%x",
154 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
155 	if (i == EUI64_LEN)
156 		goto good;
157 	/* ethernet form */
158 	i = sscanf(a, "%x:%x:%x:%x:%x:%x:%x:%x",
159 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
160 	if (i == EUI64_LEN)
161 		goto good;
162 	/* classic fwcontrol/dconschat form */
163 	i = sscanf(a, "0x%2x%2x%2x%2x%2x%2x%2x%2x",
164 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
165 	if (i == EUI64_LEN)
166 		goto good;
167 	/* MAC format (-) */
168 	i = sscanf(a, "%x-%x-%x-%x-%x-%x",
169 	    &o0, &o1, &o2, &o5, &o6, &o7);
170 	if (i == 6) {
171 		o3 = 0xff;
172 		o4 = 0xfe;
173 		goto good;
174 	}
175 	/* MAC format (:) */
176 	i = sscanf(a, "%x:%x:%x:%x:%x:%x",
177 	    &o0, &o1, &o2, &o5, &o6, &o7);
178 	if (i == 6) {
179 		o3 = 0xff;
180 		o4 = 0xfe;
181 		goto good;
182 	}
183 
184 	return (-1);
185 
186 good:
187         e->octet[0]=o0;
188 	e->octet[1]=o1;
189 	e->octet[2]=o2;
190 	e->octet[3]=o3;
191 	e->octet[4]=o4;
192 	e->octet[5]=o5;
193 	e->octet[6]=o6;
194 	e->octet[7]=o7;
195 
196         return (0);
197 }
198 
199 /*
200  * Convert a binary representation of an EUI-64 to an ASCII string.
201  */
202 int
203 eui64_ntoa(const struct eui64 *id, char *a, size_t len)
204 {
205         int i;
206 
207         i = snprintf(a, len, "%02x-%02x-%02x-%02x-%02x-%02x-%02x-%02x",
208 	    id->octet[0], id->octet[1], id->octet[2], id->octet[3],
209 	    id->octet[4], id->octet[5], id->octet[6], id->octet[7]);
210         if (i < 23 || i >= len)
211                 return (-1);
212         return (0);
213 }
214 
215 /*
216  * Map an EUI-64 to a hostname. Use either /etc/eui64 or NIS/YP.
217  */
218 int
219 eui64_ntohost(char *hostname, size_t len, const struct eui64 *id)
220 {
221 	FILE *fp;
222 	char buf[BUFSIZ + 2];
223 	struct eui64 local_eui64;
224 	char local_host[MAXHOSTNAMELEN];
225 #ifdef YP
226 	char *result;
227 	int resultlen;
228 	char eui64_a[24];
229 	char *yp_domain;
230 #endif
231 	if ((fp = fopen(_PATH_EUI64, "re")) == NULL)
232 		return (1);
233 
234 	while (fgets(buf,BUFSIZ,fp)) {
235 		if (buf[0] == '#')
236 			continue;
237 #ifdef YP
238 		if (buf[0] == '+') {
239 			if (yp_get_default_domain(&yp_domain))
240 				continue;
241 			eui64_ntoa(id, eui64_a, sizeof(eui64_a));
242 			if (yp_match(yp_domain, "eui64.byid", eui64_a,
243 				strlen(eui64_a), &result, &resultlen)) {
244 				continue;
245 			}
246 			strncpy(buf, result, resultlen);
247 			buf[resultlen] = '\0';
248 			free(result);
249 		}
250 #endif
251 		if (eui64_line(buf, &local_eui64, local_host,
252 		    sizeof(local_host)) == 0) {
253 			if (bcmp(&local_eui64.octet[0],
254 				&id->octet[0], EUI64_LEN) == 0) {
255 			/* We have a match */
256 				strcpy(hostname, local_host);
257 				fclose(fp);
258 				return(0);
259 			}
260 		}
261 	}
262 	fclose(fp);
263 	return (1);
264 }
265 
266 /*
267  * Map a hostname to an EUI-64 using /etc/eui64 or NIS/YP.
268  */
269 int
270 eui64_hostton(const char *hostname, struct eui64 *id)
271 {
272 	FILE *fp;
273 	char buf[BUFSIZ + 2];
274 	struct eui64 local_eui64;
275 	char local_host[MAXHOSTNAMELEN];
276 #ifdef YP
277 	char *result;
278 	int resultlen;
279 	char *yp_domain;
280 #endif
281 	if ((fp = fopen(_PATH_EUI64, "re")) == NULL)
282 		return (1);
283 
284 	while (fgets(buf,BUFSIZ,fp)) {
285 		if (buf[0] == '#')
286 			continue;
287 #ifdef YP
288 		if (buf[0] == '+') {
289 			if (yp_get_default_domain(&yp_domain))
290 				continue;
291 			if (yp_match(yp_domain, "eui64.byname", hostname,
292 				strlen(hostname), &result, &resultlen)) {
293 				continue;
294 			}
295 			strncpy(buf, result, resultlen);
296 			buf[resultlen] = '\0';
297 			free(result);
298 		}
299 #endif
300 		if (eui64_line(buf, &local_eui64, local_host,
301 		    sizeof(local_host)) == 0) {
302 			if (strcmp(hostname, local_host) == 0) {
303 				/* We have a match */
304 				bcopy(&local_eui64, id, sizeof(struct eui64));
305 				fclose(fp);
306 				return(0);
307 			}
308 		}
309 	}
310 	fclose(fp);
311 	return (1);
312 }
313