Interface Crypt_KeyStore_Key

Description
Description | Descendents | Methods (details)

Interface for keys (symmetric or asymmetric) stored by the key store.

Located in /Crypt/KeyStore/Key.php (line 28) 


	
			




	
	

		
Direct descendents

		

			Description |
			Descendents
			|															Methods (details)
							
								

		

			

				

					Class
					Description
				

								

					Crypt_KeyStore_PrivateKey
					
											Marker interface for implementations of a private key.
										
				

								

					Crypt_KeyStore_PublicKey
					
											Marker interface for implementations of a public key.
										
				

								

					Crypt_KeyStore_SecretKey
					
											Marker interface for implementations of a secret key.
										
				

							

		

	




	
	

		
Method Summary

		

			Description |
							Descendents |
												Methods (details)
		

		
			
			

																												
												

											string
										getAlgorithm
										()
									

																

											string
										getEncoded
										()
									

																

											string
										getFormat
										()
									

								

		

	
		

	
	
	

		
Methods

		

			Description |
							Descendents |
																Methods (details)
						
		

		

			




	
	

		getAlgorithm (line 36)
	
 
	
	

Returns the standard algorithm name for this key. For example, "DSA"  would indicate that this key is a DSA key.

	
    
				
  • return: the name of the algorithm associated with this key
    • 
				
  • access: public
    • 
			

	
	

		string
		
			getAlgorithm
		
				()
			

	
		
			
	




	
	

		getEncoded (line 44)
	
 
	
	

Returns the key in its primary encoding format, or null if this key does  not support encoding.

	
    
				
  • return: the encoded key, or null if the key does not support encoding.
    • 
				
  • access: public
    • 
			

	
	

		string
		
			getEncoded
		
				()
			

	
		
			
	




	
	

		getFormat (line 58)
	
 
	
	

Returns the name of the primary encoding format of this key, or null if


this key does not support encoding. The primary encoding format is named  in terms of the appropriate ASN.1 data format, if an ASN.1 specification  for this key exists. For example, the name of the ASN.1 data format for  public keys is SubjectPublicKeyInfo, as defined by the X.509 standard;  in this case, the returned format is "X.509". Similarly, the name of the  ASN.1 data format for private keys is PrivateKeyInfo, as defined by the  PKCS #8 standard; in this case, the returned format is "PKCS#8".

	
    
				
  • return: the primary encoding format of the key
    • 
				
  • access: public
    • 
			

	
	

		string
		
			getFormat
		
				()
			

	
		
			
	

						
		

	



	

		Documentation generated on Tue, 08 Jul 2008 14:52:09 -0500 by phpDocumentor 1.4.2