1.\" Copyright (c) 1996-1999 Whistle Communications, Inc. 2.\" All rights reserved. 3.\" 4.\" Subject to the following obligations and disclaimer of warranty, use and 5.\" redistribution of this software, in source or object code forms, with or 6.\" without modifications are expressly permitted by Whistle Communications; 7.\" provided, however, that: 8.\" 1. Any and all reproductions of the source or object code must include the 9.\" copyright notice above and the following disclaimer of warranties; and 10.\" 2. No rights are granted, in any manner or form, to use Whistle 11.\" Communications, Inc. trademarks, including the mark "WHISTLE 12.\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as 13.\" such appears in the above copyright notice or in the software. 14.\" 15.\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND 16.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO 17.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, 18.\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF 19.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. 20.\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY 21.\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS 22.\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. 23.\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES 24.\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING 25.\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 26.\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR 27.\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY 28.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30.\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY 31.\" OF SUCH DAMAGE. 32.\" 33.\" Author: Archie Cobbs <archie@FreeBSD.org> 34.\" 35.\" $FreeBSD$ 36.\" $Whistle: ng_pppoe.8,v 1.1 1999/01/25 23:46:27 archie Exp $ 37.\" 38.Dd July 27, 2004 39.Dt NG_PPPOE 4 40.Os 41.Sh NAME 42.Nm ng_pppoe 43.Nd RFC 2516 PPPoE protocol netgraph node type 44.Sh SYNOPSIS 45.In sys/types.h 46.In net/ethernet.h 47.In netgraph.h 48.In netgraph/ng_pppoe.h 49.Sh DESCRIPTION 50The 51.Nm pppoe 52node type performs the PPPoE protocol. 53It is used in conjunction with the 54.Xr netgraph 4 55extensions to the Ethernet framework to divert and inject Ethernet packets 56to and from a PPP agent (which is not specified). 57.Pp 58The 59.Dv NGM_PPPOE_GET_STATUS 60control message can be used at any time to query the current status 61of the PPPoE module. 62The only statistics presently available are the 63total packet counts for input and output. 64This node does not yet support 65the 66.Dv NGM_TEXT_STATUS 67control message. 68.Sh HOOKS 69This node type supports the following hooks: 70.Pp 71.Bl -tag -width [unspecified] 72.It Dv ethernet 73The hook that should normally be connected to an Ethernet node. 74.It Dv debug 75Presently no use. 76.It Dv [unspecified] 77Any other name is assumed to be a session hook that will be connected to 78a PPP client agent, or a PPP server agent. 79.El 80.Sh CONTROL MESSAGES 81This node type supports the generic control messages, plus the following: 82.Bl -tag -width 3n 83.It Dv NGM_PPPOE_GET_STATUS 84This command returns status information in a 85.Dv "struct ngpppoestat" : 86.Bd -literal -offset 4n 87struct ngpppoestat { 88 u_int packets_in; /* packets in from Ethernet */ 89 u_int packets_out; /* packets out towards Ethernet */ 90}; 91.Ed 92.It Dv NGM_TEXT_STATUS 93This generic message returns is a human-readable version of the node status. 94(not yet) 95.It Dv NGM_PPPOE_CONNECT 96Tell a nominated newly created hook that its session should enter 97the state machine in a manner to become a client. 98It must be newly created and 99a service name can be given as an argument. 100It is legal to specify a zero length service name. 101This is common on some DSL setups. 102A session request packet will be broadcast on the Ethernet. 103This command uses the 104.Dv ngpppoe_init_data 105structure shown below. 106.It Dv NGM_PPPOE_LISTEN 107Tell a nominated newly created hook that its session should enter 108the state machine in a manner to become a server listener. 109The argument 110given is the name of the service to listen on behalf of 111a zero length service length will match all requests for service. 112A matching service request 113packet will be passed unmodified back to the process responsible 114for starting the service. 115It can then examine it and pass it on to 116the session that is started to answer the request. 117This command uses the 118.Dv ngpppoe_init_data 119structure shown below. 120.It Dv NGM_PPPOE_OFFER 121Tell a nominated newly created hook that its session should enter 122the state machine in a manner to become a server. 123The argument given is the name of the service to offer. 124A zero length service 125is legal. 126The State machine will progress to a state where it will await 127a request packet to be forwarded to it from the startup server, 128which in turn probably received it from a LISTEN mode hook ( see above). 129This is so 130that information that is required for the session that is embedded in 131the original session request packet, is made available to the state machine 132that eventually answers the request. 133When the Session request packet is 134received, the session negotiation will proceed. 135This command uses the 136.Dv ngpppoe_init_data 137structure shown below. 138.El 139.Pp 140The three commands above use a common data structure: 141.Bd -literal -offset 4n 142struct ngpppoe_init_data { 143 char hook[NG_HOOKSIZ]; /* hook to monitor on */ 144 u_int16_t data_len; /* service name length */ 145 char data[0]; /* init data goes here */ 146}; 147.Ed 148.Bl -tag -width 3n 149.It Dv NGM_PPPOE_SUCCESS 150This command is sent to the node that started this session with one of the 151above messages, and reports a state change. 152This message reports successful Session negotiation. 153It uses the structure shown below, and 154reports back the hook name corresponding to the successful session. 155.It Dv NGM_NGM_PPPOE_FAIL 156This command is sent to the node that started this session with one of the 157above messages, and reports a state change. 158This message reports failed Session negotiation. 159It uses the structure shown below, and 160reports back the hook name corresponding to the failed session. 161The hook will probably have been removed immediately after sending this message 162.It Dv NGM_NGM_PPPOE_CLOSE 163This command is sent to the node that started this session with one of the 164above messages, and reports a state change. 165This message reports a request to close a session. 166It uses the structure shown below, and 167reports back the hook name corresponding to the closed session. 168The hook will probably have been removed immediately after sending this 169message. 170At present this message is not yet used and a 'failed' message 171will be received at closure instead. 172.It Dv NGM_PPPOE_ACNAME 173This command is sent to the node that started this session with one of the 174above messages, and reports the Access Concentrator Name. 175.El 176.Pp 177The four commands above use a common data structure: 178.Bd -literal -offset 4n 179struct ngpppoe_sts { 180 char hook[NG_HOOKSIZ]; /* hook associated with event session */ 181}; 182.Ed 183.Bl -tag -width 3n 184.It Dv NGM_PPPOE_GETMODE 185The 186.Nm 187node can operate in two different modes: 188standard mode described in RFC 2516, and in a non-standard mode compatible 189with equipment from 3Com. 190When 191.Nm 192is a client node, it initiates a session using the configured mode. 193In server mode 194.Nm 195supports both modes simultaneously. 196This message returns the currently configured mode as a string. 197.Tn ASCII 198form of this message is 199.Qq Li pppoe_getmode . 200.It Dv NGM_PPPOE_SETMODE 201Configure node to the specified mode. 202The string argument is required. 203.Tn ASCII 204form of this message is 205.Qq Li pppoe_setmode . 206For example, the following command will configure the node to initiate 207the next session in the proprietary 3Com mode: 208.Pp 209.Dl ngctl msg fxp0:orphans pppoe_setmode "3Com" 210.El 211.Sh SHUTDOWN 212This node shuts down upon receipt of a 213.Dv NGM_SHUTDOWN 214control message, when all session have been disconnected or when the 215.Dv ethernet 216hook is disconnected. 217.Sh SYSCTL VARIABLES 218The variable 219.Va net.graph.nonstandard_pppoe 220is a deprecated way to set 221.Nm 222client mode. 223Consider using 224.Dv NGM_PPPOE_SETMODE 225or an appropriate option in your client software instead. 226.Sh EXAMPLES 227The following code uses 228.Dv libnetgraph 229to set up a 230.Nm 231node and connect it to both a socket node and an Ethernet node. 232It can handle the case of when a 233.Nm 234node is already attached to the Ethernet. 235It then starts a client session. 236.Bd -literal 237#include <stdio.h> 238#include <stdlib.h> 239#include <string.h> 240#include <ctype.h> 241#include <unistd.h> 242#include <sysexits.h> 243#include <errno.h> 244#include <err.h> 245 246#include <sys/types.h> 247#include <sys/socket.h> 248#include <sys/select.h> 249#include <net/ethernet.h> 250 251#include <netgraph.h> 252#include <netgraph/ng_ether.h> 253#include <netgraph/ng_pppoe.h> 254#include <netgraph/ng_socket.h> 255static int setup(char *ethername, char *service, char *sessname, 256 int *dfd, int *cfd); 257 258int 259main() 260{ 261 int fd1, fd2; 262 setup("xl0", NULL, "fred", &fd1, &fd2); 263 sleep (30); 264} 265 266static int 267setup(char *ethername, char *service, char *sessname, 268 int *dfd, int *cfd) 269{ 270 struct ngm_connect ngc; /* connect */ 271 struct ngm_mkpeer mkp; /* mkpeer */ 272 /******** nodeinfo stuff **********/ 273 u_char rbuf[2 * 1024]; 274 struct ng_mesg *const resp = (struct ng_mesg *) rbuf; 275 struct hooklist *const hlist 276 = (struct hooklist *) resp->data; 277 struct nodeinfo *const ninfo = &hlist->nodeinfo; 278 int ch, no_hooks = 0; 279 struct linkinfo *link; 280 struct nodeinfo *peer; 281 /****message to connect PPPoE session*****/ 282 struct { 283 struct ngpppoe_init_data idata; 284 char service[100]; 285 } message; 286 /********tracking our little graph ********/ 287 char path[100]; 288 char source_ID[NG_NODESIZ]; 289 char pppoe_node_name[100]; 290 int k; 291 292 /* 293 * Create the data and control sockets 294 */ 295 if (NgMkSockNode(NULL, cfd, dfd) < 0) { 296 return (errno); 297 } 298 /* 299 * find the ether node of the name requested by asking it for 300 * it's inquiry information. 301 */ 302 if (strlen(ethername) > 16) 303 return (EINVAL); 304 sprintf(path, "%s:", ethername); 305 if (NgSendMsg(*cfd, path, NGM_GENERIC_COOKIE, 306 NGM_LISTHOOKS, NULL, 0) < 0) { 307 return (errno); 308 } 309 /* 310 * the command was accepted so it exists. Await the reply (It's 311 * almost certainly already waiting). 312 */ 313 if (NgRecvMsg(*cfd, resp, sizeof(rbuf), NULL) < 0) { 314 return (errno); 315 } 316 /** 317 * The following is available about the node: 318 * ninfo->name (string) 319 * ninfo->type (string) 320 * ninfo->id (u_int32_t) 321 * ninfo->hooks (u_int32_t) (count of hooks) 322 * check it is the correct type. and get it's ID for use 323 * with mkpeer later. 324 */ 325 if (strncmp(ninfo->type, NG_ETHER_NODE_TYPE, 326 strlen(NG_ETHER_NODE_TYPE)) != 0) { 327 return (EPROTOTYPE); 328 } 329 sprintf(source_ID, "[%08x]:", ninfo->id); 330 331 /* 332 * look for a hook already attached. 333 */ 334 for (k = 0; k < ninfo->hooks; k++) { 335 /** 336 * The following are available about each hook. 337 * link->ourhook (string) 338 * link->peerhook (string) 339 * peer->name (string) 340 * peer->type (string) 341 * peer->id (u_int32_t) 342 * peer->hooks (u_int32_t) 343 */ 344 link = &hlist->link[k]; 345 peer = &hlist->link[k].nodeinfo; 346 347 /* Ignore debug hooks */ 348 if (strcmp("debug", link->ourhook) == 0) 349 continue; 350 351 /* If the orphans hook is attached, use that */ 352 if (strcmp(NG_ETHER_HOOK_ORPHAN, 353 link->ourhook) == 0) { 354 break; 355 } 356 /* the other option is the 'divert' hook */ 357 if (strcmp("NG_ETHER_HOOK_DIVERT", 358 link->ourhook) == 0) { 359 break; 360 } 361 } 362 363 /* 364 * See if we found a hook there. 365 */ 366 if (k < ninfo->hooks) { 367 if (strcmp(peer->type, NG_PPPOE_NODE_TYPE) == 0) { 368 /* 369 * If it's a type PPPoE, we skip making one 370 * ourself, but we continue, using 371 * the existing one. 372 */ 373 sprintf(pppoe_node_name, "[%08x]:", peer->id); 374 } else { 375 /* 376 * There is already someone hogging the data, 377 * return an error. Some day we'll try 378 * daisy-chaining.. 379 */ 380 return (EBUSY); 381 } 382 } else { 383 384 /* 385 * Try make a node of type PPPoE against node "ID" 386 * On hook NG_ETHER_HOOK_ORPHAN. 387 */ 388 snprintf(mkp.type, sizeof(mkp.type), 389 "%s", NG_PPPOE_NODE_TYPE); 390 snprintf(mkp.ourhook, sizeof(mkp.ourhook), 391 "%s", NG_ETHER_HOOK_ORPHAN); 392 snprintf(mkp.peerhook, sizeof(mkp.peerhook), 393 "%s", NG_PPPOE_HOOK_ETHERNET); 394 /* Send message */ 395 if (NgSendMsg(*cfd, source_ID, NGM_GENERIC_COOKIE, 396 NGM_MKPEER, &mkp, sizeof(mkp)) < 0) { 397 return (errno); 398 } 399 /* 400 * Work out a name for the new node. 401 */ 402 sprintf(pppoe_node_name, "%s:%s", 403 source_ID, NG_ETHER_HOOK_ORPHAN); 404 } 405 /* 406 * We now have a PPPoE node attached to the Ethernet 407 * card. The Ethernet is addressed as ethername: The PPPoE 408 * node is addressed as pppoe_node_name: attach to it. 409 * Connect socket node to specified node Use the same hook 410 * name on both ends of the link. 411 */ 412 snprintf(ngc.path, sizeof(ngc.path), "%s", pppoe_node_name); 413 snprintf(ngc.ourhook, sizeof(ngc.ourhook), "%s", sessname); 414 snprintf(ngc.peerhook, sizeof(ngc.peerhook), "%s", sessname); 415 416 if (NgSendMsg(*cfd, ".:", NGM_GENERIC_COOKIE, 417 NGM_CONNECT, &ngc, sizeof(ngc)) < 0) { 418 return (errno); 419 } 420 421#ifdef NONSTANDARD 422 /* 423 * In some cases we are speaking to 3Com hardware, so 424 * configure node to non-standard mode. 425 */ 426 if (NgSendMsg(*cfd, ngc.path, NGM_PPPOE_COOKIE, 427 NGM_PPPOE_SETMODE, NG_PPPOE_NONSTANDARD, 428 strlen(NG_PPPOE_NONSTANDARD) + 1) == -1) { 429 return (errno); 430 } 431#endif 432 433 /* 434 * Send it a message telling it to start up. 435 */ 436 bzero(&message, sizeof(message)); 437 snprintf(message.idata.hook, sizeof(message.idata.hook), 438 "%s", sessname); 439 if (service == NULL) { 440 message.idata.data_len = 0; 441 } else { 442 snprintf(message.idata.data, 443 sizeof(message.idata.data), "%s", service); 444 message.idata.data_len = strlen(service); 445 } 446 /* Tell session/hook to start up as a client */ 447 if (NgSendMsg(*cfd, ngc.path, 448 NGM_PPPOE_COOKIE, NGM_PPPOE_CONNECT, &message.idata, 449 sizeof(message.idata) + message.idata.data_len) < 0) { 450 return (errno); 451 } 452 return (0); 453} 454.Ed 455.Sh SEE ALSO 456.Xr netgraph 3 , 457.Xr netgraph 4 , 458.Xr ng_ppp 4 , 459.Xr ng_socket 4 , 460.Xr ngctl 8 , 461.Xr ppp 8 462.Rs 463.%A L. Mamakos 464.%A K. Lidl 465.%A J. Evarts 466.%A D. Carrel 467.%A D. Simone 468.%A R. Wheeler 469.%T "A Method for transmitting PPP over Ethernet (PPPoE)" 470.%O RFC 2516 471.Re 472.Sh HISTORY 473The 474.Nm 475node type was implemented in 476.Fx 4.0 . 477.Sh AUTHORS 478.An Julian Elischer Aq julian@FreeBSD.org 479