usr/src/man/man3bsm/getauditflags.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 GETAUDITFLAGS 3BSM "Mar 6, 2017"
   7 .SH NAME
   8 getauditflags, getauditflagsbin, getauditflagschar \- convert audit flag
   9 specifications
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lbsm\fR \fB -lsocket \fR  \fB -lnsl \fR  [ \fIlibrary\fR... ]
  14 #include <sys/param.h>
  15 #include <bsm/libbsm.h>
  16
  17 \fBint\fR \fBgetauditflagsbin\fR(\fBchar *\fR\fIauditstring\fR, \fBau_mask_t *\fR\fImasks\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBgetauditflagschar\fR(\fBchar *\fR\fIauditstring\fR, \fBau_mask_t *\fR\fImasks\fR, \fBint\fR \fIverbose\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .LP
  27 The \fBgetauditflagsbin()\fR function converts the character representation of
  28 audit values pointed to by \fIauditstring\fR into \fBau_mask_t\fR fields
  29 pointed to by \fImasks\fR. These fields indicate which events are to be audited
  30 when they succeed and which are to be audited when they fail.
  31 .sp
  32 .LP
  33 The \fBgetauditflagschar()\fR function converts the \fBau_mask_t\fR fields
  34 pointed to by \fImasks\fR into a string pointed to by \fIauditstring\fR. If
  35 \fIverbose\fR is 0, the short (2-character) flag names are used. If
  36 \fIverbose\fR is non-zero, the long flag names are used. The \fIauditstring\fR
  37 argument should be large enough to contain the \fBASCII\fR representation of
  38 the events.
  39 .sp
  40 .LP
  41 The \fIauditstring\fR argument contains a series of event names, each one
  42 identifying a single audit class, separated by commas.  The \fBau_mask_t\fR
  43 fields pointed to by \fImasks\fR correspond to binary values defined in
  44 <\fBbsm/audit.h\fR>, which is read by  <\fBbsm/libbsm.h\fR>.
  45 .SH RETURN VALUES
  46 .LP
  47 Upon successful completion, \fBgetauditflagsbin()\fR and
  48 \fBgetauditflagschar()\fR return 0. Otherwise they return \(mi1.
  49 .SH ATTRIBUTES
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 MT-Level        MT-Safe
  62 .TE
  63
  64 .SH SEE ALSO
  65 .LP
  66 \fBaudit.log\fR(4), \fBattributes\fR(5)
  67 .SH BUGS
  68 .LP
  69 This is not a very extensible interface.