xref: /freebsd/lib/libc/net/eui64.c (revision fcb560670601b2a4d87bb31d7531c8dcc37ee71b)
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 	return (0);
136 
137 bad:
138 	free(linehead);
139 	return (-1);
140 }
141 
142 /*
143  * Convert an ASCII representation of an EUI-64 to binary form.
144  */
145 int
146 eui64_aton(const char *a, struct eui64 *e)
147 {
148 	int i;
149 	unsigned int o0, o1, o2, o3, o4, o5, o6, o7;
150 
151 	/* canonical form */
152 	i = sscanf(a, "%x-%x-%x-%x-%x-%x-%x-%x",
153 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
154 	if (i == EUI64_LEN)
155 		goto good;
156 	/* ethernet form */
157 	i = sscanf(a, "%x:%x:%x:%x:%x:%x:%x:%x",
158 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
159 	if (i == EUI64_LEN)
160 		goto good;
161 	/* classic fwcontrol/dconschat form */
162 	i = sscanf(a, "0x%2x%2x%2x%2x%2x%2x%2x%2x",
163 	    &o0, &o1, &o2, &o3, &o4, &o5, &o6, &o7);
164 	if (i == EUI64_LEN)
165 		goto good;
166 	/* MAC format (-) */
167 	i = sscanf(a, "%x-%x-%x-%x-%x-%x",
168 	    &o0, &o1, &o2, &o5, &o6, &o7);
169 	if (i == 6) {
170 		o3 = 0xff;
171 		o4 = 0xfe;
172 		goto good;
173 	}
174 	/* MAC format (:) */
175 	i = sscanf(a, "%x:%x:%x:%x:%x:%x",
176 	    &o0, &o1, &o2, &o5, &o6, &o7);
177 	if (i == 6) {
178 		o3 = 0xff;
179 		o4 = 0xfe;
180 		goto good;
181 	}
182 
183 	return (-1);
184 
185 good:
186         e->octet[0]=o0;
187 	e->octet[1]=o1;
188 	e->octet[2]=o2;
189 	e->octet[3]=o3;
190 	e->octet[4]=o4;
191 	e->octet[5]=o5;
192 	e->octet[6]=o6;
193 	e->octet[7]=o7;
194 
195         return (0);
196 }
197 
198 /*
199  * Convert a binary representation of an EUI-64 to an ASCII string.
200  */
201 int
202 eui64_ntoa(const struct eui64 *id, char *a, size_t len)
203 {
204         int i;
205 
206         i = snprintf(a, len, "%02x-%02x-%02x-%02x-%02x-%02x-%02x-%02x",
207 	    id->octet[0], id->octet[1], id->octet[2], id->octet[3],
208 	    id->octet[4], id->octet[5], id->octet[6], id->octet[7]);
209         if (i < 23 || i >= len)
210                 return (-1);
211         return (0);
212 }
213 
214 /*
215  * Map an EUI-64 to a hostname. Use either /etc/eui64 or NIS/YP.
216  */
217 int
218 eui64_ntohost(char *hostname, size_t len, const struct eui64 *id)
219 {
220 	FILE *fp;
221 	char buf[BUFSIZ + 2];
222 	struct eui64 local_eui64;
223 	char local_host[MAXHOSTNAMELEN];
224 #ifdef YP
225 	char *result;
226 	int resultlen;
227 	char eui64_a[24];
228 	char *yp_domain;
229 #endif
230 	if ((fp = fopen(_PATH_EUI64, "re")) == NULL)
231 		return (1);
232 
233 	while (fgets(buf,BUFSIZ,fp)) {
234 		if (buf[0] == '#')
235 			continue;
236 #ifdef YP
237 		if (buf[0] == '+') {
238 			if (yp_get_default_domain(&yp_domain))
239 				continue;
240 			eui64_ntoa(id, eui64_a, sizeof(eui64_a));
241 			if (yp_match(yp_domain, "eui64.byid", eui64_a,
242 				strlen(eui64_a), &result, &resultlen)) {
243 				continue;
244 			}
245 			strncpy(buf, result, resultlen);
246 			buf[resultlen] = '\0';
247 			free(result);
248 		}
249 #endif
250 		if (eui64_line(buf, &local_eui64, local_host,
251 		    sizeof(local_host)) == 0) {
252 			if (bcmp(&local_eui64.octet[0],
253 				&id->octet[0], EUI64_LEN) == 0) {
254 			/* We have a match */
255 				strcpy(hostname, local_host);
256 				fclose(fp);
257 				return(0);
258 			}
259 		}
260 	}
261 	fclose(fp);
262 	return (1);
263 }
264 
265 /*
266  * Map a hostname to an EUI-64 using /etc/eui64 or NIS/YP.
267  */
268 int
269 eui64_hostton(const char *hostname, struct eui64 *id)
270 {
271 	FILE *fp;
272 	char buf[BUFSIZ + 2];
273 	struct eui64 local_eui64;
274 	char local_host[MAXHOSTNAMELEN];
275 #ifdef YP
276 	char *result;
277 	int resultlen;
278 	char *yp_domain;
279 #endif
280 	if ((fp = fopen(_PATH_EUI64, "re")) == NULL)
281 		return (1);
282 
283 	while (fgets(buf,BUFSIZ,fp)) {
284 		if (buf[0] == '#')
285 			continue;
286 #ifdef YP
287 		if (buf[0] == '+') {
288 			if (yp_get_default_domain(&yp_domain))
289 				continue;
290 			if (yp_match(yp_domain, "eui64.byname", hostname,
291 				strlen(hostname), &result, &resultlen)) {
292 				continue;
293 			}
294 			strncpy(buf, result, resultlen);
295 			buf[resultlen] = '\0';
296 			free(result);
297 		}
298 #endif
299 		if (eui64_line(buf, &local_eui64, local_host,
300 		    sizeof(local_host)) == 0) {
301 			if (strcmp(hostname, local_host) == 0) {
302 				/* We have a match */
303 				bcopy(&local_eui64, id, sizeof(struct eui64));
304 				fclose(fp);
305 				return(0);
306 			}
307 		}
308 	}
309 	fclose(fp);
310 	return (1);
311 }
312