src/network/ssl/qsslcertificate.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtNetwork module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42
  43 #ifndef QSSLCERTIFICATE_H
  44 #define QSSLCERTIFICATE_H
  45
  46 #include <QtCore/qnamespace.h>
  47 #include <QtCore/qbytearray.h>
  48 #include <QtCore/qcryptographichash.h>
  49 #include <QtCore/qregexp.h>
  50 #include <QtCore/qsharedpointer.h>
  51 #include <QtNetwork/qssl.h>
  52
  53 typedef struct x509_st X509; // ### check if this works
  54
  55 QT_BEGIN_HEADER
  56
  57 QT_BEGIN_NAMESPACE
  58
  59 QT_MODULE(Network)
  60
  61 #ifndef QT_NO_OPENSSL
  62
  63 class QDateTime;
  64 class QIODevice;
  65 class QSslKey;
  66 class QStringList;
  67 template <typename T, typename U> class QMultiMap;
  68
  69 class QSslCertificatePrivate;
  70 class Q_NETWORK_EXPORT QSslCertificate
  71 {
  72 public:
  73     enum SubjectInfo {
  74         Organization,
  75         CommonName,
  76         LocalityName,
  77         OrganizationalUnitName,
  78         CountryName,
  79         StateOrProvinceName
  80     };
  81
  82     QSslCertificate(QIODevice *device, QSsl::EncodingFormat format = QSsl::Pem);
  83     QSslCertificate( // ### s/encoded/data (to be consistent with signature in .cpp file) ?
  84         const QByteArray &encoded = QByteArray(), QSsl::EncodingFormat format = QSsl::Pem);
  85     QSslCertificate(const QSslCertificate &other);
  86     ~QSslCertificate();
  87     QSslCertificate &operator=(const QSslCertificate &other);
  88     bool operator==(const QSslCertificate &other) const;
  89     inline bool operator!=(const QSslCertificate &other) const { return !operator==(other); }
  90
  91     bool isNull() const;
  92     bool isValid() const;
  93     void clear();
  94
  95     // Certificate info
  96     QByteArray version() const;
  97     QByteArray serialNumber() const;
  98     QByteArray digest(QCryptographicHash::Algorithm algorithm = QCryptographicHash::Md5) const;
  99     QString issuerInfo(SubjectInfo info) const;
 100     QString issuerInfo(const QByteArray &tag) const;
 101     QString subjectInfo(SubjectInfo info) const;
 102     QString subjectInfo(const QByteArray &tag) const;
 103     QMultiMap<QSsl::AlternateNameEntryType, QString> alternateSubjectNames() const;
 104     QDateTime effectiveDate() const;
 105     QDateTime expiryDate() const;
 106     QSslKey publicKey() const;
 107
 108     QByteArray toPem() const;
 109     QByteArray toDer() const;
 110
 111     static QList<QSslCertificate> fromPath(
 112         const QString &path, QSsl::EncodingFormat format = QSsl::Pem,
 113         QRegExp::PatternSyntax syntax = QRegExp::FixedString);
 114     static QList<QSslCertificate> fromDevice(
 115         QIODevice *device, QSsl::EncodingFormat format = QSsl::Pem);
 116     static QList<QSslCertificate> fromData(
 117         const QByteArray &data, QSsl::EncodingFormat format = QSsl::Pem);
 118
 119     Qt::HANDLE handle() const;
 120
 121 private:
 122     QExplicitlySharedDataPointer<QSslCertificatePrivate> d;
 123     friend class QSslCertificatePrivate;
 124     friend class QSslSocketBackendPrivate;
 125 };
 126
 127 #ifndef QT_NO_DEBUG_STREAM
 128 class QDebug;
 129 Q_NETWORK_EXPORT QDebug operator<<(QDebug debug, const QSslCertificate &certificate);
 130 Q_NETWORK_EXPORT QDebug operator<<(QDebug debug, QSslCertificate::SubjectInfo info);
 131 #endif
 132
 133 #endif // QT_NO_OPENSSL
 134
 135 QT_END_NAMESPACE
 136
 137 QT_END_HEADER
 138
 139 #endif