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/ethernet.h>
50 #include <net/if_arp.h>
51 #include <linux/ppp_defs.h>
52 #include <linux/if_pppox.h>
58 #define _PATH_ETHOPT _ROOT_PATH "/etc/ppp/options."
60 char pppd_version[] = VERSION;
62 /* From sys-linux.c in pppd -- MUST FIX THIS! */
63 extern int new_style_driver;
65 char *pppd_pppoe_service = NULL;
66 static char *acName = NULL;
67 static char *existingSession = NULL;
68 static int printACNames = 0;
69 static char *pppoe_reqd_mac = NULL;
70 unsigned char pppoe_reqd_mac_addr[6];
71 static char *host_uniq;
72 static int pppoe_padi_timeout = PADI_TIMEOUT;
73 static int pppoe_padi_attempts = MAX_PADI_ATTEMPTS;
75 static int PPPoEDevnameHook(char *cmd, char **argv, int doit);
76 static option_t Options[] = {
77 { "device name", o_wild, (void *) &PPPoEDevnameHook,
79 OPT_DEVNAM | OPT_PRIVFIX | OPT_NOARG | OPT_A2STRVAL | OPT_STATIC,
81 { "rp_pppoe_service", o_string, &pppd_pppoe_service,
82 "Desired PPPoE service name" },
83 { "rp_pppoe_ac", o_string, &acName,
84 "Desired PPPoE access concentrator name" },
85 { "rp_pppoe_sess", o_string, &existingSession,
86 "Attach to existing session (sessid:macaddr)" },
87 { "rp_pppoe_verbose", o_int, &printACNames,
88 "Be verbose about discovered access concentrators"},
89 { "pppoe-mac", o_string, &pppoe_reqd_mac,
90 "Only connect to specified MAC address" },
91 { "host-uniq", o_string, &host_uniq,
92 "Set the Host-Uniq to the supplied hex string" },
93 { "pppoe-padi-timeout", o_int, &pppoe_padi_timeout,
94 "Initial timeout for discovery packets in seconds" },
95 { "pppoe-padi-attempts", o_int, &pppoe_padi_attempts,
96 "Number of discovery attempts" },
99 int (*OldDevnameHook)(char *cmd, char **argv, int doit) = NULL;
100 static PPPoEConnection *conn = NULL;
102 /**********************************************************************
103 * %FUNCTION: PPPOEInitDevice
109 * Initializes PPPoE device.
110 ***********************************************************************/
112 PPPOEInitDevice(void)
114 conn = malloc(sizeof(PPPoEConnection));
116 novm("PPPoE session data");
118 memset(conn, 0, sizeof(PPPoEConnection));
119 conn->ifName = devnam;
120 conn->discoverySocket = -1;
121 conn->sessionSocket = -1;
122 conn->printACNames = printACNames;
123 conn->discoveryTimeout = pppoe_padi_timeout;
124 conn->discoveryAttempts = pppoe_padi_attempts;
128 /**********************************************************************
129 * %FUNCTION: PPPOEConnectDevice
133 * Non-negative if all goes well; -1 otherwise
135 * Connects PPPoE device.
136 ***********************************************************************/
138 PPPOEConnectDevice(void)
140 struct sockaddr_pppox sp;
144 /* Open session socket before discovery phase, to avoid losing session */
145 /* packets sent by peer just after PADS packet (noted on some Cisco */
146 /* server equipment). */
147 /* Opening this socket just before waitForPADS in the discovery() */
148 /* function would be more appropriate, but it would mess-up the code */
149 conn->sessionSocket = socket(AF_PPPOX, SOCK_STREAM, PX_PROTO_OE);
150 if (conn->sessionSocket < 0) {
151 error("Failed to create PPPoE socket: %m");
155 /* Restore configuration */
156 lcp_allowoptions[0].mru = conn->mtu;
157 lcp_wantoptions[0].mru = conn->mru;
159 /* Update maximum MRU */
160 s = socket(AF_INET, SOCK_DGRAM, 0);
162 error("Can't get MTU for %s: %m", conn->ifName);
165 strlcpy(ifr.ifr_name, conn->ifName, sizeof(ifr.ifr_name));
166 if (ioctl(s, SIOCGIFMTU, &ifr) < 0) {
167 error("Can't get MTU for %s: %m", conn->ifName);
173 if (lcp_allowoptions[0].mru > ifr.ifr_mtu - TOTAL_OVERHEAD)
174 lcp_allowoptions[0].mru = ifr.ifr_mtu - TOTAL_OVERHEAD;
175 if (lcp_wantoptions[0].mru > ifr.ifr_mtu - TOTAL_OVERHEAD)
176 lcp_wantoptions[0].mru = ifr.ifr_mtu - TOTAL_OVERHEAD;
179 if (!parseHostUniq(host_uniq, &conn->hostUniq))
180 fatal("Illegal value for host-uniq option");
182 /* if a custom host-uniq is not supplied, use our PID */
183 pid_t pid = getpid();
184 conn->hostUniq.type = htons(TAG_HOST_UNIQ);
185 conn->hostUniq.length = htons(sizeof(pid));
186 memcpy(conn->hostUniq.payload, &pid, sizeof(pid));
189 conn->acName = acName;
190 conn->serviceName = pppd_pppoe_service;
191 strlcpy(ppp_devnam, devnam, sizeof(ppp_devnam));
192 if (existingSession) {
193 unsigned int mac[ETH_ALEN];
195 if (sscanf(existingSession, "%d:%x:%x:%x:%x:%x:%x",
196 &ses, &mac[0], &mac[1], &mac[2],
197 &mac[3], &mac[4], &mac[5]) != 7) {
198 fatal("Illegal value for rp_pppoe_sess option");
200 conn->session = htons(ses);
201 for (i=0; i<ETH_ALEN; i++) {
202 conn->peerEth[i] = (unsigned char) mac[i];
205 conn->discoverySocket =
206 openInterface(conn->ifName, Eth_PPPOE_Discovery, conn->myEth);
208 if (conn->discoveryState != STATE_SESSION) {
209 error("Unable to complete PPPoE Discovery");
214 /* Set PPPoE session-number for further consumption */
215 ppp_session_number = ntohs(conn->session);
217 sp.sa_family = AF_PPPOX;
218 sp.sa_protocol = PX_PROTO_OE;
219 sp.sa_addr.pppoe.sid = conn->session;
220 memcpy(sp.sa_addr.pppoe.dev, conn->ifName, IFNAMSIZ);
221 memcpy(sp.sa_addr.pppoe.remote, conn->peerEth, ETH_ALEN);
223 /* Set remote_number for ServPoET */
224 sprintf(remote_number, "%02X:%02X:%02X:%02X:%02X:%02X",
225 (unsigned) conn->peerEth[0],
226 (unsigned) conn->peerEth[1],
227 (unsigned) conn->peerEth[2],
228 (unsigned) conn->peerEth[3],
229 (unsigned) conn->peerEth[4],
230 (unsigned) conn->peerEth[5]);
232 warn("Connected to %02X:%02X:%02X:%02X:%02X:%02X via interface %s",
233 (unsigned) conn->peerEth[0],
234 (unsigned) conn->peerEth[1],
235 (unsigned) conn->peerEth[2],
236 (unsigned) conn->peerEth[3],
237 (unsigned) conn->peerEth[4],
238 (unsigned) conn->peerEth[5],
241 script_setenv("MACREMOTE", remote_number, 0);
243 if (connect(conn->sessionSocket, (struct sockaddr *) &sp,
244 sizeof(struct sockaddr_pppox)) < 0) {
245 error("Failed to connect PPPoE socket: %d %m", errno);
249 return conn->sessionSocket;
252 if (conn->discoverySocket >= 0) {
253 sendPADT(conn, NULL);
254 close(conn->discoverySocket);
255 conn->discoverySocket = -1;
257 close(conn->sessionSocket);
262 PPPOERecvConfig(int mru,
267 #if 0 /* broken protocol, but no point harrassing the users I guess... */
268 if (mru > MAX_PPPOE_MTU)
269 warn("Couldn't increase MRU to %d", mru);
273 /**********************************************************************
274 * %FUNCTION: PPPOEDisconnectDevice
280 * Disconnects PPPoE device
281 ***********************************************************************/
283 PPPOEDisconnectDevice(void)
285 struct sockaddr_pppox sp;
287 sp.sa_family = AF_PPPOX;
288 sp.sa_protocol = PX_PROTO_OE;
289 sp.sa_addr.pppoe.sid = 0;
290 memcpy(sp.sa_addr.pppoe.dev, conn->ifName, IFNAMSIZ);
291 memcpy(sp.sa_addr.pppoe.remote, conn->peerEth, ETH_ALEN);
292 if (connect(conn->sessionSocket, (struct sockaddr *) &sp,
293 sizeof(struct sockaddr_pppox)) < 0 && errno != EALREADY)
294 error("Failed to disconnect PPPoE socket: %d %m", errno);
295 close(conn->sessionSocket);
296 if (conn->discoverySocket >= 0) {
297 sendPADT(conn, NULL);
298 close(conn->discoverySocket);
303 PPPOEDeviceOptions(void)
305 char buf[MAXPATHLEN];
307 strlcpy(buf, _PATH_ETHOPT, MAXPATHLEN);
308 strlcat(buf, devnam, MAXPATHLEN);
309 if (!options_from_file(buf, 0, 0, 1))
310 exit(EXIT_OPTION_ERROR);
314 struct channel pppoe_channel;
316 /**********************************************************************
317 * %FUNCTION: PPPoEDevnameHook
319 * cmd -- the command (actually, the device name
320 * argv -- argument vector
321 * doit -- if non-zero, set device name. Otherwise, just check if possible
323 * 1 if we will handle this device; 0 otherwise.
325 * Checks if name is a valid interface name; if so, returns 1. Also
326 * sets up devnam (string representation of device).
327 ***********************************************************************/
329 PPPoEDevnameHook(char *cmd, char **argv, int doit)
336 * Take any otherwise-unrecognized option as a possible device name,
337 * and test if it is the name of a network interface with a
338 * hardware address whose sa_family is ARPHRD_ETHER.
340 if (strlen(cmd) > 4 && !strncmp(cmd, "nic-", 4)) {
341 /* Strip off "nic-" */
346 if ((fd = socket(PF_PACKET, SOCK_RAW, 0)) < 0) {
350 /* Try getting interface index */
352 strlcpy(ifr.ifr_name, cmd, sizeof(ifr.ifr_name));
353 if (ioctl(fd, SIOCGIFINDEX, &ifr) < 0) {
356 if (ioctl(fd, SIOCGIFHWADDR, &ifr) < 0) {
359 if (ifr.ifr_hwaddr.sa_family != ARPHRD_ETHER) {
361 error("Interface %s not Ethernet", cmd);
371 strlcpy(devnam, cmd, sizeof(devnam));
372 if (the_channel != &pppoe_channel) {
374 the_channel = &pppoe_channel;
385 /**********************************************************************
386 * %FUNCTION: plugin_init
392 * Initializes hooks for pppd plugin
393 ***********************************************************************/
397 if (!ppp_available() && !new_style_driver) {
398 fatal("Linux kernel does not support PPPoE -- are you running 2.4.x?");
401 add_options(Options);
403 info("RP-PPPoE plugin version %s compiled against pppd %s",
404 RP_VERSION, VERSION);
407 void pppoe_check_options(void)
412 if (pppoe_reqd_mac != NULL) {
413 if (sscanf(pppoe_reqd_mac, "%x:%x:%x:%x:%x:%x",
414 &mac[0], &mac[1], &mac[2], &mac[3],
415 &mac[4], &mac[5]) != 6) {
416 option_error("cannot parse pppoe-mac option value");
417 exit(EXIT_OPTION_ERROR);
419 for (i = 0; i < 6; ++i)
420 conn->req_peer_mac[i] = mac[i];
424 lcp_allowoptions[0].neg_accompression = 0;
425 lcp_wantoptions[0].neg_accompression = 0;
427 lcp_allowoptions[0].neg_asyncmap = 0;
428 lcp_wantoptions[0].neg_asyncmap = 0;
430 lcp_allowoptions[0].neg_pcompression = 0;
431 lcp_wantoptions[0].neg_pcompression = 0;
433 if (lcp_allowoptions[0].mru > MAX_PPPOE_MTU)
434 lcp_allowoptions[0].mru = MAX_PPPOE_MTU;
435 if (lcp_wantoptions[0].mru > MAX_PPPOE_MTU)
436 lcp_wantoptions[0].mru = MAX_PPPOE_MTU;
438 /* Save configuration */
439 conn->mtu = lcp_allowoptions[0].mru;
440 conn->mru = lcp_wantoptions[0].mru;
442 ccp_allowoptions[0].deflate = 0;
443 ccp_wantoptions[0].deflate = 0;
445 ipcp_allowoptions[0].neg_vj = 0;
446 ipcp_wantoptions[0].neg_vj = 0;
448 ccp_allowoptions[0].bsd_compress = 0;
449 ccp_wantoptions[0].bsd_compress = 0;
452 struct channel pppoe_channel = {
454 .process_extra_options = &PPPOEDeviceOptions,
455 .check_options = pppoe_check_options,
456 .connect = &PPPOEConnectDevice,
457 .disconnect = &PPPOEDisconnectDevice,
458 .establish_ppp = &generic_establish_ppp,
459 .disestablish_ppp = &generic_disestablish_ppp,
461 .recv_config = &PPPOERecvConfig,