Class Swift_Authenticator_CRAMMD5

Description
Description | Methods (details)

Swift CRAM-MD5 Authenticator

This form of authentication is a secure challenge-response method

Located in /Swift/Authenticator/CRAMMD5.php (line 20) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

												

					static 						string
										generateCRAMMD5Hash
											(string $password, string $challenge)
									

																								
																				

											string
										getAuthExtensionName
										()
									

																

											boolean
										isAuthenticated
											(string $user, string $pass,  $swift)
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		static method generateCRAMMD5Hash (line 57)
	
 
	
	

Generate a CRAM-MD5 hash from a challenge

	
	

	    static
		string
		
			generateCRAMMD5Hash
		
					(string $password, string $challenge)
			

	
			
    
					
  • 
				string
				$password: The string to get a hash from			
    • 
					
  • 
				string
				$challenge: The challenge to use to make the hash			
    • 
				

		
			
	





	
	

		getAuthExtensionName (line 47)
	
 
	
	

Return the name of the AUTH extension this is for

	
	

		string
		
			getAuthExtensionName
		
				()
			

	
		
			
	




	
	

		isAuthenticated (line 30)
	
 
	
	

Try to authenticate using the username and password


Returns false on failure

	
	

		boolean
		
			isAuthenticated
		
					(string $user, string $pass,  $swift)
			

	
			
    
					
  • 
				string
				$user: The username			
    • 
					
  • 
				string
				$pass: The password			
    • 
					
  • 
				Swift
				$swift: The instance of Swift this authenticator is used in			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Tue, 06 Mar 2007 23:32:22 +0000 by phpDocumentor 1.3.1