xref: /titanic_52/usr/src/man/man2/getaudit.2 (revision 6a1af1a67532df169a657cce07140be64bdea084) 
 te
 Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
 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.
 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.
 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]
 getaudit 2 "16 Apr 2008" "SunOS 5.11" "System Calls"
 NAME
getaudit, setaudit, getaudit_addr, setaudit_addr - get or set process audit
information

 SYNOPSIS


cc [ flag ... ] file ... -lbsm  -lsocket   -lnsl  [ library ... ]
#include <sys/param.h>
#include <bsm/libbsm.h>

int getaudit(struct auditinfo *info);






int setaudit(struct auditinfo *info);






int getaudit_addr(struct auditinfo_addr *info, int length);






int setaudit_addr(struct auditinfo_addr *info, int length);




 DESCRIPTION

The getaudit() function gets the audit ID, the preselection mask,
the terminal ID and the audit session ID for the current process.


The getaudit() function can fail and return an E2BIG errno if the
address field in the terminal ID is larger than 32 bits. In this case,
getaudit_addr() should be used.


The setaudit() function sets the audit ID, the preselection mask,
the terminal ID and the audit session ID for the current process.


The getaudit_addr() function returns a variable length
auditinfo_addr structure that contains the audit ID, the
preselection mask, the terminal ID, and the audit session ID for
the current process. The terminal ID contains a size field that indicates
the size of the network address.


The setaudit_addr() function sets the audit ID, the preselection
mask, the terminal ID, and the audit session ID for the current
process. The values are taken from the variable length struture
auditinfo_addr. The terminal ID contains a size field that
indicates the size of the network address.


The auditinfo structure is used to pass the process audit information and
contains the following members:

au_id_t ai_auid; /* audit user ID */
au_mask_t ai_mask; /* preselection mask */
au_tid_t ai_termid; /* terminal ID */
au_asid_t ai_asid; /* audit session ID */





The auditinfo_addr structure is used to pass the process audit
information and contains the following members:

au_id_t ai_auid; /* audit user ID */
au_mask_t ai_mask; /* preselection mask */
au_tid_addr_t ai_termid; /* terminal ID */
au_asid_t ai_asid; /* audit session ID */




 RETURN VALUES

Upon successful completion, getaudit() and setaudit() return
0. Otherwise, -1 is returned and errno is set to indicate
the error.

 ERRORS

The getaudit() and setaudit() functions will fail if:


EFAULT


The info parameter points outside the process's allocated address space.





EPERM


The {PRIV_SYS_AUDIT} privilege is not asserted in the effective set of
the calling process.




 USAGE

The calling process must have the {PRIV_SYS_AUDIT} privilege asserted in
its effective set.

 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStable
MT-LevelMT-Safe



 SEE ALSO

bsmconv(1M), audit(2), attributes(5)

 NOTES

The functionality described in this man page is available only if the Solaris
Auditing has been enabled. See bsmconv(1M) for more information.