Class AuthenticationMechanismBasic

Description
Description | Methods (details)

Implements interfaces:

Basic HTTP Authentication mechanism

Uses the HTTP basic mechanism to get a users username and password which is then verified using a AuthenticationMechanismBasicBackend.

The authentication realm can be specified using the "auth.basic.realm" config option and defaults to "phpSATk login".

Located in /phpsatk-lib/global/org.eenterphace.sat.auth.http/authentication.mechanism.basic.php (line 39) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											AuthenticationMechanismBasic
										__construct
										()
									

								
				

											void
										forceLogOut
										()
									

								
				

											string
										getUsername
										()
									

								
				

											void
										sendPrompt
										()
									

								
				

											bool
										verifyCredentials
										()
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		Constructor __construct (line 42)
	
 
	
	
	
    
				
  • access: public
    • 
			

	
	

		AuthenticationMechanismBasic
		
			__construct
		
				()
			

	
		
		
	




	
	

		forceLogOut (line 106)
	
 
	
	

Tries to logout a user


This might be not possible for some mechanisms.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			forceLogOut
		
				()
			

	
		
		
	




	
	

		getUsername (line 97)
	
 
	
	

Gets the username of the logged in user

	
    
				
  • access: public
    • 
			

	
	

		string
		
			getUsername
		
				()
			

	
		
		
	




	
	

		sendPrompt (line 52)
	
 
	
	

Send a authentication request to the user

	
    
				
  • access: public
    • 
			

	
	

		void
		
			sendPrompt
		
				()
			

	
		
		
	




	
	

		verifyCredentials (line 67)
	
 
	
	

Verify the given crendentials


Uses a AuthenticationMechanismBasicBackend to check the provided password.  Return false if no credentials are provided.

	
    
				
  • access: public
    • 
			

	
	

		bool
		
			verifyCredentials
		
				()
			

	
		
		
	

						
		

	



	

		Documentation generated on Mon, 21 May 2007 10:34:42 +0200 by phpDocumentor 1.3.0RC5