~ubuntu-branches/ubuntu/wily/apparmor/wily

« back to all changes in this revision

Viewing changes to utils/aa-genprof.pod

  • Committer: Bazaar Package Importer
  • Author(s): Kees Cook
  • Date: 2011-04-27 10:38:07 UTC
  • mfrom: (5.1.118 natty)
  • Revision ID: james.westby@ubuntu.com-20110427103807-ym3rhwys6o84ith0
Tags: 2.6.1-2
debian/copyright: clarify for some full organization names.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# This publication is intellectual property of Novell Inc. and Canonical
 
2
# Ltd. Its contents can be duplicated, either in part or in whole, provided
 
3
# that a copyright label is visibly located on each copy.
 
4
#
 
5
# All information found in this book has been compiled with utmost
 
6
# attention to detail. However, this does not guarantee complete accuracy.
 
7
# Neither SUSE LINUX GmbH, Canonical Ltd, the authors, nor the translators
 
8
# shall be held liable for possible errors or the consequences thereof.
 
9
#
 
10
# Many of the software and hardware descriptions cited in this book
 
11
# are registered trademarks. All trade names are subject to copyright
 
12
# restrictions and may be registered trade marks. SUSE LINUX GmbH
 
13
# and Canonical Ltd. essentially adhere to the manufacturer's spelling.
 
14
#
 
15
# Names of products and trademarks appearing in this book (with or without
 
16
# specific notation) are likewise subject to trademark and trade protection
 
17
# laws and may thus fall under copyright restrictions.
 
18
#
 
19
 
 
20
 
 
21
=pod
 
22
 
 
23
=head1 NAME
 
24
 
 
25
aa-genprof - profile generation utility for AppArmor
 
26
 
 
27
=head1 SYNOPSIS
 
28
 
 
29
B<aa-genprof I<E<lt>executableE<gt>> [I<-d /path/to/profiles>]>
 
30
 
 
31
=head1 OPTIONS
 
32
 
 
33
B<-d --dir /path/to/profiles>
 
34
 
 
35
   Specifies where to look for the AppArmor security profile set.
 
36
   Defaults to /etc/apparmor.d.
 
37
 
 
38
 
 
39
=head1 DESCRIPTION
 
40
 
 
41
When running aa-genprof, you must specify a program to profile.  If the
 
42
specified program is not a fully-qualified path, aa-genprof will search $PATH
 
43
in order to find the program.
 
44
 
 
45
If a profile does not exist for the program, aa-genprof will create one using
 
46
aa-autodep(1).
 
47
 
 
48
Genprof will then:
 
49
 
 
50
   - set the profile to complain mode 
 
51
 
 
52
   - write a mark to the system log
 
53
 
 
54
   - instruct the user to start the application to
 
55
     be profiled in another window and exercise its functionality
 
56
 
 
57
It then presents the user with two options, (S)can system log for entries 
 
58
to add to profile and (F)inish.
 
59
 
 
60
If the user selects (S)can or hits return, aa-genprof will parse
 
61
the complain mode logs and iterate through generated violations
 
62
using aa-logprof(1). 
 
63
 
 
64
After the user finishes selecting profile entries based on violations 
 
65
that were detected during the program execution, aa-genprof will reload
 
66
the updated profiles in complain mode and again prompt the user for (S)can and 
 
67
(D)one. This cycle can then be repeated as necessary until all application 
 
68
functionality has been exercised without generating access violations.
 
69
 
 
70
When the user eventually hits (F)inish, aa-genprof will set the main profile,
 
71
and any other profiles that were generated, into enforce mode and exit.
 
72
 
 
73
=head1 BUGS
 
74
 
 
75
If you find any bugs, please report them at
 
76
L<http://https://bugs.launchpad.net/apparmor/+filebug>.
 
77
 
 
78
=head1 SEE ALSO
 
79
 
 
80
apparmor(7), apparmor.d(5), aa-enforce(1), aa-complain(1), aa-disable(1),
 
81
aa_change_hat(2), aa-logprof(1), logprof.conf(5), and
 
82
L<http://wiki.apparmor.net>.
 
83
 
 
84
=cut