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 static int printACNames = 0;
68 static char *pppoe_reqd_mac = NULL;
69 unsigned char pppoe_reqd_mac_addr[6];
70 static char *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 { "rp_pppoe_service", o_string, &pppd_pppoe_service,
81 "Desired PPPoE service name" },
82 { "rp_pppoe_ac", o_string, &acName,
83 "Desired PPPoE access concentrator name" },
84 { "rp_pppoe_sess", o_string, &existingSession,
85 "Attach to existing session (sessid:macaddr)" },
86 { "rp_pppoe_verbose", o_int, &printACNames,
87 "Be verbose about discovered access concentrators"},
88 { "pppoe-mac", o_string, &pppoe_reqd_mac,
89 "Only connect to specified MAC address" },
90 { "host-uniq", o_string, &host_uniq,
91 "Set the Host-Uniq to the supplied hex string" },
92 { "pppoe-padi-timeout", o_int, &pppoe_padi_timeout,
93 "Initial timeout for discovery packets in seconds" },
94 { "pppoe-padi-attempts", o_int, &pppoe_padi_attempts,
95 "Number of discovery attempts" },
98 int (*OldDevnameHook)(char *cmd, char **argv, int doit) = NULL;
99 static PPPoEConnection *conn = NULL;
101 /**********************************************************************
102 * %FUNCTION: PPPOEInitDevice
108 * Initializes PPPoE device.
109 ***********************************************************************/
111 PPPOEInitDevice(void)
113 conn = malloc(sizeof(PPPoEConnection));
115 novm("PPPoE session data");
117 memset(conn, 0, sizeof(PPPoEConnection));
118 conn->ifName = devnam;
119 conn->discoverySocket = -1;
120 conn->sessionSocket = -1;
121 conn->printACNames = printACNames;
122 conn->discoveryTimeout = pppoe_padi_timeout;
123 conn->discoveryAttempts = pppoe_padi_attempts;
127 /**********************************************************************
128 * %FUNCTION: PPPOEConnectDevice
132 * Non-negative if all goes well; -1 otherwise
134 * Connects PPPoE device.
135 ***********************************************************************/
137 PPPOEConnectDevice(void)
139 struct sockaddr_pppox sp;
143 /* Open session socket before discovery phase, to avoid losing session */
144 /* packets sent by peer just after PADS packet (noted on some Cisco */
145 /* server equipment). */
146 /* Opening this socket just before waitForPADS in the discovery() */
147 /* function would be more appropriate, but it would mess-up the code */
148 conn->sessionSocket = socket(AF_PPPOX, SOCK_STREAM, PX_PROTO_OE);
149 if (conn->sessionSocket < 0) {
150 error("Failed to create PPPoE socket: %m");
154 /* Restore configuration */
155 lcp_allowoptions[0].mru = conn->mtu;
156 lcp_wantoptions[0].mru = conn->mru;
158 /* Update maximum MRU */
159 s = socket(AF_INET, SOCK_DGRAM, 0);
161 error("Can't get MTU for %s: %m", conn->ifName);
164 strlcpy(ifr.ifr_name, conn->ifName, sizeof(ifr.ifr_name));
165 if (ioctl(s, SIOCGIFMTU, &ifr) < 0) {
166 error("Can't get MTU for %s: %m", conn->ifName);
172 if (lcp_allowoptions[0].mru > ifr.ifr_mtu - TOTAL_OVERHEAD)
173 lcp_allowoptions[0].mru = ifr.ifr_mtu - TOTAL_OVERHEAD;
174 if (lcp_wantoptions[0].mru > ifr.ifr_mtu - TOTAL_OVERHEAD)
175 lcp_wantoptions[0].mru = ifr.ifr_mtu - TOTAL_OVERHEAD;
178 if (!parseHostUniq(host_uniq, &conn->hostUniq))
179 fatal("Illegal value for host-uniq option");
181 /* if a custom host-uniq is not supplied, use our PID */
182 pid_t pid = getpid();
183 conn->hostUniq.type = htons(TAG_HOST_UNIQ);
184 conn->hostUniq.length = htons(sizeof(pid));
185 memcpy(conn->hostUniq.payload, &pid, sizeof(pid));
188 conn->acName = acName;
189 conn->serviceName = pppd_pppoe_service;
190 strlcpy(ppp_devnam, devnam, sizeof(ppp_devnam));
191 if (existingSession) {
192 unsigned int mac[ETH_ALEN];
194 if (sscanf(existingSession, "%d:%x:%x:%x:%x:%x:%x",
195 &ses, &mac[0], &mac[1], &mac[2],
196 &mac[3], &mac[4], &mac[5]) != 7) {
197 fatal("Illegal value for rp_pppoe_sess option");
199 conn->session = htons(ses);
200 for (i=0; i<ETH_ALEN; i++) {
201 conn->peerEth[i] = (unsigned char) mac[i];
204 conn->discoverySocket =
205 openInterface(conn->ifName, Eth_PPPOE_Discovery, conn->myEth);
207 if (conn->discoveryState != STATE_SESSION) {
208 error("Unable to complete PPPoE Discovery");
213 /* Set PPPoE session-number for further consumption */
214 ppp_session_number = ntohs(conn->session);
216 sp.sa_family = AF_PPPOX;
217 sp.sa_protocol = PX_PROTO_OE;
218 sp.sa_addr.pppoe.sid = conn->session;
219 memcpy(sp.sa_addr.pppoe.dev, conn->ifName, IFNAMSIZ);
220 memcpy(sp.sa_addr.pppoe.remote, conn->peerEth, ETH_ALEN);
222 /* Set remote_number for ServPoET */
223 sprintf(remote_number, "%02X:%02X:%02X:%02X:%02X:%02X",
224 (unsigned) conn->peerEth[0],
225 (unsigned) conn->peerEth[1],
226 (unsigned) conn->peerEth[2],
227 (unsigned) conn->peerEth[3],
228 (unsigned) conn->peerEth[4],
229 (unsigned) conn->peerEth[5]);
231 warn("Connected to %02X:%02X:%02X:%02X:%02X:%02X via interface %s",
232 (unsigned) conn->peerEth[0],
233 (unsigned) conn->peerEth[1],
234 (unsigned) conn->peerEth[2],
235 (unsigned) conn->peerEth[3],
236 (unsigned) conn->peerEth[4],
237 (unsigned) conn->peerEth[5],
240 script_setenv("MACREMOTE", remote_number, 0);
242 if (connect(conn->sessionSocket, (struct sockaddr *) &sp,
243 sizeof(struct sockaddr_pppox)) < 0) {
244 error("Failed to connect PPPoE socket: %d %m", errno);
248 return conn->sessionSocket;
251 if (conn->discoverySocket >= 0) {
252 sendPADT(conn, NULL);
253 close(conn->discoverySocket);
254 conn->discoverySocket = -1;
256 close(conn->sessionSocket);
261 PPPOERecvConfig(int mru,
266 #if 0 /* broken protocol, but no point harrassing the users I guess... */
267 if (mru > MAX_PPPOE_MTU)
268 warn("Couldn't increase MRU to %d", mru);
272 /**********************************************************************
273 * %FUNCTION: PPPOEDisconnectDevice
279 * Disconnects PPPoE device
280 ***********************************************************************/
282 PPPOEDisconnectDevice(void)
284 struct sockaddr_pppox sp;
286 sp.sa_family = AF_PPPOX;
287 sp.sa_protocol = PX_PROTO_OE;
288 sp.sa_addr.pppoe.sid = 0;
289 memcpy(sp.sa_addr.pppoe.dev, conn->ifName, IFNAMSIZ);
290 memcpy(sp.sa_addr.pppoe.remote, conn->peerEth, ETH_ALEN);
291 if (connect(conn->sessionSocket, (struct sockaddr *) &sp,
292 sizeof(struct sockaddr_pppox)) < 0 && errno != EALREADY)
293 error("Failed to disconnect PPPoE socket: %d %m", errno);
294 close(conn->sessionSocket);
295 if (conn->discoverySocket >= 0) {
296 sendPADT(conn, NULL);
297 close(conn->discoverySocket);
302 PPPOEDeviceOptions(void)
304 char buf[MAXPATHLEN];
306 strlcpy(buf, _PATH_ETHOPT, MAXPATHLEN);
307 strlcat(buf, devnam, MAXPATHLEN);
308 if (!options_from_file(buf, 0, 0, 1))
309 exit(EXIT_OPTION_ERROR);
313 struct channel pppoe_channel;
315 /**********************************************************************
316 * %FUNCTION: PPPoEDevnameHook
318 * cmd -- the command (actually, the device name
319 * argv -- argument vector
320 * doit -- if non-zero, set device name. Otherwise, just check if possible
322 * 1 if we will handle this device; 0 otherwise.
324 * Checks if name is a valid interface name; if so, returns 1. Also
325 * sets up devnam (string representation of device).
326 ***********************************************************************/
328 PPPoEDevnameHook(char *cmd, char **argv, int doit)
335 * Take any otherwise-unrecognized option as a possible device name,
336 * and test if it is the name of a network interface with a
337 * hardware address whose sa_family is ARPHRD_ETHER.
339 if (strlen(cmd) > 4 && !strncmp(cmd, "nic-", 4)) {
340 /* Strip off "nic-" */
345 if ((fd = socket(PF_PACKET, SOCK_RAW, 0)) < 0) {
349 /* Try getting interface index */
351 strlcpy(ifr.ifr_name, cmd, sizeof(ifr.ifr_name));
352 if (ioctl(fd, SIOCGIFINDEX, &ifr) < 0) {
355 if (ioctl(fd, SIOCGIFHWADDR, &ifr) < 0) {
358 if (ifr.ifr_hwaddr.sa_family != ARPHRD_ETHER) {
360 error("Interface %s not Ethernet", cmd);
370 strlcpy(devnam, cmd, sizeof(devnam));
371 if (the_channel != &pppoe_channel) {
373 the_channel = &pppoe_channel;
384 /**********************************************************************
385 * %FUNCTION: plugin_init
391 * Initializes hooks for pppd plugin
392 ***********************************************************************/
396 if (!ppp_available() && !new_style_driver) {
397 fatal("Linux kernel does not support PPPoE -- are you running 2.4.x?");
400 add_options(Options);
402 info("PPPoE plugin from pppd %s", VERSION);
405 void pppoe_check_options(void)
410 if (pppoe_reqd_mac != NULL) {
411 if (sscanf(pppoe_reqd_mac, "%x:%x:%x:%x:%x:%x",
412 &mac[0], &mac[1], &mac[2], &mac[3],
413 &mac[4], &mac[5]) != 6) {
414 option_error("cannot parse pppoe-mac option value");
415 exit(EXIT_OPTION_ERROR);
417 for (i = 0; i < 6; ++i)
418 conn->req_peer_mac[i] = mac[i];
422 lcp_allowoptions[0].neg_accompression = 0;
423 lcp_wantoptions[0].neg_accompression = 0;
425 lcp_allowoptions[0].neg_asyncmap = 0;
426 lcp_wantoptions[0].neg_asyncmap = 0;
428 lcp_allowoptions[0].neg_pcompression = 0;
429 lcp_wantoptions[0].neg_pcompression = 0;
431 if (lcp_allowoptions[0].mru > MAX_PPPOE_MTU)
432 lcp_allowoptions[0].mru = MAX_PPPOE_MTU;
433 if (lcp_wantoptions[0].mru > MAX_PPPOE_MTU)
434 lcp_wantoptions[0].mru = MAX_PPPOE_MTU;
436 /* Save configuration */
437 conn->mtu = lcp_allowoptions[0].mru;
438 conn->mru = lcp_wantoptions[0].mru;
440 ccp_allowoptions[0].deflate = 0;
441 ccp_wantoptions[0].deflate = 0;
443 ipcp_allowoptions[0].neg_vj = 0;
444 ipcp_wantoptions[0].neg_vj = 0;
446 ccp_allowoptions[0].bsd_compress = 0;
447 ccp_wantoptions[0].bsd_compress = 0;
450 struct channel pppoe_channel = {
452 .process_extra_options = &PPPOEDeviceOptions,
453 .check_options = pppoe_check_options,
454 .connect = &PPPOEConnectDevice,
455 .disconnect = &PPPOEDisconnectDevice,
456 .establish_ppp = &generic_establish_ppp,
457 .disestablish_ppp = &generic_disestablish_ppp,
459 .recv_config = &PPPOERecvConfig,