Repository navigation
Contributing
Contributing to the SELinux userspace project is a similar process to other open source projects. Bug reports, new features to the existing code, additional tools, or updated documentation are all welcome. Before undertaking a new task, it is a good idea to first post to the selinux@vger.kernel.org mailing list to see if anyone else is already working on it.
You can find a list of open issues to the SELinux userspace code at https://github.com/SELinuxProject/selinux/issues
See the SELinux kernel Getting Started guide if you want to contribute to SELinux kernel development instead.
SELinux has a public mailing list for developers, subscribe by sending an email to selinux+subscribe@vger.kernel.org. It is generally wise to read relevant postings to the list before beginning any area of new work. Searchable mailing list archives are available externally at https://lore.kernel.org/selinux/ . Patches for SELinux are tracked via https://patchwork.kernel.org/project/selinux/list/ .
An unofficial SELinux IRC channel is #selinux on Libera.Chat .
All bugs and patches should be submitted to the SELinux mailing list at selinux@vger.kernel.org.
When reporting bugs please include versions of SELinux related libraries and tools (libsepol, libselinux, libsemanage, checkpolicy). If you are using a custom policy please include it as well.
There are a number of dependencies required to build the userspace tools/libraries. Consult the README.md for the current list of dependencies and how to build the userspace code.
After cloning the code of the repository (see below), create a patch against the repository, and post that patch to the SELinux mailing list at selinux@vger.kernel.org. When preparing patches, please follow these guidelines:
- Patches should apply with git am
- Must apply against HEAD of the main branch
- Separate large patches into logical patches
- Patch descriptions must end with your "Signed-off-by" line. This means your code meets the Developer's certificate of origin, see below.
- C code should be formatted using clang-format, using the .clang-format configuration file at the root of this repository.
When adding new, large features or tools it is best to discuss the design on the mailing list prior to submitting the patch.
See git-send-email and submitting-patches for how to configure git-send-email for sending patches inline within email messages as required by the SELinux maintainers.
You will send the patch via git send-email to the selinux@vger.kernel.org mailing list. The command below is for sending the topmost patch from your repository; if you need to send more than one patch or you are sending a patch from a file instead, you will need to adjust the command line accordingly.
git send-email --subject-prefix="PATCH userspace" -1 --to=selinux@vger.kernel.org
- Consider installing and using b4 for verifying and applying patches.
- Use patchwork for tracking patches, updating the state of each patch to reflect where it is in the workflow.
To get a copy of the SELinux userland repository you can run:
$ git clone https://github.com/SELinuxProject/selinux
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.