Translation(s): none

These user stories have been set up to check that our documentation answers all possible probable issues which users, contributors, maintainers might face with AppArmor in Debian.

Feature: Ship an existing AppArmor profile confining software S in the Debian package that ships S
  Scenario:
    As a Debian package maintainer,
    When I want to ship an AppArmor profile in package P, 
    Given this profile exists upstream or in the apparmor-profiles-extra package
    Then I need to be told how to do that.

→ Usertag: "new-profile"

→ Usertag: "migrate-profile"

→ Documentation: AppArmor/Contribute/FirstTimeProfileImport

Feature: Testing AppArmor confinement before uploading a new version of a package
  Scenario:
    As a Debian package maintainer,
    Given I ship an AppArmor profile in package P, 
    When I prepare an upload for a new upstream release,
    Then I want to check that it still works under AppArmor confinement. 

→ Documentation AppArmor/Debug

Feature: New AppArmor profile
  Scenario:
    As a Debian package maintainer or as a Debian contributor,
    Given that I have written or found an AppArmor profile for package P, 
    And this profile does not exist in apparmor-profiles-extra nor upstream,
    Then I need to be taught how to test the profile
    And I need to be taught to ask for a review of this profile
    And I need to be taught how to upstream this profile

→ Usertag "new-profile"

→ Documentation AppArmor/Debug

→ Documentation: AppArmor/Contribute/Upstream

Feature: Update an AppArmor profile to include upstream improvements
  Scenario:
     As a Debian user or contributor,
     When I want an already packaged profile to be updated to the latest upstream version
     Then I need to be taught how to make the AppArmor team aware of my needs.

→ Usertag "merge-from-upstream"

→ Usertag "patch" with attached patch

→ Documentation: Updating a profile in Debian’s apparmor-profiles-extra package

Feature: Modify an already shipped AppArmor profile
  Scenario:
     As a Debian contributor,
     Given that an AppArmor profile is shipped in package P
     When I want to update that profile 
     And changes should be merged upstream and in the Debian package
     Then I need to know how to do that.

→ Usertag "modify-profile"

Feature: Upstream Debian changes made on an AppArmor profile we ship
  Scenario:
     As a Debian contributor,
     When I want to request that a profile which is shipped in Debian be updated upstream
     Then I need to be taught how to do that.

→ Usertag "merge-to-upstream"

Documentation AppArmor/Contribute/Upstream

Feature: Find out if a problem with a confined software is AppArmor related
  Scenario:
      As a Debian user,
      Given I use a program that comes with an AppArmor profile,
      When this software does not behave as it should or crashes,
      Then I want to be taught how to diagnose whether AppArmor is involved
      And if that is the case, I want to be taught what to include in a bugreport and how I could fix the problem myself.

→ Usertag "help-needed", to request help for initial diagnosis

→ Usertag "buggy-profile" if AppArmor has been identified as culprit

→ Documentation: AppArmor/Reportbug

→ Documentation: AppArmor/Debug

Feature: Find out if a bug is AppArmor related
  Scenario:
     As a Debian package maintainer,
     Given I ship an AppArmor profile in package P I am maintaining, 
     When I receive a bug report that might be caused by AppArmor, 
     Then I want to be taught how to diagnose whether AppArmor is involved
     And if that is the case, I want to be taught how to put the problem under the pkg-apparmor team's radar.

→ Usertag "help-needed", to request help for initial diagnosis

→ Documentation: AppArmor/Debug

→ Usertag "buggy-profile" if AppArmor has been identified as culprit

Feature: Other AppArmor related problems
   Scenario:
     As a Debian user or contributor, 
     When I encounter problems with any AppArmor related tools (systemd, auditd, syslog, etc.),
     And I submit a bug report,
     Then I want to make the team aware of those bugs.

→ Usertags: will be refined as we go

→ Documentation: AppArmor/Reportbug

→ Currently, there is a usertag called "ux" for a bug related to auditd's formatting of AppArmor related messages and "platform" for #775331


CategorySystemSecurity