[thirdparty/squid.git] / src / ssl / cert_validate_message.h

/*
 */

#ifndef SQUID_SSL_CERT_VALIDATE_MESSAGE_H
#define SQUID_SSL_CERT_VALIDATE_MESSAGE_H

#include "ssl/support.h"
#include "ssl/crtd_message.h"
#include <vector>

namespace Ssl
{

/**
 * This class is used to hold the required informations to build
 * a request message for the certificate validator helper
 */
class CertValidationRequest
{
public:
    SSL *ssl;
    Errors *errors; ///< The list of errors detected
    std::string domainName; ///< The server name
    CertValidationRequest() : ssl(NULL), errors(NULL) {}
};

/**
 * This class is used to store informations found in certificate validation
 * response messages read from certificate validator helper
 */
class CertValidationResponse
{
public:
    /**
     * This class used to hold error informations returned from
     * cert validator helper.
     */
    class  RecvdError
    {
    public:
        RecvdError(): id(0), error_no(SSL_ERROR_NONE), cert(NULL) {}
        RecvdError(const RecvdError &);
        RecvdError & operator = (const RecvdError &);
        void setCert(X509 *);  ///< Sets cert to the given certificate
        int id; ///<  The id of the error
        ssl_error_t error_no; ///< The OpenSSL error code
        std::string error_reason; ///< A string describing the error
        X509_Pointer cert; ///< The broken certificate
    };

    typedef std::vector<RecvdError> RecvdErrors;

    /// Search in errors list for the error item with id=errorId.
    /// If none found a new RecvdError item added with the given id;
    RecvdError &getError(int errorId);
    RecvdErrors errors; ///< The list of parsed errors
    HelperReply::Result_ resultCode; ///< The helper result code
};

/**
 * This class is responsible for composing or parsing messages destined to
 * or comming from a cert validator helper.
 * The messages format is:
 *   <response/request code> <whitespace> <body length> <whitespace> <key=value> ...\1
 */
class CertValidationMsg: public CrtdMessage
{
private:
    /**
     * This class used to hold the certId/cert pairs found
     * in cert validation messages.
     */
    class CertItem
    {
    public:
        std::string name; ///< The certificate Id to use
        X509_Pointer cert;       ///< A pointer to certificate
        CertItem(): cert(NULL) {}
        CertItem(const CertItem &);
        CertItem & operator = (const CertItem &);
        void setCert(X509 *); ///< Sets cert to the given certificate
    };

public:
    CertValidationMsg(MessageKind kind): CrtdMessage(kind) {}

    /// Build a request message for the cert validation helper
    /// using informations provided by vcert object
    void composeRequest(CertValidationRequest const &vcert);

    /// Parse a response message and fill the resp object with parsed informations
    bool parseResponse(CertValidationResponse &resp, STACK_OF(X509) *peerCerts, std::string &error);

    /// Search a CertItems list for the certificate with ID "name"
    X509 *getCertByName(std::vector<CertItem> const &, std::string const & name);

    /// String code for "cert_validate" messages
    static const std::string code_cert_validate;
    /// Parameter name for passing intended domain name
    static const std::string param_domain;
    /// Parameter name for passing SSL errors
    static const std::string param_error;
    /// Parameter name for passing SSL certificates
    static const std::string param_cert;
    /// Parameter name for passing the major SSL error
    static const std::string param_error_name;
    /// Parameter name for passing the error reason
    static const std::string param_error_reason;
    /// Parameter name for passing the error cert ID
    static const std::string param_error_cert;
};

}//namespace Ssl
#endif // SQUID_SSL_CERT_VALIDATE_MESSAGE_H
Commit	Line	Data
a1f04d64	1	/*
a1f04d64 AR	2	*/
	3
	4	#ifndef SQUID_SSL_CERT_VALIDATE_MESSAGE_H
	5	#define SQUID_SSL_CERT_VALIDATE_MESSAGE_H
	6
	7	#include "ssl/support.h"
	8	#include "ssl/crtd_message.h"
	9	#include <vector>
	10
22636a68	11	namespace Ssl
a1f04d64 AR	12	{
a1f04d64 AR	13
b56756cb CT	14	/**
	15	* This class is used to hold the required informations to build
	16	* a request message for the certificate validator helper
	17	*/
22636a68 CT	18	class CertValidationRequest
22636a68 CT	19	{
a1f04d64	20	public:
14798e73	21	SSL *ssl;
b56756cb CT	22	Errors *errors; ///< The list of errors detected
b56756cb CT	23	std::string domainName; ///< The server name
14798e73	24	CertValidationRequest() : ssl(NULL), errors(NULL) {}
a1f04d64 AR	25	};
a1f04d64 AR	26
b56756cb CT	27	/**
	28	* This class is used to store informations found in certificate validation
	29	* response messages read from certificate validator helper
	30	*/
22636a68 CT	31	class CertValidationResponse
22636a68 CT	32	{
a1f04d64	33	public:
b56756cb CT	34	/**
	35	* This class used to hold error informations returned from
	36	* cert validator helper.
	37	*/
22636a68 CT	38	class RecvdError
22636a68 CT	39	{
a1f04d64	40	public:
b56756cb CT	41	RecvdError(): id(0), error_no(SSL_ERROR_NONE), cert(NULL) {}
b56756cb CT	42	RecvdError(const RecvdError &);
b56756cb CT	43	RecvdError & operator = (const RecvdError &);
b56756cb CT	44	void setCert(X509 *); ///< Sets cert to the given certificate
3a7d782f	45	int id; ///< The id of the error
b56756cb	46	ssl_error_t error_no; ///< The OpenSSL error code
3a7d782f	47	std::string error_reason; ///< A string describing the error
4a77bb4e	48	X509_Pointer cert; ///< The broken certificate
a1f04d64 AR	49	};
a1f04d64 AR	50
b56756cb	51	typedef std::vector<RecvdError> RecvdErrors;
3a7d782f	52
b56756cb CT	53	/// Search in errors list for the error item with id=errorId.
	54	/// If none found a new RecvdError item added with the given id;
	55	RecvdError &getError(int errorId);
	56	RecvdErrors errors; ///< The list of parsed errors
14798e73	57	HelperReply::Result_ resultCode; ///< The helper result code
3a7d782f CT	58	};
3a7d782f CT	59
b56756cb CT	60	/**
	61	* This class is responsible for composing or parsing messages destined to
	62	* or comming from a cert validator helper.
	63	* The messages format is:
	64	* <response/request code> <whitespace> <body length> <whitespace> <key=value> ...\1
	65	*/
22636a68 CT	66	class CertValidationMsg: public CrtdMessage
22636a68 CT	67	{
3a7d782f	68	private:
b56756cb CT	69	/**
	70	* This class used to hold the certId/cert pairs found
	71	* in cert validation messages.
	72	*/
22636a68 CT	73	class CertItem
22636a68 CT	74	{
a1f04d64	75	public:
b56756cb	76	std::string name; ///< The certificate Id to use
4a77bb4e	77	X509_Pointer cert; ///< A pointer to certificate
a1f04d64 AR	78	CertItem(): cert(NULL) {}
	79	CertItem(const CertItem &);
	80	CertItem & operator = (const CertItem &);
b56756cb	81	void setCert(X509 *); ///< Sets cert to the given certificate
a1f04d64	82	};
b56756cb	83
a1f04d64	84	public:
53251bc3	85	CertValidationMsg(MessageKind kind): CrtdMessage(kind) {}
b56756cb CT	86
	87	/// Build a request message for the cert validation helper
	88	/// using informations provided by vcert object
	89	void composeRequest(CertValidationRequest const &vcert);
	90
	91	/// Parse a response message and fill the resp object with parsed informations
	92	bool parseResponse(CertValidationResponse &resp, STACK_OF(X509) *peerCerts, std::string &error);
	93
	94	/// Search a CertItems list for the certificate with ID "name"
	95	X509 *getCertByName(std::vector<CertItem> const &, std::string const & name);
a1f04d64 AR	96
	97	/// String code for "cert_validate" messages
	98	static const std::string code_cert_validate;
	99	/// Parameter name for passing intended domain name
	100	static const std::string param_domain;
	101	/// Parameter name for passing SSL errors
	102	static const std::string param_error;
	103	/// Parameter name for passing SSL certificates
22636a68	104	static const std::string param_cert;
a1f04d64	105	/// Parameter name for passing the major SSL error
22636a68	106	static const std::string param_error_name;
a1f04d64	107	/// Parameter name for passing the error reason
22636a68	108	static const std::string param_error_reason;
a1f04d64 AR	109	/// Parameter name for passing the error cert ID
	110	static const std::string param_error_cert;
	111	};
	112
	113	}//namespace Ssl
	114	#endif // SQUID_SSL_CERT_VALIDATE_MESSAGE_H