Merge from trunk rev 1698: Update the toplevel README file to discuss

the needed apparmor compatibility patches, mention the profile
consistency check, and remove some variables that no longer need to
be set at build time.
This commit is contained in:
Steve Beattie 2011-03-18 23:15:43 -07:00
parent be34a7e217
commit e268784406

35
README
View file

@ -30,13 +30,26 @@ AppArmor consists of several different parts:
changehat/ source for using changehat with Apache, PAM and Tomcat changehat/ source for using changehat with Apache, PAM and Tomcat
common/ common makefile rules common/ common makefile rules
desktop/ empty desktop/ empty
kernel-patches/ patches for various kernel versions kernel-patches/ compatibility patches for various kernel versions
libraries/ libapparmor source and language bindings libraries/ libapparmor source and language bindings
parser/ source for parser/loader and corresponding documentation parser/ source for parser/loader and corresponding documentation
profiles/ configuration files, reference profiles and abstractions profiles/ configuration files, reference profiles and abstractions
tests/ regression and stress testsuites tests/ regression and stress testsuites
utils/ high-level utilities for working with AppArmor utils/ high-level utilities for working with AppArmor
--------------------------------------
Important note on AppArmor kernel code
--------------------------------------
While most of the kernel AppArmor code has been accepted in the
upstream Linux kernel, a few important pieces were not included. These
missing pieces unfortunately are important bits for AppArmor userspace
and kernel interaction; therefore we have included compatibility
patches in the kernel-patches/ subdirectory, versioned by upstream
kernel (2.6.37 patches should apply cleanly to 2.6.38 source).
Without these patches applied to the kernel, the AppArmor userspace
will not function correctly.
------------------------------------------ ------------------------------------------
Building and Installing AppArmor Userspace Building and Installing AppArmor Userspace
@ -49,10 +62,14 @@ the following order.
libapparmor: libapparmor:
$ cd ./libraries/libapparmor $ cd ./libraries/libapparmor
$ sh ./autogen.sh $ sh ./autogen.sh
$ sh ./configure --prefix=/usr --with-perl $ sh ./configure --prefix=/usr --with-perl # see below
$ make $ make
$ make check $ make check
[optional arguments to libapparmor's configure include --with-python
and --with-ruby, to generate python and ruby bindings to libapparmor,
respectively.]
Utilities: Utilities:
$ cd utils $ cd utils
@ -70,23 +87,23 @@ $ make install
Apache mod_apparmor: Apache mod_apparmor:
$ cd changehat/mod_apparmor $ cd changehat/mod_apparmor
$ LIBS="-lapparmor" make $ make # depends on libapparmor having been built first
$ make install $ make install
PAM AppArmor: PAM AppArmor:
$ cd changehat/pam_apparmor $ cd changehat/pam_apparmor
$ LIBS="-lapparmor -lpam" make $ make # depends on libapparmor having been built first
$ make install $ make install
Profiles: Profiles:
$ cd profiles $ cd profiles
$ make $ make
$ make check # depends on the parser having been built first
$ make install $ make install
------------------- -------------------
AppArmor Testsuites AppArmor Testsuites
------------------- -------------------
@ -124,6 +141,14 @@ For details on structure and adding tests, see libraries/libapparmor/README.
$ cd libraries/libapparmor $ cd libraries/libapparmor
$ make check $ make check
Profile checks
--------------
A basic consistency check to ensure that the parser and aa-logprof parse
successfully the current set of shipped profiles. The system or other
parser and logprof can be passed in by overriding the PARSER and LOGPROF
variables.
$ cd profiles
$ make && make check
Stress Tests Stress Tests
------------ ------------