crypto/weakcryptospi/inc/spi/hashplugin.h
changeset 33 cf642210ecb7
parent 8 35751d3474b7
equal deleted inserted replaced
29:ece3df019add 33:cf642210ecb7
    68 		information from the current object.  
    68 		information from the current object.  
    69 
    69 
    70 		To make a copy of a message digest with its internal state intact,
    70 		To make a copy of a message digest with its internal state intact,
    71 		see CopyL().
    71 		see CopyL().
    72 		@return A pointer to the new reset MHash object
    72 		@return A pointer to the new reset MHash object
       
    73 		@leave ...	Any of the crypto error codes defined in 
       
    74   					cryptospi_errs.h or any of the system-wide error codes.
    73 		*/
    75 		*/
    74 		virtual MHash* ReplicateL() = 0;		
    76 		virtual MHash* ReplicateL() = 0;		
    75 
    77 
    76 		/** 
    78 		/** 
    77 		Creates a new MHash object with the exact same state as
    79 		Creates a new MHash object with the exact same state as
    78 		the current object.  
    80 		the current object.  
    79 
    81 
    80 		This function copies all internal state of the message digest.
    82 		This function copies all internal state of the message digest.  
    81 		To create a new MHash object without the state of
    83 		To create a new MHash object without the state of
    82 		the current object, see ReplicateL().
    84 		the current object, see ReplicateL().
    83 		@return A pointer to the new MHash object
    85 		@return A pointer to the new MHash object
       
    86 		@leave ...	Any of the crypto error codes defined in 
       
    87   					cryptospi_errs.h or any of the system-wide error codes.
    84 		*/
    88 		*/
    85 		virtual MHash* CopyL() = 0;
    89 		virtual MHash* CopyL() = 0;
    86 		
    90 		
    87 		/**
    91 		/**
    88 		 * @deprecated
    92 		 * @deprecated
    89 		 * 
    93 		 * 
    90 		 * Set the key used for HMAC mode operation.
    94 		 * Set the key used for HMAC mode operation.
    91 		 * @param aKey	The key for HMAC
    95 		 * @param aKey	The key for HMAC
       
    96 		 * @leave KErrArgument if aKey is not of the expected type.
       
    97 		 * @leave KErrNotSupported if the key is not of valid length.
       
    98 		 * @leave ...	Any of the crypto error codes defined in 
       
    99   						cryptospi_errs.h or any of the system-wide error codes.
    92 		 */
   100 		 */
    93 		virtual void SetKeyL(const CKey& aKey) = 0;
   101 		virtual void SetKeyL(const CKey& aKey) = 0;
    94 			
   102 			
    95 		/**
   103 		/**
    96 		 * @deprecated
   104 		 * @deprecated
    97 		 * 
   105 		 * 
    98 		 * Set the operation mode, ie hash or hmac
   106 		 * Set the operation mode, ie hash or hmac
    99 		 * @param aOperationMode	The UID to identifiy the operation mode
   107 		 * @param aOperationMode	The UID to identifiy the operation mode
       
   108 
       
   109 		@leave KErrNotSupported if the operation mode is not supported.
       
   110 		@leave ...	Any of the crypto error codes defined in 
       
   111   					cryptospi_errs.h or any of the system-wide error codes.
   100 		 */		
   112 		 */		
   101 		virtual void SetOperationModeL(TUid aOperationMode) = 0;
   113 		virtual void SetOperationModeL(TUid aOperationMode) = 0;
   102 	    };
   114 	    };
   103 
   115 
   104 
   116 
   143 
   155 
   144 		To make a copy of a message digest with its internal state intact,
   156 		To make a copy of a message digest with its internal state intact,
   145 		see CopyL().
   157 		see CopyL().
   146 
   158 
   147 		@return A pointer to the new reset MAsyncHash object
   159 		@return A pointer to the new reset MAsyncHash object
       
   160 
       
   161 		@leave ...	Any of the crypto error codes defined in 
       
   162   					cryptospi_errs.h or any of the system-wide error codes.
   148 		*/
   163 		*/
   149 		virtual MAsyncHash* ReplicateL() = 0;		
   164 		virtual MAsyncHash* ReplicateL() = 0;		
   150 
   165 
   151 		/** 
   166 		/** 
   152 		Creates a new MAsyncHash object with the exact same state as
   167 		Creates a new MAsyncHash object with the exact same state as
   155 		This function copies all internal state of the message digest.
   170 		This function copies all internal state of the message digest.
   156 		To create a new MAsyncHash object without the state of
   171 		To create a new MAsyncHash object without the state of
   157 		the current object, see ReplicateL().
   172 		the current object, see ReplicateL().
   158 
   173 
   159 		@return A pointer to the new MAsyncHash object
   174 		@return A pointer to the new MAsyncHash object
       
   175 
       
   176 		@leave ...	Any of the crypto error codes defined in 
       
   177   					cryptospi_errs.h or any of the system-wide error codes.
   160 		*/
   178 		*/
   161 		virtual MAsyncHash* CopyL() = 0;
   179 		virtual MAsyncHash* CopyL() = 0;
   162 		
   180 		
   163 		/**
   181 		/**
   164 		 * @deprecated
   182 		 * @deprecated
   165 		 * 
   183 		 * 
   166 		 * Set the key used for HMAC mode operation.
   184 		 * Set the key used for HMAC mode operation.
   167 		 * @param aKey	The key for HMAC
   185 		 * @param aKey	The key for HMAC
       
   186 		 * @leave KErrArgument if aKey is not of the expected type.
       
   187 		 * @leave KErrNotSupported if the key is not of valid length.
       
   188 		 * @leave ...	Any of the crypto error codes defined in 
       
   189   						cryptospi_errs.h or any of the system-wide error codes.
   168 		 */
   190 		 */
   169 		virtual void SetKeyL(const CKey& aKey) = 0;
   191 		virtual void SetKeyL(const CKey& aKey) = 0;
   170 			
   192 			
   171 		/**
   193 		/**
   172 		 * @deprecated
   194 		 * @deprecated
   173 		 * 
   195 		 * 
   174 		 * Set the operation mode, ie hash or hmac
   196 		 * Set the operation mode, ie hash or hmac
   175 		 * @param aOperationMode	The UID to identifiy the operation mode
   197 		 * @param aOperationMode	The UID to identifiy the operation mode
       
   198 	 	 * @leave KErrArgument if aKey is not of the expected type.
       
   199 		 * @leave KErrNotSupported if the key is not of valid length.
       
   200 		 * @leave ...	Any of the crypto error codes defined in 
       
   201   						cryptospi_errs.h or any of the system-wide error codes.
   176 		 */		
   202 		 */		
   177 		virtual void SetOperationModeL(TUid aOperationMode) = 0;
   203 		virtual void SetOperationModeL(TUid aOperationMode) = 0;
   178 	    };	
   204 	    };	
   179 	}
   205 	}
   180 
   206