X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/2d21ac55c334faf3a56e5634905ed6987fc787d4..6d2010ae8f7a6078e10b361c6962983bab233e0f:/bsd/man/man2/setauid.2 diff --git a/bsd/man/man2/setauid.2 b/bsd/man/man2/setauid.2 index 0fe8e9df4..299196718 100644 --- a/bsd/man/man2/setauid.2 +++ b/bsd/man/man2/setauid.2 @@ -1,5 +1,5 @@ .\" -.\" Copyright (c) 2007 Apple Inc. All rights reserved. +.\" Copyright (c) 2008-2009 Apple Inc. All rights reserved. .\" .\" @APPLE_LICENSE_HEADER_START@ .\" @@ -20,35 +20,86 @@ .\" .\" @APPLE_LICENSE_HEADER_END@ .\" -.Dd July 30, 2007 +.Dd March 21, 2009 .Dt SETAUID 2 -.Os Darwin +.Os .Sh NAME .Nm setauid -.Nd set the audit user ID for the calling process +.Nd "set audit indentifier" .Sh SYNOPSIS -.Fd #include +.In bsm/audit.h .Ft int -.Fn setauid "const au_id_t * auid" +.Fn setauid "au_id_t *auid" .Sh DESCRIPTION The .Fn setauid -function sets the audit user ID for the calling process. The ID is set to the -value pointed at by +system call +sets the active audit identifier for the current process from the +.Vt au_id_t +pointed to by .Fa auid . +The value of AU_DEFAUDITID (-1) should not be used for +.Fa auid . +.Pp +This system call requires an appropriate privilege to complete. +.Pp +Once the audit identifier is set to some other value than +AU_DEAUDITID (-1) then it is immutable. +This system call may be used to set the audit identifier after +initially setting up the audit session with the +.Xr setaudit 2 , +or +.Xr setaudit_addr 2 +system call. .Sh RETURN VALUES -Upon successful completion a value of 0 is returned. -Otherwise, a value of -1 is returned and -.Va errno -is set to indicate the error. +.Rv -std +.Sh ERRORS +The +.Fn setauid +function will fail if: +.Bl -tag -width Er +.It Bq Er EFAULT +A failure occurred while data transferred to +the kernel failed. +.It Bq Er EINVAL +An invalid value for +.Fa auid +was used. +.Fa auid +can be any value of type +.Vt au_id_t +except AU_DEFAUDITID. +.It Bq Er EPERM +The process does not have sufficient permission to complete +the operation. +.El .Sh SEE ALSO .Xr audit 2 , .Xr auditon 2 , -.Xr auditctl 2 , -.Xr getauid 2 , .Xr getaudit 2 , -.Xr setaudit 2 +.Xr getaudit_addr 2 , +.Xr getauid 2 , +.Xr setaudit 2 , +.Xr setaudit_addr 2 , +.Xr libbsm 3 .Sh HISTORY -The -.Fn setauid -function call first appeared in Mac OS X 10.3 (Panther). +The OpenBSM implementation was created by McAfee Research, the security +division of McAfee Inc., under contract to Apple Computer Inc.\& in 2004. +It was subsequently adopted by the TrustedBSD Project as the foundation for +the OpenBSM distribution. +.Sh AUTHORS +.An -nosplit +This software was created by McAfee Research, the security research division +of McAfee, Inc., under contract to Apple Computer Inc. +Additional authors include +.An Wayne Salamon , +.An Robert Watson , +and SPARTA Inc. +.Pp +The Basic Security Module (BSM) interface to audit records and audit event +stream format were defined by Sun Microsystems. +.Pp +This manual page was written by +.An Robert Watson Aq rwatson@FreeBSD.org +and +.An Stacey Son Aq sson@FreeBSD.org .