From 86215013d3e95355b4346473e0344bab062519b3 Mon Sep 17 00:00:00 2001 From: Alexandre Pujol Date: Mon, 2 Aug 2021 11:54:58 +0100 Subject: [PATCH] Add usage section. --- README.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3253ca8c..f8922b39 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ## Description -A set of over 800 AppArmor profiles which aims is to confine most of Linux base applications and processes. +A set of over 1000 AppArmor profiles which aims is to confine most of Linux base applications and processes. **Goals & Purpose** - Support all distribution that support AppArmor (currenlty Archlinux and Debian), @@ -34,10 +34,6 @@ We take inspiration from the [Android/ChromeOS Security Model][android_model] an This is fundamentally different from how AppArmor is used on Linux server as it is common to only confine the applications that face the internet and/or the users. -## Tests - -A full test suite to ensure compatibility across distributions and softwares is -still a work in progress. ## Installation @@ -61,6 +57,37 @@ Build using standard Debian package build tools: dpkg-buildpackage -b -d -us -ui --sign-key= ``` +## Usage + +Once installed and with the rules enabled, you can ensure the rules are loaded +with `sudo aa-satus`, it should give something like: +``` +apparmor module is loaded. +1042 profiles are loaded. +753 profiles are in enforce mode. + ... +289 profiles are in complain mode. + ... +0 profiles are in kill mode. +0 profiles are in unconfined mode. +119 processes have profiles defined. +90 processes are in enforce mode. + ... +29 processes are in complain mode. + ... +0 processes are unconfined but have a profile defined. +0 processes are in mixed mode. +0 processes are in kill mode. +``` + +You can also list the current processes alongside with their security profile with +`ps auxZ`. Most of the process should then be confined. + +## Tests + +A full test suite to ensure compatibility across distributions and softwares is still a work in progress. + + ## Contribution Feedbacks, contributors, pull requests, are all very welcome.