src/client-api/src/include/common/spds/CredentialHandler.h

   1 /*
   2  * Funambol is a mobile platform developed by Funambol, Inc.
   3  * Copyright (C) 2003 - 2007 Funambol, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by
   7  * the Free Software Foundation with the addition of the following permission
   8  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
   9  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
  10  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program; if not, see http://www.gnu.org/licenses or write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301 USA.
  21  *
  22  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
  23  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License
  30  * version 3, these Appropriate Legal Notices must retain the display of the
  31  * "Powered by Funambol" logo. If the display of the logo is not reasonably
  32  * feasible for technical reasons, the Appropriate Legal Notices must display
  33  * the words "Powered by Funambol".
  34  */
  35
  36  #ifndef INCL_CREDENTIAL_HANDLER
  37     #define INCL_CREDENTIAL_HANDLER
  38 /** @cond DEV */
  39
  40     #include "base/fscapi.h"
  41     #include "base/constants.h"
  42     #include "base/util/utils.h"
  43     #include "spds/constants.h"
  44     #include "syncml/core/TagNames.h"
  45     #include "syncml/core/ObjectDel.h"
  46 #include "base/globalsdef.h"
  47
  48 BEGIN_NAMESPACE
  49
  50     class CredentialHandler{
  51
  52     private:
  53
  54         char*  username;
  55         char*  password;
  56         char*  clientAuthType;
  57         char*  clientNonce;
  58
  59         char*  serverID;
  60         char*  serverPWD;
  61         char*  serverAuthType;
  62         char*  serverNonce;
  63
  64         bool isServerAuthRequired;
  65
  66         /**
  67          * Initializes private members
  68          */
  69         void initialize();
  70         void  generateNonce(char nonce[16]);
  71
  72     public:
  73         /*
  74          * Default constructor
  75          */
  76         CredentialHandler();
  77
  78         ~CredentialHandler();
  79
  80         /*
  81          * Constructs a new SyncItem identified by the given key. The key must
  82          * not be longer than DIM_KEY (see SPDS Constants).
  83          *
  84          * @param key - the key
  85          */
  86         CredentialHandler(const char*  key);
  87
  88         /*
  89          * Returns the SyncItem's key. If key is NULL, the internal buffer is
  90          * returned; if key is not NULL, the value is copied in the caller
  91          * allocated buffer and the given buffer pointer is returned.
  92          *
  93          * @param key - buffer where the key will be stored
  94          */
  95
  96         void setUsername(const char*  t);
  97         const char*  getUsername();
  98         void setPassword(const char*  t);
  99         const char*  getPassword();
 100         void setClientAuthType(const char*  t);
 101         void setClientNonce(const char*  t);
 102         const char*  getClientAuthType();
 103         const char*  getClientNonce();
 104
 105         void setServerID(const char*  t);
 106         void setServerPWD(const char*  t);
 107         void setServerAuthType(const char*  t);
 108         void setServerNonce(const char*  t);
 109         const char*  getServerAuthType();
 110         const char*  getServerNonce();
 111
 112         void setServerAuthRequired(bool t);
 113         bool getServerAuthRequired();
 114
 115         Cred* getClientCredential();
 116         Cred* getServerCredential();
 117         Chal* getServerChal(bool isServerAuthenticated);
 118         bool  performServerAuth(Cred* cred);
 119
 120     };
 121
 122
 123 END_NAMESPACE
 124
 125 /** @endcond */
 126 #endif