vos/metaobjects/misc/login.hh

Go to the documentation of this file.

/* $Id: login.hh,v 1.9 2003/08/01 01:40:44 neil Exp $ */


/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges <reed@zerohour.net>.

   Search for TODO for stuff that needs editing. You will want to especially fill in constructors,
   destructors, message handlers, non-property subobjects...

   I can make no garuntee that this code will work, or even that it even is safe to run.
   Use it at your own risk.
*/

/** @file login.hh Defines MetaObject class for Login type (revision 0).

*/

#ifndef _LOGIN_HH_
#define _LOGIN_HH_

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef MISC_EXPORTS
#  define MISC_API __declspec(dllexport)
# else
#  define MISC_API __declspec(dllimport)
# endif
#else
# define MISC_API
#endif

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>

/** MetaObject implementing Login Object Type.

    An authentication point for challenge-response based identity
    verification. Identity is site-based, so granting authentication
    to any object on a site should authenticate the entire site.
    Successful completion of the protocol authenticates the user as
    having a legal username/password combination.

*/

/** Local version of Login. */

class MISC_API LocalLogin : public virtual MetaObject
{
public:

    /** Constructor */
    LocalLogin(MetaObject* superobject);

    /** Destructor */
    virtual ~LocalLogin();

    class BadUsernameError : public runtime_error {
    public:
        BadUsernameError(const string& s) : runtime_error(s) { };
    };

    virtual string getPassword(string username) = 0;
    virtual void notifyAuthenticated(const string& username, Site* site) = 0;

    virtual const string getType();

protected:

    /** @name Message Handlers */
//@{

    // TODO you might want to override some of these messages in LocalLogin and RemoteLogin.

    /** Handle message request-login (  Begin a login sequence.) */
    virtual void handleRequestLogin(Message* m);

    /** Handle message login-challenge-reply (  The user must append their password to the string supplied  with request-login-challenge, hash the result using MD5, and  transmit the hash.) */
    virtual void handleLoginChallengeReply(Message* m);

    //@}

    struct AuthState
    {
        string username;
        int timestamp;
        string nonce;
    };
    map<Site*, AuthState > nonceMap;
};


/** Remote version of Login. */

class MISC_API RemoteLogin : public virtual MetaObject
{
public:

    /** Constructor */
    RemoteLogin(MetaObject* superobject);

    static void registerExtenders();

    /** Destructor */
    virtual ~RemoteLogin();

    /** Static generator, for factory. */
    static MetaObject* new_RemoteLogin(MetaObject* superobject, const string& type);

    /** @name Actuators.
        These are user-functions corresponding to messages. The remote actuators marshal arguments and send a message to the Local object. */
    //@{

    /** Send a request-login messsage to the local object. */
    virtual bool doRequestLogin(const string& username, const string& password);

    virtual const string getType();

protected:
    /** @name Update Handlers. Handlers for remote update messages */
    //@{

    /** Handle a request-login-challenge messsage from the local object. */
    virtual void handleRequestLoginChallenge(Message* m);

    /** Handle a login-result messsage from the local object. */
    virtual void handleLoginResult(Message* m);

    //@}

    bool success;
    string password;
};


#endif // #ifdef _LOGIN_HH_

---