trustbridge: ui/sslconnection.h annotate

annotate ui/sslconnection.h @ 1331:8897c90b8166

(issue108) Remove generate_cppcheck and cppcheck target This did not work correctly. It is better just to manually execute cppcheck on the files as it gives you more control over the options.

author	Andre Heinecke <andre.heinecke@intevation.de>
date	Wed, 15 Oct 2014 13:24:59 +0200
parents	2a1aa9df8f11
children

rev	line source
404 17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 46 diff changeset	1 /* Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 46 diff changeset	2 * Software engineering by Intevation GmbH
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 46 diff changeset	3 *
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 46 diff changeset	4 * This file is Free Software under the GNU GPL (v>=2)
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 46 diff changeset	5 * and comes with ABSOLUTELY NO WARRANTY!
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 46 diff changeset	6 * See LICENSE.txt for details.
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 46 diff changeset	7 */
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	8 #ifndef SSLCONNECTION_H
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	9 #define SSLCONNECTION_H
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	10
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	11 /**
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	12 * @file sslconnection.h
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	13 * @brief Controller of the downloader network connection
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	14 */
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	15
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	16 #include <QDebug>
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	17 #include <QUrl>
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	18 #include <QString>
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	19 #include <QByteArray>
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	20
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	21 /** @brief Controller of the downloader network connection
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	22 *
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	23 * Base class of the SSL connection used. Offers a high
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	24 * level API that the downloader can use regardless of the
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	25 * concrete SSL implementation.
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	26 *
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	27 */
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	28 class SSLConnection
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	29 {
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	30 public:
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	31 /**
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	32 * @enum ErrorCode
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	33 * @brief Possible Errors of the SSL connection.
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	34 */
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	35 enum ErrorCode {
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	36 /! Everything OK /
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	37 NoError,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	38 /! Failure before the SSL Handshake. Connection failure./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	39 NoConnection,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	40 /! SSL Handshake failed. Probably unsupported ciphersuites./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	41 SSLHandshakeFailed,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	42 /! The pinned certificate did not match with the server cert./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	43 InvalidCertificate,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	44 /! The pinned certificate could not be parsed. Coding error!./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	45 InvalidPinnedCertificate,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	46 /! The response from the server could not be parsed./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	47 InvalidResponse,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	48 /! The connection was established but lost at one point./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	49 ConnectionLost,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	50 /! A connection timeout was hit./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	51 Timeout,
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	52 /! The unexpected./
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	53 ErrUnknown
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	54 };
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	55
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	56 /**
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	57 * @brief Construct a pinned SSL Connection
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	58 *
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	59 * @param[in] url the Url to connect to
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	60 * @param[in] certificate optional certificate to validate https connection
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	61 */
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	62 SSLConnection(const QString& url,
990 2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	63 const QByteArray& certificate = QByteArray());
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	64
908 d1c951b3012d Curl based implementation of sslconnection Andre Heinecke <andre.heinecke@intevation.de> parents: 404 diff changeset	65 virtual ~SSLConnection() {};
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	66
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	67 /**@brief wether or not everything could be parsed and all options could be set.
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	68 *
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	69 * This should usually be true. Otherwise it is likely something wrong
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	70 * with the internal data or the used library versions.
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	71 *
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	72 * @returns false when some error occured during initalization.
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	73 **/
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	74 bool initialized() { return mInitialized; }
1255 2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	75
2a1aa9df8f11 (issue133) Improve API documentation Andre Heinecke <andre.heinecke@intevation.de> parents: 1053 diff changeset	76 /** @brief wether or not the connection has been established */
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	77 bool connected() { return mConnected; }
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	78
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	79 ErrorCode getLastError() { return mErrorState; }
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	80
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	81 /** @brief: Establish the connection
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	82 *
908 d1c951b3012d Curl based implementation of sslconnection Andre Heinecke <andre.heinecke@intevation.de> parents: 404 diff changeset	83 * @returns 0 on success otherwise an error or -1 is returned
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	84 */
908 d1c951b3012d Curl based implementation of sslconnection Andre Heinecke <andre.heinecke@intevation.de> parents: 404 diff changeset	85 virtual int connect() = 0;
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	86
910 eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	87 /** @brief get the last modified header of a resource.
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	88 *
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	89 * Connection should be established beforehand.
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	90 * Modifies the error state.
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	91 *
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	92 * @param[in] resource The resource to check
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	93 *
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	94 * @returns the last modified date or a null datetime in case of errors
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	95 */
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	96 virtual QDateTime getLastModifiedHeader(const QString &resource) = 0;
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	97
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	98 /** @brief Download resource
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	99 *
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	100 * Download a resource with the established connection.
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	101 * Modifies the error state.
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	102 *
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	103 * @param[in] resource the resource to download
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	104 * @param[in] filename where the file should be saved.
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	105 * @param[in] maxSize maximum amount of bytes to download
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	106 *
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	107 * @returns True if the download was successful.
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	108 */
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	109 virtual bool downloadFile(const QString &resource, const QString &filename,
eaed02defe6a More SSLConnection refactoring. Fixes curl downloader. Andre Heinecke <andre.heinecke@intevation.de> parents: 908 diff changeset	110 size_t maxSize) = 0;
956 879a634d0a40 (issue41) Add proxy support Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	111
879a634d0a40 (issue41) Add proxy support Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	112 /** @brief Set a proxy server to use.
879a634d0a40 (issue41) Add proxy support Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	113 *
879a634d0a40 (issue41) Add proxy support Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	114 * @param [in] proxyUrl theo URL of the proxy to use.
879a634d0a40 (issue41) Add proxy support Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	115 */
990 2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	116 virtual void setProxy(const QUrl &proxyUrl);
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	117
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	118 /** @brief Set acceptable ciphersuites.
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	119 *
1053 78798d3af8f0 Fixed doxygen build warnings. Emanuel Schuetze <emanuel@intevation.de> parents: 990 diff changeset	120 * @param [in] ciphers a zero terminated list of ciphers as defined in
990 2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	121 * polarssl/ssl_ciphersuites.h
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	122 */
2949f1842955 (issue90) Add possibility to force cipher suites in bare connection and test for this Andre Heinecke <andre.heinecke@intevation.de> parents: 956 diff changeset	123 virtual void setCiphersuites(int ciphers[]) = 0;
956 879a634d0a40 (issue41) Add proxy support Andre Heinecke <andre.heinecke@intevation.de> parents: 910 diff changeset	124
908 d1c951b3012d Curl based implementation of sslconnection Andre Heinecke <andre.heinecke@intevation.de> parents: 404 diff changeset	125 protected:
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	126 QUrl mUrl;
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	127 QByteArray mPinnedCert;
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	128 bool mInitialized;
46 d28e2624c1d5 Reset connection before the next request. Andre Heinecke <aheinecke@intevation.de> parents: 45 diff changeset	129 bool mConnected; /* A connection was established */
d28e2624c1d5 Reset connection before the next request. Andre Heinecke <aheinecke@intevation.de> parents: 45 diff changeset	130 bool mNeedsReset; /* The connection needs to be reset before the next
d28e2624c1d5 Reset connection before the next request. Andre Heinecke <aheinecke@intevation.de> parents: 45 diff changeset	131 write */
45 c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	132 int mServerFD;
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	133 SSLConnection::ErrorCode mErrorState;
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	134 };
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	135
c6125d73faf4 Move SSLConnection into it's own class Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	136 #endif

Mercurial > trustbridge

annotate ui/sslconnection.h @ 1331:8897c90b8166