.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "AA_GETCON 2" .TH AA_GETCON 2 2024-10-14 "AppArmor 4.0.3" AppArmor .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME aa_getprocattr_raw, aa_getprocattr \- read and parse procattr data .PP aa_getcon, aa_gettaskcon \- get task confinement information .PP aa_getpeercon \- get the confinement of a socket's other end (peer) .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fB#include \fR .PP \&\fBint aa_getprocattr_raw(pid_t tid, const char *attr, char *buf, int len, char **mode);\fR .PP \&\fBint aa_getprocattr(pid_t tid, const char *attr, char **label, char **mode);\fR .PP \&\fBint aa_gettaskcon(pid_t target, char **label, char **mode);\fR .PP \&\fBint aa_getcon(char **label, char **mode);\fR .PP \&\fBint aa_getpeercon_raw(int fd, char *buf, int *len, char **mode);\fR .PP \&\fBint aa_getpeercon(int fd, char **label, char **mode);\fR .PP Link with \fB\-lapparmor\fR when compiling. .SH DESCRIPTION .IX Header "DESCRIPTION" The aa_getcon function gets the current AppArmor confinement context for the current task. The confinement context consists of a label and a mode. The label is usually just the name of the AppArmor profile restricting the task, but it may include the profile namespace or in some cases a set of profile names (known as a stack of profiles). The mode is a string that describes how the kernel is enforcing the policy defined in the profile. Profiles loaded in "enforce" mode will result in enforcement of the policy defined in the profile as well as reporting policy violation attempts. Profiles in "complain" mode will not enforce policy but instead report policy violation attempts. .PP Some examples of possible returned *label strings are "unconfined", "/sbin/dhclient", and "Firefox". The string can consist of any non-NUL characters but it will be NUL-terminated. The *label string must be freed using \fBfree()\fR. .PP The possible *mode strings are "enforce" and "complain". Additionally, *mode may be NULL when *label is "unconfined". \fBThe *mode string must not be freed\fR. The *label and *mode strings come from a single buffer allocation and are separated by a NUL character. .PP The aa_gettaskcon function is like the aa_getcon function except it will work for any arbitrary task in the system. .PP The aa_getpeercon function is similar to that of aa_gettaskcon except that it returns the confinement information for task on the other end of a socket connection. .PP The aa_getpeercon_raw function is the backend for the aa_getpeercon function and does not handle buffer allocation. .PP The aa_getprocattr function is the backend for the aa_getcon and aa_gettaskcon functions and handles the reading and parsing of the confinement data from different arbitrary attr files and returns the processed results in an allocated buffer. .PP The \fBaa_getprocattr_raw()\fR is the backend for the aa_getprocattr function and does not handle buffer allocation. .SH "RETURN VALUE" .IX Header "RETURN VALUE" On success size of data placed in the buffer is returned, this includes the mode if present and any terminating characters. On error, \-1 is returned, and \&\fBerrno\fR\|(3) is set appropriately. .SH ERRORS .IX Header "ERRORS" .IP \fBEINVAL\fR 4 .IX Item "EINVAL" The apparmor kernel module is not loaded or the communication via the \&\fI/proc/*/attr/file\fR did not conform to protocol. .IP \fBENOMEM\fR 4 .IX Item "ENOMEM" Insufficient kernel memory was available. .IP \fBEACCES\fR 4 .IX Item "EACCES" Access to the specified \fIfile/task\fR was denied. .IP \fBENOENT\fR 4 .IX Item "ENOENT" The specified \fIfile/task\fR does not exist or is not visible. .IP \fBERANGE\fR 4 .IX Item "ERANGE" The confinement data is too large to fit in the supplied buffer. .IP \fBENOPROTOOPT\fR 4 .IX Item "ENOPROTOOPT" The kernel doesn't support the SO_PEERLABEL option in sockets. This happens mainly when the kernel lacks 'fine grained unix mediation' support. It also can happen on LSM stacking kernels where another LSM has claimed this interface and decides to return this error, although this is really a corner case. .SH NOTES .IX Header "NOTES" If aa_getpeercon_raw returns \-1 and errno is ERANGE, the value of *len can be used to reallocate buf so that it is sufficiently large enough to store the confinement data. .SH BUGS .IX Header "BUGS" None known. If you find any, please report them at . .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBapparmor\fR\|(7), \fBapparmor.d\fR\|(5), \fBapparmor_parser\fR\|(8), \fBaa_change_profile\fR\|(2), \&\fBaa_splitcon\fR\|(3) and .