ircproxy  The Ultimate Cyborg

---

Authentication.h

Go to the documentation of this file.

// ircproxy -- An IRC bouncer.
//
//! @file Authentication.h
//! @brief This file contains the declaration of class Authentication.
//
// Copyright (C) 2006, 2007 by
//
// Carlo Wood, Run on IRC <carlo@alinoe.com>
// RSA-1024 0x624ACAD5 1997-01-26                    Sign & Encrypt
// Fingerprint16 = 32 EC A7 B6 AC DB 65 A6  F6 F6 55 DD 1C DC FF 61
//
// This file may be distributed under the terms of the Q Public License
// version 1.0 as appearing in the file LICENSE.QPL included in the
// packaging of this file.

#ifndef AUTHENTICATION_H
#define AUTHENTICATION_H

#ifndef USE_PCH
#include <string>
#include <boost/shared_ptr.hpp>
#include "debug.h"
#endif

#include "IdentityReference.h"

class UserAnswerEventType;

/*! @brief Authentication token.
 *
 * This object keeps the data that is needed to connect
 * to a server and authenticate with any services.
 *
 * The information contained in it is received with
 * The PASS and USER messages. It is assumed that the
 * PASS message is always received first. At the moment
 * the USER message is received, this object will be
 * used to establish a connection with a server.
 */
class Authentication : protected IdentityReference {
private:
  std::string M_server_pass;                    //!< Server password.
  std::string M_service_pass;                   //!< Service password.
  std::string M_ident;                          //!< Ident string.
  std::string M_realname;                       //!< The real name.
  boost::shared_ptr<Authentication>& M_ptr;     //!< Reference to the (only) pointer to this object.
  bool M_received_nick;                         //!< True if NICK was received from the client.
  bool M_received_user;                         //!< True if USER was received from the client.

public:
  void decode_pass(ClientMessageIn const& pass_msg);
  void received_nick(void);
  void decode_user(ClientMessageIn const& user_msg);

  void send_authentication(ServerConnection& server_connection);

public:
  //! Update \a ptr to point to the Authentication object for this Identity.
  //! If no Authentication object exists yet, it will be created.
  static void get(Identity* identity, boost::shared_ptr<Authentication>& ptr)
      { if (!ptr.get()) ptr.reset(NEW(Authentication(identity, ptr))); }

  //! Return the Service password (used to login into X, for example).
  std::string const& service_pass(void) const { return M_service_pass; }

private:
  //! The constructor is private, use Authentication::get to get a pointer to an Authentication object.
  Authentication(Identity* identity, boost::shared_ptr<Authentication>& ptr) :
      IdentityReference(identity), M_ptr(ptr), M_received_nick(false), M_received_user(false)
      { Dout(dc::objects, "Constructing Authentication " << *this); }

  //! Called when both NICK and USER are received from the client.
  void received_nick_and_user(void);

public:
#ifdef CWDEBUG
  //! Destructor.
  ~Authentication() { Dout(dc::objects, "Destructing Authentication " << *this); }
#endif
  //! Copyconstructor.
  Authentication(Authentication const& authentication) :
     IdentityReference(authentication),
     M_server_pass(authentication.M_server_pass),
     M_service_pass(authentication.M_service_pass),
     M_ident(authentication.M_ident),
     M_realname(authentication.M_realname),
     M_ptr(authentication.M_ptr),
     M_received_nick(authentication.M_received_nick),
     M_received_user(authentication.M_received_user)
     { Dout(dc::objects, "Copy-constructing Authentication from " << authentication); }

  friend std::ostream& operator<<(std::ostream&, Authentication const&);
};

#endif // AUTHENTICATION_H

---