libexplain/setuid.h File Reference

explain setuid(2) errors More...

#include <libexplain/gcc_attributes.h>
#include <libexplain/large_file_support.h>

Go to the source code of this file.

Functions
void	explain_setuid_or_die (int uid)
int	explain_setuid_on_error (int uid)
const char *	explain_setuid (int uid) LIBEXPLAIN_WARN_UNUSED_RESULT
const char *	explain_errno_setuid (int errnum, int uid) LIBEXPLAIN_WARN_UNUSED_RESULT
void	explain_message_setuid (char *message, int message_size, int uid)
void	explain_message_errno_setuid (char *message, int message_size, int errnum, int uid)

---

Detailed Description

explain setuid(2) errors

These functions may be used to obtain explanations for errors returned by the setuid(2) system call.

Definition in file setuid.h.

---

Function Documentation

const char* explain_errno_setuid	(	int	errnum,
		int	uid
	)

The explain_errno_setuid function is used to obtain an explanation of an error returned by the setuid(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
uid	The original uid, exactly as passed to the setuid(2) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (setuid(uid) < 0)
 {
     int err = errno;
     fprintf(stderr, "%s\n", explain_errno_setuid(err, uid));
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_setuid_or_die function.

void explain_message_errno_setuid	(	char *	message,
		int	message_size,
		int	errnum,
		int	uid
	)

The explain_message_errno_setuid function is used to obtain an explanation of an error returned by the setuid(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
errnum	The error value to be decoded, usually obtained from the errno global variable just before this function is called. This is necessary if you need to call any code between the system call to be explained and this function, because many libc functions will alter the value of errno.
uid	The original uid, exactly as passed to the setuid(2) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (setuid(uid) < 0)
 {
     int err = errno;
     char message[3000];
     explain_message_errno_setuid(message, sizeof(message), err, uid);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_setuid_or_die function.

void explain_message_setuid	(	char *	message,
		int	message_size,
		int	uid
	)

The explain_message_setuid function is used to obtain an explanation of an error returned by the setuid(2) system call. The least the message will contain is the value of strerror(errnum), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

message	The location in which to store the returned message. If a suitable message return buffer is supplied, this function is thread safe.
message_size	The size in bytes of the location in which to store the returned message.
uid	The original uid, exactly as passed to the setuid(2) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (setuid(uid) < 0)
 {
     char message[3000];
     explain_message_setuid(message, sizeof(message), uid);
     fprintf(stderr, "%s\n", message);
     exit(EXIT_FAILURE);
 }

The above code example is available pre-packaged as the explain_setuid_or_die function.

const char* explain_setuid

(

int

uid

)

The explain_setuid function is used to obtain an explanation of an error returned by the setuid(2) system call. The least the message will contain is the value of strerror(errno), but usually it will do much better, and indicate the underlying cause in more detail.

The errno global variable will be used to obtain the error value to be decoded.

Parameters:

uid	The original uid, exactly as passed to the setuid(2) system call.

Returns:

The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads.

Note:

This function is not thread safe, because it shares a return buffer across all threads, and many other functions in this library.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (setuid(uid) < 0)
 {
     fprintf(stderr, "%s\n", explain_setuid(uid));
     exit(EXIT_FAILURE);
 }

The above code example is available pre\-packaged as the explain_setuid_or_die function.

int explain_setuid_on_error

(

int

uid

)

The explain_setuid_on_error function is used to call the setuid(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_setuid(3) function.

Parameters:

uid	The uid, exactly as to be passed to the setuid(2) system call.

Returns:

The value returned by the wrapped setuid(2) system call.

Example:

This function is intended to be used in a fashion similar to the following example:

 if (explain_setuid_on_error(uid) < 0)
 {
     ...cope with error
     ...no need to print error message
 }

void explain_setuid_or_die

(

int

uid

)

The explain_setuid_or_die function is used to call the setuid(2) system call. On failure an explanation will be printed to stderr, obtained from the explain_setuid(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

Parameters:

uid	The uid, exactly as to be passed to the setuid(2) system call.

Returns:

This function only returns on success, see setuid(2) for more information. On failure, prints an explanation and exits, it does not return.

Example:

This function is intended to be used in a fashion similar to the following example:

 explain_setuid_or_die(uid);