#
# Copyright 2004 Sun Microsystems, Inc. All rights reserved.
# Use is subject to license terms.
#
#ident "@(#)Ucred.pod 1.1 04/01/22 SMI"
#
# Sun::Solaris::Ucred documentation.
#
=head1 NAME
Sun::Solaris::Ucred - Perl interface to User Credentials
=head1 SYNOPSIS
use Sun::Solaris::Ucred qw(:ALL);
This module provides wrappers for the Ucred-related system and
library calls.
=head2 Functions
B>
This function returns the credential of the process specified by $pid,
if the process exists and the calling process is permitted to obtain
the credentials of that process.
B>
If $fd is a connected connection oriented TLI endpoint, a connected
SOCK_STREAM or SOCK_SEQPKT socket, getpeerucred will return the user
credential of the peer at the time the connection was established,
if availble.
B>
This function returns the effective uid of a user credential, if available.
B>
This function returns the real uid of a user credential, if available.
B>
This function returns the saved uid of a user credential, if available.
B>
This function returns the effective group of a user credential, if available.
B>
This function returns the real group of a user credential, if available.
B>
This function returns the saved group of a user credential, if available.
B>
This function returns the list of supplemental groups of a user
credential, if available. An array of groups is returned in ARRAY
context; the number of groups is returned in SCALAR context.
B>
This function returns the privilege set specified by $which of a user
credential, if available.
B>
This function returns the value of a specific process flag of a user
credential, if available.
B>
This function returns the process id of a user credential, if available.
B>
This function returns the zone id of a user credential, if available.
=head2 Class methods
None.
=head2 Object methods
None.
=head2 Exports
By default nothing is exported from this module. The following tags can be
used to selectively import constants and functions defined in this module:
:SYSCALLS ucred_get(), getpeerucred()
:LIBCALLS ucred_geteuid(), ucred_getruid(), ucred_getsuid(),
ucred_getegid(), ucred_getrgid(), ucred_getsgid(),
ucred_getgroups(), ucred_getprivset(), ucred_getpflags(),
ucred_getpid(), ucred_getzone()
:CONSTANTS
:VARIABLES %PRIVILEGES, %PRIVSETS
:ALL :SYSCALLS, :LIBCALLS, and :CONSTANTS
=head1 ATTRIBUTES
See C for descriptions of the following attributes:
___________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | CPAN (http://www.cpan.org) |
|_____________________________|_____________________________|
| Interface Stability | Evolving |
|_____________________________|_____________________________|
=head1 SEE ALSO
C, C, C