[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/vos/passwordauth.hh

Go to the documentation of this file.

#ifndef _PASSWORDAUTH_HH_
#define _PASSWORDAUTH_HH_

#include <vos/vos/metaobject.hh>

#ifndef VOS_EXPORTS
IMPORT_METAOBJECT_FACTORIES(PasswordAuth)
#endif

namespace VOS {

/** @class LocalPasswordAuth passwordauth.hh vos/vos/passwordauth.hh
    @ingroup libvos

    This class should be a cotype with an Identity Vobject.  It
    implements a secure hash-based challenge-response password
    validation protocol, and upon successfully completing the
    authentication, the remote site takes on this Identity.  The
    cleartext password is never sent during the validation protocol.
 */
class VOS_API LocalPasswordAuth : public MetaObject
{
private:
    std::string password;

    LocalPasswordAuth(VobjectBase* superobject);
public:
    /** destructor */
    virtual ~LocalPasswordAuth();

    /** Used by metaobject factory, never call directly */
    static MetaObject* new_LocalPasswordAuth(VobjectBase* superobject,
                                             const std::string& type);

    /** @return VOS type "core:passwordauth" */
    virtual const std::string getVOSType();

    /** Set the password (cleartext)
        @param password
    */
    void setPassword(const std::string& password);

    /** @return the password (cleartext) */
    std::string getPassword();

    /** Handles the challenge-reply protocol to authenticate
        a remote site to take on this identity.
    */
    void handleAuthRequest(Message* m);
    void handleSetPassword(Message* m);
};

/** @class RemotePasswordAuth passwordauth.hh vos/vos/passwordauth.hh
    @ingroup libvos
 */
class VOS_API RemotePasswordAuth : public MetaObject
{
    RemotePasswordAuth(VobjectBase* superobject);
public:
    /** destructor */
    virtual ~RemotePasswordAuth();

    /** used by metaobject factory, never call directly */
    static MetaObject* new_RemotePasswordAuth(VobjectBase* superobject,
                                              const std::string& type);

    /** @return VOS type "core:passwordauth" */
    virtual const std::string getVOSType();

    /** Using the supplied password, will attempt an authentication
        protocol with the server in order to take on this Identity.
        The cleartext password is never sent during the validation
        protocol.
        @param password the password (cleartext)
        @throw AccessControlError if the authentication fails
    */
    void authenticate(const std::string& password);

    /** Request that the password be changed to the supplied password.
        You must have already taken on this this Identity using
        authenticate().  Note that this will send a CLEARTEXT
        password, that is, someone can sniff the password-set message
        to learn the password (unlike the authentication protocol
        which never sends the password) so use with care.

        @param password the password (cleartext)
        @throw AccessControlError if setting the password was not
        allowed
     */
    void setPassword(const std::string& password);
};

}

#endif