EmailPDU.asn 10.3 KB
Newer Older
1
EmailPDU
2
{itu-t(0) identified-organization(4) etsi(0) securityDomain(2) lawfulIntercept(2) li-ps(5) email(2) version9(9)}
3
4
5
6
7
8
9
10
11

DEFINITIONS IMPLICIT TAGS ::=
BEGIN

IMPORTS

	-- from TS 101 671 [4]
	IPAddress
		FROM HI2Operations
12
		{itu-t(0) identified-organization(4) etsi(0) securityDomain(2) lawfulIntercept(2) hi2(1) version17(17)};
13
14
15
16
17
18


-- ============================
-- Object Identifier Definition
-- ============================

19
20
21
22
emailIRIObjId RELATIVE-OID		::= {li-ps(5) email(2) version9(9) iRI(1)}
emailCCObjId RELATIVE-OID		::= {li-ps(5) email(2) version9(9) cC(2)}
messagingIRIObjId RELATIVE-OID 	::= {li-ps(5) email(2) version9(9) messagingIRI(3)}
messagingCCObjId RELATIVE-OID 	::= {li-ps(5) email(2) version9(9) messagingCC(4)}
23

24
25
26
27
28
29
30
31
	-- definitions are relative to 
	-- {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) lawfulintercept(2)}


-- =============================
-- Email Communications Contents
-- =============================

32
EmailCC ::= SEQUENCE
33
34
35
36
37
38
39
40
	-- EmailCC is the PDU sent for each "piece" of E-mail captured content
{
	emailCCObjId		[0] RELATIVE-OID,
	email-Format		[1] Email-Format,
	content				[2] OCTET STRING
		-- Network byte order
}

41
Email-Format ::= ENUMERATED
42
43
44
45
{
	ip-packet(1),
		-- When this is the email format, the content will contain the bytes of the IP packet from 
		-- the IP header through to the end of the IP packet
46
		-- Meets requirement E.2.7
47
48
49
50
51
52
53
54
55
	application(2)
		-- Only the IP stack Layer 4 payload, (i.e. no IP or TCP headers)
		-- Meets requirement E.2.8
}

-- =======================================
-- Intercept-related information for Email
-- =======================================

56
EmailIRI ::= SEQUENCE
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
	-- EmailIRI is the PDU sent for each "piece" of E-mail IRI
{
	emailIRIObjId				[0] RELATIVE-OID,
	eventType					[1] E-mail-Event,
	client-Address				[2] IPAddress OPTIONAL,
		-- Provided if available
	server-Address				[3] IPAddress OPTIONAL,
		-- Provided if available
	client-Port					[4] INTEGER OPTIONAL,
		-- Provided if available
	server-Port					[5] INTEGER OPTIONAL,
		-- Provided if available
	server-Octets-Sent			[6] INTEGER,
	client-Octets-Sent			[7] INTEGER,
	protocol-ID					[8] E-mail-Protocol,
	e-mail-Sender				[9] UTF8String (SIZE (0..255)) OPTIONAL,
		-- Not available in some cases; if a value is available, it must be provided
	e-mail-Recipients			[10] E-mail-Address-List OPTIONAL,
		-- Not available in some cases; if a value is available, it must be provided
	status						[11] E-mail-Status,
	total-Recipient-Count 		[12] INTEGER (0..4294967295) OPTIONAL,
	message-ID					[13] OCTET STRING OPTIONAL,
		-- Network byte order
	nationalParameter			[14] OCTET STRING OPTIONAL,
		-- Completely defined on a national basis, including byte ordering
	...,
	national-EM-ASN1parameters	[15] National-EM-ASN1parameters OPTIONAL,
		-- Completely defined on a national basis
85
86
87
88
89
90
91
92
93
	aAAInformation				[16] AAAInformation OPTIONAL,
	e-mail-Sender-Validity		[17] ENUMERATED
		{
			validated(0),
				-- The operator has assured the e-mail-sender
			nonvalidated(1),
				-- The operator does not assure the e-mail-sender
			...
		} OPTIONAL
94
95
}

96
E-mail-Status ::= ENUMERATED
97
98
99
100
101
102
{
	status-unknown(1),
	operation-failed(2),
	operation-succeeded(3)
}

103
E-mail-Event ::= ENUMERATED
104
105
106
107
108
109
110
111
112
113
114
115
116
{
	e-mail-send(1),
	e-mail-receive(2),
	e-mail-download(3),
	...,
	e-mail-logon-attempt(4),
	e-mail-logon(5),
	e-mail-logon-failure(6),
	e-mail-logoff(7),
	e-mail-partial-download(8),
	e-mail-upload(9)
}

117
E-mail-Protocol ::= ENUMERATED
118
119
120
{
	smtp(1),
	pop3(2),
121
	imap4(3),
122
123
	undefined(255),
		-- The protocol is not known or not representable by the current enumeration
124
	...
125
126
}

127
E-mail-Address-List ::= SEQUENCE (SIZE (0..1023)) OF UTF8String(SIZE (0..255))
128

129
National-EM-ASN1parameters ::= SEQUENCE
130
131
132
133
134
135
136
137
138
139
{
	countryCode		[1] PrintableString (SIZE (2)),
		-- Country Code according to ISO 3166-1 [12],
		-- the country to which the parameters inserted after the extension marker apply
	...
		-- In case a given country wants to use additional national parameters according to its law,
		-- these national parameters should be defined using the ASN.1 syntax and added after the 
		-- extension marker (...)
}

140
AAAInformation ::= CHOICE
141
142
143
144
	-- The AAAInformation field allows for POP3 and authenticated SMTP AAA information
{
	pOP3AAAInformation			[0] POP3AAAInformation,
	aSMTPAAAInformation			[1] ASMTPAAAInformation,
145
146
	...,
	iMAPAAAInformation			[2] IMAPAAAInformation
147
148
}

149
POP3AAAInformation ::= SEQUENCE
150
151
152
153
154
155
156
157
	-- The POP3AAAInformation field contains the POP3 username & optionally the password
{
	username					[0] UTF8String (SIZE (0..64)),
	password					[1] UTF8String (SIZE (0..64)) OPTIONAL,
	aAAResult					[2] AAAResult OPTIONAL,
	...
}

158
ASMTPAAAInformation ::= SEQUENCE
159
160
161
162
163
164
165
166
167
168
169
170
171
172
	-- The ASMTPAAAInformation field contains the SMTP username and
	-- optionally the authentication fields
{
	username					[0] UTF8String (SIZE (0..64)),
	authMethod					[1] AAAauthMethod OPTIONAL,
		-- The hashing method used, i.e. CRAM-MD5, DIGEST-MD5, etc
	challenge					[2] OCTET STRING OPTIONAL,
		-- A BASE64 encoded challenge send by the SMTP server
	response					[3] OCTET STRING OPTIONAL,
		-- A BASE64 encoded hashed response returned by the client
	aAAResult					[4] AAAResult OPTIONAL,
	...
}

173
IMAPAAAInformation ::= SEQUENCE
174
175
176
177
178
179
180
181
	--- The iMAPAAAInformation field contains the IMAP username & optionally the password
{
	username					[0] UTF8String (SIZE (0..64)),
	password					[1] UTF8String (SIZE (0..64)) OPTIONAL,
	aAAResult					[2] AAAResult OPTIONAL,
	...
}

182
AAAResult ::= ENUMERATED
183
184
185
186
187
188
189
{
	resultUnknown(1),
	aAAFailed(2),
	aAASucceeded(3),
	...
}

190
AAAauthMethod ::= ENUMERATED
191
192
193
194
195
196
197
{
	undefinedAuthMethod(1),
	cramMD5(2),
	digestMD5(3),
	...
}

198
199
200
201
202
203
204
205
206
207
-- =================================
-- Messaging Communications Contents
-- =================================

MessagingCC ::= SEQUENCE
	-- MessagingCC is the PDU sent for the captured content
{
	messaging-cc-obj-id			[0] RELATIVE-OID,
	event-identifier			[1] INTEGER (0..4294967295),
		-- Used to correlate to MessagingIRI within the same CIN
208
209
210
211
	content-identifier			[2] INTEGER (0..4294967295) OPTIONAL,
	sequence-number				[3] INTEGER (0..4294967295) OPTIONAL,
	end-of-sequence				[4] BOOLEAN DEFAULT FALSE,
	content-type				[5] OCTET STRING,
212
		-- MIME content type, i.e.: image/png, text/plain;charset=utf8, audio/PCMA
213
	content						[6] OCTET STRING,
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
	...
}

-- ===========================================
-- Intercept-related information for Messaging
-- ===========================================

MessagingIRI ::= SEQUENCE
{
	messaging-iri-obj-id		[0] RELATIVE-OID,
	system-type					[1] Messaging-System-Type,
	system-identifier			[2] OCTET STRING OPTIONAL,
		-- Identifier up to national agreement, uniquely identifies a certain messaging system
	category					[3] Messaging-Event-Category OPTIONAL,
	status						[4] Messaging-Status,
	party-information			[5] SET OF Messaging-Party-Information OPTIONAL,
	trigger						[6] Messaging-Trigger,
	properties					[7] SEQUENCE OF Messaging-Property OPTIONAL,
	event-identifier			[8] INTEGER (0..4294967295) OPTIONAL,
		-- Used to correlate to MessagingCC within the same CIN. Mandatory when CC is also sent
	original-message			[9] OCTET STRING OPTIONAL,
235
236
	...,
	box-identifier				[10] OCTET STRING OPTIONAL
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
}

Messaging-System-Type ::= ENUMERATED
{
	unified-messaging(1),
	...
}

Messaging-Event-Category ::= CHOICE
{
	message						[0] Messaging-Event,
	message-box					[1] Messaging-Box-Event,
	message-notification		[2] Messaging-Notification-Event,
	call						[3] Messaging-Call-Event,
	...
}

Messaging-Event ::= ENUMERATED
{
	deposit(1),
	retrieve(2),
	delete(3),
	save(4),
260
	slamdown(5),
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
	...
}

Messaging-Box-Event ::= ENUMERATED
{
	login(1),
	logout(2),
	lock(3),
	unlock(4),
	activate(5),
	deactivate(6),
	delete(7),
	pin-change(8),
	greeting-record(9),
	greeting-change(10),
	greeting-delete(11),
	greeting-enable(12),
	greeting-disable(13),
	notification-enable(14),
	notification-disable(15),
	disconnect(16),
282
	connect(17),
283
284
285
286
287
	...,
	greeting-play(18),
	language-change(19),
	pin-security-enable(20),
	pin-security-disable(21)
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
}

Messaging-Notification-Event ::= ENUMERATED
{
	sms(1),
	sms-deposit(2),
	sms-slamdown(3),
	sms-pin-reminder(4),
	email(5),
	fax-to-email(6),
	...
}

Messaging-Call-Event ::= ENUMERATED
{
	callout(1),
	...
}

Messaging-Status ::= ENUMERATED
{
309
310
	unknown(0),
	not-applicable(1),
311
312
313
	operation-failed(2),
	operation-succeeded(3),
	operation-cancelled(4),
314
	operation-started(5),
315
316
317
318
319
	...
}

Messaging-Party-Information ::= SEQUENCE
{
320
	party-qualifier		[0] Messaging-Party-Qualifier,
321
322
323
324
325
326
327
328
329
330
331
332
333
334
	party-identity		[1] Messaging-Party-Identity,
	...
}

Messaging-Party-Qualifier ::= ENUMERATED
{
	unknown-party(0),
		-- In this case the party cannot be classified as either originating or terminating
	originating-party(1),
		-- In this case, the partyInformation parameter provides the identities related to 
		-- the originating party and all information provided by this party.
	terminating-party(2),
		-- In this case, the partyInformation parameter provides the identities related to 
		-- the terminating party and all information provided by this party.
335
336
337
338
	...,
	associated-party(3)
		-- In this case, the partyInformation parameter provides the identites related to
		-- an associated party and all information provided by this party
339
340
341
342
343
344
}

Messaging-Party-Identity ::= CHOICE
{
	msisdn				[0] OCTET STRING (SIZE (1..9)),
		-- MSISDN of the target, encoded in the same format as the AddressString
345
		-- parameters defined in MAP format 3GPP TS 09.02 [22], clause 17.7.8.
346
347
	e164-format			[1] OCTET STRING (SIZE (1..25)),
		-- E.164 address of the node in international format. Coded in the same format as 
348
		-- the calling party number parameter of the ISUP (parameter part: EN 300 356 [23])
349
	email-address		[2] E-mail-Address-List,
350
351
352
	...,
	ip-address			[3] IPAddress,
	alphanumeric		[4] UTF8String
353
354
355
356
357
}

Messaging-Trigger ::= ENUMERATED
{
	unknown(0),
358
359
360
361
	user(1),
	user-agent(2),
	system(3),
	system-operator(4),
362
363
364
365
366
	...
}

Messaging-Property ::= CHOICE
{
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
	pincode				[0] OCTET STRING (SIZE (1..32)),
	...,
	priority			[1] Messaging-Property-Priority,
	greeting-type		[2] Messaging-Property-Greeting-Type,
	notification-type	[3] Messaging-Property-Notification-Type,
	language			[4] OCTET STRING
		-- Language according to RFC 3066 [24]
}

Messaging-Property-Priority ::= ENUMERATED
{
	low(1),
	medium(2),
	high(3),
	private(4),
	...
}

Messaging-Property-Greeting-Type ::= ENUMERATED
{
	general(1),
	name(2),
	personal(3),
	absence(4),
	number(5),
	...
}

Messaging-Property-Notification-Type ::= ENUMERATED
{
	empty-call(1),
	lost-call(2),
399
400
401
	...
}

402
END -- end of EmailPDU