QDtls Class

メンバ関数のドキュメント

[explicit] QDtls::QDtls(QSslSocket::SslMode mode, QObject *parent = nullptr)

QDtls オブジェクトを作成します。parent がQObject コンストラクタに渡されます。mode は、サーバー側のDTLS接続の場合はQSslSocket::SslServerMode 、クライアントの場合はQSslSocket::SslClientMode となります。

sslMode() およびQSslSocket::SslModeも参照してください 。

[virtual noexcept] QDtls::~QDtls()

QDtls オブジェクトを破棄します。

bool QDtls::abortHandshake(QUdpSocket *socket)

進行中のハンドシェイクを中止します。socket でハンドシェイクが進行中であれば true を返します。そうでない場合は、適切なエラーを設定して false を返します。

doHandshake() およびresumeHandshake()も参照してください 。

QDtls::GeneratorParameters QDtls::cookieGeneratorParameters() const

現在のハッシュアルゴリズムとシークレットを返します。これらはデフォルトのもの、あるいは以前に `setCookieGeneratorParameters()` の呼び出しによって設定されたものです。

デフォルトのハッシュアルゴリズムは、Qtがそれをサポートするように構成されている場合はQCryptographicHash::Sha256 、そうでない場合はQCryptographicHash::Sha1 となります。デフォルトのシークレットは、バックエンド固有の暗号学的に強固な擬似乱数生成器から取得されます。

QDtlsClientVerifier およびsetCookieGeneratorParameters()も参照してください 。

QByteArray QDtls::decryptDatagram(QUdpSocket *socket, const QByteArray &dgram)

dgram を復号化し、その内容を平文として返します。データグラムの復号化を行うには、ハンドシェイクが完了している必要があります。TLSメッセージの種類によっては、接続がsocket に書き込みを行う場合があります。 は有効なポインタである必要があります。

bool QDtls::doHandshake(QUdpSocket *socket, const QByteArray &dgram = {})

DTLSハンドシェイクを開始または継続します。socket は有効なポインタでなければなりません。サーバー側のDTLSハンドシェイクを開始する場合、dgram には、QUdpSocket から読み込まれた初期のClientHelloメッセージが含まれている必要があります。この関数は、エラーが検出されなかった場合、true を返します。ハンドシェイクの状態は、handshakeState()を使用して確認できます。false が返された場合は何らかのエラーが発生したことを意味します。詳細な情報を得るには、dtlsError()を使用してください。

if (!dtls.doHandshake(&socket, dgram)) {
    if (dtls.dtlsError() == QDtlsError::PeerVerificationError)
        dtls.abortAfterError(&socket);
}

関連項目： handshakeState()、dtlsError()、ignoreVerificationErrors()、resumeHandshake()、およびabortHandshake()。

QSslConfiguration QDtls::dtlsConfiguration() const

デフォルトの DTLS 設定、または以前に `setDtlsConfiguration()` を呼び出して設定された設定のいずれかを返します。

setDtlsConfiguration() およびQSslConfiguration::defaultDtlsConfiguration()も参照してください 。

QDtlsError QDtls::dtlsError() const

接続で最後に発生したエラー、または `QDtlsError::NoError` を返します。

dtlsErrorString() およびQDtlsErrorも参照してください 。

QString QDtls::dtlsErrorString() const

接続で最後に発生したエラーに関する説明テキスト、または空の文字列を返します。

dtlsError()も参照してください 。

bool QDtls::handleTimeout(QUdpSocket *socket)

ハンドシェイク中にタイムアウトが発生した場合、handshakeTimeout() シグナルが発信されます。アプリケーションは、ハンドシェイクメッセージを再送信するために handleTimeout() を呼び出す必要があります。handleTimeout() は、タイムアウトが発生した場合はtrue を返し、それ以外の場合は false を返します。socket は有効なポインタでなければなりません。

handshakeTimeout()も参照してください 。

QDtls::HandshakeState QDtls::handshakeState() const

このQDtls の現在のハンドシェイク状態を返します。

doHandshake() およびQDtls::HandshakeStateも参照してください 。

[signal] void QDtls::handshakeTimeout()

パケット損失が発生すると、ハンドシェイクフェーズ中にタイムアウトが生じる可能性があります。この場合、QDtls はhandshakeTimeout()シグナルを発行します。handleTimeout()を呼び出して、ハンドシェイクメッセージを再送信してください：

DtlsClient::DtlsClient()
{
    // Some initialization code here ...
    connect(&clientDtls, &QDtls::handshakeTimeout, this, &DtlsClient::handleTimeout);
}

void DtlsClient::handleTimeout()
{
    clientDtls.handleTimeout(&clientSocket);
}

handleTimeout()も参照してください 。

void QDtls::ignoreVerificationErrors(const QList<QSslError> &errorsToIgnore)

この方法では、QDtls に対し、errorsToIgnore に指定されたエラーのみを無視するように指示します。

たとえば、自己署名証明書を使用するサーバーに接続したい場合は、次のコードスニペットを参照してください。

QList<QSslCertificate> cert = QSslCertificate::fromPath("server-certificate.pem"_L1);
QSslError error(QSslError::SelfSignedCertificate, cert.at(0));
QList<QSslError> expectedSslErrors;
expectedSslErrors.append(error);

QDtls dtls;
dtls.ignoreVerificationErrors(expectedSslErrors);
dtls.doHandshake(udpSocket);

また、doHandshake() がQDtlsError::PeerVerificationError のエラーを検出した後にこの関数を呼び出し、その後resumeHandshake() を呼び出すことでハンドシェイクを再開することもできます。

この関数をその後呼び出すと、以前の呼び出しで渡されたエラーのリストが上書きされます。無視したいエラーのリストをクリアするには、空のリストを引数としてこの関数を呼び出します。

doHandshake()、resumeHandshake()、およびQSslErrorも参照してください 。

bool QDtls::isConnectionEncrypted() const

DTLSハンドシェイクが正常に完了した場合、true を返します。

doHandshake() およびhandshakeState()も参照してください 。

quint16 QDtls::mtuHint() const

setMtuHint() で以前に設定された値を返します。デフォルト値は 0 です。

setMtuHint()も参照してください 。

QHostAddress QDtls::peerAddress() const

setPeer() またはQHostAddress::Null によって設定されたピアのアドレスを返します。

setPeer()も参照してください 。

quint16 QDtls::peerPort() const

setPeer() で設定されたピアのポート番号、または 0 を返します。

setPeer()も参照してください 。

QList<QSslError> QDtls::peerVerificationErrors() const

ピアの識別情報を確立する際に検出されたエラーを返します。

発生したエラーにもかかわらず接続を続行したい場合は、ignoreVerificationErrors() を呼び出す必要があります。

QString QDtls::peerVerificationName() const

setPeer() またはsetPeerVerificationName() で設定されたホスト名を返します。デフォルト値は空の文字列です。

setPeerVerificationName() およびsetPeer()も参照してください 。

[signal] void QDtls::pskRequired(QSslPreSharedKeyAuthenticator *authenticator)

QDtls PSK暗号スイートをネゴシエートする際にこの信号を出力するため、その後PSK認証が必要となります。

PSK を使用する場合、TLS ハンドシェイクを継続するためには、クライアントはサーバーに対して有効な識別情報と有効な事前共有鍵を送信する必要があります。アプリケーションは、このシグナルに接続されたスロット内で、渡された `authenticator ` オブジェクトを必要に応じて設定することで、この情報を提供できます。

「QSslPreSharedKeyAuthenticator」も参照してください 。

bool QDtls::resumeHandshake(QUdpSocket *socket)

ハンドシェイク中にピア検証エラーが無視された場合、resumeHandshake() はハンドシェイクを再開・完了させ、true を返します。socket は有効なポインタでなければなりません。ハンドシェイクを再開できなかった場合は、false を返します。

doHandshake()、abortHandshake()、peerVerificationErrors()、およびignoreVerificationErrors()も参照してください 。

QSslCipher QDtls::sessionCipher() const

この接続で使用される暗号化cipher を返します。接続が暗号化されていない場合は、null cipherを返します。セッションの暗号は、ハンドシェイクフェーズ中に選択されます。この暗号は、データの暗号化および復号化に使用されます。

QSslConfiguration ハンドシェイクフェーズにおいて最終的にセッション暗号が選択される、暗号の順序付きリストを設定するための関数を提供します。この順序付きリストは、ハンドシェイクフェーズが開始される前に用意されていなければなりません。

QSslConfiguration 、setDtlsConfiguration()、およびdtlsConfiguration()も参照してください 。

QSsl::SslProtocol QDtls::sessionProtocol() const

この接続で使用されている DTLS プロトコルのバージョンを返します。接続がまだ暗号化されていない場合は、UnknownProtocol を返します。接続に使用するプロトコルは、ハンドシェイクフェーズ中に選択されます。

setDtlsConfiguration() を使用すると、ハンドシェイクが開始される前に優先バージョンを設定できます。

関連項目： setDtlsConfiguration()、QSslConfiguration 、QSslConfiguration::defaultDtlsConfiguration()、およびQSslConfiguration::setProtocol()。

bool QDtls::setCookieGeneratorParameters(const QDtls::GeneratorParameters &params)

params から暗号ハッシュアルゴリズムとシークレットを設定します。この関数は、サーバーサイドのQDtls 接続でのみ必要です。成功した場合はtrue を返します。

関連項目： cookieGeneratorParameters()、doHandshake()、QDtlsClientVerifier 、およびQDtlsClientVerifier::cookieGeneratorParameters()。

bool QDtls::setDtlsConfiguration(const QSslConfiguration &configuration)

configuration から接続の TLS 設定を設定し、成功した場合はtrue を返します。

関連項目： dtlsConfiguration() およびdoHandshake()。

void QDtls::setMtuHint(quint16 mtuHint)

mtuHint これは、アプリケーションによって検出されたか、あるいは推測された最大伝送単位（MTU）です。アプリケーションがこの値を設定する必要はありません。

mtuHint() およびQAbstractSocket::PathMtuSocketOptionも参照してください 。

bool QDtls::setPeer(const QHostAddress &address, quint16 port, const QString &verificationName = {})

ピアのアドレス（port ）およびホスト名を設定し、成功した場合はtrue を返します。address は、null、マルチキャスト、またはブロードキャストであってはなりません。verificationName は、証明書の検証に使用されるホスト名です。

peerAddress()、peerPort()、およびpeerVerificationName()も参照してください 。

bool QDtls::setPeerVerificationName(const QString &name)

証明書の検証に使用するホストname を設定し、成功した場合はtrue を返します。

関連項目： peerVerificationName() およびsetPeer()。

bool QDtls::shutdown(QUdpSocket *socket)

暗号化されたシャットダウン通知メッセージを送信し、DTLS接続を閉じます。ハンドシェイクの状態はQDtls::HandshakeNotStarted に変更されます。socket は有効なポインタでなければなりません。この関数は、成功した場合にtrue を返します。

doHandshake()も参照してください 。

QSslSocket::SslMode QDtls::sslMode() const

サーバー側の接続の場合は `QSslSocket::SslServerMode ` を、クライアント側の場合は `QSslSocket::SslClientMode ` を返します。

QDtls() およびQSslSocket::SslModeも参照してください 。

qint64 QDtls::writeDatagramEncrypted(QUdpSocket *socket, const QByteArray &dgram)

dgram を暗号化し、暗号化されたデータをsocket に書き込みます。書き込まれたバイト数を返します。エラーが発生した場合は -1 を返します。暗号化されたデータを書き込む前に、ハンドシェイクを完了させる必要があります。socket は有効なポインタでなければなりません。

doHandshake()、handshakeState()、isConnectionEncrypted()、およびdtlsError()も参照してください 。