share/man/man3bsm/getfauditflags.3bsm

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GETFAUDITFLAGS 3BSM "Mar 6, 2017"
   7 .SH NAME
   8 getfauditflags \- generate process audit state
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lbsm\fR [ \fIlibrary\fR... ]
  13 #include <sys/param.h>
  14 #include <bsm/libbsm.h>
  15
  16 \fBint\fR \fBgetfauditflags\fR(\fBau_mask_t *\fR\fIusremasks\fR, \fBau_mask_t *\fR\fIusrdmasks\fR,
  17      \fBau_mask_t *\fR\fIlastmasks\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .LP
  22 The \fBgetfauditflags()\fR function generates a process audit state by
  23 combining the audit masks passed as parameters with the system audit masks.
  24 .sp
  25 .LP
  26 The \fIusremasks\fR argument points to \fBau_mask_t\fR fields that contains two
  27 values. The first value defines which events are always to be audited when they
  28 succeed. The second value defines which events are always to be audited when
  29 they fail.
  30 .sp
  31 .LP
  32 The \fIusrdmasks\fR argument points to \fBau_mask_t\fR fields that contains two
  33 values.  The first value defines which events are never to be audited when they
  34 succeed. The second value defines which events are never to be audited when
  35 they fail.
  36 .sp
  37 .LP
  38 The output of this function is stored in \fIlastmasks\fR, a pointer of type
  39 \fBau_mask_t\fR as well. The first value defines which events are to be audited
  40 when they succeed and the second defines which events are to be audited when
  41 they fail.
  42 .sp
  43 .LP
  44 Both \fIusremasks\fR and \fIusrdmasks\fR override the values in the system
  45 audit values.
  46 .SH RETURN VALUES
  47 .LP
  48 Upon successful completion, \fBgetfauditflags()\fR returns 0. Otherwise it
  49 returns \fB\(mi1\fR\&.
  50 .SH ATTRIBUTES
  51 .LP
  52 See \fBattributes\fR(5) for descriptions of the following attributes:
  53 .sp
  54
  55 .sp
  56 .TS
  57 box;
  58 c | c
  59 l | l .
  60 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  61 _
  62 MT-Level        MT-Safe
  63 .TE
  64
  65 .SH SEE ALSO
  66 .LP
  67 \fBgetauditflags\fR(3BSM), \fBaudit.log\fR(4), \fBattributes\fR(5)