1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
|
package l2tp
import (
"fmt"
"sync"
"time"
"github.com/go-kit/kit/log"
"github.com/go-kit/kit/log/level"
"golang.org/x/sys/unix"
)
type sendMsg struct {
msg controlMessage
completeChan chan error
}
type eventArgs struct {
event string
args []interface{}
}
type dynamicTunnel struct {
*baseTunnel
closingLock sync.Mutex
isClosing bool
established bool
sal, sap unix.Sockaddr
cp *controlPlane
xport *transport
dp TunnelDataPlane
closeChan chan bool
sendChan chan *sendMsg
eventChan chan *eventArgs
wg sync.WaitGroup
sessionTxWg sync.WaitGroup
fsm fsm
}
func (dt *dynamicTunnel) NewSession(name string, cfg *SessionConfig) (sess Session, err error) {
// Must have configuration
if cfg == nil {
return nil, fmt.Errorf("invalid nil config")
}
// Name clashes are not allowed
if _, ok := dt.findSessionByName(name); ok {
return nil, fmt.Errorf("already have session %q", name)
}
dt.closingLock.Lock()
if dt.isClosing {
dt.closingLock.Unlock()
return nil, fmt.Errorf("tunnel is closing")
}
dt.closingLock.Unlock()
// Duplicate the configuration so we don't modify the user's copy
myCfg := *cfg
// If the session ID in the config is unset, we must generate one.
// If the session ID is set, we must check for collisions.
// TODO: there is a potential race here if sessions are concurrently
// added -- an ID assigned here isn't actually reserved until the linkSession
// call.
if myCfg.SessionID != 0 {
// Must not have session ID clashes
if _, ok := dt.findSessionByID(myCfg.SessionID); ok {
return nil, fmt.Errorf("already have session with SID %q", myCfg.SessionID)
}
} else {
myCfg.SessionID, err = dt.allocSid()
if err != nil {
return nil, fmt.Errorf("failed to allocate a SID: %q", err)
}
}
s, err := newDynamicSession(dt.parent.allocCallSerial(), name, dt, &myCfg)
if err != nil {
return nil, err
}
dt.injectEvent("newsession", s)
sess = s
return
}
func (dt *dynamicTunnel) Close() {
if dt != nil {
dt.parent.unlinkTunnel(dt)
close(dt.closeChan)
dt.wg.Wait()
}
}
func (dt *dynamicTunnel) closeAllSessions() {
// In order to prevent any concurrently executing sessions from
// blocking in a channel send when trying to transmit control
// messages, drain the send channel while closing the sessions.
var wg sync.WaitGroup
exit := make(chan interface{})
wg.Add(1)
go func() {
defer wg.Done()
for {
select {
case <-exit:
return
case sm, ok := <-dt.sendChan:
if !ok {
return
}
sm.completeChan <- fmt.Errorf("tunnel is shutting down")
}
}
}()
dt.baseTunnel.closeAllSessions()
dt.sessionTxWg.Wait()
close(exit)
wg.Wait()
}
func (dt *dynamicTunnel) sendMessage(msg controlMessage) error {
sm := &sendMsg{
msg: msg,
completeChan: make(chan error),
}
dt.sendChan <- sm
return <-sm.completeChan
}
func (dt *dynamicTunnel) runTunnel() {
defer dt.wg.Done()
level.Info(dt.logger).Log(
"message", "new dynamic tunnel",
"version", dt.cfg.Version,
"encap", dt.cfg.Encap,
"local", dt.cfg.Local,
"peer", dt.cfg.Peer,
"tunnel_id", dt.cfg.TunnelID,
"peer_tunnel_id", dt.cfg.PeerTunnelID)
dt.handleEvent("open")
for {
select {
case <-dt.closeChan:
dt.handleEvent("close", avpStopCCNResultCodeClearConnection)
return
case m, ok := <-dt.xport.recvChan:
if !ok {
dt.fsmActClose(nil)
return
}
dt.handleMsg(m)
case ea, ok := <-dt.eventChan:
if !ok {
dt.fsmActClose(nil)
return
}
dt.handleEvent(ea.event, ea.args...)
case sm, ok := <-dt.sendChan:
if !ok {
dt.fsmActClose(nil)
return
}
dt.sessionTxWg.Add(1)
go func() {
defer dt.sessionTxWg.Done()
err := dt.xport.send(sm.msg)
sm.completeChan <- err
}()
}
}
}
func (dt *dynamicTunnel) handleEvent(ev string, args ...interface{}) {
if ev != "" {
level.Debug(dt.logger).Log(
"message", "fsm event",
"event", ev)
err := dt.fsm.handleEvent(ev, args...)
if err != nil {
level.Error(dt.logger).Log(
"message", "failed to handle fsm event",
"error", err)
// TODO: this may be extreme
dt.fsmActClose(nil)
}
}
}
func (dt *dynamicTunnel) injectEvent(ev string, args ...interface{}) {
ea := eventArgs{event: ev}
for i := 0; i < len(args); i++ {
ea.args = append(ea.args, args[i])
}
dt.eventChan <- &ea
}
// panics if expected arguments are not passed
func fsmArgsToV2MsgFrom(args []interface{}) (msg *v2ControlMessage, from unix.Sockaddr) {
if len(args) != 2 {
panic(fmt.Sprintf("unexpected argument count (wanted 2, got %v)", len(args)))
}
msg, ok := args[0].(*v2ControlMessage)
if !ok {
panic(fmt.Sprintf("first argument %T not *v2ControlMessage", args[0]))
}
from, ok = args[1].(unix.Sockaddr)
if !ok {
panic(fmt.Sprintf("second argument %T not unix.Sockaddr", args[0]))
}
return
}
// panics if expected arguments are not passed
func fsmArgsToSession(args []interface{}) (ds *dynamicSession) {
if len(args) != 1 {
panic(fmt.Sprintf("unexpected argument count (wanted 1, got %v)", len(args)))
}
ds, ok := args[0].(*dynamicSession)
if !ok {
panic(fmt.Sprintf("first argument %T not *dynamicSession", args[0]))
}
return
}
// stopccn args are optional, we set defaults here
func fsmArgsToStopccnResult(args []interface{}) *resultCode {
rc := resultCode{
result: avpStopCCNResultCodeClearConnection,
errCode: avpErrorCodeNoError,
}
for i := 0; i < len(args); i++ {
switch v := args[i].(type) {
case avpResultCode:
rc.result = v
case avpErrorCode:
rc.errCode = v
case string:
rc.errMsg = v
}
}
return &rc
}
func (dt *dynamicTunnel) handleMsg(m *recvMsg) {
// Initial validation: ignore a message with the wrong protocol version
if m.msg.protocolVersion() != dt.cfg.Version {
level.Error(dt.logger).Log(
"message", "received control message with wrong protocol version",
"expected", dt.cfg.Version,
"got", m.msg.protocolVersion())
return
}
switch m.msg.protocolVersion() {
case ProtocolVersion2:
msg, ok := m.msg.(*v2ControlMessage)
if !ok {
// This shouldn't occur, since the header protocol version
// dictates the message type during parsing. Bail out if
// it does since it indicates some dire coding error.
level.Error(dt.logger).Log(
"message", "couldn't cast L2TPv2 message as v2ControlMessage")
dt.fsmActClose(nil)
return
}
dt.handleV2Msg(msg, m.from)
return
}
level.Error(dt.logger).Log(
"message", "unhandled protocol version",
"version", m.msg.protocolVersion())
dt.handleEvent("close",
avpStopCCNResultCodeChannelProtocolVersionUnsupported,
avpErrorCode(ProtocolVersion2),
fmt.Sprintf("unhandled protocol version %v", m.msg.protocolVersion()))
}
func (dt *dynamicTunnel) handleV2Msg(msg *v2ControlMessage, from unix.Sockaddr) {
// It's possible to have a message mis-delivered on our control
// socket. Ignore these messages: ideally we'd redirect them
// but dropping them is a good compromise for now.
if msg.Tid() != uint16(dt.cfg.TunnelID) {
level.Error(dt.logger).Log(
"message", "received control message with the wrong TID",
"expected", dt.cfg.TunnelID,
"got", msg.Tid())
return
}
// Validate the message. If validation fails drive shutdown via.
// the FSM to allow the error to be communicated to the peer.
err := msg.validate()
if err != nil {
level.Error(dt.logger).Log(
"message", "bad control message",
"message_type", msg.getType(),
"error", err)
dt.handleEvent("close",
avpStopCCNResultCodeGeneralError,
avpErrorCodeBadValue,
fmt.Sprintf("bad %v message: %v", msg.getType(), err))
}
// Map the message to the appropriate event type. If we haven't got
// an event appropriate to the incoming message close the tunnel.
eventMap := []struct {
m avpMsgType
e string
}{
{avpMsgTypeSccrq, "sccrq"},
{avpMsgTypeSccrp, "sccrp"},
{avpMsgTypeScccn, "scccn"},
{avpMsgTypeStopccn, "stopccn"},
{avpMsgTypeHello, ""}, // fsm ignores empty events
{avpMsgTypeIcrq, "sessionmsg"},
{avpMsgTypeIcrp, "sessionmsg"},
{avpMsgTypeIccn, "sessionmsg"},
{avpMsgTypeCdn, "sessionmsg"},
{avpMsgTypeSli, "sli"},
{avpMsgTypeWen, "wen"},
}
for _, em := range eventMap {
if msg.getType() == em.m {
dt.handleEvent(em.e, msg, from)
return
}
}
level.Error(dt.logger).Log(
"message", "unhandled v2 control message",
"message_type", msg.getType())
dt.handleEvent("close",
avpStopCCNResultCodeGeneralError,
avpErrorCodeBadValue,
fmt.Sprintf("unhandled v2 control message %v", msg.getType()))
}
func (dt *dynamicTunnel) fsmActSendSccrq(args []interface{}) {
err := dt.sendSccrq()
if err != nil {
level.Error(dt.logger).Log(
"message", "failed to send SCCRQ message",
"error", err)
dt.fsmActClose(nil)
}
}
func (dt *dynamicTunnel) sendSccrq() error {
msg, err := newV2Sccrq(dt.cfg)
if err != nil {
return err
}
return dt.xport.send(msg)
}
func (dt *dynamicTunnel) fsmActOnSccrp(args []interface{}) {
msg, from := fsmArgsToV2MsgFrom(args)
ptid, err := findUint16Avp(msg.getAvps(), vendorIDIetf, avpTypeTunnelID)
if err != nil {
// Shouldn't occur since tunnel ID is mandatory
level.Error(dt.logger).Log(
"message", "failed to parse peer tunnel ID from SCCRP",
"error", err)
dt.handleEvent("close")
return
}
// Reconfigure transport and socket now we know the peer TID
// and the address being used for this tunnel
dt.xport.config.PeerControlConnID = ControlConnID(ptid)
dt.cfg.PeerTunnelID = ControlConnID(ptid)
dt.cp.connectTo(from)
err = dt.sendScccn()
if err != nil {
level.Error(dt.logger).Log(
"message", "failed to send SCCCN",
"error", err)
dt.fsmActClose(nil)
return
}
level.Info(dt.logger).Log("message", "control plane established")
// establish the data plane
dt.dp, err = dt.parent.dp.NewTunnel(dt.cfg, dt.sal, dt.sap, dt.cp.fd)
if err != nil {
level.Error(dt.logger).Log(
"message", "failed to establish data plane",
"error", err)
dt.handleEvent("close",
avpStopCCNResultCodeGeneralError,
avpErrorCodeVendorSpecificError,
fmt.Sprintf("failed to instantiate tunnel data plane: %v", err))
return
}
level.Info(dt.logger).Log("message", "data plane established")
// inform sessions that we're up
for _, s := range dt.allSessions() {
if ds, ok := s.(*dynamicSession); ok {
ds.onTunnelUp()
}
}
dt.established = true
dt.parent.handleUserEvent(&TunnelUpEvent{
TunnelName: dt.getName(),
Tunnel: dt,
Config: dt.cfg,
LocalAddress: dt.sal,
PeerAddress: dt.sap,
})
}
func (dt *dynamicTunnel) sendScccn() error {
msg, err := newV2Scccn(dt.cfg)
if err != nil {
return err
}
return dt.xport.send(msg)
}
func (dt *dynamicTunnel) fsmActSendStopccn(args []interface{}) {
rc := fsmArgsToStopccnResult(args)
// Ignore tx error since we're going to close in any case
_ = dt.sendStopccn(rc)
dt.fsmActClose(args)
}
func (dt *dynamicTunnel) sendStopccn(rc *resultCode) error {
msg, err := newV2Stopccn(rc, dt.cfg)
if err != nil {
return err
}
return dt.xport.send(msg)
}
// Implementes stopccn pend timeout as per RFC2661 section 5.7.
//
// While pending the timeout we ignore further messages, but
// continue to drain the transport in order to allow messages to
// be ACKed.
func (dt *dynamicTunnel) fsmActOnStopccn(args []interface{}) {
level.Debug(dt.logger).Log(
"message", "pending for stopccn retransmit period",
"timeout", dt.cfg.StopCCNTimeout)
timeout := time.NewTimer(dt.cfg.StopCCNTimeout)
for {
select {
case <-timeout.C:
dt.fsmActClose(args)
return
case <-dt.xport.recvChan:
}
}
}
func (dt *dynamicTunnel) fsmActLinkSession(args []interface{}) {
ds := fsmArgsToSession(args)
dt.linkSession(ds)
}
func (dt *dynamicTunnel) fsmActStartSession(args []interface{}) {
ds := fsmArgsToSession(args)
dt.linkSession(ds)
ds.onTunnelUp()
}
func (dt *dynamicTunnel) fsmActForwardSessionMsg(args []interface{}) {
msg, _ := fsmArgsToV2MsgFrom(args)
if s, ok := dt.findSessionByID(ControlConnID(msg.Sid())); ok {
if ds, ok := s.(*dynamicSession); ok {
ds.handleCtlMsg(msg)
}
} else {
// TODO: on receipt of ICRQ we'll end up here; to handle this
// we'd need to be able to create an LNS-mode session instance
level.Error(dt.logger).Log(
"message", "received session message for unknown session",
"message_type", msg.getType(),
"session ID", msg.Sid())
}
}
func (dt *dynamicTunnel) fsmActIgnoreMsg(args []interface{}) {
msg, _ := fsmArgsToV2MsgFrom(args)
level.Warn(dt.logger).Log(
"message", "ignoring unimplemented v2 control message",
"message_type", msg.getType())
}
// Closes all tunnel resources and unlinks child sessions.
// The tunnel goroutine will terminate after this call completes
// because the transport recv channel will have been closed.
func (dt *dynamicTunnel) fsmActClose(args []interface{}) {
if dt != nil {
dt.closingLock.Lock()
defer dt.closingLock.Unlock()
if dt.isClosing {
return
}
dt.isClosing = true
dt.closeAllSessions()
if dt.dp != nil {
err := dt.dp.Down()
if err != nil {
level.Error(dt.logger).Log("message", "dataplane down failed", "error", err)
}
}
if dt.xport != nil {
dt.xport.close()
}
if dt.cp != nil {
dt.cp.close()
}
if dt.established {
dt.established = false
dt.parent.handleUserEvent(&TunnelDownEvent{
TunnelName: dt.getName(),
Tunnel: dt,
Config: dt.cfg,
LocalAddress: dt.sal,
PeerAddress: dt.sap,
})
}
dt.parent.unlinkTunnel(dt)
level.Info(dt.logger).Log("message", "close")
}
}
// Create a new client/LAC mode tunnel instance running the full control protocol
func newDynamicTunnel(name string, parent *Context, sal, sap unix.Sockaddr, cfg *TunnelConfig) (dt *dynamicTunnel, err error) {
// Currently only handle L2TPv2
if cfg.Version != ProtocolVersion2 {
return nil, fmt.Errorf("L2TPv3 dynamic tunnels are not (yet) supported")
}
dt = &dynamicTunnel{
baseTunnel: newBaseTunnel(
log.With(parent.logger, "tunnel_name", name),
name,
parent,
cfg),
sal: sal,
sap: sap,
closeChan: make(chan bool),
sendChan: make(chan *sendMsg),
eventChan: make(chan *eventArgs),
}
// Ref: RFC2661 section 7.2.1
dt.fsm = fsm{
current: "idle",
table: []eventDesc{
// No other events possible in the idle state since we handle open to
// kick off the FSM
{from: "idle", events: []string{"open"}, cb: dt.fsmActSendSccrq, to: "waitctlreply"},
// waitctlreply is for when we've sent an sccrq to the peer and are waiting on the reply
{from: "waitctlreply", events: []string{"sccrp"}, cb: dt.fsmActOnSccrp, to: "established"},
{from: "waitctlreply", events: []string{"stopccn"}, cb: dt.fsmActOnStopccn, to: "dead"},
{from: "waitctlreply", events: []string{"newsession"}, cb: dt.fsmActLinkSession, to: "waitctlreply"},
// TODO: don't really expect session messages: OK to ignore?
{from: "waitctlreply", events: []string{"sessionmsg"}, cb: nil, to: "waitctlreply"},
{
from: "waitctlreply",
events: []string{
"sccrq",
"scccn",
"close",
},
cb: dt.fsmActSendStopccn,
to: "dead",
},
// established is for once the tunnel three-way handshake is complete
{from: "established", events: []string{"stopccn"}, cb: dt.fsmActOnStopccn, to: "dead"},
{from: "established", events: []string{"newsession"}, cb: dt.fsmActStartSession, to: "established"},
{from: "established", events: []string{"sessionmsg"}, cb: dt.fsmActForwardSessionMsg, to: "established"},
{from: "established", events: []string{"sli", "wen"}, cb: dt.fsmActIgnoreMsg, to: "established"},
{
from: "established",
events: []string{
"sccrq",
"sccrp",
"scccn",
"close",
},
cb: dt.fsmActSendStopccn,
to: "dead",
},
},
}
dt.cp, err = newL2tpControlPlane(sal, sap)
if err != nil {
dt.Close()
return nil, err
}
err = dt.cp.bind()
if err != nil {
dt.Close()
return nil, err
}
dt.xport, err = newTransport(dt.logger, dt.cp, transportConfig{
HelloTimeout: dt.cfg.HelloTimeout,
TxWindowSize: dt.cfg.WindowSize,
MaxRetries: dt.cfg.MaxRetries,
RetryTimeout: dt.cfg.RetryTimeout,
AckTimeout: time.Millisecond * 100,
Version: dt.cfg.Version,
PeerControlConnID: dt.cfg.PeerTunnelID,
})
if err != nil {
dt.Close()
return nil, err
}
dt.wg.Add(1)
go dt.runTunnel()
return
}
|