PERFORCE change 76276 for review

Robert Watson rwatson at FreeBSD.org
Sat Apr 30 13:38:01 GMT 2005


http://perforce.freebsd.org/chv.cgi?CH=76276

Change 76276 by rwatson at rwatson_paprika on 2005/04/30 13:37:12

	Remove trailing white space.

Affected files ...

.. //depot/projects/trustedbsd/openbsm/libbsm/libbsm.h#9 edit

Differences ...

==== //depot/projects/trustedbsd/openbsm/libbsm/libbsm.h#9 (text+ko) ====

@@ -1,18 +1,18 @@
 /*
  * Copyright (c) 2004, Apple Computer, Inc. All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1.  Redistributions of source code must retain the above copyright
- *     notice, this list of conditions and the following disclaimer. 
+ *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
  *     notice, this list of conditions and the following disclaimer in the
- *     documentation and/or other materials provided with the distribution. 
+ *     documentation and/or other materials provided with the distribution.
  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  *     its contributors may be used to endorse or promote products derived
- *     from this software without specific prior written permission. 
- * 
+ *     from this software without specific prior written permission.
+ *
  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -32,7 +32,7 @@
 /*
  * NB: definitions, etc., marked with "OpenSSH compatibility" were
  * introduced solely to allow OpenSSH to compile; Darwin/Apple code should
- * not use them.  
+ * not use them.
  */
 
 #define MAX_ARGS 10
@@ -72,14 +72,14 @@
 #define AU_CLASS_DESC_MAX       72
 #define AU_EVENT_NAME_MAX       30
 #define AU_EVENT_DESC_MAX       50
-#define AU_USER_NAME_MAX      	50 
+#define AU_USER_NAME_MAX      	50
 #define AU_LINE_MAX		256
 #define MAX_AUDITSTRING_LEN	256
 #define BSM_TEXTBUFSZ		MAX_AUDITSTRING_LEN	/* OpenSSH compatibility */
 
-/* 
+/*
  * These are referenced in Solaris 9 au_open(3BSM); values are guesses.
- * Provided for OpenSSH compatibility.  
+ * Provided for OpenSSH compatibility.
  */
 #define AU_TO_NO_WRITE		0
 #define AU_TO_WRITE		1
@@ -117,7 +117,7 @@
 		if(sel & AU_PRS_FAILURE) {\
 			(m)->am_failure |= c;\
 		}\
-	}while(0)	
+	}while(0)
 
 #define SUB_FROM_MASK(m, c, sel) \
 	do {\
@@ -188,18 +188,18 @@
 
 	u_char no;
 	u_int32_t val;
-	u_int16_t len;	
+	u_int16_t len;
 	char *text;
-	
+
 } au_arg32_t;
 
 typedef struct {
 
 	u_char no;
 	u_int64_t val;
-	u_int16_t len;	
+	u_int16_t len;
 	char *text;
-	
+
 } au_arg64_t;
 
 
@@ -214,7 +214,7 @@
 	u_char howtopr;
 	u_char bu;
 	u_char uc;
-	u_char *data; 
+	u_char *data;
 
 } au_arb_t;
 
@@ -254,9 +254,9 @@
 /*
  * count                   4 bytes
  * text                    count null-terminated string(s)
- */ 
+ */
 typedef struct {
-	
+
 	u_int32_t count;
 	char *text[MAX_ARGS];
 
@@ -268,20 +268,20 @@
  * text                    count null-terminated string(s)
  */
 typedef struct {
-	
+
 	u_int32_t count;
 	char *text[MAX_ENV];
-	
-} au_execenv_t;	
+
+} au_execenv_t;
 
 /*
  * status                  4 bytes
  * return value            4 bytes
- */ 
+ */
 typedef struct {
 
 	u_int32_t status;
-	u_int32_t ret;	
+	u_int32_t ret;
 
 } au_exit_t;
 
@@ -290,13 +290,13 @@
  * milliseconds of time    4 bytes
  * file name length        2 bytes
  * file pathname           N bytes + 1 terminating NULL byte
- */ 
+ */
 typedef struct {
 
 	u_int32_t s;
 	u_int32_t ms;
 	u_int16_t len;
-	char *name;	
+	char *name;
 
 } au_file_t;
 
@@ -304,11 +304,11 @@
 /*
  * number groups           2 bytes
  * group list              N * 4 bytes
- */ 
+ */
 typedef struct {
 
 	u_int16_t no;
-	u_int32_t list[BSM_MAX_GROUPS];		
+	u_int32_t list[BSM_MAX_GROUPS];
 
 } au_groups_t;
 
@@ -320,7 +320,7 @@
  * event modifier          2 bytes
  * seconds of time         4 bytes/8 bytes (32-bit/64-bit value)
  * milliseconds of time    4 bytes/8 bytes (32-bit/64-bit value)
- */ 
+ */
 typedef struct {
 
 	u_int32_t size;
@@ -328,8 +328,8 @@
 	u_int16_t e_type;
 	u_int16_t e_mod;
 	u_int32_t s;
-	u_int32_t ms;	
-		
+	u_int32_t ms;
+
 } au_header32_t;
 
 typedef struct {
@@ -339,18 +339,18 @@
 	u_int16_t e_type;
 	u_int16_t e_mod;
 	u_int64_t s;
-	u_int64_t ms;	
-		
+	u_int64_t ms;
+
 } au_header64_t;
 
 
 /*
  * internet address        4 bytes
- */ 
+ */
 typedef struct {
-		
+
 	u_int32_t addr;
-		
+
 } au_inaddr_t;
 
 /*
@@ -375,9 +375,9 @@
  * checksum                2 bytes
  * source address          4 bytes
  * destination address     4 bytes
- */ 
+ */
 typedef struct {
-		
+
 	u_char version;
 	u_char tos;
 	u_int16_t len;
@@ -388,17 +388,17 @@
 	u_int16_t chksm;
 	u_int32_t src;
 	u_int32_t dest;
-		
+
 } au_ip_t;
 
 /*
  * object ID type          1 byte
  * object ID               4 bytes
- */	 
+ */
 typedef struct {
 
 	u_char type;
-	u_int32_t id;	
+	u_int32_t id;
 
 } au_ipc_t;
 
@@ -410,7 +410,7 @@
  * access mode             4 bytes
  * slot sequence #         4 bytes
  * key                     4 bytes
- */							  
+ */
 typedef struct {
 
 	u_int32_t uid;
@@ -431,20 +431,20 @@
 
 	u_int16_t port;
 
-} au_iport_t;	
+} au_iport_t;
 
 
 /*
  * length		2 bytes
  * data			length bytes
- */ 
+ */
 typedef struct {
 
 	u_int16_t size;
 	char *data;
-		
+
 } au_opaque_t;
-		
+
 
 /*
  * path length             2 bytes
@@ -467,10 +467,10 @@
  * real group ID           4 bytes
  * process ID              4 bytes
  * session ID              4 bytes
- * terminal ID     
+ * terminal ID
  * port ID               4 bytes/8 bytes (32-bit/64-bit value)
  * machine address       4 bytes
- */			   
+ */
 typedef struct {
 
 	u_int32_t auid;
@@ -481,7 +481,7 @@
 	u_int32_t pid;
 	u_int32_t sid;
 	au_tid32_t tid;
-		
+
 } au_proc32_t;
 
 typedef struct {
@@ -494,7 +494,7 @@
 	u_int32_t pid;
 	u_int32_t sid;
 	au_tid64_t tid;
-		
+
 } au_proc64_t;
 
 /*
@@ -531,22 +531,22 @@
 
 	u_char status;
 	u_int32_t ret;
-		
+
 } au_ret32_t;
 
 typedef struct {
 
 	u_char err;
 	u_int64_t val;
-		
+
 } au_ret64_t;
 
 
 /*
  * sequence number         4 bytes
- */ 
+ */
 typedef struct {
-		
+
 	u_int32_t seqno;
 
 } au_seq_t;
@@ -568,7 +568,7 @@
 
 } au_socket_t;
 
-/*      
+/*
  * socket type             2 bytes
  * local port              2 bytes
  * address type/length     4 bytes
@@ -622,7 +622,7 @@
  * real group ID           4 bytes
  * process ID              4 bytes
  * session ID              4 bytes
- * terminal ID     
+ * terminal ID
  * 	port ID               4 bytes/8 bytes (32-bit/64-bit value)
  * 	machine address       4 bytes
  */
@@ -652,7 +652,7 @@
 
 } au_subject64_t;
 
-/*      
+/*
  * audit ID                4 bytes
  * effective user ID       4 bytes
  * effective group ID      4 bytes
@@ -660,22 +660,22 @@
  * real group ID           4 bytes
  * process ID              4 bytes
  * session ID              4 bytes
- * terminal ID     
+ * terminal ID
  * port ID               4 bytes/8 bytes (32-bit/64-bit value)
  * type                  4 bytes
  * machine address       16 bytes
- */                        
-typedef struct {           
- 
-	u_int32_t auid;       
-	u_int32_t euid;       
+ */
+typedef struct {
+
+	u_int32_t auid;
+	u_int32_t euid;
 	u_int32_t egid;
 	u_int32_t ruid;
 	u_int32_t rgid;
 	u_int32_t pid;
 	u_int32_t sid;
 	au_tidaddr32_t tid;
-                
+
 } au_subject32ex_t;
 
 
@@ -715,7 +715,7 @@
 
 	u_int16_t magic;
 	u_int32_t count;
-		
+
 } au_trailer_t;
 
 
@@ -726,16 +726,16 @@
 
 	u_char *data;
 	size_t	len;
-	
+
 	union {
 
 		au_arg32_t		arg32;
 		au_arg64_t		arg64;
-		au_arb_t		arb; 
+		au_arb_t		arb;
 		au_attr32_t		attr32;
 		au_attr64_t		attr64;
 		au_execarg_t		execarg;
-		au_execenv_t		execenv;	
+		au_execenv_t		execenv;
 		au_exit_t		exit;
 		au_file_t		file;
 		au_groups_t		grps;
@@ -766,9 +766,9 @@
 		au_kevent_t		kevent;
 		au_invalid_t		invalid;
 		au_trailer_t		trail;
-		
+
 	} tt; /* The token is one of the above types */
-	
+
 } ;
 
 typedef struct tokenstr tokenstr_t;
@@ -780,7 +780,7 @@
 struct au_event_ent *getauevnum(au_event_t event_number);
 /*
  * Free the au_event_ent structure
- */  
+ */
 void free_au_event_ent(struct au_event_ent *e);
 au_event_t *getauevnonam(char *event_name);
 void free_au_event(au_event_t *e);
@@ -791,7 +791,7 @@
 struct au_class_ent *getauclassnam(const char *name);
 /*
  * Free the au_class_ent structure
- */   
+ */
 void free_au_class_ent(struct au_class_ent *c);
 
 void setac();
@@ -811,14 +811,14 @@
 struct au_user_ent *getauuserent();
 struct au_user_ent *getauusernam(const char *name);
 int au_user_mask(char *username, au_mask_t *mask_p);
-int getfauditflags(au_mask_t *usremask, au_mask_t *usrdmask, 
+int getfauditflags(au_mask_t *usremask, au_mask_t *usrdmask,
                                 au_mask_t *lastmask);
 void free_au_user_ent(struct au_user_ent *u);
 
 
 int au_read_rec(FILE *fp, u_char **buf);
 int au_fetch_tok(tokenstr_t *tok, u_char *buf, int len);
-//XXX The following interface has different prototype from BSM 
+//XXX The following interface has different prototype from BSM
 void au_print_tok(FILE *outfp, tokenstr_t *tok, char *del, char raw, char sfrm);
 __END_DECLS
 
@@ -837,10 +837,10 @@
 #define __BSM_INTERNAL_NOTIFY_KEY "com.apple.audit.change"
 #endif /* __APPLE_API_PRIVATE */
 
-/* 
- * au_get_state() return values 
- * XXX  use AUC_* values directly instead (<bsm/audit.h>); AUDIT_OFF and 
- * AUDIT_ON are deprecated and WILL be removed.  
+/*
+ * au_get_state() return values
+ * XXX  use AUC_* values directly instead (<bsm/audit.h>); AUDIT_OFF and
+ * AUDIT_ON are deprecated and WILL be removed.
  */
 #ifdef __APPLE_API_PRIVATE
 #define AUDIT_OFF	AUC_NOAUDIT
@@ -849,8 +849,8 @@
 #endif /* !__APPLE__ */
 
 /*
- * Error return codes for audit_set_terminal_id(), audit_write() and its 
- * brethren.  We have 255 (not including kAUNoErr) to play with.  
+ * Error return codes for audit_set_terminal_id(), audit_write() and its
+ * brethren.  We have 255 (not including kAUNoErr) to play with.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -877,10 +877,10 @@
  * Error return codes for au_get_state() and/or its private support
  * functions.  These codes are designed to be compatible with the
  * NOTIFY_STATUS_* codes defined in <notify.h> but non-overlapping.
- * Any changes to notify(3) may cause these values to change in future.  
+ * Any changes to notify(3) may cause these values to change in future.
  *
- * AU_UNIMPL should never happen unless you've changed your system software 
- * without rebooting.  Shame on you.  
+ * AU_UNIMPL should never happen unless you've changed your system software
+ * without rebooting.  Shame on you.
  */
 #ifdef __APPLE_API_PRIVATE
 #define AU_UNIMPL	NOTIFY_STATUS_FAILED + 1	/* audit unimplemented */
@@ -895,18 +895,18 @@
  * au_free_token()
  *
  * @summary - au_free_token() deallocates a token_t created by any of
- * the au_to_*() BSM API functions.  
+ * the au_to_*() BSM API functions.
  *
- * The BSM API generally manages deallocation of token_t objects.  However, 
+ * The BSM API generally manages deallocation of token_t objects.  However,
  * if au_write() is passed a bad audit descriptor, the token_t * parameter
- * will be left untouched.  In that case, the caller can deallocate the 
+ * will be left untouched.  In that case, the caller can deallocate the
  * token_t using au_free_token() if desired.  This is, in fact, what
  * audit_write() does, in keeping with the existing memory management model
- * of the BSM API.  
+ * of the BSM API.
  *
  * @param tok - A token_t * generated by one of the au_to_*() BSM API
  * calls.  For convenience, tok may be NULL, in which case
- * au_free_token() returns immediately.  
+ * au_free_token() returns immediately.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -916,13 +916,13 @@
  * Lightweight check to determine if auditing is enabled.  If a client
  * wants to use this to govern whether an entire series of audit calls
  * should be made--as in the common case of a caller building a set of
- * tokens, then writing them--it should cache the audit status in a local 
- * variable.  This call always returns the current state of auditing.  
- * 
+ * tokens, then writing them--it should cache the audit status in a local
+ * variable.  This call always returns the current state of auditing.
+ *
  * @return - AUC_AUDITING or AUC_NOAUDIT if no error occurred.
- * Otherwise the function can return any of the errno values defined for 
- * setaudit(2), or AU_UNIMPL if audit does not appear to be supported by 
- * the system.  
+ * Otherwise the function can return any of the errno values defined for
+ * setaudit(2), or AU_UNIMPL if audit does not appear to be supported by
+ * the system.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -939,11 +939,11 @@
  * @summary - audit_set_terminal_id() fills in an au_tid_t struct, which is
  * used in audit session initialization by processes like /usr/bin/login.
  *
- * @param tid - A pointer to an au_tid_t struct.  
+ * @param tid - A pointer to an au_tid_t struct.
  *
- * @return - kAUNoErr on success; kAUBadParamErr if tid is NULL, kAUStatErr 
+ * @return - kAUNoErr on success; kAUBadParamErr if tid is NULL, kAUStatErr
  * or kAUSysctlErr if one of the underlying system calls fails (a message
- * is sent to the system log in those cases).  
+ * is sent to the system log in those cases).
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -956,49 +956,49 @@
  * provided subject information, if any, to construct the subject token
  * required for every log message.  They use the provided return/error
  * value(s), if any, to construct the success/failure indication required
- * for every log message.  They only permit one "miscellaneous" token, 
+ * for every log message.  They only permit one "miscellaneous" token,
  * which should contain the event-specific logging information mandated by
- * CAPP.  
+ * CAPP.
  *
  * All these calls assume the caller has previously determined that
- * auditing is enabled by calling au_get_state().  
+ * auditing is enabled by calling au_get_state().
  */
 
 /*
  * audit_write()
  *
- * @summary - audit_write() is the basis for the other audit_write_*() 
- * calls.  Performs a basic write of an audit record (subject, additional 
- * info, success/failure).  Note that this call only permits logging one 
- * caller-specified token; clients needing to log more flexibly must use 
- * the existing BSM API (au_open(), et al.) directly.  
+ * @summary - audit_write() is the basis for the other audit_write_*()
+ * calls.  Performs a basic write of an audit record (subject, additional
+ * info, success/failure).  Note that this call only permits logging one
+ * caller-specified token; clients needing to log more flexibly must use
+ * the existing BSM API (au_open(), et al.) directly.
  *
- * Note on memory management: audit_write() guarantees that the token_t *s 
- * passed to it will be deallocated whether or not the underlying write to 
+ * Note on memory management: audit_write() guarantees that the token_t *s
+ * passed to it will be deallocated whether or not the underlying write to
  * the audit log succeeded.  This addresses an inconsistency in the
  * underlying BSM API in which token_t *s are usually but not always
- * deallocated.  
+ * deallocated.
  *
- * @param event_code - The code for the event being logged.  This should 
- * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.  
+ * @param event_code - The code for the event being logged.  This should
+ * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
  *
  * @param subject - A token_t * generated by au_to_subject(),
  * au_to_subject32(), au_to_subject64(), or au_to_me().  If no subject is
- * required, subject should be NULL.  
- * 
+ * required, subject should be NULL.
+ *
  * @param misctok - A token_t * generated by one of the au_to_*() BSM API
  * calls.  This should correspond to the additional information required by
  * CAPP for the event being audited.  If no additional information is
- * required, misctok should be NULL.  
+ * required, misctok should be NULL.
  *
  * @param retval - The return value to be logged for this event.  This
- * should be 0 (zero) for success, otherwise the value is event-specific.  
+ * should be 0 (zero) for success, otherwise the value is event-specific.
  *
  * @param errcode - Any error code associated with the return value (e.g.,
- * errno or h_errno).  If there was no error, errcode should be 0 (zero).  
+ * errno or h_errno).  If there was no error, errcode should be 0 (zero).
  *
  * @return - The status of the call: 0 (zero) on success, else one of the
- * kAU*Err values defined above.  
+ * kAU*Err values defined above.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -1007,65 +1007,65 @@
 
 /*
  * audit_write_success()
- * 
+ *
  * @summary - audit_write_success() records an auditable event that did not
  * encounter an error.  The interface is designed to require as little
  * direct use of the au_to_*() API as possible.  It builds a subject token
- * from the information passed in and uses that to invoke audit_write().  
- * A subject, as defined by CAPP, is a process acting on the user's behalf.  
+ * from the information passed in and uses that to invoke audit_write().
+ * A subject, as defined by CAPP, is a process acting on the user's behalf.
  *
  * If the subject information is the same as the current process, use
- * au_write_success_self().  
+ * au_write_success_self().
  *
- * @param event_code - The code for the event being logged.  This should 
- * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.  
+ * @param event_code - The code for the event being logged.  This should
+ * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
  *
  * @param misctok - A token_t * generated by one of the au_to_*() BSM API
  * calls.  This should correspond to the additional information required by
  * CAPP for the event being audited.  If no additional information is
- * required, misctok should be NULL.  
+ * required, misctok should be NULL.
+ *
+ * @param auid - The subject's audit ID.
  *
- * @param auid - The subject's audit ID.  
+ * @param euid - The subject's effective user ID.
  *
- * @param euid - The subject's effective user ID.  
+ * @param egid - The subject's effective group ID.
  *
- * @param egid - The subject's effective group ID.  
+ * @param ruid - The subject's real user ID.
  *
- * @param ruid - The subject's real user ID.  
+ * @param rgid - The subject's real group ID.
  *
- * @param rgid - The subject's real group ID.  
+ * @param pid - The subject's process ID.
  *
- * @param pid - The subject's process ID.  
- * 
- * @param sid - The subject's session ID.  
+ * @param sid - The subject's session ID.
  *
- * @param tid - The subject's terminal ID.  
+ * @param tid - The subject's terminal ID.
  *
  * @return - The status of the call: 0 (zero) on success, else one of the
- * kAU*Err values defined above.  
+ * kAU*Err values defined above.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
-int audit_write_success(short event_code, token_t *misctok, au_id_t auid, 
-			uid_t euid, gid_t egid, uid_t ruid, gid_t rgid, 
+int audit_write_success(short event_code, token_t *misctok, au_id_t auid,
+			uid_t euid, gid_t egid, uid_t ruid, gid_t rgid,
 			pid_t pid, au_asid_t sid, au_tid_t *tid);
 
-/* 
+/*
  * audit_write_success_self()
- * 
- * @summary - Similar to audit_write_success(), but used when the subject 
- * (process) is owned and operated by the auditable user him/herself.  
+ *
+ * @summary - Similar to audit_write_success(), but used when the subject
+ * (process) is owned and operated by the auditable user him/herself.
  *
- * @param event_code - The code for the event being logged.  This should 
- * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.  
+ * @param event_code - The code for the event being logged.  This should
+ * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
  *
  * @param misctok - A token_t * generated by one of the au_to_*() BSM API
  * calls.  This should correspond to the additional information required by
  * CAPP for the event being audited.  If no additional information is
- * required, misctok should be NULL.  
+ * required, misctok should be NULL.
  *
  * @return - The status of the call: 0 (zero) on success, else one of the
- * kAU*Err values defined above.  
+ * kAU*Err values defined above.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -1073,72 +1073,72 @@
 
 /*
  * audit_write_failure()
- * 
- * @summary - audit_write_failure() records an auditable event that 
+ *
+ * @summary - audit_write_failure() records an auditable event that
  * encountered an error.  The interface is designed to require as little
  * direct use of the au_to_*() API as possible.  It builds a subject token
- * from the information passed in and uses that to invoke audit_write().  
- * A subject, as defined by CAPP, is a process acting on the user's behalf.  
+ * from the information passed in and uses that to invoke audit_write().
+ * A subject, as defined by CAPP, is a process acting on the user's behalf.
  *
  * If the subject information is the same as the current process, use
- * au_write_failure_self().  
+ * au_write_failure_self().
  *
- * @param event_code - The code for the event being logged.  This should 
- * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.  
+ * @param event_code - The code for the event being logged.  This should
+ * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
  *
- * @param errmsg - A text message providing additional information about 
- * the event being audited.  
+ * @param errmsg - A text message providing additional information about
+ * the event being audited.
  *
  * @param errret - A numerical value providing additional information about
- * the error.  This is intended to store the value of errno or h_errno if 
- * it's relevant.  This can be 0 (zero) if no additional information is 
- * available.  
+ * the error.  This is intended to store the value of errno or h_errno if
+ * it's relevant.  This can be 0 (zero) if no additional information is
+ * available.
+ *
+ * @param auid - The subject's audit ID.
  *
- * @param auid - The subject's audit ID.  
+ * @param euid - The subject's effective user ID.
  *
- * @param euid - The subject's effective user ID.  
+ * @param egid - The subject's effective group ID.
  *
- * @param egid - The subject's effective group ID.  
+ * @param ruid - The subject's real user ID.
  *
- * @param ruid - The subject's real user ID.  
+ * @param rgid - The subject's real group ID.
  *
- * @param rgid - The subject's real group ID.  
+ * @param pid - The subject's process ID.
  *
- * @param pid - The subject's process ID.  
- * 
- * @param sid - The subject's session ID.  
+ * @param sid - The subject's session ID.
  *
- * @param tid - The subject's terminal ID.  
+ * @param tid - The subject's terminal ID.
  *
  * @return - The status of the call: 0 (zero) on success, else one of the
- * kAU*Err values defined above.  
+ * kAU*Err values defined above.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
-int audit_write_failure(short event_code, char *errmsg, int errret, 
+int audit_write_failure(short event_code, char *errmsg, int errret,
 			au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
-			gid_t rgid, pid_t pid, au_asid_t sid, 
+			gid_t rgid, pid_t pid, au_asid_t sid,
 			au_tid_t *tid);
 
-/* 
+/*
  * audit_write_failure_self()
- * 
- * @summary - Similar to audit_write_failure(), but used when the subject 
- * (process) is owned and operated by the auditable user him/herself.  
+ *
+ * @summary - Similar to audit_write_failure(), but used when the subject
+ * (process) is owned and operated by the auditable user him/herself.
  *
- * @param event_code - The code for the event being logged.  This should 
- * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.  
+ * @param event_code - The code for the event being logged.  This should
+ * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
  *
- * @param errmsg - A text message providing additional information about 
- * the event being audited.  
+ * @param errmsg - A text message providing additional information about
+ * the event being audited.
  *
  * @param errret - A numerical value providing additional information about
- * the error.  This is intended to store the value of errno or h_errno if 
- * it's relevant.  This can be 0 (zero) if no additional information is 
- * available.  
+ * the error.  This is intended to store the value of errno or h_errno if
+ * it's relevant.  This can be 0 (zero) if no additional information is
+ * available.
  *
  * @return - The status of the call: 0 (zero) on success, else one of the
- * kAU*Err values defined above.  
+ * kAU*Err values defined above.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -1147,30 +1147,30 @@
 /*
  * audit_write_failure_na()
  *
- * @summary - audit_write_failure_na() records errors during login.  Such 
- * errors are implicitly non-attributable (i.e., not ascribable to any user).  
+ * @summary - audit_write_failure_na() records errors during login.  Such
+ * errors are implicitly non-attributable (i.e., not ascribable to any user).
  *
- * @param event_code - The code for the event being logged.  This should 
- * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.  
+ * @param event_code - The code for the event being logged.  This should
+ * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
  *
- * @param errmsg - A text message providing additional information about 
- * the event being audited.  
+ * @param errmsg - A text message providing additional information about
+ * the event being audited.
  *
  * @param errret - A numerical value providing additional information about
- * the error.  This is intended to store the value of errno or h_errno if 
- * it's relevant.  This can be 0 (zero) if no additional information is 
- * available.  
+ * the error.  This is intended to store the value of errno or h_errno if
+ * it's relevant.  This can be 0 (zero) if no additional information is
+ * available.
+ *
+ * @param euid - The subject's effective user ID.
  *
- * @param euid - The subject's effective user ID.  
+ * @param egid - The subject's effective group ID.
  *
- * @param egid - The subject's effective group ID.  
+ * @param pid - The subject's process ID.
  *
- * @param pid - The subject's process ID.  
- * 
- * @param tid - The subject's terminal ID.  
+ * @param tid - The subject's terminal ID.
  *
  * @return - The status of the call: 0 (zero) on success, else one of the
- * kAU*Err values defined above.  
+ * kAU*Err values defined above.
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
  */
@@ -1184,37 +1184,37 @@
 /*
  * audit_token_to_au32()
  *
- * @summary - Extract information from an audit_token_t, used to identify 
+ * @summary - Extract information from an audit_token_t, used to identify
  * Mach tasks and senders of Mach messages as subjects to the audit system.
  * audit_tokent_to_au32() is the only method that should be used to parse
  * an audit_token_t, since its internal representation may change over
  * time.  A pointer parameter may be NULL if that information is not
- * needed.  
+ * needed.
  *
  * @param atoken - the audit token containing the desired information
  *
- * @param auidp - Pointer to a uid_t; on return will be set to the task or 
+ * @param auidp - Pointer to a uid_t; on return will be set to the task or
  * sender's audit user ID
  *
- * @param euidp - Pointer to a uid_t; on return will be set to the task or 
+ * @param euidp - Pointer to a uid_t; on return will be set to the task or
  * sender's effective user ID
  *
- * @param egidp - Pointer to a gid_t; on return will be set to the task or 
+ * @param egidp - Pointer to a gid_t; on return will be set to the task or
  * sender's effective group ID
  *
- * @param ruidp - Pointer to a uid_t; on return will be set to the task or 
+ * @param ruidp - Pointer to a uid_t; on return will be set to the task or
  * sender's real user ID
  *
- * @param rgidp - Pointer to a gid_t; on return will be set to the task or 
+ * @param rgidp - Pointer to a gid_t; on return will be set to the task or
  * sender's real group ID
  *
- * @param pidp - Pointer to a pid_t; on return will be set to the task or 
+ * @param pidp - Pointer to a pid_t; on return will be set to the task or
  * sender's process ID
  *
- * @param asidp - Pointer to an au_asid_t; on return will be set to the 
+ * @param asidp - Pointer to an au_asid_t; on return will be set to the
  * task or sender's audit session ID
  *
- * @param tidp - Pointer to an au_tid_t; on return will be set to the task 
+ * @param tidp - Pointer to an au_tid_t; on return will be set to the task
  * or sender's terminal ID
  *
  * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
To Unsubscribe: send mail to majordomo at trustedbsd.org
with "unsubscribe trustedbsd-cvs" in the body of the message



More information about the trustedbsd-cvs mailing list