#include <QtCrypto>
|
class | CertificateChain |
|
class | Private |
|
Public Key (X.509) certificate.
This class contains one X.509 certificate
- Examples
- certtest.cpp, publickeyexample.cpp, sslservtest.cpp, and ssltest.cpp.
◆ Certificate() [1/4]
QCA::Certificate::Certificate |
( |
| ) |
|
◆ Certificate() [2/4]
QCA::Certificate::Certificate |
( |
const QString & |
fileName | ) |
|
Create a Certificate from a PEM encoded file.
- Parameters
-
fileName | the name (and path, if required) of the file that contains the PEM encoded certificate |
◆ Certificate() [3/4]
Create a Certificate with specified options and a specified private key.
- Parameters
-
opts | the options to use |
key | the private key for this certificate |
provider | the provider to use to create this key, if a particular provider is required |
◆ Certificate() [4/4]
QCA::Certificate::Certificate |
( |
const Certificate & |
from | ) |
|
Standard copy constructor.
- Parameters
-
from | the certificate to copy from |
◆ operator=()
Standard assignment operator.
- Parameters
-
◆ isNull()
bool QCA::Certificate::isNull |
( |
| ) |
const |
Test if the certificate is empty (null)
- Returns
- true if the certificate is null
- Examples
- publickeyexample.cpp.
◆ notValidBefore()
QDateTime QCA::Certificate::notValidBefore |
( |
| ) |
const |
◆ notValidAfter()
QDateTime QCA::Certificate::notValidAfter |
( |
| ) |
const |
◆ subjectInfo()
Properties of the subject of the certificate, as a QMultiMap
This is the method that provides information on the
subject organisation, common name, DNS name, and so
on. The list of information types (i.e. the key to
the multi-map) is a CertificateInfoType. The values
are a list of QString.
An example of how you can iterate over the list is:
\code
foreach( QString dns, info.values(QCA::DNS) ) { std::cout << " " << qPrintable(dns) << std::endl; }
- Examples
- certtest.cpp.
◆ subjectInfoOrdered()
Properties of the subject of the certificate, as
an ordered list (QList of CertificateInfoPair).
This allows access to the certificate information
in the same order as they appear in a certificate.
Each pair in the list has a type and a value.
For example:
\code
CertificateInfoOrdered info = cert.subjectInfoOrdered(); // info[0].type == CommonName // info[0].value == "example.com"
- See also
- subjectInfo for an unordered version
-
issuerInfoOrdered for the ordered information on the issuer
-
CertificateInfoPair for the elements in the list
◆ issuerInfo()
Properties of the issuer of the certificate.
- See also
- subjectInfo for how the return value works.
- Examples
- certtest.cpp.
◆ issuerInfoOrdered()
Properties of the issuer of the certificate, as an ordered list (QList of CertificateInfoPair).
This allows access to the certificate information in the same order as they appear in a certificate. Each pair in the list has a type and a value.
- See also
- issuerInfo for an unordered version
-
subjectInfoOrdered for the ordered information on the subject
-
CertificateInfoPair for the elements in the list
◆ constraints()
The constraints that apply to this certificate.
◆ policies()
QStringList QCA::Certificate::policies |
( |
| ) |
const |
The policies that apply to this certificate.
Policies are specified as strings containing OIDs
◆ crlLocations()
QStringList QCA::Certificate::crlLocations |
( |
| ) |
const |
List of URI locations for CRL files.
Each URI refers to the same CRL file
◆ issuerLocations()
QStringList QCA::Certificate::issuerLocations |
( |
| ) |
const |
List of URI locations for issuer certificate files.
Each URI refers to the same issuer file
◆ ocspLocations()
QStringList QCA::Certificate::ocspLocations |
( |
| ) |
const |
List of URI locations for OCSP services.
◆ commonName()
QString QCA::Certificate::commonName |
( |
| ) |
const |
The common name of the subject of the certificate.
Common names are normally the name of a person, company or organisation
- Examples
- ssltest.cpp.
◆ serialNumber()
BigInteger QCA::Certificate::serialNumber |
( |
| ) |
const |
◆ subjectPublicKey()
PublicKey QCA::Certificate::subjectPublicKey |
( |
| ) |
const |
The public key associated with the subject of the certificate.
◆ isCA()
bool QCA::Certificate::isCA |
( |
| ) |
const |
◆ isSelfSigned()
bool QCA::Certificate::isSelfSigned |
( |
| ) |
const |
◆ isIssuerOf()
bool QCA::Certificate::isIssuerOf |
( |
const Certificate & |
other | ) |
const |
Test if the Certificate has signed another Certificate object and is therefore the issuer.
- Parameters
-
other | the certificate to test |
- Returns
- true if this certificate is the issuer of the argument
◆ pathLimit()
int QCA::Certificate::pathLimit |
( |
| ) |
const |
The upper bound of the number of links in the certificate chain, if any.
◆ signatureAlgorithm()
The signature algorithm used for the signature on this certificate.
◆ subjectKeyId()
QByteArray QCA::Certificate::subjectKeyId |
( |
| ) |
const |
The key identifier associated with the subject.
◆ issuerKeyId()
QByteArray QCA::Certificate::issuerKeyId |
( |
| ) |
const |
The key identifier associated with the issuer.
◆ validate()
Check the validity of a certificate.
- Parameters
-
trusted | a collection of trusted certificates |
untrusted | a collection of additional certificates, not necessarily trusted |
u | the use required for the certificate |
vf | the conditions to validate |
- Note
- This function may block
◆ toDER()
QByteArray QCA::Certificate::toDER |
( |
| ) |
const |
◆ toPEM()
QString QCA::Certificate::toPEM |
( |
| ) |
const |
◆ toPEMFile()
bool QCA::Certificate::toPEMFile |
( |
const QString & |
fileName | ) |
const |
Export the Certificate into PEM format in a file.
- Parameters
-
fileName | the name of the file to use |
◆ fromDER()
static Certificate QCA::Certificate::fromDER |
( |
const QByteArray & |
a, |
|
|
ConvertResult * |
result = nullptr , |
|
|
const QString & |
provider = QString() |
|
) |
| |
|
static |
Import the certificate from DER.
- Parameters
-
a | the array containing the certificate in DER format |
result | a pointer to a ConvertResult, which if not-null will be set to the conversion status |
provider | the provider to use, if a specific provider is required |
- Returns
- the Certificate corresponding to the certificate in the provided array
◆ fromPEM()
static Certificate QCA::Certificate::fromPEM |
( |
const QString & |
s, |
|
|
ConvertResult * |
result = nullptr , |
|
|
const QString & |
provider = QString() |
|
) |
| |
|
static |
Import the certificate from PEM format.
- Parameters
-
s | the string containing the certificate in PEM format |
result | a pointer to a ConvertResult, which if not-null will be set to the conversion status |
provider | the provider to use, if a specific provider is required |
- Returns
- the Certificate corresponding to the certificate in the provided string
- Examples
- sslservtest.cpp, and ssltest.cpp.
◆ fromPEMFile()
static Certificate QCA::Certificate::fromPEMFile |
( |
const QString & |
fileName, |
|
|
ConvertResult * |
result = nullptr , |
|
|
const QString & |
provider = QString() |
|
) |
| |
|
static |
Import the certificate from a file.
- Parameters
-
fileName | the name (and path, if required) of the file containing the certificate in PEM format |
result | a pointer to a ConvertResult, which if not-null will be set to the conversion status |
provider | the provider to use, if a specific provider is required |
- Returns
- the Certificate corresponding to the certificate in the provided string
◆ matchesHostName()
bool QCA::Certificate::matchesHostName |
( |
const QString & |
host | ) |
const |
Test if the subject of the certificate matches a specified host name.
This will return true (indicating a match), if the specified host name meets the RFC 2818 validation rules with this certificate.
If the host is an internationalized domain name, then it must be provided in unicode format, not in IDNA ACE/punycode format.
- Parameters
-
host | the name of the host to compare to |
◆ operator==()
bool QCA::Certificate::operator== |
( |
const Certificate & |
a | ) |
const |
Test for equality of two certificates.
- Parameters
-
a | the certificate to compare this certificate with |
- Returns
- true if the two certificates are the same
◆ operator!=()
bool QCA::Certificate::operator!= |
( |
const Certificate & |
other | ) |
const |
|
inline |
Inequality operator.
- Parameters
-
other | the certificate to compare this certificate with |
◆ change()
The documentation for this class was generated from the following file: