selinux/libselinux/man/man3/getkeycreatecon.3
Guillem Jover 6ef13eeda7 libselinux: man: Fix man pages formatting
- Add man page sections '(N)' to external references, and '()' on
  functions described in the same man page.
- Escape minus signs when those are expected to be used on the command
  line or files.
- Mark files and variables in italic; Note headings, function names,
  constants, program options and man page references in bold.
- Do not justify and hyphenate SEE ALSO section, and avoid hyphenation
  on symbol names by prepending them with \%.
- Remove trailing dot from NAME section description.
- Split sections with a no-op command '.', to visually distinguish them
  but to avoid introducing spurious vertical space in the formatted
  output.
- Add explicit .sp commands in the SYNOPSIS section between function
  prototypes, and fix space placement in function protoypes.
- Split header includes with .br (instead of the explicit or implicit
  .sp) so that they are vertically contiguous.
- Add missing {} around SELINUXTYPE and POLICYTYPE variable text in
  paths.
- Remove unneeded formatting commands.
- Remove spurious blank lines.

Signed-off-by: Guillem Jover <guillem@debian.org>
Signed-off-by: Eric Paris <eparis@redhat.com>
Acked-by: Dan Walsh <dwalsh@redhat.com>
2013-02-05 20:14:43 -05:00

48 lines
1.5 KiB
Groff

.TH "getkeycreatecon" "3" "9 September 2008" "dwalsh@redhat.com" "SELinux API documentation"
.SH "NAME"
getkeycreatecon, setkeycreatecon \- get or set the SELinux security context used for creating a new kernel keyrings
.
.SH "SYNOPSIS"
.B #include <selinux/selinux.h>
.sp
.BI "int getkeycreatecon(security_context_t *" con );
.sp
.BI "int setkeycreatecon(security_context_t "context );
.
.SH "DESCRIPTION"
.BR getkeycreatecon ()
retrieves the context used for creating a new kernel keyring.
This returned context should be freed with
.BR freecon (3)
if non-NULL.
.BR getkeycreatecon ()
sets *con to NULL if no keycreate context has been explicitly
set by the program (i.e. using the default policy behavior).
.BR setkeycreatecon ()
sets the context used for creating a new kernel keyring.
NULL can be passed to
.BR setkeycreatecon ()
to reset to the default policy behavior.
The keycreate context is automatically reset after the next
.BR execve (2),
so a program doesn't need to explicitly sanitize it upon startup.
.BR setkeycreatecon ()
can be applied prior to library
functions that internally perform an file creation,
in order to set an file context on the objects.
.B Note:
Signal handlers that perform a
.BR setkeycreatecon ()
must take care to
save, reset, and restore the keycreate context to avoid unexpected behavior.
.
.SH "RETURN VALUE"
On error \-1 is returned.
On success 0 is returned.
.
.SH "SEE ALSO"
.BR selinux "(8), " freecon "(3), " getcon "(3), " getexeccon "(3)"