OpenGL Vizserver Reference Page


NAME
vsAuthUser - Authenticated local user container

HEADER FILE
#include <vizserver/vsAuth.h>

PUBLIC METHOD SUMMARY

   Creating and Destroying
vsAuthUser ( const char* name, const char* pwd, long uid, long gid, gid_t* gidSet, unsigned int gidSetCount, const char* shell, const char* homeDir);
virtual ~vsAuthUser (  );

   User Control
virtual vsStatus become (  ) const;

   Getting and Setting
const char* getName (  ) const;
const char* getEncPasswd (  ) const;
long getUID (  ) const;
long getGID (  ) const;
const gid_t* getGIDSet ( unsigned int& count) const;
const char* getShell (  ) const;
const char* getHomeDir (  ) const;

PROTECTED METHOD SUMMARY
vsStatus assume (  ) const;
vsStatus restore (  ) const;

CLASS DESCRIPTION
Contains user, group, id, shell and home directory info for a user. Essentially this information is grabbed from /etc/passwd

METHOD DESCRIPTIONS

   vsAuthUser()
vsAuthUser ( const char* name, const char* pwd, long uid, long gid, gid_t* gidSet, unsigned int gidSetCount, const char* shell, const char* homeDir);

Construct user information about the authenticated user.

   ~vsAuthUser()
virtual ~vsAuthUser (  );

Destroy object and data contained by object.

   assume()
vsStatus assume (  ) const;

Have the current process assume the identity of the user identified by this vsAuthUser object.

   become()
virtual vsStatus become (  ) const;

Force the current process to become the user identified by this vsAuthUser object. This action is irrevokable.

   getEncPasswd()
const char* getEncPasswd (  ) const;

Return the encrypted password for this user.

   getGID()
long getGID (  ) const;

Return the group id of this user.

   getGIDSet()
const gid_t* getGIDSet ( unsigned int& count) const;

Return the group membership set for this user.

   getHomeDir()
const char* getHomeDir (  ) const;

Return the home directory for this user.

   getName()
const char* getName (  ) const;

Return the name of the user.

   getShell()
const char* getShell (  ) const;

Return the default shell for this user.

   getUID()
long getUID (  ) const;

Return the userid of this user.

   restore()
vsStatus restore (  ) const;

Restore the identity of the current process to the real user.