File: test-ptrace.py

package info (click to toggle)
apparmor 4.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 34,800 kB
  • sloc: ansic: 24,940; python: 24,595; sh: 12,524; cpp: 9,024; yacc: 2,061; makefile: 1,921; lex: 1,215; pascal: 1,145; perl: 1,033; ruby: 365; lisp: 282; exp: 250; java: 212; xml: 159
file content (618 lines) | stat: -rw-r--r-- 29,763 bytes parent folder | download
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
#!/usr/bin/python3
# ----------------------------------------------------------------------
#    Copyright (C) 2015 Christian Boltz <apparmor@cboltz.de>
#
#    This program is free software; you can redistribute it and/or
#    modify it under the terms of version 2 of the GNU General Public
#    License as published by the Free Software Foundation.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
# ----------------------------------------------------------------------

import unittest
from collections import namedtuple

from apparmor.common import AppArmorBug, AppArmorException, hasher
from apparmor.logparser import ReadLog
from apparmor.rule.ptrace import PtraceRule, PtraceRuleset
from apparmor.translations import init_translation
from common_test import AATest, setup_all_loops

_ = init_translation()

exp = namedtuple(
    'exp', ('audit', 'allow_keyword', 'deny', 'comment', 'access', 'all_access', 'peer',
            'all_peers'),
)


# # --- tests for single PtraceRule --- #

class PtraceTest(AATest):
    def _compare_obj(self, obj, expected):
        self.assertEqual(expected.allow_keyword, obj.allow_keyword)
        self.assertEqual(expected.audit, obj.audit)
        self.assertEqual(expected.access, obj.access)
        if obj.peer:
            self.assertEqual(expected.peer, obj.peer.regex)
        else:
            self.assertEqual(expected.peer, obj.peer)
        self.assertEqual(expected.all_access, obj.all_access)
        self.assertEqual(expected.all_peers, obj.all_peers)
        self.assertEqual(expected.deny, obj.deny)
        self.assertEqual(expected.comment, obj.comment)


class PtraceTestParse(PtraceTest):
    tests = (
        # PtraceRule object            audit  allow  deny   comment       access               all?   peer           all?
        ('ptrace,',                   exp(False, False, False, '',       None,                 True,  None,         True)),
        # ('ptrace (),',                exp(False, False, False, '',       None,                 True,  None,         True)),  # XXX also broken in SignalRule?
        ('ptrace read,',              exp(False, False, False, '',       {'read'},             False, None,         True)),
        ('ptrace (read, tracedby),',  exp(False, False, False, '',       {'read', 'tracedby'}, False, None,         True)),
        ('ptrace read,',              exp(False, False, False, '',       {'read'},             False, None,         True)),
        ('deny ptrace read, # cmt',   exp(False, False, True,  ' # cmt', {'read'},             False, None,         True)),
        ('audit allow ptrace,',       exp(True,  True,  False, '',       None,                 True,  None,         True)),
        ('ptrace peer=unconfined,',   exp(False, False, False, '',       None,                 True,  'unconfined', False)),
        ('ptrace peer="unconfined",', exp(False, False, False, '',       None,                 True,  'unconfined', False)),
        ('ptrace read,',              exp(False, False, False, '',       {'read'},             False, None,         True)),
        ('ptrace peer=/foo,',         exp(False, False, False, '',       None,                 True,  '/foo',       False)),
        ('ptrace r peer=/foo,',       exp(False, False, False, '',       {'r'},                False, '/foo',       False)),
        ('ptrace r peer="/foo bar",', exp(False, False, False, '',       {'r'},                False, '/foo bar',   False)),
    )

    def _run_test(self, rawrule, expected):
        self.assertTrue(PtraceRule.match(rawrule))
        obj = PtraceRule.create_instance(rawrule)
        self.assertEqual(rawrule.strip(), obj.raw_rule)
        self._compare_obj(obj, expected)


class PtraceTestParseInvalid(PtraceTest):
    tests = (
        ('ptrace foo,',           AppArmorException),
        ('ptrace foo bar,',       AppArmorException),
        ('ptrace foo int,',       AppArmorException),
        ('ptrace read bar,',      AppArmorException),
        ('ptrace read tracedby,', AppArmorException),
        ('ptrace peer=,',         AppArmorException),
    )

    def _run_test(self, rawrule, expected):
        self.assertTrue(PtraceRule.match(rawrule))  # the above invalid rules still match the main regex!
        with self.assertRaises(expected):
            PtraceRule.create_instance(rawrule)


class PtraceTestParseFromLog(PtraceTest):
    def test_ptrace_from_log(self):
        parser = ReadLog('', '', '')
        event = 'type=AVC msg=audit(1409700683.304:547661): apparmor="DENIED" operation="ptrace" profile="/home/ubuntu/bzr/apparmor/tests/regression/apparmor/ptrace" pid=22465 comm="ptrace" requested_mask="tracedby" denied_mask="tracedby" peer="/home/ubuntu/bzr/apparmor/tests/regression/apparmor/ptrace"'

        parsed_event = parser.parse_event(event)

        self.assertEqual(parsed_event, {
            'request_mask': 'tracedby',
            'denied_mask': 'tracedby',
            'error_code': 0,
            'magic_token': 0,
            'parent': 0,
            'profile': '/home/ubuntu/bzr/apparmor/tests/regression/apparmor/ptrace',
            'peer': '/home/ubuntu/bzr/apparmor/tests/regression/apparmor/ptrace',
            'operation': 'ptrace',
            'resource': None,
            'info': None,
            'aamode': 'REJECTING',
            'time': 1409700683,
            'active_hat': None,
            'pid': 22465,
            'task': 0,
            'attr': None,
            'name2': None,
            'name': None,
            'family': None,
            'protocol': None,
            'sock_type': None,
            'class': None,
        })

        obj = PtraceRule(parsed_event['denied_mask'], parsed_event['peer'], log_event=parsed_event)

        #             audit  allow  deny  comment  access     all?   peer                                                          all?
        expected = exp(False, False, False, '', {'tracedby'}, False, '/home/ubuntu/bzr/apparmor/tests/regression/apparmor/ptrace', False)

        self._compare_obj(obj, expected)

        self.assertEqual(
            obj.get_raw(1),
            '  ptrace tracedby peer=/home/ubuntu/bzr/apparmor/tests/regression/apparmor/ptrace,')

    def test_null_ptrace_from(self):
        log = 'type=AVC msg=audit(1495217772.047:4471): apparmor="DENIED" operation="ptrace" profile="/usr/bin/pidgin" pid=21704 comm="pidgin" peer="//null-"'
        parser = ReadLog('', '', '')

        hl = hasher()

        ev = parser.parse_event(log)
        PtraceRule.hashlog_from_event(hl, ev)

        expected = {'//null-': {None: True}}
        self.assertEqual(hl, expected)

        sr = PtraceRule.from_hashlog(hl)

        with self.assertRaises(StopIteration):
            next(sr)


class PtraceFromInit(PtraceTest):
    tests = (
        # PtraceRule object                              audit  allow  deny   comment  access         all?   peer          all?
        (PtraceRule('r', 'unconfined', deny=True),   exp(False, False, True,  '',      {'r'},         False, 'unconfined', False)),
        (PtraceRule(('r', 'read'), '/bin/foo'),      exp(False, False, False, '',      {'r', 'read'}, False, '/bin/foo',   False)),
        (PtraceRule(PtraceRule.ALL, '/bin/foo'),     exp(False, False, False, '',      None,          True,  '/bin/foo',   False)),
        (PtraceRule('rw', '/bin/foo'),               exp(False, False, False, '',      {'rw'},        False, '/bin/foo',   False)),
        (PtraceRule('rw', PtraceRule.ALL),           exp(False, False, False, '',      {'rw'},        False, None,         True)),
        (PtraceRule(PtraceRule.ALL, PtraceRule.ALL), exp(False, False, False, '',      None,          True,  None,         True)),
    )

    def _run_test(self, obj, expected):
        self._compare_obj(obj, expected)


class InvalidPtraceInit(AATest):
    tests = (
        # (init params, expected exception)
        (('',     '/foo'), AppArmorBug),        # empty access
        (('read', ''),     AppArmorBug),        # empty peer
        (('    ', '/foo'), AppArmorBug),        # whitespace access
        (('read', '    '), AppArmorBug),        # whitespace peer
        (('xyxy', '/foo'), AppArmorException),  # invalid access
        # XXX is 'invalid peer' possible at all?
        ((dict(), '/foo'), AppArmorBug),        # wrong type for access
        ((None,   '/foo'), AppArmorBug),        # wrong type for access
        (('read', dict()), AppArmorBug),        # wrong type for peer
        (('read', None),   AppArmorBug),        # wrong type for peer
    )

    def _run_test(self, params, expected):
        with self.assertRaises(expected):
            PtraceRule(*params)

    def test_missing_params_1(self):
        with self.assertRaises(TypeError):
            PtraceRule()

    def test_missing_params_2(self):
        with self.assertRaises(TypeError):
            PtraceRule('r')


class InvalidPtraceTest(AATest):
    def _check_invalid_rawrule(self, rawrule):
        obj = None
        self.assertFalse(PtraceRule.match(rawrule))
        with self.assertRaises(AppArmorException):
            obj = PtraceRule.create_instance(rawrule)

        self.assertIsNone(obj, 'PtraceRule handed back an object unexpectedly')

    def test_invalid_ptrace_missing_comma(self):
        self._check_invalid_rawrule('ptrace')  # missing comma

    def test_invalid_non_PtraceRule(self):
        self._check_invalid_rawrule('dbus,')  # not a ptrace rule

    def test_empty_data_1(self):
        obj = PtraceRule('read', '/foo')
        obj.access = ''
        # no access set, and ALL not set
        with self.assertRaises(AppArmorBug):
            obj.get_clean(1)

    def test_empty_data_2(self):
        obj = PtraceRule('read', '/foo')
        obj.peer = ''
        # no ptrace set, and ALL not set
        with self.assertRaises(AppArmorBug):
            obj.get_clean(1)


class WritePtraceTestAATest(AATest):
    def _run_test(self, rawrule, expected):
        self.assertTrue(PtraceRule.match(rawrule))
        obj = PtraceRule.create_instance(rawrule)
        clean = obj.get_clean()
        raw = obj.get_raw()

        self.assertEqual(expected.strip(), clean, 'unexpected clean rule')
        self.assertEqual(rawrule.strip(), raw, 'unexpected raw rule')

    tests = (
        #  raw rule                                           clean rule
        ('ptrace,',                                           'ptrace,'),
        ('     ptrace         ,    # foo        ',            'ptrace, # foo'),
        ('    audit     ptrace read,',                        'audit ptrace read,'),
        ('    audit     ptrace (read  ),',                    'audit ptrace read,'),
        ('    audit     ptrace (read , tracedby ),',          'audit ptrace (read tracedby),'),
        ('   deny ptrace         read      ,# foo bar',       'deny ptrace read, # foo bar'),
        ('   deny ptrace      (  read      ),  ',             'deny ptrace read,'),
        ('   allow ptrace                        ,# foo bar', 'allow ptrace, # foo bar'),
        ('ptrace,',                                           'ptrace,'),
        ('ptrace (trace),',                                   'ptrace trace,'),
        ('ptrace (tracedby),',                                'ptrace tracedby,'),
        ('ptrace (read),',                                    'ptrace read,'),
        ('ptrace (readby),',                                  'ptrace readby,'),
        ('ptrace (trace read),',                              'ptrace (read trace),'),
        ('ptrace (read tracedby),',                           'ptrace (read tracedby),'),
        ('ptrace r,',                                         'ptrace r,'),
        ('ptrace w,',                                         'ptrace w,'),
        ('ptrace rw,',                                        'ptrace rw,'),
        ('ptrace read,',                                      'ptrace read,'),
        ('ptrace (tracedby),',                                'ptrace tracedby,'),
        ('ptrace w,',                                         'ptrace w,'),
        ('ptrace read peer=foo,',                             'ptrace read peer=foo,'),
        ('ptrace tracedby peer=foo,',                         'ptrace tracedby peer=foo,'),
        ('ptrace (read tracedby) peer=/usr/bin/bar,',         'ptrace (read tracedby) peer=/usr/bin/bar,'),
        ('ptrace (trace read) peer=/usr/bin/bar,',            'ptrace (read trace) peer=/usr/bin/bar,'),
        ('ptrace wr peer=/sbin/baz,',                         'ptrace wr peer=/sbin/baz,'),
    )

    def test_write_manually(self):
        obj = PtraceRule('read', '/foo', allow_keyword=True)

        expected = '    allow ptrace read peer=/foo,'

        self.assertEqual(expected, obj.get_clean(2), 'unexpected clean rule')
        self.assertEqual(expected, obj.get_raw(2), 'unexpected raw rule')


class PtraceCoveredTest(AATest):
    def _run_test(self, param, expected):
        obj = PtraceRule.create_instance(self.rule)
        check_obj = PtraceRule.create_instance(param)

        self.assertTrue(PtraceRule.match(param))

        self.assertEqual(obj.is_equal(check_obj), expected[0], 'Mismatch in is_equal, expected {}'.format(expected[0]))
        self.assertEqual(obj.is_equal(check_obj, True), expected[1], 'Mismatch in is_equal/strict, expected {}'.format(expected[1]))

        self.assertEqual(obj.is_covered(check_obj), expected[2], 'Mismatch in is_covered, expected {}'.format(expected[2]))
        self.assertEqual(obj.is_covered(check_obj, True, True), expected[3], 'Mismatch in is_covered/exact, expected {}'.format(expected[3]))


class PtraceCoveredTest_01(PtraceCoveredTest):
    rule = 'ptrace read,'

    tests = (
        #   rule                          equal  strict equal  covered  covered exact
        ('ptrace,',                      (False, False,        False,   False)),
        ('ptrace read,',                 (True,  True,         True,    True)),
        ('ptrace read peer=unconfined,', (False, False,        True,    True)),
        ('ptrace read, # comment',       (True,  False,        True,    True)),
        ('allow ptrace read,',           (True,  False,        True,    True)),
        ('ptrace     read,',             (True,  False,        True,    True)),
        ('audit ptrace read,',           (False, False,        False,   False)),
        ('audit ptrace,',                (False, False,        False,   False)),
        ('ptrace tracedby,',             (False, False,        False,   False)),
        ('audit deny ptrace read,',      (False, False,        False,   False)),
        ('deny ptrace read,',            (False, False,        False,   False)),
    )


class PtraceCoveredTest_02(PtraceCoveredTest):
    rule = 'audit ptrace read,'

    tests = (
        #   rule                equal  strict equal  covered  covered exact
        ('      ptrace read,', (False, False,        True,    False)),
        ('audit ptrace read,', (True,  True,         True,    True)),
        ('      ptrace,',      (False, False,        False,   False)),
        ('audit ptrace,',      (False, False,        False,   False)),
        ('ptrace tracedby,',   (False, False,        False,   False)),
    )


class PtraceCoveredTest_03(PtraceCoveredTest):
    rule = 'ptrace,'

    tests = (
        #   rule                equal  strict equal  covered  covered exact
        ('      ptrace,',      (True,  True,         True,    True)),
        ('allow ptrace,',      (True,  False,        True,    True)),
        ('      ptrace read,', (False, False,        True,    True)),
        ('      ptrace w,',    (False, False,        True,    True)),
        ('audit ptrace,',      (False, False,        False,   False)),
        ('deny  ptrace,',      (False, False,        False,   False)),
    )


class PtraceCoveredTest_04(PtraceCoveredTest):
    rule = 'deny ptrace read,'

    tests = (
        #   rule                         equal  strict equal  covered   covered exact
        ('      deny ptrace read,',     (True,  True,         True,    True)),
        ('audit deny ptrace read,',     (False, False,        False,   False)),
        ('           ptrace read,',     (False, False,        False,   False)),  # XXX should covered be true here?
        ('      deny ptrace tracedby,', (False, False,        False,   False)),
        ('      deny ptrace,',          (False, False,        False,   False)),
    )


class PtraceCoveredTest_05(PtraceCoveredTest):
    rule = 'ptrace read peer=unconfined,'

    tests = (
        #   rule                                equal  strict equal  covered  covered exact
        ('ptrace,',                            (False, False,        False,   False)),
        ('ptrace read,',                       (False, False,        False,   False)),
        ('ptrace read peer=unconfined,',       (True,  True,         True,    True)),
        ('ptrace peer=unconfined,',            (False, False,        False,   False)),
        ('ptrace read, # comment',             (False, False,        False,   False)),
        ('allow ptrace read,',                 (False, False,        False,   False)),
        ('allow ptrace read peer=unconfined,', (True,  False,        True,    True)),
        ('allow ptrace read peer=/foo/bar,',   (False, False,        False,   False)),
        ('allow ptrace read peer=/**,',        (False, False,        False,   False)),
        ('allow ptrace read peer=**,',         (False, False,        False,   False)),
        ('ptrace    read,',                    (False, False,        False,   False)),
        ('ptrace    read peer=unconfined,',    (True,  False,        True,    True)),
        ('audit ptrace read peer=unconfined,', (False, False,        False,   False)),
        ('audit ptrace,',                      (False, False,        False,   False)),
        ('ptrace tracedby,',                   (False, False,        False,   False)),
        ('audit deny ptrace read,',            (False, False,        False,   False)),
        ('deny ptrace read,',                  (False, False,        False,   False)),
    )


class PtraceCoveredTest_06(PtraceCoveredTest):
    rule = 'ptrace read peer=/foo/bar,'

    tests = (
        #   rule                             equal   strict equal  covered  covered exact
        ('ptrace,',                          (False, False,        False,   False)),
        ('ptrace read,',                     (False, False,        False,   False)),
        ('ptrace read peer=/foo/bar,',       (True,  True,         True,    True)),
        ('ptrace read peer=/foo/*,',         (False, False,        False,   False)),
        ('ptrace read peer=/**,',            (False, False,        False,   False)),
        ('ptrace read peer=/what/*,',        (False, False,        False,   False)),
        ('ptrace peer=/foo/bar,',            (False, False,        False,   False)),
        ('ptrace read, # comment',           (False, False,        False,   False)),
        ('allow ptrace read,',               (False, False,        False,   False)),
        ('allow ptrace read peer=/foo/bar,', (True,  False,        True,    True)),
        ('ptrace    read,',                  (False, False,        False,   False)),
        ('ptrace    read peer=/foo/bar,',    (True,  False,        True,    True)),
        ('ptrace    read peer=/what/ever,',  (False, False,        False,   False)),
        ('audit ptrace read peer=/foo/bar,', (False, False,        False,   False)),
        ('audit ptrace,',                    (False, False,        False,   False)),
        ('ptrace tracedby,',                 (False, False,        False,   False)),
        ('audit deny ptrace read,',          (False, False,        False,   False)),
        ('deny ptrace read,',                (False, False,        False,   False)),
    )


class PtraceCoveredTest_07(PtraceCoveredTest):
    rule = 'ptrace read peer=**,'

    tests = (
        #   rule                              equal  strict equal  covered  covered exact
        ('ptrace,',                          (False, False,        False,   False)),
        ('ptrace read,',                     (False, False,        False,   False)),
        ('ptrace read peer=/foo/bar,',       (False, False,        True,    True)),
        ('ptrace read peer=/foo/*,',         (False, False,        False,   False)),  # TODO: wildcard vs. wildcard never matches in is_covered_aare()
        ('ptrace read peer=/**,',            (False, False,        False,   False)),  # TODO: wildcard vs. wildcard never matches in is_covered_aare()
        ('ptrace read peer=/what/*,',        (False, False,        False,   False)),  # TODO: wildcard vs. wildcard never matches in is_covered_aare()
        ('ptrace peer=/foo/bar,',            (False, False,        False,   False)),
        ('ptrace read, # comment',           (False, False,        False,   False)),
        ('allow ptrace read,',               (False, False,        False,   False)),
        ('allow ptrace read peer=/foo/bar,', (False, False,        True,    True)),
        ('ptrace    read,',                  (False, False,        False,   False)),
        ('ptrace    read peer=/foo/bar,',    (False, False,        True,    True)),
        ('ptrace    read peer=/what/ever,',  (False, False,        True,    True)),
        ('audit ptrace read peer=/foo/bar,', (False, False,        False,   False)),
        ('audit ptrace,',                    (False, False,        False,   False)),
        ('ptrace tracedby,',                 (False, False,        False,   False)),
        ('audit deny ptrace read,',          (False, False,        False,   False)),
        ('deny ptrace read,',                (False, False,        False,   False)),
    )


class PtraceCoveredTest_08(PtraceCoveredTest):
    rule = 'ptrace (trace, tracedby) peer=/foo/*,'

    tests = (
        #   rule                                    equal  strict equal  covered  covered exact
        ('ptrace,',                                (False, False,        False,  False)),
        ('ptrace trace,',                          (False, False,        False,  False)),
        ('ptrace (tracedby, trace),',              (False, False,        False,  False)),
        ('ptrace trace peer=/foo/bar,',            (False, False,        True,   True)),
        ('ptrace (tracedby trace) peer=/foo/bar,', (False, False,        True,   True)),
        ('ptrace (tracedby, trace) peer=/foo/*,',  (True,  False,        True,   True)),
        ('ptrace tracedby peer=/foo/bar,',         (False, False,        True,   True)),
        ('ptrace trace peer=/foo/*,',              (False, False,        True,   True)),
        ('ptrace trace peer=/**,',                 (False, False,        False,  False)),
        ('ptrace trace peer=/what/*,',             (False, False,        False,  False)),
        ('ptrace peer=/foo/bar,',                  (False, False,        False,  False)),
        ('ptrace trace, # comment',                (False, False,        False,  False)),
        ('allow ptrace trace,',                    (False, False,        False,  False)),
        ('allow ptrace trace peer=/foo/bar,',      (False, False,        True,   True)),
        ('ptrace    trace,',                       (False, False,        False,  False)),
        ('ptrace    trace peer=/foo/bar,',         (False, False,        True,   True)),
        ('ptrace    trace peer=/what/ever,',       (False, False,        False,  False)),
        ('audit ptrace trace peer=/foo/bar,',      (False, False,        False,  False)),
        ('audit ptrace,',                          (False, False,        False,  False)),
        ('ptrace tracedby,',                       (False, False,        False,  False)),
        ('audit deny ptrace trace,',               (False, False,        False,  False)),
        ('deny ptrace trace,',                     (False, False,        False,  False)),
    )


class PtraceCoveredTest_Invalid(AATest):
    def test_borked_obj_is_covered_1(self):
        obj = PtraceRule.create_instance('ptrace read peer=/foo,')

        testobj = PtraceRule('read', '/foo')
        testobj.access = ''

        with self.assertRaises(AppArmorBug):
            obj.is_covered(testobj)

    def test_borked_obj_is_covered_2(self):
        obj = PtraceRule.create_instance('ptrace read peer=/foo,')

        testobj = PtraceRule('read', '/foo')
        testobj.peer = ''

        with self.assertRaises(AppArmorBug):
            obj.is_covered(testobj)

    def test_invalid_is_covered(self):
        raw_rule = 'ptrace read,'

        class SomeOtherClass(PtraceRule):
            pass

        obj = PtraceRule.create_instance(raw_rule)
        testobj = SomeOtherClass.create_instance(raw_rule)  # different type
        with self.assertRaises(AppArmorBug):
            obj.is_covered(testobj)

    def test_invalid_is_equal_1(self):
        raw_rule = 'ptrace read,'

        class SomeOtherClass(PtraceRule):
            pass

        obj = PtraceRule.create_instance(raw_rule)
        testobj = SomeOtherClass.create_instance(raw_rule)  # different type
        with self.assertRaises(AppArmorBug):
            obj.is_equal(testobj)

    def test_invalid_is_equal_2(self):
        obj = PtraceRule.create_instance('ptrace read,')

        testobj = PtraceRule.create_instance('ptrace read,')
        testobj.all_peers = False  # make testobj invalid (should trigger exception in _is_equal_aare())

        with self.assertRaises(AppArmorBug):
            obj.is_equal(testobj)


class PtraceLogprofHeaderTest(AATest):
    tests = (
        ('ptrace,',                            [                              _('Access mode'), _('ALL'),        _('Peer'), _('ALL')]),  # noqa: E201
        ('ptrace read,',                       [                              _('Access mode'), 'read',          _('Peer'), _('ALL')]),  # noqa: E201
        ('deny ptrace,',                       [_('Qualifier'), 'deny',       _('Access mode'), _('ALL'),        _('Peer'), _('ALL')]),  # noqa: E201
        ('allow ptrace read,',                 [_('Qualifier'), 'allow',      _('Access mode'), 'read',          _('Peer'), _('ALL')]),
        ('audit ptrace read,',                 [_('Qualifier'), 'audit',      _('Access mode'), 'read',          _('Peer'), _('ALL')]),
        ('audit deny ptrace read,',            [_('Qualifier'), 'audit deny', _('Access mode'), 'read',          _('Peer'), _('ALL')]),
        ('ptrace (read, tracedby) peer=/foo,', [                              _('Access mode'), 'read tracedby', _('Peer'), '/foo']),  # noqa: E201
    )

    def _run_test(self, params, expected):
        obj = PtraceRule.create_instance(params)
        self.assertEqual(obj.logprof_header(), expected)


# --- tests for PtraceRuleset --- #

class PtraceRulesTest(AATest):
    def test_empty_ruleset(self):
        ruleset = PtraceRuleset()
        ruleset_2 = PtraceRuleset()
        self.assertEqual([], ruleset.get_raw(2))
        self.assertEqual([], ruleset.get_clean(2))
        self.assertEqual([], ruleset_2.get_raw(2))
        self.assertEqual([], ruleset_2.get_clean(2))

        # test __repr__() for empty ruleset
        self.assertEqual(str(ruleset), '<PtraceRuleset (empty) />')

    def test_ruleset_1(self):
        ruleset = PtraceRuleset()
        rules = (
            'ptrace peer=/foo,',
            'ptrace read,',
        )

        expected_raw = [
            'ptrace peer=/foo,',
            'ptrace read,',
            '',
        ]

        expected_clean = [
            'ptrace peer=/foo,',
            'ptrace read,',
            '',
        ]

        for rule in rules:
            ruleset.add(PtraceRule.create_instance(rule))

        self.assertEqual(expected_raw, ruleset.get_raw())
        self.assertEqual(expected_clean, ruleset.get_clean())

        # test __repr__() for non-empty ruleset
        self.assertEqual(
            str(ruleset), '<PtraceRuleset>\n  ptrace peer=/foo,\n  ptrace read,\n</PtraceRuleset>')

    def test_ruleset_2(self):
        ruleset = PtraceRuleset()
        rules = (
            'ptrace read peer=/foo,',
            'allow ptrace read,',
            'deny ptrace peer=/bar, # example comment',
        )

        expected_raw = [
            '  ptrace read peer=/foo,',
            '  allow ptrace read,',
            '  deny ptrace peer=/bar, # example comment',
            '',
        ]

        expected_clean = [
            '  deny ptrace peer=/bar, # example comment',
            '',
            '  allow ptrace read,',
            '  ptrace read peer=/foo,',
            '',
        ]

        for rule in rules:
            ruleset.add(PtraceRule.create_instance(rule))

        self.assertEqual(expected_raw, ruleset.get_raw(1))
        self.assertEqual(expected_clean, ruleset.get_clean(1))


class PtraceGlobTestAATest(AATest):
    def setUp(self):
        self.maxDiff = None
        self.ruleset = PtraceRuleset()

    def test_glob_1(self):
        self.assertEqual(self.ruleset.get_glob('ptrace read,'), 'ptrace,')

    # not supported or used yet
    # def test_glob_2(self):
    #     self.assertEqual(self.ruleset.get_glob('ptrace read raw,'), 'ptrace read,')

    def test_glob_ext(self):
        with self.assertRaises(NotImplementedError):
            # get_glob_ext is not available for ptrace rules
            self.ruleset.get_glob_ext('ptrace read peer=/foo,')


# class PtraceDeleteTestAATest(AATest):
#     pass


setup_all_loops(__name__)
if __name__ == '__main__':
    unittest.main(verbosity=1)