Completed the EAPOL State machine
Stopping BBSim in the proper way when OLT-Reboot is received
Change-Id: I142eaa70e329121a5331f1a5706ed864fcf5d993
diff --git a/internal/bbsim/responders/eapol/eapol.go b/internal/bbsim/responders/eapol/eapol.go
new file mode 100644
index 0000000..d32999a
--- /dev/null
+++ b/internal/bbsim/responders/eapol/eapol.go
@@ -0,0 +1,287 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+
+ * http://www.apache.org/licenses/LICENSE-2.0
+
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package eapol
+
+import (
+ "crypto/md5"
+ "errors"
+ bbsim "github.com/opencord/bbsim/internal/bbsim/types"
+ "github.com/google/gopacket"
+ "github.com/google/gopacket/layers"
+ "github.com/looplab/fsm"
+ omci "github.com/opencord/omci-sim"
+ "github.com/opencord/voltha-protos/go/openolt"
+ log "github.com/sirupsen/logrus"
+ "net"
+ "sync"
+)
+
+var eapolLogger = log.WithFields(log.Fields{
+ "module": "EAPOL",
+})
+
+var eapolVersion uint8 = 1
+
+func CreateWPASupplicant(onuId uint32, ponPortId uint32, serialNumber *openolt.SerialNumber, onuStateMachine *fsm.FSM, stream openolt.Openolt_EnableIndicationServer, pktOutCh chan *bbsim.ByteMsg) {
+ // NOTE pckOutCh is channel to listen on for packets received by VOLTHA
+ // the OLT device will publish messages on that channel
+
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Infof("EAPOL State Machine starting")
+
+ var wg sync.WaitGroup
+ wg.Add(1)
+
+ if err := sendEapStart(onuId, ponPortId, serialNumber, stream); err != nil {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Errorf("Can't retrieve GemPortId: %s", err)
+ if err := onuStateMachine.Event("auth_failed"); err != nil {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Errorf("Error while transitioning ONU State %v", err)
+ }
+ return
+ }
+ if err := onuStateMachine.Event("eap_start_sent"); err != nil {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Errorf("Error while transitioning ONU State %v", err)
+ }
+
+ // NOTE do we really need a thread here?
+ go func() {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Infof("Listening on eapolPktOutCh")
+ for msg := range pktOutCh {
+ recvpkt := gopacket.NewPacket(msg.Bytes, layers.LayerTypeEthernet, gopacket.Default)
+ eap, err := extractEAP(recvpkt)
+ if err != nil {
+ eapolLogger.Errorf("%s", err)
+ }
+
+ if eap.Code == layers.EAPCodeRequest && eap.Type == layers.EAPTypeIdentity {
+ reseap := createEAPIdentityResponse(eap.Id)
+ pkt := createEAPOLPkt(reseap, onuId, ponPortId)
+
+ msg := bbsim.ByteMsg{
+ IntfId: ponPortId,
+ OnuId: onuId,
+ Bytes: pkt,
+ }
+
+ sendEapolPktIn(msg, stream)
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Infof("Sent EAPIdentityResponse packet")
+ if err := onuStateMachine.Event("eap_resonse_identity_sent"); err != nil {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Errorf("Error while transitioning ONU State %v", err)
+ }
+
+ } else if eap.Code == layers.EAPCodeRequest && eap.Type == layers.EAPTypeOTP {
+ senddata := getMD5Data(eap)
+ senddata = append([]byte{0x10}, senddata...)
+ sendeap := createEAPChallengeResponse(eap.Id, senddata)
+ pkt := createEAPOLPkt(sendeap, onuId, ponPortId)
+
+ msg := bbsim.ByteMsg{
+ IntfId: ponPortId,
+ OnuId: onuId,
+ Bytes: pkt,
+ }
+
+ sendEapolPktIn(msg, stream)
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Infof("Sent EAPChallengeResponse packet")
+ if err := onuStateMachine.Event("eap_resonse_challenge_sent"); err != nil {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Errorf("Error while transitioning ONU State %v", err)
+ }
+ } else if eap.Code == layers.EAPCodeSuccess && eap.Type == layers.EAPTypeNone {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Infof("Received EAPSuccess packet")
+ if err := onuStateMachine.Event("eap_resonse_success_received"); err != nil {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Errorf("Error while transitioning ONU State %v", err)
+ }
+ wg.Done()
+ }
+
+ }
+
+
+ }()
+
+ defer eapolLogger.WithFields(log.Fields{
+ "OnuId": onuId,
+ "IntfId": ponPortId,
+ "OnuSn": serialNumber,
+ }).Infof("EAPOL State machine completed")
+
+ wg.Wait()
+}
+
+func sendEapolPktIn(msg bbsim.ByteMsg, stream openolt.Openolt_EnableIndicationServer) {
+ gemid, err := omci.GetGemPortId(msg.IntfId, msg.OnuId)
+ if err != nil {
+ eapolLogger.WithFields(log.Fields{
+ "OnuId": msg.OnuId,
+ "IntfId": msg.IntfId,
+ }).Errorf("Can't retrieve GemPortId: %s", err)
+ return
+ }
+ data := &openolt.Indication_PktInd{PktInd: &openolt.PacketIndication{
+ IntfType: "pon", IntfId: msg.IntfId, GemportId: uint32(gemid), Pkt: msg.Bytes,
+ }}
+
+ if err := stream.Send(&openolt.Indication{Data: data}); err != nil {
+ eapolLogger.Errorf("Fail to send EAPOL PktInd indication. %v", err)
+ return
+ }
+}
+
+func getMD5Data(eap *layers.EAP) []byte {
+ i := byte(eap.Id)
+ C := []byte(eap.BaseLayer.Contents)[6:]
+ P := []byte{i, 0x70, 0x61, 0x73, 0x73, 0x77, 0x6f, 0x72, 0x64} // "password"
+ data := md5.Sum(append(P, C...))
+ ret := make([]byte, 16)
+ for j := 0; j < 16; j++ {
+ ret[j] = data[j]
+ }
+ return ret
+}
+
+func createEAPChallengeResponse(eapId uint8, payload []byte) *layers.EAP {
+ eap := layers.EAP{
+ Code: layers.EAPCodeResponse,
+ Id: eapId,
+ Length: 22,
+ Type: layers.EAPTypeOTP,
+ TypeData: payload,
+ }
+ return &eap
+}
+
+func createEAPIdentityResponse(eapId uint8) *layers.EAP {
+ eap := layers.EAP{Code: layers.EAPCodeResponse,
+ Id: eapId,
+ Length: 9,
+ Type: layers.EAPTypeIdentity,
+ TypeData: []byte{0x75, 0x73, 0x65, 0x72}}
+ return &eap
+}
+
+func createEAPOLPkt(eap *layers.EAP, onuId uint32, intfId uint32) []byte {
+ buffer := gopacket.NewSerializeBuffer()
+ options := gopacket.SerializeOptions{}
+
+ ethernetLayer := &layers.Ethernet{
+ SrcMAC: net.HardwareAddr{0x2e, 0x60, 0x70, 0x13, byte(intfId), byte(onuId)},
+ DstMAC: net.HardwareAddr{0x01, 0x80, 0xC2, 0x00, 0x00, 0x03},
+ EthernetType: layers.EthernetTypeEAPOL,
+ }
+
+
+ gopacket.SerializeLayers(buffer, options,
+ ethernetLayer,
+ &layers.EAPOL{Version: eapolVersion, Type: 0, Length: eap.Length},
+ eap,
+ )
+
+ bytes := buffer.Bytes()
+ return bytes
+}
+
+func extractEAP(pkt gopacket.Packet) (*layers.EAP, error) {
+ layerEAP := pkt.Layer(layers.LayerTypeEAP)
+ eap, _ := layerEAP.(*layers.EAP)
+ if eap == nil {
+ return nil, errors.New("Cannot extract EAP")
+ }
+ return eap, nil
+}
+
+var sendEapStart = func(onuId uint32, ponPortId uint32, serialNumber *openolt.SerialNumber, stream openolt.Openolt_EnableIndicationServer) error {
+
+ // send the packet (hacked together)
+ gemid, err := omci.GetGemPortId(ponPortId, onuId)
+ if err != nil {
+ return err
+ }
+
+ buffer := gopacket.NewSerializeBuffer()
+ options := gopacket.SerializeOptions{}
+
+ ethernetLayer := &layers.Ethernet{
+ SrcMAC: net.HardwareAddr{0x2e, 0x60, 0x70, 0x13, byte(ponPortId), byte(onuId)}, // TODO move the SrcMAC in the ONU Device
+ DstMAC: net.HardwareAddr{0x01, 0x80, 0xC2, 0x00, 0x00, 0x03},
+ EthernetType: layers.EthernetTypeEAPOL,
+ }
+
+ gopacket.SerializeLayers(buffer, options,
+ ethernetLayer,
+ &layers.EAPOL{Version: eapolVersion, Type: 1, Length: 0},
+ )
+
+ msg := buffer.Bytes()
+
+ data := &openolt.Indication_PktInd{
+ PktInd: &openolt.PacketIndication{
+ IntfType: "pon",
+ IntfId: ponPortId,
+ GemportId: uint32(gemid),
+ Pkt: msg,
+ },
+ }
+ // end of hacked (move in an EAPOL state machine)
+ if err := stream.Send(&openolt.Indication{Data: data}); err != nil {
+ eapolLogger.Errorf("Fail to send EAPOL PktInd indication. %v", err)
+ return err
+ }
+ return nil
+}
\ No newline at end of file