API_REF/Public_API: comparison epoc32/include/x509keys.h

equal deleted inserted replaced

-:e1b950c65cb4
+:837f303aceeb
 * X.509 key classes and utility classes for key encoding/decoding.
 *
 */
 /**
 @file
-@internalTechnology
+@publishedAll
+@released
 */
 #if !defined (__X509KEYS_H__)
 #define __X509KEYS_H__
 class CASN1EncBase;
 class CASN1EncContainer;
 class CASN1EncSequence;
 class CASN1EncBitString;
+#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
+#include <x509keyencoder.h>
+#endif
 class CX509RSAPublicKey : public CRSAPublicKey
 /** Adds the capability to decode DER-encoded RSA public keys.
 *
 * Adds a commitment to a specific encoding scheme allowing X.509 RSA public key
 * superclasses to remain encoding-independent.
 *
-* @publishedAll
-* @released
 *
 * @since v6.0
 */
 	{
 public:
 class TASN1EncRSAPublicKey
 /**
 * Class for encoding RSA public keys to ASN.1 encoding.
 *
-* @publishedAll
-* @released
 * @since v8.0
 */
 	{
 public:
 	/**
 class TASN1DecRSAPublicKey
 /**
 * Class for decoding RSA public keys from ASN.1 DER encoding.
 *
-* @publishedAll
-* @released
 * @since v8.0
 */
 	{
 public:
 	/**
 class TASN1DecRSAKeyPair
 /**
 * Class for decoding RSA key pairs from ASN.1 DER encoding.
 *
-* @publishedAll
-* @released
 * @since v8.0
 */
 	{
 public:
 	/**
 /** Encapsulates the X.509 DSA public key.
 *
 * Adds a commitment to a specific encoding scheme allowing superclasses to remain
 * encoding-independent.
 *
-* @publishedAll
-* @released
 * @since v6.0
 */
 // DSA public key, params, signature.
 	{
 public:
 class TASN1DecDSAKeyPair
 /**
 * Class for decoding DSA key pairs from ASN.1 DER encoding.
 *
-* @publishedAll
-* @released
 * @since v8.0
 */
 	{
 public:
 	/**
 	};
 /**
 * Class for encoding DSA public keys to ASN.1 encoding.
 *
-* @publishedAll
-* @released
 * @since v8.0
 */
 class TASN1EncDSAPublicKey
 	{
 public:
 /** Encapsulates the X.509 DSA signature.
 *
 * Adds a commitment to a specific encoding scheme allowing superclasses to remain
 * encoding-independent.
 *
-* @publishedAll
-* @released
 * @since v6.0 */
 	{
 public:
 	/** Creates a new DSA Signature object from the specified buffer containing the
 	* encoded binary representation.
 class CX509DHPublicKey : public CDHPublicKey
 /** Provides clients with the information they need for Diffie-Hellman key exchange
 * within a protocol.
 *
-* @publishedAll
-* @released
 * @since v6.0 */
 	{
 public:
 	/** Creates a new CX509DHPublicKey object from the specified buffer containing the encoded
 	* binary representation.
 	};
 class CX509DHKeyPair : public CDHKeyPair
 /** This class represents the Diffie-Hellman Key Pair.
 *
-* @publishedAll
-* @released
 * @since v8.0 */
 {
 public:
 	/** Creates a new DH key pair object from the specified buffer containing
 	* the encoded binary representation .
 *
 * Provides access to the DH Validation Parameters, which are used to determine
 * if the DH Public Key has been generated in conformance with the algorithm
 * specified in ESDH (see RFC 2631).
 *
-* @publishedAll
-* @released
 * @since v6.0 */
 	{
 public:
 	/** Creates a new DH Validation parameters object from the specified buffer containing
 	* the encoded binary representation.
 class CX509DHDomainParams : public CBase
 /** Encapsulates the compulsory Diffie-Hellman domain parameter values P and G
 * (See RFC 2459).
 *
-* @publishedAll
-* @released
 * @since v6.0 */
 	{
 public:
 	/** Creates a new DH Domain parameters object from the specified buffer containing
 	* the encoded binary representation.
 	RInteger iQ;
 	RInteger iJ;
 	CX509DHValidationParams* iValidationParams;
 	};
-class TX509KeyEncoder
-/**
-* Abstract class that is the base class for RSA and DSA key encoder classes.
-* These classes are used to encode the X509 ASN.1 types AlgorithmIdentifier and
-* SubjectPublicKeyInfo.
-*
-* This class is part of the pkcs10 API, and will be changed or removed in a
-* future release.  You should not use it.
-*
-* @internalTechnology
-*/
-	{
-public:
-	/**
-	 * Constructor that takes an algorithm identifier and saves it into the
-	 * corresponding member variable. It is then used in the
-	 * EncodeSignatureAlgorithm() function.
-	 *
-	 * @param aDigestAlg	Digest algorithm to use. Currently the following
-	 * 						algorithms are supported: MD2, MD5, and SHA-1.
-	 */
-	IMPORT_C TX509KeyEncoder(TAlgorithmId aDigestAlg);
-	/**
-	 * Produces the SubjectPublicKeyInfo encoding.
-	 *
-	 * The encoding has the following ASN.1 format:
-	 * @code
-	 * SubjectPublicKeyInfo {ALGORITHM : IOSet} ::= SEQUENCE {
-	 *     algorithm        AlgorithmIdentifier {{IOSet}},
-	 *     subjectPublicKey BIT STRING
-	 *     }
-	 * @endcode
-	 */
-	IMPORT_C virtual CASN1EncBase* EncodeKeyLC() const = 0;
-	/**
-	 * Produces the AlgorithmIdentifier encoding.
-	 *
-	 * @return	ASN.1 sequence containing signature algorithm
-	 */
-	IMPORT_C virtual CASN1EncSequence* EncodeSignatureAlgorithmLC() const = 0;
-	/**
-	 * Produces the DigestAlgorithmIdentifier encoder.
-	 *
-	 * The encoding has the following ASN.1 format
-	 * @code
-*   DigestAlgorithmIdentifier ::= SEQUENCE {
-*     algorithm AlgorithmIdentifier,
-*     parameters ANY DEFINED BY algorithm OPTIONAL }
-*
-*   AlgorithmIdentifier ::= OBJECT IDENTIFIER
-	 * @endcode
-	 *
-	 * @return Appropriate ASN.1 sequence of type <code>DigestAlgorithmIdentifier</code>
-	 */
-	IMPORT_C virtual CASN1EncSequence* EncodeDigestAlgorithmLC() const;
-protected:
-	/** Digest algorithm to use. */
-	TAlgorithmId iDigestAlg;
-	};
-class TX509RSAKeyEncoder : public TX509KeyEncoder
-/**
-* Subclasses TC509KeyEncoder to provides key encoding capability for RSA public keys.
-*
-* This class is part of the pkcs10 API, and will be changed or removed in a
-* future release.  You should not use it.
-*
-* @internalTechnology
-*/
-	{
-public:
-	/**
-	 * Constructs a RSA key pair encoder, saving reference to the passed
-	 * key pair in the member variable.
-	 *
-	 * @param aPublicKey	RSA public key to use for encoding.
-	 * @param aDigestAlg	Digest algorithm to use.
-	 */
-	IMPORT_C TX509RSAKeyEncoder(const CRSAPublicKey& aPublicKey, TAlgorithmId aDigestAlg);
-	/**
-	 * Produces the SubjectPublicKeyInfo encoding.
-	 *
-	 * The resulting encoding has the following form:
-	 * @code
-	 *     SEQUENCE-OF
-	 *         SEQUENCE-OF
-	 *             OID of the encryption algorithm (KRSA)
-	 *             NULL
-	 *         BIT STRING encoded public key.
-	 * @endcode
-	 *
-	 * @return	DER-encoded public key information, placed on the cleanup stack.
-	 */
-	IMPORT_C virtual CASN1EncBase* EncodeKeyLC() const;
-	/**
-	 * Produces the AlgorithmIdentifier encoding.
-	 *
-	 * This has the following form:
-	 * @code
-	 *     SEQUENCE-OF
-	 *         OID signature-algorithm
-	 *         NULL
-	 * @endcode
-	 *
-	 * @return	ASN.1 sequence containing signature algorithm encoding,
-	 * 			placed on the cleanup stack.
-	 */
-	IMPORT_C virtual CASN1EncSequence* EncodeSignatureAlgorithmLC() const;
-private:
-	/**
-	 * Saved reference to the RSA public key to be used for encoding.
-	 */
-	const CRSAPublicKey& iPublicKey;
-	};
-class TX509DSAKeyEncoder : public TX509KeyEncoder
-/**
-* Provides key encoding and signing capability using a DSA public key.
-*
-* This class is part of the pkcs10 API, and will be changed or removed in a
-* future release.  You should not use it.
-*
-* @internalTechnology
-*/
-	{
-public:
-	/**
-	 * Constructs a DSA key pair encoder, saving reference to the passed
-	 * public key in the member variable.
-	 *
-	 * @param aKeyPublic	DSA public key to use for encoding.
-	 * @param aDigestAlg	Digest algorithm to use.
-	 */
-	IMPORT_C TX509DSAKeyEncoder(const CDSAPublicKey& aKeyPublic,
-								TAlgorithmId aDigestAlg);
-	/**
-	 * Produces the SubjectPublicKeyInfo encoding.
-	 *
-	 * The ASN.1 encoding of a DSA key has the following form:
-	 * @code
-	 * SEQUENCE-OF
-	 *     SEQUENCE-OF
-	 *         OID dsa (1.2.840.10040.4.1)
-	 *         SEQUENCE-OF
-	 *             INTEGER p
-	 *             INTEGER q
-	 *             INTEGER g
-	 *     BIT STRING
-	 *         INTEGER public value (y)
-	 * @endcode
-	 *
-	 * @return DER-encoded public key information, placed on the cleanup stack.
-	 */
-	IMPORT_C virtual CASN1EncBase* EncodeKeyLC() const;
-	/**
-	 * Produces the AlgorithmIdentifier encoding.
-	 *
-	 * This has the following form:
-	 * @code
-	 * SEQUENCE-OF
-	 *     OID dsa-signature-oid
-	 *     SEQUENCE-OF dsa-params
-	 *         INTEGER p
-	 *         INTEGER q
-	 *         INTEGER g
-	 * @endcode
-	 *
-	 * @return	ASN.1 sequence containing signature algorithm encoding,
-	 *     		placed on the cleanup stack.
-	 */
-	IMPORT_C virtual CASN1EncSequence* EncodeSignatureAlgorithmLC() const;
-private:
-	/**
-	 * Saved reference to the DSA public key to be used for encoding.
-	 */
-	const CDSAPublicKey& iPublicKey;
-	};
 #endif

branch	Symbian3
changeset 4	837f303aceeb
parent 2	2fe1408b6811