summaryrefslogtreecommitdiff
path: root/maximus/python/lib/mmentry/encapsulation/encapsulation.py
blob: d09deedfbf11067ef80ef4ad1924f5a13cd88249 (plain)
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
# -*- coding:Utf-8 -*-

#------ Encapsulated MME Library Prototypes -------

import sys
sys.path.append('../../python/lib/mmentry')

from Constants import *		#Constants library is used : mme
from struct import *		#struct library is used : pack(), 

#import sys
sys.path.append('./test')
sys.path.append('../test')
import startup

from maximus import *

#print "Create MME"
myMme = MME()

#The Encapsulated MME is composed by :

class EncapsulatedMme():
	
	#Original Destination address in the MME is a 6 Bytes field
	oda = unpack('Q',staAAddress+"\x00\x00")[0]
	odaField = staAAddress
	#createOda creates the Original Destination Address Field in the MME
	def createOda(self, myOda=None):
		try:
			if myOda!=None:
				self.oda=myOda
			self.odaField = pack('Q',self.oda)[0:6]
		except:
			if myOda!=None:
				self.odaField=myOda
			self.oda = unpack('Q',self.odaField+"\x00\x00")[0]
		print "oda = "+hex(self.oda)
	
	#Original source address in the MME is a 6 Bytes field
	# by default equals to the Maximus Simulator Address
	osa = unpack('Q',maxAddress+"\x00\x00")[0]
	osaField = maxAddress
	#osa = maxAddress
	#osaField = pack('Q',osa)[0:6]
	#createOsa creates the Original Destination Address Field in the MME
	def createOsa(self, myOsa=None):
		try:
			if myOsa!=None:
				self.osa=myOsa
			self.osaField = pack('Q',self.osa)[0:6]
		except:
			if myOsa!=None:
				self.osaField=myOsa
			self.osa = unpack('Q',self.osaField+"\x00\x00")[0]
		print "osa = "+hex(self.osa)
	
	#VLAN Tag in the MME is an optional 4 Bytes field
	# by convention if vlanTag = 0, there is no VLAN Tag Field in the MME
	vlanTag = 0x00000000
	vlanTagField = pack('I',vlanTag)
	#createVlanTag creates the otional VLAN Tag Field in The MME
	def createVlanTag(self, myVlanTag=None):
		try:
			if myVlanTag!=None:
				self.vlanTagField=myVlanTag
			self.vlanTag = unpack('I',self.vlanTagField)[0]
		except:
			if myVlanTag!=None:
				self.vlanTag=myVlanTag
			self.vlanTagField = pack('I',self.vlanTag)
		print "vlanTag = "+hex(self.vlanTag)
	
	#mtype in the MME is a 2 Bytes Field
	mtype = 0xe188			#Default IEEE value
	mtypeField = pack('H',mtype)
	#createMtype creates the MTYPE Field in the MME
	def createMtype(self, myMtype=None):
		try:
			if myMtype!=None:
				self.mtype=myMtype
			self.mtypeField = pack('H',self.mtype)
		except:
			if myMtype!=None:
				self.mtypeField=myMtype
			self.mtype = unpack('H',self.mtypeField)[0]
		print "mtype = "+hex(self.mtype)
	
	#MMV in the MME is a 1 Byte Field
	# equals to 0 for HPAV Specification V1.0
	# equals to 1 for HPAV Specification V1.1
	# all others values are reserved
	mmv = 0
	mmvField = pack('B',mmv)
	#createMmv creates the MMV Field in the MME
	def createMmv(self, myMmv=None):
		try:
			if myMmv!=None:
				self.mmv=myMmv
			self.mmvField = pack('B',self.mmv)
		except:
			if myMmv!=None:
				self.mmvField=myMmv
			self.mmv = unpack('B',self.mmvField)[0]
		print "mmv = "+hex(self.mmv)
	
	#MMTYPE in the MME is a 2 Bytes Field
	# corresponding to the MME Type
	# see MME interpretation in the Constants
	mmtype = 0
	mmtypeField = pack('H',mmtype)
	#createMmtype creates the MMTYPE Field in the MME
	def createMmtype(self, myMmtype=None):
		try:
			if myMmtype!=None:
				self.mmtype=myMmtype
			self.mmtypeField = pack('H',self.mmtype)
		except:
			if myMmtype!=None:
				self.mmtypeField=myMmtype
			self.mmtype = unpack('H',self.mmtypeField)[0]
		print "mmtype = "+hex(self.mmtype)
	
	#FMI in the MME is a 2 Bytes Field composed by :
	# - MSByte :
	#	- 4 MSBits = NF_MI = Number of fragments
	#	- 4 LSBits = FN_MI = Fragment Number
	# - LSByte = FMSN = Fragmentation Message Sequence Number
	nfMi = 0	#by default MMENTRY is not Fragmented
	fnMi = 0	#by default First or Only Fragment
	fmsn = 0	#initialized to 0 by default
	#FMI equals to 	 NF_MI 12 bits left shifted
	#		+FN_MI 4 bits left shifted
	#		+FNSM
	#First or Only fragment FMI
	fmi = nfMi*pow(2,8+4)+fnMi*pow(2,8)+fmsn
	#First or Only fragment FMI Field
	fmiField = pack('H',fmi)
	#creatFmi creates the FMI Field in the MME
	def createFmi(self, myNfmi=None, myFnMi=None, myFmsn=None, myFmi=None):
		if myFmi!=None:
			try:
				self.fmi = myFmi
				self.fmiField = pack('H',self.fmi)
				self.fmsn = self.fmi%pow(2,8)
				self.fnMi = (self.fmi/pow(2,8))%pow(2,4)
				self.nfMi = self.fmi/pow(2,12)
			except:
				self.fmiField = myFmi
				self.fmi = unpack('H',self.fmiField)[0]
				self.fmsn = int(self.fmi%pow(2,8))
				self.fnMi = int((self.fmi/pow(2,8))%pow(2,4))
				self.nfMi = int(self.fmi/pow(2,12))
		else:
			if myNfmi!=None:
				self.nfMi=myNfmi
			if myFnMi!=None:
				self.fnMi=myFnMi
			if myFmsn!=None:
				self.fmsn=myFmsn
			#FMI computation
			self.fmi=self.nfMi*pow(2,8+4)+self.fnMi*pow(2,8)+self.fmsn
			#FMI Field creation
			self.fmiField = pack('H',self.fmi)
		print "nfMi = "+hex(self.nfMi)
		print "fnMi = "+hex(self.fnMi)
		print "fmsn = "+hex(self.fmsn)
	
	#MMENTRY in the MME is a m Bytes field
	mmentryField = ""
	#createMmentry creates the MMENTRY Field in the MME
	def createMmentry(self, myMmentry=None):
		if myMmentry!=None:
			self.mmentryField=myMmentry
		#print "mmentry = "+self.mmentryField
	
	
	#MME Frame (CM_ENCRYPTED_PAYLOAD.IND Encapsulated MM Entry Field)
	encapsulatedMmEntry = ""
	#createEncapsulatedMmEntry creates the Encapsulated MM Entry Field in the encrypted MME
	def createEncapsulatedMmEntry(self, myOda=None, myOsa=None, myVlanTag=None, myMtype=None, myMmv=None, myMmtype=None, myNfmi=None, myFnMi=0, myFmsn=0, myMmentry=None, myEncapsulatedMmEntry=None, myThisFnMi=None):
		if myEncapsulatedMmEntry=="ToEncrypt":
			print "encapsulatedMmEntry :"
			self.createOda(myOda)
			self.createOsa(myOsa)
			self.createVlanTag(myVlanTag)
			self.createMtype(myMtype)
			self.createMmv(myMmv)
			self.createMmtype(myMmtype)
			if myNfmi == None:
				myNfmi = int((len(myMmentry)-1)/1492)
			if myFnMi==None:
				myFnMi = myThisFnMi
			self.createFmi(myNfmi, myFnMi, myFmsn)
			if myThisFnMi == None:
				myThisFnMi = self.fnMi
			self.createMmentry(myMmentry)	#No fragmentation before encryption
			self.encapsulatedMmEntry = self.odaField + self.osaField + self.vlanTagField + self.mtypeField + self.mmvField + self.mmtypeField + self.fmiField + self.mmentryField
			try:
				myMme.set_mmheader(self.encapsulatedMmEntry[:23])
				myMme.set_mmentry(self.mmentryField)
			except:
				print "MM Entry too long"
			return self.encapsulatedMmEntry
		elif myEncapsulatedMmEntry!=None:
			self.encapsulatedMmEntry=myEncapsulatedMmEntry
			self.createOda(myOda=self.encapsulatedMmEntry[0:6])
			self.createOsa(myOsa=self.encapsulatedMmEntry[6:12])
			self.createVlanTag(myVlanTag=self.encapsulatedMmEntry[12:16])
			self.createMtype(myMtype=self.encapsulatedMmEntry[16:18])
			self.createMmv(myMmv=self.encapsulatedMmEntry[18:19])
			self.createMmtype(myMmtype=self.encapsulatedMmEntry[19:21])
			self.createFmi(myFmi = self.encapsulatedMmEntry[21:23])
			self.createMmentry(myMmentry=self.encapsulatedMmEntry[23:])
			return self.mmentryField
		else:
			print "encapsulatedMmEntry :"
			self.createOda(myOda)
			self.createOsa(myOsa)
			self.createVlanTag(myVlanTag)
			self.createMtype(myMtype)
			self.createMmv(myMmv)
			self.createMmtype(myMmtype)
			if myNfmi == None:
				myNfmi = int((len(myMmentry)-1)/1492)
			if myFnMi==None:
				myFnMi = myThisFnMi
			self.createFmi(myNfmi, myFnMi, myFmsn)
			if myThisFnMi == None:
				myThisFnMi = self.fnMi
			self.createMmentry(myMmentry[myThisFnMi*1492:(myThisFnMi+1)*1492])
			self.encapsulatedMmEntry = self.odaField + self.osaField + self.vlanTagField + self.mtypeField + self.mmvField + self.mmtypeField + self.fmiField + self.mmentryField
			try:
				myMme.set_mmheader(self.encapsulatedMmEntry[:23])
				myMme.set_mmentry(self.mmentryField)
			except:
				print "MM Entry too long"
			return self.encapsulatedMmEntry