/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtNetwork module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

/*!

    \class QSslCertificate

    \brief The QSslCertificate class provides a convenient API for an X509 certificate.

    \since 4.3

    \reentrant

    \ingroup network

    \ingroup ssl

    \inmodule QtNetwork

    QSslCertificate stores an X509 certificate, and is commonly used

    to verify the identity and store information about the local host,

    a remotely connected peer, or a trusted third party Certificate

    Authority.

    There are many ways to construct a QSslCertificate. The most

    common way is to call QSslSocket::peerCertificate(), which returns

    a QSslCertificate object, or QSslSocket::peerCertificateChain(),

    which returns a list of them. You can also load certificates from

    a DER (binary) or PEM (Base64) encoded bundle, typically stored as

    one or more local files, or in a Qt Resource.

    You can call isNull() to check if your certificate is null. By

    default, QSslCertificate constructs a null certificate. To check

    if the certificate is valid, call isValid(). A null certificate is

    invalid, but an invalid certificate is not necessarily null. If

    you want to reset all contents in a certificate, call clear().

    After loading a certificate, you can find information about the

    certificate, its subject, and its issuer, by calling one of the

    many accessor functions, including version(), serialNumber(),

    issuerInfo() and subjectInfo(). You can call effectiveDate() and

    expiryDate() to check when the certificate starts being

    effective and when it expires.

    The publicKey() function returns the certificate

    subject's public key as a QSslKey. You can call issuerInfo() or

    subjectInfo() to get detailed information about the certificate

    issuer and its subject.

    Internally, QSslCertificate is stored as an X509 structure. You

    can access this handle by calling handle(), but the results are

    likely to not be portable.

    \sa QSslSocket, QSslKey, QSslCipher, QSslError

*/

/*!

    \enum QSslCertificate::SubjectInfo

    Describes keys that you can pass to QSslCertificate::issuerInfo() or

    QSslCertificate::subjectInfo() to get information about the certificate

    issuer or subject.

    \value Organization "O" The name of the organization.

    \value CommonName "CN" The common name; most often this is used to store

    the host name.

    \value LocalityName "L" The locality.

    \value OrganizationalUnitName "OU" The organizational unit name.

    \value CountryName "C" The country.

    \value StateOrProvinceName "ST" The state or province.

*/

#include "qsslsocket_openssl_symbols_p.h"

#include "qsslcertificate.h"

#include "qsslcertificate_p.h"

#include "qsslkey.h"

#include "qsslkey_p.h"

#include <QtCore/qatomic.h>

#include <QtCore/qdatetime.h>

#include <QtCore/qdebug.h>

#include <QtCore/qdir.h>

#include <QtCore/qdiriterator.h>

#include <QtCore/qfile.h>

#include <QtCore/qfileinfo.h>

#include <QtCore/qmap.h>

#include <QtCore/qstring.h>

#include <QtCore/qstringlist.h>

QT_BEGIN_NAMESPACE

// forward declaration

static QMap<QString, QString> _q_mapFromOnelineName(char *name);

/*!

    Constructs a QSslCertificate by reading \a format encoded data

    from \a device and using the first certificate found. You can

    later call isNull() to see if \a device contained a certificate,

    and if this certificate was loaded successfully.

*/

QSslCertificate::QSslCertificate(QIODevice *device, QSsl::EncodingFormat format)

    : d(new QSslCertificatePrivate)

{

    QSslSocketPrivate::ensureInitialized();

    if (device)

        d->init(device->readAll(), format);

}

/*!

    Constructs a QSslCertificate by parsing the \a format encoded

    \a data and using the first available certificate found. You can

    later call isNull() to see if \a data contained a certificate,

    and if this certificate was loaded successfully.

*/

QSslCertificate::QSslCertificate(const QByteArray &data, QSsl::EncodingFormat format)

    : d(new QSslCertificatePrivate)

{

    QSslSocketPrivate::ensureInitialized();

    d->init(data, format);

}

/*!

    Constructs an identical copy of \a other.

*/

QSslCertificate::QSslCertificate(const QSslCertificate &other) : d(other.d)

{

}

/*!

    Destroys the QSslCertificate.

*/

QSslCertificate::~QSslCertificate()

{

}

/*!

    Copies the contents of \a other into this certificate, making the two

    certificates identical.

*/

QSslCertificate &QSslCertificate::operator=(const QSslCertificate &other)

{

    d = other.d;

    return *this;

}

/*!

    Returns true if this certificate is the same as \a other; otherwise

    returns false.

*/

bool QSslCertificate::operator==(const QSslCertificate &other) const

{

    if (d == other.d)

        return true;

    if (d->null && other.d->null)

        return true;

    if (d->x509 && other.d->x509)

        return q_X509_cmp(d->x509, other.d->x509) == 0;

    return false;

}

/*!

    \fn bool QSslCertificate::operator!=(const QSslCertificate &other) const

    Returns true if this certificate is not the same as \a other; otherwise

    returns false.

*/

/*!

    Returns true if this is a null certificate (i.e., a certificate

    with no contents); otherwise returns false.

    By default, QSslCertificate constructs a null certificate.

    \sa isValid(), clear()

*/

bool QSslCertificate::isNull() const

{

    return d->null;

}

/*!

    Returns true if this certificate is valid; otherwise returns

    false.

    Note: Currently, this function only checks that the current

    data-time is within the date-time range during which the

    certificate is considered valid. No other checks are

    currently performed.

    \sa isNull()

*/

bool QSslCertificate::isValid() const

{

    const QDateTime currentTime = QDateTime::currentDateTime();

    return currentTime >= d->notValidBefore && currentTime <= d->notValidAfter;

}

/*!

    Clears the contents of this certificate, making it a null

    certificate.

    \sa isNull()

*/

void QSslCertificate::clear()

{

    if (isNull())

        return;

    d = new QSslCertificatePrivate;

}

/*!

    Returns the certificate's version string.

*/

QByteArray QSslCertificate::version() const

{

    if (d->versionString.isEmpty() && d->x509)

        d->versionString =

            QByteArray::number(qlonglong(q_ASN1_INTEGER_get(d->x509->cert_info->version)) + 1);

    return d->versionString;

}

/*!

    Returns the certificate's serial number string in decimal format.

    In case the serial number cannot be converted to decimal format

    (i.e. if it is bigger than 4294967295, which means it does not fit into 4 bytes),

    its hexadecimal version is returned.

*/

QByteArray QSslCertificate::serialNumber() const

{

    if (d->serialNumberString.isEmpty() && d->x509) {

        ASN1_INTEGER *serialNumber = d->x509->cert_info->serialNumber;

        // if we cannot convert to a long, just output the hexadecimal number

        if (serialNumber->length > 4) {

            QByteArray hexString;

            hexString.reserve(serialNumber->length * 3);

            for (int a = 0; a < serialNumber->length; ++a) {

                hexString += QByteArray::number(serialNumber->data[a], 16).rightJustified(2, '0');

                hexString += ':';

            }

            hexString.chop(1);

            d->serialNumberString = hexString;

        } else {

            d->serialNumberString = QByteArray::number(qlonglong(q_ASN1_INTEGER_get(serialNumber)));

        }

    }

    return d->serialNumberString;

}

/*!

    Returns a cryptographic digest of this certificate. By default,

    an MD5 digest will be generated, but you can also specify a

    custom \a algorithm.

*/

QByteArray QSslCertificate::digest(QCryptographicHash::Algorithm algorithm) const

{

    return QCryptographicHash::hash(toDer(), algorithm);

}

static QString _q_SubjectInfoToString(QSslCertificate::SubjectInfo info)

{

    QString str;

    switch (info) {

    case QSslCertificate::Organization: str = QLatin1String("O"); break;

    case QSslCertificate::CommonName: str = QLatin1String("CN"); break;

    case QSslCertificate::LocalityName: str = QLatin1String("L"); break;

    case QSslCertificate::OrganizationalUnitName: str = QLatin1String("OU"); break;

    case QSslCertificate::CountryName: str = QLatin1String("C"); break;

    case QSslCertificate::StateOrProvinceName: str = QLatin1String("ST"); break;

    }

    return str;

}

/*!

  \fn QString QSslCertificate::issuerInfo(SubjectInfo subject) const

  Returns the issuer information for the \a subject from the

  certificate, or an empty string if there is no information for

  \a subject in the certificate.

  \sa subjectInfo()

*/

QString QSslCertificate::issuerInfo(SubjectInfo info) const

{

    // lazy init

    if (d->issuerInfo.isEmpty() && d->x509)

        d->issuerInfo =

                _q_mapFromOnelineName(q_X509_NAME_oneline(q_X509_get_issuer_name(d->x509), 0, 0));

    return d->issuerInfo.value(_q_SubjectInfoToString(info));

}

/*!

  Returns the issuer information for \a tag from the certificate,

  or an empty string if there is no information for \a tag in the

  certificate.

  \sa subjectInfo()

*/

QString QSslCertificate::issuerInfo(const QByteArray &tag) const

{

    // lazy init

    if (d->issuerInfo.isEmpty() && d->x509)

        d->issuerInfo =

                _q_mapFromOnelineName(q_X509_NAME_oneline(q_X509_get_issuer_name(d->x509), 0, 0));

    return d->issuerInfo.value(QString::fromLatin1(tag));

}

/*!

  \fn QString QSslCertificate::subjectInfo(SubjectInfo subject) const

  Returns the information for the \a subject, or an empty string if

  there is no information for \a subject in the certificate.

    \sa issuerInfo()

*/

QString QSslCertificate::subjectInfo(SubjectInfo info) const

{

    // lazy init

    if (d->subjectInfo.isEmpty() && d->x509)

        d->subjectInfo =

                _q_mapFromOnelineName(q_X509_NAME_oneline(q_X509_get_subject_name(d->x509), 0, 0));

    return d->subjectInfo.value(_q_SubjectInfoToString(info));

}

/*!

    Returns the subject information for \a tag, or an empty string if

    there is no information for \a tag in the certificate.

    \sa issuerInfo()

*/

QString QSslCertificate::subjectInfo(const QByteArray &tag) const

{

    // lazy init

    if (d->subjectInfo.isEmpty() && d->x509)

        d->subjectInfo =

                _q_mapFromOnelineName(q_X509_NAME_oneline(q_X509_get_subject_name(d->x509), 0, 0));

    return d->subjectInfo.value(QString::fromLatin1(tag));

}

/*!

  Returns the list of alternative subject names for this

  certificate. The alternate subject names typically contain host

  names, optionally with wildcards, that are valid for this

  certificate.

  These names are tested against the connected peer's host name, if

  either the subject information for \l CommonName doesn't define a

  valid host name, or the subject info name doesn't match the peer's

  host name.

  \sa subjectInfo()

*/

QMultiMap<QSsl::AlternateNameEntryType, QString> QSslCertificate::alternateSubjectNames() const

{

    QMultiMap<QSsl::AlternateNameEntryType, QString> result;

    if (!d->x509)

        return result;

    STACK_OF(GENERAL_NAME) *altNames = (STACK_OF(GENERAL_NAME)*)q_X509_get_ext_d2i(d->x509, NID_subject_alt_name, 0, 0);

    if (altNames) {

        for (int i = 0; i < q_sk_GENERAL_NAME_num(altNames); ++i) {

            const GENERAL_NAME *genName = q_sk_GENERAL_NAME_value(altNames, i);

            if (genName->type != GEN_DNS && genName->type != GEN_EMAIL)

                continue;

            int len = q_ASN1_STRING_length(genName->d.ia5);

            if (len < 0 || len >= 8192) {

                // broken name

                continue;

            }

            const char *altNameStr = reinterpret_cast<const char *>(q_ASN1_STRING_data(genName->d.ia5));

            const QString altName = QString::fromLatin1(altNameStr, len);

            if (genName->type == GEN_DNS)

                result.insert(QSsl::DnsEntry, altName);

            else if (genName->type == GEN_EMAIL)

                result.insert(QSsl::EmailEntry, altName);

        }

        q_sk_pop_free((STACK*)altNames, reinterpret_cast<void(*)(void*)>(q_sk_free));

    }

    return result;

}

/*!

  Returns the date-time that the certificate becomes valid, or an

  empty QDateTime if this is a null certificate.

  \sa expiryDate()

*/

QDateTime QSslCertificate::effectiveDate() const

{

    return d->notValidBefore;

}

/*!

  Returns the date-time that the certificate expires, or an empty

  QDateTime if this is a null certificate.

    \sa effectiveDate()

*/

QDateTime QSslCertificate::expiryDate() const

{

    return d->notValidAfter;

}

/*!

    Returns a pointer to the native certificate handle, if there is

    one, or a null pointer otherwise.

    You can use this handle, together with the native API, to access

    extended information about the certificate.

    \warning Use of this function has a high probability of being

    non-portable, and its return value may vary from platform to

    platform or change from minor release to minor release.

*/

Qt::HANDLE QSslCertificate::handle() const

{

    return Qt::HANDLE(d->x509);

}

/*!

    Returns the certificate subject's public key.

*/

QSslKey QSslCertificate::publicKey() const

{

    if (!d->x509)

        return QSslKey();

    QSslKey key;

    key.d->type = QSsl::PublicKey;

    X509_PUBKEY *xkey = d->x509->cert_info->key;

    EVP_PKEY *pkey = q_X509_PUBKEY_get(xkey);

    Q_ASSERT(pkey);

    if (q_EVP_PKEY_type(pkey->type) == EVP_PKEY_RSA) {

        key.d->rsa = q_EVP_PKEY_get1_RSA(pkey);

        key.d->algorithm = QSsl::Rsa;

        key.d->isNull = false;

    } else if (q_EVP_PKEY_type(pkey->type) == EVP_PKEY_DSA) {

        key.d->dsa = q_EVP_PKEY_get1_DSA(pkey);

        key.d->algorithm = QSsl::Dsa;

        key.d->isNull = false;

    } else if (q_EVP_PKEY_type(pkey->type) == EVP_PKEY_DH) {

        // DH unsupported

    } else {

        // error?

    }

    q_EVP_PKEY_free(pkey);

    return key;

}

/*!

    Returns this certificate converted to a PEM (Base64) encoded

    representation.

*/

QByteArray QSslCertificate::toPem() const

{

    if (!d->x509)

        return QByteArray();

    return d->QByteArray_from_X509(d->x509, QSsl::Pem);

}

/*!

    Returns this certificate converted to a DER (binary) encoded

    representation.

*/

QByteArray QSslCertificate::toDer() const

{

    if (!d->x509)

        return QByteArray();

    return d->QByteArray_from_X509(d->x509, QSsl::Der);

}

/*!

    Searches all files in the \a path for certificates encoded in the

    specified \a format and returns them in a list. \e must be a file or a

    pattern matching one or more files, as specified by \a syntax.