apparmor/utils/genprof.pod
Steve Beattie 60f2312372 Subject: Add manpages to utils package.
Move the autodep(8), complain(8), enforce(8), logprof(8), genprof(8),
unconfined(8), logprof.conf(5), and apparmor_status(8) manpages, along
with their aa- form symlinks, to the utils package.
2007-04-03 19:13:35 +00:00

86 lines
2.8 KiB
Text

# $Id$
# This publication is intellectual property of Novell Inc. Its contents
# can be duplicated, either in part or in whole, provided that a copyright
# label is visibly located on each copy.
#
# All information found in this book has been compiled with utmost
# attention to detail. However, this does not guarantee complete accuracy.
# Neither SUSE LINUX GmbH, the authors, nor the translators shall be held
# liable for possible errors or the consequences thereof.
#
# Many of the software and hardware descriptions cited in this book
# are registered trademarks. All trade names are subject to copyright
# restrictions and may be registered trade marks. SUSE LINUX GmbH
# essentially adheres to the manufacturer's spelling.
#
# Names of products and trademarks appearing in this book (with or without
# specific notation) are likewise subject to trademark and trade protection
# laws and may thus fall under copyright restrictions.
#
# Please direct suggestions and comments to apparmor-general@forge.novell.com.
=pod
=head1 NAME
genprof - profile generation utility for AppArmor
=head1 SYNOPSIS
B<genprof I<E<lt>executableE<gt>> [I<-d /path/to/profiles>]>
=head1 OPTIONS
B<-d --dir /path/to/profiles>
Specifies where to look for the AppArmor security profile set.
Defaults to /etc/apparmor.d.
=head1 DESCRIPTION
When running genprof, you must specify a program to profile. If the
specified program is not a fully-qualified path, genprof will search $PATH
in order to find the program.
If a profile does not exist for the program, genprof will create one using
autodep(1).
Genprof will then:
- set the profile to complain mode
- write a mark to the system log
- instruct the user to start the application to
be profiled in another window and exercise its functionality
It then presents the user with two options, (S)can system log for entries
to add to profile and (F)inish.
If the user selects (S)can or hits return, genprof will parse
the complain mode logs and iterate through generated violations
using logprof(1).
After the user finishes selecting profile entries based on violations
that were detected during the program execution, genprof will reload
the updated profiles in complain mode and again prompt the user for (S)can and
(D)one. This cycle can then be repeated as neccesary until all application
functionality has been exercised without generating access violations.
When the user eventually hits (F)inish, genprof will set the main profile,
and any other profiles that were generated, into enforce mode and exit.
=head1 BUGS
None. Please report any you find to bugzilla at
L<http://bugzilla.novell.com>.
=head1 SEE ALSO
apparmor(7), apparmor.d(5), enforce(1), complain(1), change_hat(2),
logprof(1), logprof.conf(5), and
L<http://forge.novell.com/modules/xfmod/project/?apparmor>.
=cut