OpenGL Vizserver Reference Page


NAME
vsAuthContext - Contextual information for authenteiced sessions

HEADER FILE
#include <vizserver/vsAuth.h>

PUBLIC METHOD SUMMARY

   Destruction
virtual ~vsAuthContext (  );

   Getting
virtual vsStatus getAuthenticator ( vsAuthData& data) = 0;
virtual vsStatus authenticate ( const char* data, unsigned int length) = 0;
virtual vsStatus getUser ( const vsAuthUser*& user) = 0;

   User Creation
vsAuthUser* createUser ( uid_t uid);
vsAuthUser* createUser ( const char* userName);

PROTECTED METHOD SUMMARY
vsAuthContext (  );
virtual vsAuthUser* createAuthUser ( const char* name, const char* pwd, long uid, long gid, gid_t* gidSet, unsigned int gidSetCount, const char* shell, const char* homeDir);

CLASS DESCRIPTION
The vsAuthContext retains contextual information for a particular authenticated session between two principals.

METHOD DESCRIPTIONS

   vsAuthContext()
vsAuthContext (  );

Constructor.

   ~vsAuthContext()
virtual ~vsAuthContext (  );

Destroys authentication context.

   authenticate()
virtual vsStatus authenticate ( const char* data, unsigned int length) = 0;

Given the authenticator in data (of length length), authenticate verifies the identity of the sender.

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

Creates a user under vizserver space. Parameters are as per /etc/passwd

   createUser()
vsAuthUser* createUser ( uid_t uid);

Creates a user by user id.

   createUser()
vsAuthUser* createUser ( const char* userName);

Creates a user by username.

   getAuthenticator()
virtual vsStatus getAuthenticator ( vsAuthData& data) = 0;

Returns an authenticator that can be presented to the other principal for authenticating this principal.

   getUser()
virtual vsStatus getUser ( const vsAuthUser*& user) = 0;

Returns the user (primarily for server consumption) that identifies the client user on this server.