[ class tree: core ] [ index: core ] [ all elements ]

Class: OAuthSignatureMethod

Source Location: /zp-extensions/common/oAuth/OAuth.php

Class OAuthSignatureMethod

Class Overview
Class Overview | Descendants | Method Summary | Methods Detail

A class for implementing a Signature Method

See section 9 ("Signing Requests") in the spec

Located in /zp-extensions/common/oAuth/OAuth.php [line 59] 



		
				Author(s):
		
    
		  			 		  		

		
		API Tags:



  

    Abstract:  
  






				

		
				
		
Methods

		
				
		
		

		
[ Top ]

	




	
	

		
Descendants

		

			Class Overview
							| Descendants
																	| Method Summary | Methods Detail
									

		

			

				

					Child Class
					Description
				

								

					OAuthSignatureMethod_HMAC_SHA1
					
											The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104]  where the Signature Base String is the text and the key is the concatenated values (each first  encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&'  character (ASCII code 38) even if empty.
										
				

								

					OAuthSignatureMethod_PLAINTEXT
					
											The PLAINTEXT method does not provide any security protection and SHOULD only be used  over a secure channel such as HTTPS. It does not use the Signature Base String.
										
				

								

					OAuthSignatureMethod_RSA_SHA1
					
											The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in
										
				

							

			
[ Top ]

		

	





	
	

		
Method Summary

		

			Class Overview
							| Descendants
									    					| Method Summary | Methods Detail
		

		

			

				

											

											

											

																																								
string  
										build_signature()  
					Build up the signature  NOTE: The output of this function MUST NOT be urlencoded.

				
																
bool  
										check_signature()  
					Verifies that a given signature is correct

				
																
string  
										get_name()  
					Needs to return the name of the Signature Method (ie HMAC-SHA1)

				
												

			

			
[ Top ]

		

	



	
	

		
Methods

		

			Class Overview
							| Descendants
																			| Method Summary | Methods Detail
					

		

			







	build_signature  [line 76]





	

    

    
 
		string build_signature(
OAuthRequest
$request, OAuthConsumer
$consumer, OAuthToken
$token 
)
    

    



	
Build up the signature  NOTE: The output of this function MUST NOT be urlencoded.



the encoding is handled in OAuthRequest when the final  request is serialized

			Parameters:

			

					

				OAuthRequest  
				
				$request: 
				
							

					

				OAuthConsumer  
				
				$consumer: 
				
							

					

				OAuthToken  
				
				$token: 
				
							

				


	

	API Tags:



  

    Abstract:  
  

  

    Access:  public
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	check_signature  [line 86]





	

    

    
 
		bool check_signature(
OAuthRequest
$request, OAuthConsumer
$consumer, OAuthToken
$token, string
$signature 
)
    

    



	
Verifies that a given signature is correct



			Parameters:

			

					

				OAuthRequest  
				
				$request: 
				
							

					

				OAuthConsumer  
				
				$consumer: 
				
							

					

				OAuthToken  
				
				$token: 
				
							

					

				string  
				
				$signature: 
				
							

				


	

	API Tags:



  

    Access:  public
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]









	get_name  [line 64]





	

    

    
 
		string get_name(
)
    

    



	
Needs to return the name of the Signature Method (ie HMAC-SHA1)



	

	API Tags:



  

    Abstract:  
  

  

    Access:  public
  







		
			

		
Redefined in descendants as:

		
		

	
[ Top ]



		

	



    
core

      Packages:

  

              core

              admin

              classes

              functions

              plugins

      	

      

                        Files:
        

  

				404.php

			admin-dynamic-album.php

			admin-thumbcrop.php

			c.php

			canon.php

			closed.php

			combiNews.php

			comment-full.js.php

			comment-ribbon.js.php

			comment-slim.js.php

			comment_form.php

			connector_zp.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			deprecated-functions.php

			dialog.php

			Discover.php

			elfinder.php

			elFinderConnector.class.php

			elFinderVolumeDriver.class.php

			elFinderVolumeLocalFileSystem.class.php

			exampleMacros.php

			exif.php

			external_auth.php

			favoritesClass.php

			fieldExtender.php

			fujifilm.php

			full-image.php

			functions-common.php

			functions-config.php

			functions-controller.php

			functions-db-MySQL.php

			functions-db-MySQLi.php

			functions-db-PDO_MySQL.php

			functions-db_NULL.php

			functions-db_PDO.php

			functions-i18n.php

			functions-image.php

			functions.php

			functions.php

			functions.php

			functions.php

			functions.php

			getid3.lib.php

			getid3.php

			global-definitions.php

			gps.php

			i.php

			index.php

			jcarousel_ajax.php

			lib-encryption.php

			lib-GD.php

			lib-Imagick.php

			lib-kses.php

			lib-MimeTypes.php

			lib-NoGraphics.php

			lib-pclzip.php

			lib-utf8.php

			lib-zipStream.php

			Map.php

			menu_manager-admin-functions.php

			menu_tab.php

			menu_tab_edit.php

			Mobile_Detect.php

			module.audio-video.flv.php

			module.audio-video.mpeg.php

			module.audio-video.quicktime.php

			module.audio-video.swf.php

			module.audio.aac.php

			module.audio.mp3.php

			module.tag.apetag.php

			module.tag.id3v1.php

			module.tag.id3v2.php

			module.tag.lyrics3.php

			nikon.php

			OAuth.php

			olympus.php

			OpenID_common.php

			OpenID_detect.php

			OpenID_finish_auth.php

			OpenID_try_auth.php

			panasonic.php

			PAPE.php

			publishContent.php

			recaptchalib.php

			reconfigure.php

			refresh_database.php

			refresh_metadata.php

			rewriteRules.php

			sanyo.php

			setup-sqlform.php

			setup.php

			site_upgrade.php

			template-filters.php

			tinyURL.php

			tinyzenpage-functions.php

			tinyzenpage.php

			twitteroauth.php

			uploader.php

			uploader.php

			upload_form.php

			upload_form.php

			userAddressFields.php

			XRIRes.php

			zenpage-basic.js.php

			zenpage-classic.js.php

			zenpage-full.js.php

			zenpage-light.js.php

			zenpage-ribbon.js.php

			zenpage-slim.js.php

			zenphoto-basic.js.php

			zenphoto-classic.js.php

			zenphoto-full.js.php

			zenphoto-light.js.php

			zenphoto-ribbon.js.php

			zenphoto-slim.js.php

			zoom.php

	  

            

                  Classes:

        

		    		AMFReader    	 

	    		AMFStream    	 

	    		Auth_OpenID_PAPE_Request    	 

	    		Auth_OpenID_PAPE_Response    	 

	    		Auth_OpenID_ServiceEndpoint    	 

	    		Auth_Yadis_ProxyResolver    	 

	    		AVCSequenceParameterSetReader    	 

	    		elFinderConnector    	 

	    		elFinderVolumeDriver    	 

	    		elFinderVolumeLocalFileSystem    	 

	    		exampleMacros    	 

	    		external_auth    	 

	    		fieldExtender    	 

	    		getID3    	 

	    		getid3_aac    	 

	    		getid3_apetag    	 

	    		getid3_exception    	 

	    		getid3_flv    	 

	    		getid3_handler    	 

	    		getid3_id3v1    	 

	    		getid3_id3v2    	 

	    		getid3_lib    	 

	    		getid3_lyrics3    	 

	    		getid3_mp3    	 

	    		getid3_mpeg    	 

	    		getid3_quicktime    	 

	    		getid3_swf    	 

	    		HTML    	 

	    		internal_deprecations    	 

	    		lib_GD_Options    	 

	    		lib_Imagick_Options    	 

	    		lib_NoGraphics    	 

	    		Mobile_Detect    	 

	    		OAuthConsumer    	 

	    		OAuthDataStore    	 

	    		OAuthException    	 

	    		OAuthRequest    	 

	    		OAuthServer    	 

	    		OAuthSignatureMethod    	 

	    		OAuthSignatureMethod_HMAC_SHA1    	 

	    		OAuthSignatureMethod_PLAINTEXT    	 

	    		OAuthSignatureMethod_RSA_SHA1    	 

	    		OAuthToken    	 

	    		OAuthUtil    	 

	    		PclZip    	 

	    		PlainText    	 

	    		ReCaptchaResponse    	 

	    		rewriteRules    	 

	    		RSS_internal_deprecations    	 

	    		TextObject_internal_deprecations    	 

	    		tinyURL    	 

	    		TwitterOAuth    	 

	    		UploadHandler    	 

	    		userAddressFields    	 

	    		utf8    	 

	    		Video_internal_deprecations    	 

	    		Zenpage_internal_deprecations    	 

	    		ZipStream    	 

	    		zpFunctions    	 

	    		_zp_captcha    	 

	    		_zp_HTML_cache    	 

	  

                		        
        
        
       
      

     
    
    		
  




  

		    

		    Documentation generated on Sat, 07 Jun 2014 18:03:40 +0200 by phpDocumentor 1.4.3