github.com/zartbot/goflow@v0.0.0-20221001080520-456f7dfad288/ipfix/record.go (about)

     1  package ipfix
     2  
     3  import (
     4  	"github.com/zartbot/goflow/datarecord"
     5  	"github.com/zartbot/goflow/iedb"
     6  	"github.com/zartbot/goflow/reader"
     7  )
     8  
     9  // FieldValueDecode : a fv decode function
    10  func FieldValueDecode(r *reader.Reader, tr *TemplateFieldSpecifier) (interface{}, error) {
    11  	var f interface{}
    12  	var err error
    13  	//f.Key = tr.Key
    14  	//f.Name = tr.Name
    15  	//f.Type = tr.Type
    16  	//  Variable Length Field
    17  	//	0                   1                   2                   3
    18  	//	0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
    19  	//  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    20  	//  | Length (< 255)|          Information Element                  |
    21  	//  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    22  	//  |                      ... continuing as needed                 |
    23  	//  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    24  	//		  Figure R: Variable-Length Information Element (IE)
    25  	//						 (Length < 255 Octets)
    26  	//  0                   1                   2                   3
    27  	//  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
    28  	//  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    29  	//  |      255      |      Length (0 to 65535)      |       IE      |
    30  	//  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    31  	//  |                      ... continuing as needed                 |
    32  	//  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    33  	//          Figure S: Variable-Length Information Element (IE)
    34  	//                      (Length 0 to 65535 Octets)
    35  	var tempValue []byte
    36  	if tr.Length == 65535 {
    37  		vlen, err := r.ReadUint8()
    38  		if err != nil {
    39  			return f, err
    40  		}
    41  		if vlen == 255 {
    42  			//Figure.S Length more than 255
    43  			var vlen2 uint16
    44  			vlen2, err = r.ReadUint16()
    45  			if err != nil {
    46  				return f, err
    47  			}
    48  			tempValue, err = r.ReadN(vlen2)
    49  		} else {
    50  			//Figure.R Length less than 255
    51  			if vlen > 0 {
    52  				tempValue, err = r.ReadN(uint16(vlen))
    53  			} else {
    54  				tempValue = []byte{}
    55  			}
    56  		}
    57  		if err != nil {
    58  			return f, err
    59  		}
    60  	} else {
    61  		//Normal fixed Length Field Reader
    62  		tempValue, err = r.ReadN(tr.Length)
    63  		if err != nil {
    64  			return f, err
    65  		}
    66  	}
    67  
    68  	f = iedb.ConvertDataType(&tempValue, tr.Dtype)
    69  	return f, nil
    70  }
    71  
    72  // DataRecordDecode : decode function
    73  func DataRecordDecode(r *reader.Reader, AgentID string, localport int, m *MessageHeader, s *FlowSetHeader) (datarecord.DataFrame, error) {
    74  	//d := datarecord.NewDataFrame()
    75  
    76  	var d datarecord.DataFrame
    77  	var err error
    78  
    79  	var t TemplateRecord
    80  
    81  	d.AgentID = AgentID
    82  	d.DomainID = m.DomainID
    83  	d.ExportTime = m.ExportTime
    84  	d.SetID = s.SetID
    85  
    86  	t, err = FetchTemplateMap(d.AgentID, localport, d.DomainID, d.SetID)
    87  	if err != nil {
    88  		//Template does not found, drop record
    89  		return d, nil
    90  	}
    91  
    92  	//debug processing time
    93  	//now := time.Now().Format("2006-01-02 15:04:05")
    94  
    95  	initpos := r.Pos
    96  	var byteremain uint16
    97  	for {
    98  		data := make(map[string]interface{})
    99  		//debug processing time
   100  		//data["GoFlow Processing Time"] = now
   101  		for idx := uint16(0); idx < t.Header.ScopeFieldCount; idx++ {
   102  			tr := t.ScopeFieldRecord[idx]
   103  			var fv interface{}
   104  			fv, err = FieldValueDecode(r, &tr)
   105  			if err != nil {
   106  				return d, err
   107  			}
   108  
   109  			if tr.Type == "ciscoappvarstring" {
   110  				//multiple same type element should be merge together
   111  				existElement, ok := data[tr.Name]
   112  				if ok {
   113  					e := existElement.(map[iedb.CiscoAppVarStringKey]string)
   114  					result := fv.(map[iedb.CiscoAppVarStringKey]string)
   115  					for k, v := range e {
   116  						result[k] = v
   117  					}
   118  					fv = result
   119  				}
   120  			}
   121  			data[tr.Name] = fv
   122  		}
   123  		for idx := uint16(0); idx < t.Header.FieldCount-t.Header.ScopeFieldCount; idx++ {
   124  			tr := t.FieldRecord[idx]
   125  			var fv interface{}
   126  			fv, err = FieldValueDecode(r, &tr)
   127  			if err != nil {
   128  				return d, err
   129  			}
   130  
   131  			if tr.Type == "ciscoappvarstring" {
   132  				//multiple same type element should be merge together
   133  				existElement, ok := data[tr.Name]
   134  				if ok {
   135  					e := existElement.(map[iedb.CiscoAppVarStringKey]string)
   136  					result := fv.(map[iedb.CiscoAppVarStringKey]string)
   137  					for k, v := range e {
   138  						result[k] = v
   139  					}
   140  					fv = result
   141  				}
   142  			}
   143  			data[tr.Name] = fv
   144  		}
   145  
   146  		d.Record = append(d.Record, data)
   147  
   148  		//fmt.Printf("Recode Finished......\tFlowSetLength:%d\tRead_Pos:%d\tInitPos:%d\tAlreadyRead:%d\t\n", s.Length, r.Pos, initpos, r.Pos-initpos)
   149  
   150  		byteremain = s.Length - 4 - (r.Pos - initpos)
   151  		// RFC 7011 Section 3.3.1. Set Format
   152  		// Padding
   153  		//
   154  		// The Exporting Process MAY insert some padding octets, so that the
   155  		// subsequent Set starts at an aligned boundary.  For security
   156  		// reasons, the padding octet(s) MUST be composed of octets with
   157  		// value zero (0).  The padding length MUST be shorter than any
   158  		// allowable record in this Set.  If padding of the IPFIX Message is
   159  		// desired in combination with very short records, then the padding
   160  		// Information Element 'paddingOctets' can be used for padding
   161  		// records such that their length is increased to a multiple of 4 or
   162  		// 8 octets.  Because Template Sets are always 4-octet aligned by
   163  		// definition, padding is only needed in the case of other
   164  		// alignments, e.g., on 8-octet boundaries.
   165  
   166  		if byteremain < 4 {
   167  			//read padding...
   168  			if byteremain > 0 {
   169  				_, err = r.ReadN(byteremain)
   170  				if err != nil {
   171  					return d, err
   172  				}
   173  			}
   174  			break
   175  		}
   176  	}
   177  	return d, nil
   178  }