smf/smfcredentialmgr/smfcredmgrclient/smfcredmgrclient.h
changeset 26 83d6a149c755
parent 24 1cee9f1b95e0
equal deleted inserted replaced
25:a180113055cb 26:83d6a149c755
    94 	 */
    94 	 */
    95 	QString GenerateNONCE(const qint64 Length);
    95 	QString GenerateNONCE(const qint64 Length);
    96 
    96 
    97 	/**
    97 	/**
    98 	 * API to update the list of authenticated plugins-add, remove, update to plugins
    98 	 * API to update the list of authenticated plugins-add, remove, update to plugins
    99 	 * @param NewPluginID ID of the new plugin
    99 	 * @param NewPluginID ID of the new plugin 
   100 	 * @param Flag flag to enable or disable the plugin
   100 	 * @param Flag flag to enable or disable the plugin
   101 	 * @param OldPluginID ID of the old plugin to be replaced
   101 	 * @param OldPluginID ID of the old plugin to be replaced
   102 	 * @todo - should return an error code to indicate error while changing the list.
   102 	 * @todo - should return an error code to indicate error while changing the list.
   103 	 */
   103 	 */
   104 	void ChangePluginIDList(QString NewPluginID,bool Flag, QString OldPluginID);
   104 	void ChangePluginIDList(QString NewPluginID,bool Flag, QString OldPluginID);
   108 	 * @param Validity time by which the Auth set will expire
   108 	 * @param Validity time by which the Auth set will expire
   109 	 * @param URLList The URL list to be set
   109 	 * @param URLList The URL list to be set
   110 	 * @param PluginList The plugin list to be set
   110 	 * @param PluginList The plugin list to be set
   111 	 * @param AuthAppId The Authentication Application Id
   111 	 * @param AuthAppId The Authentication Application Id
   112 	 * @param Flag flag to enable or disable the plugins
   112 	 * @param Flag flag to enable or disable the plugins
   113 	 * @return The registration token that completes authentication, its a NULL string if the
   113 	 * @return The registration token that completes authentication, its a NULL string if the 
   114 	 *   API fails due to any wrong argument
   114 	 *   API fails due to any wrong argument
   115 	 */
   115 	 */
   116 	QString StoreAuthData(SmfAuthParams Set,
   116 	QString StoreAuthData(SmfAuthParams Set,
   117 			QDateTime Validity, QList<QUrl> URLList, QStringList PluginList,
   117 			QDateTime Validity, QList<QUrl> URLList, QStringList PluginList,
   118 			QString AuthAppId, bool Flag);
   118 			QString AuthAppId, bool Flag);
   134 	 * 				returned while storeRSAKeys(), if signature method is HMAC-SHA1 key
   134 	 * 				returned while storeRSAKeys(), if signature method is HMAC-SHA1 key
   135 	 * 				must the value to sign the message with
   135 	 * 				must the value to sign the message with
   136 	 * @param Signature The signed message is an output argument
   136 	 * @param Signature The signed message is an output argument
   137 	 * @param AlgorithmUsed The algorithm used for signing
   137 	 * @param AlgorithmUsed The algorithm used for signing
   138 	 * return Smf defined errorcode
   138 	 * return Smf defined errorcode
   139 	 * @todo - RSA Signing is falgged-put for time being.
   139 	 * @todo - RSA Signing is falgged-put for time being. 
   140 	 */
   140 	 */
   141 	SMFCredMgrErrorCode SignMessage(QString Message,
   141 	SMFCredMgrErrorCode SignMessage(QString Message,
   142 			QString Key, QString& Signature, SmfSignatureMethod AlgorithmUsed);
   142 			QString Key, QString& Signature, SmfSignatureMethod AlgorithmUsed);
   143 	/**
   143 	/**
   144 	 * API To delete the RSA Key from the Key Store
   144 	 * API To delete the RSA Key from the Key Store 
   145 	 * @param KeyLabel The Label of key pair. This is the value returned while StoreRSAKeys().
   145 	 * @param KeyLabel The Label of key pair. This is the value returned while StoreRSAKeys().
   146 	 */
   146 	 */
   147 	void DeleteRSAKey(QString KeyLabel);
   147 	void DeleteRSAKey(QString KeyLabel);
       
   148 	
       
   149 	/**
       
   150 	 * API to check if a particular service is logged in or not (ie, key sets 
       
   151 	 * of a service is saved in credential manager or not)
       
   152 	 * @param AuthAppId The Authentication Application Id
       
   153 	 * @return true if service is logged in else false
       
   154 	 */
       
   155 	bool CheckServiceAuthorization( const QString& AuthAppId );
       
   156 	
       
   157 	/**
       
   158 	 * API to delete all data related to an auth app i.e URL list for Plugins, List of Plugins.etc.
       
   159 	 * @param AuthAppId The Authentication Application Id
       
   160 	 * @param RegToken Registration Token obtained from SMF while storing this Auth Data set
       
   161 	 * @param Validity Time by which the Auth set will expire
       
   162 	 * @return Smf defined errorcode of the operation
       
   163 	 */
       
   164 	SMFCredMgrErrorCode DeleteAuthData( const QString& AuthAppId,
       
   165 			const QString& RegToken, const QDateTime& Validity );
   148 
   166 
   149 private:
   167 private:
   150 	/**
   168 	/**
   151 	 * Handle to private implementation class.
   169 	 * Handle to private implementation class.
   152 	 */
   170 	 */
   153 #ifdef Q_OS_SYMBIAN
   171 #ifdef Q_OS_SYMBIAN
   154 	CSmfCredMgrClientSymbian* m_SmfClientPrivate;
   172 	CSmfCredMgrClientSymbian* m_SmfClientPrivate;
   155 	//friend class CSmfCredMgrClientSymbian;
       
   156 #endif
   173 #endif
   157 
   174 
   158 	};
   175 	};
   159 
   176 
   160 #endif /* SMFCREDMGRCLIENT_H_ */
   177 #endif /* SMFCREDMGRCLIENT_H_ */