xref: /titanic_44/usr/src/man/man3c/door_ucred.3c (revision 430b4c467020edf2445feb0c21db01c88b86243a) 
 te
 Copyright (c) 2005, 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]
 door_ucred 3C "22 Mar 2005" "SunOS 5.11" "Standard C Library Functions"
 NAME
door_ucred - return credential information associated with the client

 SYNOPSIS


cc -mt [ flag... ] file... [ library... ]
#include <door.h>

int door_ucred(ucred_t **info);




 DESCRIPTION

The door_ucred() function returns credential information associated with
the client, if any, of the current door invocation.


When successful, door_ucred() writes a pointer to a user credential to
the location pointed to by info if that location was previously
NULL. If that location was non-null, door_ucred() assumes that
info points to a previously allocated ucred_t which is then reused.
The location pointed to by info can be used multiple times before being
freed. The value returned in info must be freed using
ucred_free(3C).


The resulting user credential includes information about the effective user and
group ID, the real user and group ID, all privilege sets and the calling PID.


The credential information associated with the client refers to the information
from the immediate caller, not necessarily from the first thread in a chain of
door calls.

 RETURN VALUES

Upon successful completion, door_ucred() returns 0. Otherwise, -1 is
returned and errno is set to indicate the error, in which case the memory
location pointed to by the info argument is unchanged.

 ERRORS

The door_ucred() function will fail if:


EAGAIN


The location pointed to by info was NULL and allocating memory
sufficient to hold a ucred failed.





EFAULT


The address of the info argument is invalid.





EINVAL


There is no associated door client.





ENOMEM


The location pointed to by info was NULL and allocating memory
sufficient to hold a ucred failed.




 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStable
MT-LevelSafe



 SEE ALSO

door_call(3C), door_create(3C), ucred_get(3C),
attributes(5)