crypto/weakcryptospi/inc/spi/cryptohashapi.h
changeset 33 cf642210ecb7
parent 8 35751d3474b7
equal deleted inserted replaced
29:ece3df019add 33:cf642210ecb7
    87 	
    87 	
    88 	    To make a copy of a message digest with its internal state intact,
    88 	    To make a copy of a message digest with its internal state intact,
    89 		see CopyL().
    89 		see CopyL().
    90 	
    90 	
    91 		@return A pointer to the new reset CHash object.
    91 		@return A pointer to the new reset CHash object.
       
    92 		@leave ...	Any of the crypto error codes defined in 
       
    93   					cryptospi_errs.h or any of the system-wide error codes.
    92 		*/
    94 		*/
    93 		IMPORT_C CHash* ReplicateL();		
    95 		IMPORT_C CHash* ReplicateL();		
    94 
    96 
    95 		/** 
    97 		/** 
    96 		Creates a new CHash object with the exact same state as
    98 		Creates a new CHash object with the exact same state as
   100 		This function copies all internal state of the message digest.
   102 		This function copies all internal state of the message digest.
   101 		To create a new CHash object without the state of
   103 		To create a new CHash object without the state of
   102 		the current object, see ReplicateL().
   104 		the current object, see ReplicateL().
   103 
   105 
   104 		@return A pointer to the new CHash object.
   106 		@return A pointer to the new CHash object.
       
   107 		@leave ...	Any of the crypto error codes defined in 
       
   108   					cryptospi_errs.h or any of the system-wide error codes.
   105 		*/
   109 		*/
   106 		IMPORT_C CHash* CopyL();
   110 		IMPORT_C CHash* CopyL();
   107 				
   111 				
   108 		/**
   112 		/**
   109 		 * @deprecated
   113 		 * @deprecated
   110 		 * 
   114 		 * 
   111 		 * Set the key used for HMAC mode operation.
   115 		 * Set the key used for HMAC mode operation.
   112 		 * @param aKey	The key for HMAC
   116 		 * @param aKey	The key for HMAC
       
   117 		 * @leave KErrArgument if aKey is not of the expected type.
       
   118 		 * @leave ...	Any of the crypto error codes defined in 
       
   119   				    	cryptospi_errs.h or any of the system-wide error codes.
   113 		 */
   120 		 */
   114 		IMPORT_C void SetKeyL(const CKey& aKey);
   121 		IMPORT_C void SetKeyL(const CKey& aKey);
   115 			
   122 			
   116 		/**
   123 		/**
   117 		 * @deprecated
   124 		 * @deprecated
   118 		 * 
   125 		 * 
   119 		 * Set the operation mode, ie hash or hmac
   126 		 * Set the operation mode, ie hash or hmac
   120 		 * @param aOperationMode	The UID to identifiy the operation mode
   127 		 * @param aOperationMode	The UID to identifiy the operation mode
       
   128 		 * @leave KErrNotSupported if the specified operation mode is not supported.
       
   129 		 * @leave ...	Any of the crypto error codes defined in 
       
   130   						cryptospi_errs.h or any of the system-wide error codes.
   121 		 */		
   131 		 */		
   122 		IMPORT_C void SetOperationModeL(TUid aOperationMode);
   132 		IMPORT_C void SetOperationModeL(TUid aOperationMode);
   123 		
   133 		
   124 	private:
   134 	private:
   125 		/**
   135 		/**
   188 
   198 
   189 		To make a copy of a message digest with its internal state intact,
   199 		To make a copy of a message digest with its internal state intact,
   190 		see CopyL().
   200 		see CopyL().
   191 
   201 
   192 		@return A pointer to the new reset CAsyncHash object.
   202 		@return A pointer to the new reset CAsyncHash object.
       
   203 		@leave ...	Any of the crypto error codes defined in 
       
   204   					cryptospi_errs.h or any of the system-wide error codes.
   193 		*/
   205 		*/
   194 		IMPORT_C CAsyncHash* ReplicateL();		
   206 		IMPORT_C CAsyncHash* ReplicateL();		
   195 
   207 
   196 		/** 
   208 		/** 
   197 		Creates a new CAsyncHash object with the exact same state as
   209 		Creates a new CAsyncHash object with the exact same state as
   201 		This function copies all internal state of the message digest.
   213 		This function copies all internal state of the message digest.
   202 		To create a new CAsyncHash object without the state of
   214 		To create a new CAsyncHash object without the state of
   203 		the current object, see ReplicateL().
   215 		the current object, see ReplicateL().
   204 
   216 
   205 		@return A pointer to the new CAsyncHash object.
   217 		@return A pointer to the new CAsyncHash object.
       
   218 		@leave ...	Any of the crypto error codes defined in 
       
   219   					cryptospi_errs.h or any of the system-wide error codes.
   206 		*/
   220 		*/
   207 		IMPORT_C CAsyncHash* CopyL();
   221 		IMPORT_C CAsyncHash* CopyL();
   208 		
   222 		
   209 		/**
   223 		/**
   210 		 * @deprecated
   224 		 * @deprecated
   211 		 * 
   225 		 * 
   212 		 * Set the key used for HMAC mode operation.
   226 		 * Set the key used for HMAC mode operation.
   213 		 * @param aKey the key for HMAC
   227 		 * @param aKey the key for HMAC
       
   228 		 * @leave KErrArgument if aKey is not of the expected type.
       
   229 		 * @leave ...	Any of the crypto error codes defined in 
       
   230   						cryptospi_errs.h or any of the system-wide error codes.
   214 		 */
   231 		 */
   215 		IMPORT_C void SetKeyL(const CKey& aKey);
   232 		IMPORT_C void SetKeyL(const CKey& aKey);
   216 			
   233 			
   217 		/**
   234 		/**
   218 		 * @deprecated
   235 		 * @deprecated
   219 		 * 
   236 		 * 
   220 		 * Set the operation mode, ie hash or hmac
   237 		 * Set the operation mode, ie hash or hmac
   221 		 * @param aOperationMode The UID to identifiy the operation mode
   238 		 * @param aOperationMode The UID to identifiy the operation mode
       
   239 		 * @leave KErrNotSupported if the specified mode is not supported.
       
   240 		 * @leave ...	Any of the crypto error codes defined in 
       
   241   						cryptospi_errs.h or any of the system-wide error codes.
   222 		 */		
   242 		 */		
   223 		IMPORT_C void SetOperationModeL(TUid aOperationMode);
   243 		IMPORT_C void SetOperationModeL(TUid aOperationMode);
   224 		
   244 		
   225 	private:
   245 	private:
   226 		
   246