1 /***********************************************************************
5 * pppd plugin for kernel-mode PPPoE on Linux
7 * Copyright (C) 2001 by Roaring Penguin Software Inc., Michal Ostrowski
8 * and Jamal Hadi Salim.
10 * Much code and many ideas derived from pppoe plugin by Michal
11 * Ostrowski and Jamal Hadi Salim, which carries this copyright:
13 * Copyright 2000 Michal Ostrowski <mostrows@styx.uwaterloo.ca>,
14 * Jamal Hadi Salim <hadi@cyberus.ca>
15 * Borrows heavily from the PPPoATM plugin by Mitchell Blank Jr.,
16 * which is based in part on work from Jens Axboe and Paul Mackerras.
18 * This program is free software; you can redistribute it and/or
19 * modify it under the terms of the GNU General Public License
20 * as published by the Free Software Foundation; either version
21 * 2 of the License, or (at your option) any later version.
23 ***********************************************************************/
25 static char const RCSID[] =
26 "$Id: plugin.c,v 1.17 2008/06/15 04:35:50 paulus Exp $";
31 #include "pppd/pppd.h"
34 #include "pppd/ipcp.h"
36 /* #include "pppd/pathnames.h" */
38 #include <linux/types.h>
39 #include <sys/ioctl.h>
40 #include <sys/types.h>
41 #include <sys/socket.h>
49 #include <net/if_arp.h>
50 #include <linux/ppp_defs.h>
51 #include <linux/if_pppox.h>
57 #define _PATH_ETHOPT _ROOT_PATH "/etc/ppp/options."
59 char pppd_version[] = VERSION;
61 /* From sys-linux.c in pppd -- MUST FIX THIS! */
62 extern int new_style_driver;
64 char *pppd_pppoe_service = NULL;
65 static char *acName = NULL;
66 static char *existingSession = NULL;
67 int pppoe_verbose = 0;
68 static char *pppoe_reqd_mac = NULL;
69 unsigned char pppoe_reqd_mac_addr[6];
70 static char *pppoe_host_uniq;
71 static int pppoe_padi_timeout = PADI_TIMEOUT;
72 static int pppoe_padi_attempts = MAX_PADI_ATTEMPTS;
74 static int PPPoEDevnameHook(char *cmd, char **argv, int doit);
75 static option_t Options[] = {
76 { "device name", o_wild, (void *) &PPPoEDevnameHook,
78 OPT_DEVNAM | OPT_PRIVFIX | OPT_NOARG | OPT_A2STRVAL | OPT_STATIC,
80 { "pppoe-service", o_string, &pppd_pppoe_service,
81 "Desired PPPoE service name" },
82 { "rp_pppoe_service", o_string, &pppd_pppoe_service,
83 "Legacy alias for pppoe-service", OPT_ALIAS },
84 { "pppoe-ac", o_string, &acName,
85 "Desired PPPoE access concentrator name" },
86 { "rp_pppoe_ac", o_string, &acName,
87 "Legacy alias for pppoe-ac", OPT_ALIAS },
88 { "pppoe-sess", o_string, &existingSession,
89 "Attach to existing session (sessid:macaddr)" },
90 { "rp_pppoe_sess", o_string, &existingSession,
91 "Legacy alias for pppoe-sess", OPT_ALIAS },
92 { "pppoe-verbose", o_int, &pppoe_verbose,
93 "Be verbose about discovered access concentrators" },
94 { "rp_pppoe_verbose", o_int, &pppoe_verbose,
95 "Legacy alias for pppoe-verbose", OPT_ALIAS },
96 { "pppoe-mac", o_string, &pppoe_reqd_mac,
97 "Only connect to specified MAC address" },
98 { "pppoe-host-uniq", o_string, &pppoe_host_uniq,
99 "Set the Host-Uniq to the supplied hex string" },
100 { "host-uniq", o_string, &pppoe_host_uniq,
101 "Legacy alias for pppoe-host-uniq", OPT_ALIAS },
102 { "pppoe-padi-timeout", o_int, &pppoe_padi_timeout,
103 "Initial timeout for discovery packets in seconds" },
104 { "pppoe-padi-attempts", o_int, &pppoe_padi_attempts,
105 "Number of discovery attempts" },
108 int (*OldDevnameHook)(char *cmd, char **argv, int doit) = NULL;
109 static PPPoEConnection *conn = NULL;
111 /**********************************************************************
112 * %FUNCTION: PPPOEInitDevice
118 * Initializes PPPoE device.
119 ***********************************************************************/
121 PPPOEInitDevice(void)
123 conn = malloc(sizeof(PPPoEConnection));
125 novm("PPPoE session data");
127 memset(conn, 0, sizeof(PPPoEConnection));
128 conn->ifName = devnam;
129 conn->discoverySocket = -1;
130 conn->sessionSocket = -1;
131 conn->discoveryTimeout = pppoe_padi_timeout;
132 conn->discoveryAttempts = pppoe_padi_attempts;
136 /**********************************************************************
137 * %FUNCTION: PPPOEConnectDevice
141 * Non-negative if all goes well; -1 otherwise
143 * Connects PPPoE device.
144 ***********************************************************************/
146 PPPOEConnectDevice(void)
148 struct sockaddr_pppox sp;
152 /* Open session socket before discovery phase, to avoid losing session */
153 /* packets sent by peer just after PADS packet (noted on some Cisco */
154 /* server equipment). */
155 /* Opening this socket just before waitForPADS in the discovery() */
156 /* function would be more appropriate, but it would mess-up the code */
157 conn->sessionSocket = socket(AF_PPPOX, SOCK_STREAM, PX_PROTO_OE);
158 if (conn->sessionSocket < 0) {
159 error("Failed to create PPPoE socket: %m");
163 /* Restore configuration */
164 lcp_allowoptions[0].mru = conn->mtu = conn->storedmtu;
165 lcp_wantoptions[0].mru = conn->mru = conn->storedmru;
167 /* Update maximum MRU */
168 s = socket(AF_INET, SOCK_DGRAM, 0);
170 error("Can't get MTU for %s: %m", conn->ifName);
173 strlcpy(ifr.ifr_name, conn->ifName, sizeof(ifr.ifr_name));
174 if (ioctl(s, SIOCGIFMTU, &ifr) < 0) {
175 error("Can't get MTU for %s: %m", conn->ifName);
181 if (lcp_allowoptions[0].mru > ifr.ifr_mtu - TOTAL_OVERHEAD)
182 lcp_allowoptions[0].mru = conn->mtu = ifr.ifr_mtu - TOTAL_OVERHEAD;
183 if (lcp_wantoptions[0].mru > ifr.ifr_mtu - TOTAL_OVERHEAD)
184 lcp_wantoptions[0].mru = conn->mru = ifr.ifr_mtu - TOTAL_OVERHEAD;
186 if (pppoe_host_uniq) {
187 if (!parseHostUniq(pppoe_host_uniq, &conn->hostUniq))
188 fatal("Illegal value for pppoe-host-uniq option");
190 /* if a custom host-uniq is not supplied, use our PID */
191 pid_t pid = getpid();
192 conn->hostUniq.type = htons(TAG_HOST_UNIQ);
193 conn->hostUniq.length = htons(sizeof(pid));
194 memcpy(conn->hostUniq.payload, &pid, sizeof(pid));
197 conn->acName = acName;
198 conn->serviceName = pppd_pppoe_service;
199 strlcpy(ppp_devnam, devnam, sizeof(ppp_devnam));
200 if (existingSession) {
201 unsigned int mac[ETH_ALEN];
203 if (sscanf(existingSession, "%d:%x:%x:%x:%x:%x:%x",
204 &ses, &mac[0], &mac[1], &mac[2],
205 &mac[3], &mac[4], &mac[5]) != 7) {
206 fatal("Illegal value for pppoe-sess option");
208 conn->session = htons(ses);
209 for (i=0; i<ETH_ALEN; i++) {
210 conn->peerEth[i] = (unsigned char) mac[i];
213 conn->discoverySocket =
214 openInterface(conn->ifName, Eth_PPPOE_Discovery, conn->myEth);
215 if (conn->discoverySocket < 0) {
216 error("Failed to create PPPoE discovery socket: %m");
220 /* discovery1() may update conn->mtu and conn->mru */
221 lcp_allowoptions[0].mru = conn->mtu;
222 lcp_wantoptions[0].mru = conn->mru;
223 if (conn->discoveryState != STATE_RECEIVED_PADO) {
224 error("Unable to complete PPPoE Discovery phase 1");
228 /* discovery2() may update conn->mtu and conn->mru */
229 lcp_allowoptions[0].mru = conn->mtu;
230 lcp_wantoptions[0].mru = conn->mru;
231 if (conn->discoveryState != STATE_SESSION) {
232 error("Unable to complete PPPoE Discovery phase 2");
237 /* Set PPPoE session-number for further consumption */
238 ppp_session_number = ntohs(conn->session);
240 sp.sa_family = AF_PPPOX;
241 sp.sa_protocol = PX_PROTO_OE;
242 sp.sa_addr.pppoe.sid = conn->session;
243 memcpy(sp.sa_addr.pppoe.dev, conn->ifName, IFNAMSIZ);
244 memcpy(sp.sa_addr.pppoe.remote, conn->peerEth, ETH_ALEN);
246 /* Set remote_number for ServPoET */
247 sprintf(remote_number, "%02X:%02X:%02X:%02X:%02X:%02X",
248 (unsigned) conn->peerEth[0],
249 (unsigned) conn->peerEth[1],
250 (unsigned) conn->peerEth[2],
251 (unsigned) conn->peerEth[3],
252 (unsigned) conn->peerEth[4],
253 (unsigned) conn->peerEth[5]);
255 warn("Connected to %02X:%02X:%02X:%02X:%02X:%02X via interface %s",
256 (unsigned) conn->peerEth[0],
257 (unsigned) conn->peerEth[1],
258 (unsigned) conn->peerEth[2],
259 (unsigned) conn->peerEth[3],
260 (unsigned) conn->peerEth[4],
261 (unsigned) conn->peerEth[5],
264 script_setenv("MACREMOTE", remote_number, 0);
266 if (connect(conn->sessionSocket, (struct sockaddr *) &sp,
267 sizeof(struct sockaddr_pppox)) < 0) {
268 error("Failed to connect PPPoE socket: %d %m", errno);
272 return conn->sessionSocket;
275 if (conn->discoverySocket >= 0) {
276 sendPADT(conn, NULL);
277 close(conn->discoverySocket);
278 conn->discoverySocket = -1;
280 close(conn->sessionSocket);
285 PPPOERecvConfig(int mru,
290 #if 0 /* broken protocol, but no point harrassing the users I guess... */
291 if (mru > MAX_PPPOE_MTU)
292 warn("Couldn't increase MRU to %d", mru);
296 /**********************************************************************
297 * %FUNCTION: PPPOEDisconnectDevice
303 * Disconnects PPPoE device
304 ***********************************************************************/
306 PPPOEDisconnectDevice(void)
308 struct sockaddr_pppox sp;
310 sp.sa_family = AF_PPPOX;
311 sp.sa_protocol = PX_PROTO_OE;
312 sp.sa_addr.pppoe.sid = 0;
313 memcpy(sp.sa_addr.pppoe.dev, conn->ifName, IFNAMSIZ);
314 memcpy(sp.sa_addr.pppoe.remote, conn->peerEth, ETH_ALEN);
315 if (connect(conn->sessionSocket, (struct sockaddr *) &sp,
316 sizeof(struct sockaddr_pppox)) < 0 && errno != EALREADY)
317 error("Failed to disconnect PPPoE socket: %d %m", errno);
318 close(conn->sessionSocket);
319 if (conn->discoverySocket >= 0) {
320 sendPADT(conn, NULL);
321 close(conn->discoverySocket);
326 PPPOEDeviceOptions(void)
328 char buf[MAXPATHLEN];
330 strlcpy(buf, _PATH_ETHOPT, MAXPATHLEN);
331 strlcat(buf, devnam, MAXPATHLEN);
332 if (!options_from_file(buf, 0, 0, 1))
333 exit(EXIT_OPTION_ERROR);
337 struct channel pppoe_channel;
339 /**********************************************************************
340 * %FUNCTION: PPPoEDevnameHook
342 * cmd -- the command (actually, the device name
343 * argv -- argument vector
344 * doit -- if non-zero, set device name. Otherwise, just check if possible
346 * 1 if we will handle this device; 0 otherwise.
348 * Checks if name is a valid interface name; if so, returns 1. Also
349 * sets up devnam (string representation of device).
350 ***********************************************************************/
352 PPPoEDevnameHook(char *cmd, char **argv, int doit)
359 * Take any otherwise-unrecognized option as a possible device name,
360 * and test if it is the name of a network interface with a
361 * hardware address whose sa_family is ARPHRD_ETHER.
363 if (strlen(cmd) > 4 && !strncmp(cmd, "nic-", 4)) {
364 /* Strip off "nic-" */
369 if ((fd = socket(PF_PACKET, SOCK_RAW, 0)) < 0) {
373 /* Try getting interface index */
375 strlcpy(ifr.ifr_name, cmd, sizeof(ifr.ifr_name));
376 if (ioctl(fd, SIOCGIFINDEX, &ifr) < 0) {
379 if (ioctl(fd, SIOCGIFHWADDR, &ifr) < 0) {
382 if (ifr.ifr_hwaddr.sa_family != ARPHRD_ETHER) {
384 error("Interface %s not Ethernet", cmd);
394 strlcpy(devnam, cmd, sizeof(devnam));
395 if (the_channel != &pppoe_channel) {
397 the_channel = &pppoe_channel;
408 /**********************************************************************
409 * %FUNCTION: plugin_init
415 * Initializes hooks for pppd plugin
416 ***********************************************************************/
420 if (!ppp_available() && !new_style_driver) {
421 fatal("Linux kernel does not support PPPoE -- are you running 2.4.x?");
424 add_options(Options);
426 info("PPPoE plugin from pppd %s", VERSION);
429 void pppoe_check_options(void)
434 if (pppoe_reqd_mac != NULL) {
435 if (sscanf(pppoe_reqd_mac, "%x:%x:%x:%x:%x:%x",
436 &mac[0], &mac[1], &mac[2], &mac[3],
437 &mac[4], &mac[5]) != 6) {
438 option_error("cannot parse pppoe-mac option value");
439 exit(EXIT_OPTION_ERROR);
441 for (i = 0; i < 6; ++i)
442 conn->req_peer_mac[i] = mac[i];
446 lcp_allowoptions[0].neg_accompression = 0;
447 lcp_wantoptions[0].neg_accompression = 0;
449 lcp_allowoptions[0].neg_asyncmap = 0;
450 lcp_wantoptions[0].neg_asyncmap = 0;
452 lcp_allowoptions[0].neg_pcompression = 0;
453 lcp_wantoptions[0].neg_pcompression = 0;
455 if (lcp_allowoptions[0].mru > MAX_PPPOE_MTU)
456 lcp_allowoptions[0].mru = MAX_PPPOE_MTU;
457 if (lcp_wantoptions[0].mru > MAX_PPPOE_MTU)
458 lcp_wantoptions[0].mru = MAX_PPPOE_MTU;
460 /* Save configuration */
461 conn->storedmtu = lcp_allowoptions[0].mru;
462 conn->storedmru = lcp_wantoptions[0].mru;
464 ccp_allowoptions[0].deflate = 0;
465 ccp_wantoptions[0].deflate = 0;
467 ipcp_allowoptions[0].neg_vj = 0;
468 ipcp_wantoptions[0].neg_vj = 0;
470 ccp_allowoptions[0].bsd_compress = 0;
471 ccp_wantoptions[0].bsd_compress = 0;
474 struct channel pppoe_channel = {
476 .process_extra_options = &PPPOEDeviceOptions,
477 .check_options = pppoe_check_options,
478 .connect = &PPPOEConnectDevice,
479 .disconnect = &PPPOEDisconnectDevice,
480 .establish_ppp = &generic_establish_ppp,
481 .disestablish_ppp = &generic_disestablish_ppp,
483 .recv_config = &PPPOERecvConfig,