QSslSocket Class

メンバ関数ドキュメント

[explicit] QSslSocket::QSslSocket(QObject *parent = nullptr)

QSslSocket オブジェクトを構築する。parent はQObject のコンストラクタに渡される。新しいソケットのcipher スイートを static メソッド defaultCiphers() が返すものに設定する。

[virtual noexcept] QSslSocket::~QSslSocket()

QSslSocket を破棄する。

[static, since 6.1] QString QSslSocket::activeBackend()

QSslSocket および関連するクラスが使用するバックエンドの名前を返す。アクティブなバックエンドが明示的に設定されていない場合、この関数は、QSslSocket が使用可能なバックエンドの一覧から暗黙的に選択するデフォルトのバックエンドの名前を返します。

この関数は Qt 6.1 で導入されました。

setActiveBackend() およびavailableBackends()も参照してください 。

[signal] void QSslSocket::alertReceived(QSsl::AlertLevel level, QSsl::AlertType type, const QString &description)

QSslSocket level は、アラートが致命的なものなのか警告なのかを示します。 は、アラートが送信された理由を説明するコードです。アラートメッセージのテキストによる説明がある場合は、 。type description

alertSent()、QSsl::AlertLevel 、QSsl::AlertTypeも参照 。

[signal] void QSslSocket::alertSent(QSsl::AlertLevel level, QSsl::AlertType type, const QString &description)

QSslSocket level 、警告か致命的エラーかを記述する。 、警告メッセージのコードを与える。アラートメッセージのテキスト記述がある場合は、 で提供される。type description

alertReceived()、QSsl::AlertLevel 、QSsl::AlertTypeも参照のこと 。

[override virtual] bool QSslSocket::atEnd() const

を参照してください：QIODevice::atEnd() const.

[static, since 6.1] QList<QString> QSslSocket::availableBackends()

現在利用可能なバックエンドの名前を返します。これらの名前は小文字で、例えば "openssl"、"securetransport"、"schannel" などです（Qt の TLS バックエンドの既存の機能名と同様です）。

この関数は Qt 6.1 で導入されました。

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

[override virtual] qint64 QSslSocket::bytesAvailable() const

再インプリメント：QAbstractSocket::bytesAvailable() const.

すぐに読み込める復号化されたバイト数を返します。

[override virtual] qint64 QSslSocket::bytesToWrite() const

再実装: () const：QAbstractSocket::bytesToWrite() const.

暗号化されてネットワークに書き込まれるのを待っている、暗号化されていないバイト数を返します。

[override virtual] bool QSslSocket::canReadLine() const

再インプリメントQIODevice::canReadLine() const.

復号化された文字の 1 行(ASCII の ' \n' 文字 1 文字で終端)を読める場合はtrue を返し、そうでない場合は false を返します。

[override virtual] void QSslSocket::close()

そうでなければ false を返します：QAbstractSocket::close().

void QSslSocket::connectToHostEncrypted(const QString &hostName, quint16 port, QIODeviceBase::OpenMode mode = ReadWrite, QAbstractSocket::NetworkLayerProtocol protocol = AnyIPProtocol)

mode をOpenMode として使用して、port 上のデバイスhostName への暗号化接続を開始します。これは、connectToHost() を呼び出して接続を確立し、startClientEncryption() を呼び出すのと同じです。protocol パラメータを使用して、使用するネットワーク・プロトコルを指定でき る（IPv4またはIPv6など）。

QSslSocket 最初にHostLookupStateに入る。次に、イベントループまたはwaitFor...()関数のいずれかに入った後、ConnectingStateに入り、 ()を発行し、SSLクライアント・ハンドシェイクを開始する。状態が変わるたびに、 はシグナル () を発する。connected QSslSocket stateChanged

SSLクライアントハンドシェイクを開始した後、相手のIDが確立できない場合、シグナルsslErrors()が発せられる。エラーを無視して接続を続行したい場合は、sslErrors() シグナルに接続されたスロット関数の内部から、または暗号化モードに入る前に、ignoreSslErrors() を呼び出す必要があります。ignoreSslErrors() が呼び出されなかった場合、接続は切断され、シグナルdisconnected() が発せられ、QSslSocket は UnconnectedState に戻る。

SSLハンドシェイクが成功すると、QSslSocket 、encrypted （）が発信される。

QSslSocket socket;
connect(&socket, &QSslSocket::encrypted, receiver, &Receiver::socketEncrypted);

socket.connectToHostEncrypted("imap", 993);
socket->write("1 CAPABILITY\r\n");

mode のデフォルトはReadWrite である。

接続のサーバー側でQSslSocket を作成したい場合は、代わりにQTcpServer を介して着信接続を受信した際にstartServerEncryption() を呼び出す必要がある。

connectToHost()、startClientEncryption()、waitForConnected()、waitForEncrypted()も参照 。

void QSslSocket::connectToHostEncrypted(const QString &hostName, quint16 port, const QString &sslPeerName, QIODeviceBase::OpenMode mode = ReadWrite, QAbstractSocket::NetworkLayerProtocol protocol = AnyIPProtocol)

これはオーバーロードされた関数である。

connectToHostEncryptedの元の動作に加えて、このオーバーロードされたメソッドでは、TCP接続で使用されるホスト名(hostName)の代わりに、証明書の検証用に別のホスト名(sslPeerName)を使用することができます。

connectToHostEncrypted()も参照 。

[since 6.0] void QSslSocket::continueInterruptedHandshake()

アプリケーションがhandshakeInterruptedOnError() シグナルを受信した後でもハンドシェイクを終了したい場合は、 この関数を呼び出す必要がある。この呼び出しは、シグナルに接続されたスロット関数から行う必要がある。シグナルとスロットの接続は直接でなければなりません。

この関数はQt 6.0で導入されました。

handshakeInterruptedOnError() とQSslConfiguration::setHandshakeMustInterruptOnError()も参照してください 。

[signal] void QSslSocket::encrypted()

このシグナルは、QSslSocket が暗号化モードに入ると発せられます。このシグナルが発せられた後、QSslSocket::isEncrypted() は真を返し、それ以降のソケットの通信はすべて暗号化される。

QSslSocket::connectToHostEncrypted() およびQSslSocket::isEncrypted()も参照のこと 。

qint64 QSslSocket::encryptedBytesAvailable() const

復号化待ちの暗号化バイト数を返す。通常、QSslSocket は受信データをできるだけ早く復号化するので、この関数は 0 を返す。

qint64 QSslSocket::encryptedBytesToWrite() const

ネットワークへの書き込み待ちの暗号化バイト数を返す。

[signal] void QSslSocket::encryptedBytesWritten(qint64 written)

このシグナルは、QSslSocket が暗号化されたデータをネットワークに書き込むときに発せられる。written パラメータには、正常に書き込まれたバイト数が含まれる。

QIODevice::bytesWritten()も参照 。

[signal] void QSslSocket::handshakeInterruptedOnError(const QSslError &error)

QSslSocket 証明書検証エラーが見つかった場合、および で早期エラー報告が有効になっている場合、 このシグナルが発行される。アプリケーションは を検査し、ハンドシェイクを続行するか、中止して相手に警告 メッセージを送信するかを決定することが期待される。シグナルスロット接続は直接接続でなければならない。QSslConfiguration error

continueInterruptedHandshake()、sslErrors()、QSslConfiguration::setHandshakeMustInterruptOnError()も参照のこと 。

[slot] void QSslSocket::ignoreSslErrors()

このスロットは、QSslSocket のハンドシェーク・フェーズのエラーを無視し、 接続を継続するようにQSslSocket に指示する。ハンドシェークフェーズ中にエラーが発生しても接続を続行したい場合は、sslErrors()に接続されたスロットから、またはハンドシェークフェーズの前に、 このスロットを呼び出す必要がある。このスロットを呼び出さない場合は、エラーに応答するか、ハンドシェイクの前に、sslErrors() シグナルが発せられた後に接続は切断されます。

SSLハンドシェークフェーズでエラーがない場合(つまり、問題なく相手のIDが確立されている場合)、QSslSocket はsslErrors() シグナルを発しないので、この関数を呼び出す必要はありません。

sslErrors()も参照のこと 。

void QSslSocket::ignoreSslErrors(const QList<QSslError> &errors)

これはオーバーロードされた関数です。

このメソッドはerrors で与えられたエラーだけを無視するようにQSslSocket に指示します。

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

QSslSocket socket;
socket.ignoreSslErrors(expectedSslErrors);
socket.connectToHostEncrypted("server.tld", 443);

この関数を複数回呼び出すと、前の呼び出しで渡されたエラーのリストが置き換わります。この関数を複数回呼び出すと、前の呼び出しで渡されたエラーのリストが置き換えられます。この関数を空のリストで呼び出すと、無視したいエラーのリストを消去できます。

sslErrors() およびsslHandshakeErrors()も参照 。

[static, since 6.1] QList<QSsl::ImplementedClass> QSslSocket::implementedClasses(const QString &backendName = {})

この関数は、backendName というバックエンドが実装しているバックエンド固有のクラスを返します。空のbackendName は、現在アクティブなバックエンドについての問い合わせとみなされます。

この関数はQt 6.1で導入されました。

QSsl::ImplementedClass 、activeBackend()、isClassImplemented()も参照してください 。

[static, since 6.1] bool QSslSocket::isClassImplemented(QSsl::ImplementedClass cl, const QString &backendName = {})

cl というクラスがbackendName というバックエンドによって実装されている場合に true を返します。空のbackendName は、現在アクティブなバックエンドに関するクエリとして理解されます。

この関数は Qt 6.1 で導入されました。

implementedClasses()も参照 。

bool QSslSocket::isEncrypted() const

ソケットが暗号化されていればtrue を返し、そうでなければ false を返す。

暗号化されたソケットでは、write() またはputChar() を呼び出して書き込まれたデータがネットワークに書き込まれる前にすべて暗号化され、read(),readLine() またはgetChar() を呼び出す前に、ネットワークから受信したデータがすべて復号化される。

QSslSocket 暗号化モードに入ると、 （）を呼び出す。encrypted

sessionCipher() を呼び出すと、データの暗号化と復号にどの暗号が使用されているかを確認でき る。

mode()も参照 。

[static, since 6.1] bool QSslSocket::isFeatureSupported(QSsl::SupportedFeature ft, const QString &backendName = {})

ft という機能がbackendName というバックエンドでサポートされている場合に true を返します。空のbackendName は、現在アクティブなバックエンドに関するクエリとして理解されます。

この関数は Qt 6.1 で導入されました。

QSsl::SupportedFeature およびsupportedFeatures()も参照してください 。

[static, since 6.1] bool QSslSocket::isProtocolSupported(QSsl::SslProtocol protocol, const QString &backendName = {})

backendName というバックエンドがprotocol をサポートしている場合は true を返します。空のbackendName は、現在アクティブなバックエンドに関するクエリとして理解されます。

この関数は Qt 6.1 で導入されました。

supportedProtocols()も参照 。

QSslCertificate QSslSocket::localCertificate() const

ソケットのローカル証明書certificate 、またはローカル証明書が割り当てられていない場合は空の証明書を返す。

setLocalCertificate() およびprivateKey() も参照 。

QList<QSslCertificate> QSslSocket::localCertificateChain() const

ソケットのローカル証明書certificate チェーン(ローカル証明書が割り当てられていない場合は空リスト)を返す。

setLocalCertificateChain() も参照 。

QSslSocket::SslMode QSslSocket::mode() const

QSslSocket がQTcpSocket と同じ動作をするUnencryptedMode か、クライアントがネゴシエーション中か暗号化モードであるSslClientMode またはSslServerMode のいずれかを返す。

モードが変更されると、QSslSocket はmodeChanged() を返す。

SslModeも参照のこと 。

[signal] void QSslSocket::modeChanged(QSslSocket::SslMode mode)

このシグナルは、QSslSocket がQSslSocket::UnencryptedMode からQSslSocket::SslClientMode またはQSslSocket::SslServerMode のいずれかに変更されたときに発信される。mode が新しいモードである。

QSslSocket::mode()も参照 。

[signal] void QSslSocket::newSessionTicketReceived()

ハンドシェイク中にTLS 1.3プロトコルがネゴシエートされた場合、QSslSocket はNewSessionTicketメッセージを受信した後にこのシグナルを発する。セッションとセッションチケットの有効期間ヒントはソケットのコンフィギュレーションで更新される。このセッションは、今後の TLS 接続でセッションの再開(および短縮されたハンドシェイク)に使用できる。

QSslSocket::sslConfiguration()、QSslConfiguration::sessionTicket()、QSslConfiguration::sessionTicketLifeTimeHint()も参照 。

QList<QOcspResponse> QSslSocket::ocspResponses() const

この関数は、OCSP ステープリングを使用した TLS ハンドシェイク中にサーバーが送信する可能性のある Online Certificate Status Protocol レスポンスを返す。明確な応答がない場合、あるいはまったく応答を受け取らなかった場合は、リストは空である。

QSslConfiguration::setOcspStaplingEnabled()も参照のこと 。

QSslCertificate QSslSocket::peerCertificate() const

相手のデジタル証明書（つまり、接続しているホストの即時証明書）、あるいは相手が証明書を割り当てていない場合はヌル証明書を返す。

相手の証明書はハンドシェイクの段階で自動的にチェックされるため、この関数は通常、表示や接続診断の目的で証明書を取得するために使用されます。この関数には、相手のホスト名、証明書の発行者、相手の公開鍵などの情報が含まれています。

ピア証明書はハンドシェーク段階で設定されるため、sslErrors() シグナルまたはencrypted() シグナルに接続されたスロットからピア証明書にアクセスしても安全である。

ヌル証明書が返された場合、SSLハンドシェイクが失敗したことを意味するか、接続先のホストが証明書を持っていないことを意味するか、接続がないことを意味します。

相手の証明書の完全なチェーンを確認したい場合は、peerCertificateChain() を使って一度に取得します。

peerCertificateChain()も参照 。

QList<QSslCertificate> QSslSocket::peerCertificateChain() const

ピアの電子証明書チェーン、または空の証明書リストを返します。

ピアの証明書は、ハンドシェーク時に自動的にチェックされます。この関数は通常、証明書を取得して表示したり、接続診断を行ったりするために使用します。証明書には、ホスト名、発行者名、発行者公開鍵など、相手と証明書発行者に関する情報が含まれています。

ピア証明書は、ハンドシェーク・フェーズ中にQSslSocket で設定されるため、sslErrors() シグナルまたはencrypted() シグナルに接続されたスロットからこの関数をコールしても安全である。

空のリストが返された場合、SSLハンドシェイクが失敗したことを意味するか、接続先のホストが証明書を持っていないことを意味するか、接続がないことを意味します。

相手の直近の証明書だけを取得したい場合は、peerCertificate() を使用する。

peerCertificate()も参照 。

int QSslSocket::peerVerifyDepth() const

SSL ハンドシェークフェーズで確認する相手の証明書チェーンの最大数を返します。最大深度が設定されていない場合は 0 (デフォルト) を返し、証明書チェーン全体を確認する必要があることを示します。

証明書は発行順にチェックされ、ピア自身の証明書から始まり、その発行者の証明書というようにチェックされます。

setPeerVerifyDepth() およびpeerVerifyMode()も参照の こと。

[signal] void QSslSocket::peerVerifyError(const QSslError &error)

QSslSocket は、SSL ハンドシェイクの間、暗号化が確立する前にこのシグナルを何度か発して、相手の ID を確立する際にエラーが発生したことを示すことができます。 は通常、 がピアを安全に識別できないことを示す。error QSslSocket

このシグナルは、何か問題が発生したときに、その兆候を早期に示してくれる。このシグナルに接続することで、ハンドシェイクが完了する前に、接続されたスロットの内部から手動で接続を切断することを選択できる。何もアクションを起こさなければ、QSslSocket はQSslSocket::sslErrors()の発信に進む。

sslErrors()も参照のこと 。

QSslSocket::PeerVerifyMode QSslSocket::peerVerifyMode() const

ソケットのベリファイモードを返す。このモードは、QSslSocket がピアに証明書を要求するか(すなわち、クライアントがサーバに 証明書を要求するか、サーバがクライアントに証明書を要求するか)、その証明書が有効であることを要求するかを決定する。

デフォルトのモードはAutoVerifyPeer で、QSslSocket に、クライアントにはVerifyPeer 、サーバーにはQueryPeer を使用するように指示する。

setPeerVerifyMode()、peerVerifyDepth()、mode()も参照 。

QString QSslSocket::peerVerifyName() const

setPeerVerifyName またはconnectToHostEncrypted で設定された、証明書検証用の別のホスト名を返す。

setPeerVerifyName() およびconnectToHostEncrypted()も参照 。

[signal] void QSslSocket::preSharedKeyAuthenticationRequired(QSslPreSharedKeyAuthenticator *authenticator)

QSslSocket は、PSK暗号化方式をネゴシエートする際にこのシグナルを発行するため、 PSK認証が必要となる。

PSKを使う場合、クライアントはSSLハンドシェイクを続けるために、有効なIDと有効な事前共有鍵をサーバーに送らなければなりません。アプリケーションはこのシグナルに接続されたスロットに、渡されたauthenticator オブジェクトを必要に応じて入力することで、この情報を提供することができます。

QSslPreSharedKeyAuthenticatorも参照のこと 。

QSslKey QSslSocket::privateKey() const

このソケットの秘密鍵を返す。

setPrivateKey() およびlocalCertificate() も参照する こと。

QSsl::SslProtocol QSslSocket::protocol() const

ソケットの SSL プロトコルを返す。デフォルトではQSsl::SecureProtocols が使用される。

setProtocol()も参照 。

[override virtual protected] qint64 QSslSocket::readData(char *data, qint64 maxlen)

再実装する：QAbstractSocket::readData(char *data, qint64 maxSize).

[override virtual] void QSslSocket::resume()

再実装: (char *data, qint64 maxSize)：QAbstractSocket::resume().

一時停止したソケットのデータ転送を継続する。このソケットで "setPauseMode(QAbstractSocket::PauseOnSslErrors);" が呼び出され、sslErrors() シグナルを受信した場合、ソケットのデータ転送を継続するためにこのメソッドを呼び出す必要がある。

QAbstractSocket::pauseMode() およびQAbstractSocket::setPauseMode()も参照すること 。

QSslCipher QSslSocket::sessionCipher() const

ソケットの暗号化方式cipher を返し、接続が暗号化されていない場合は NULL 暗号を返す。セッションのソケット暗号はハンドシェークフェーズで設定される。この暗号は、ソケットを介して送信されるデータの暗号化・復号化に使用される。

QSslSocket また、ハンドシェークフェーズで最終的にセッション暗号を選択する暗号の順序リストを設定する関数も提供する。この順序付きリストはハンドシェークフェーズが始まる前に設定されていなければならない。

QSslConfiguration::ciphers(),QSslConfiguration::setCiphers(),QSslConfiguration::setCiphers(),QSslConfiguration::ciphers(),QSslConfiguration::supportedCiphers()も参照のこと 。

QSsl::SslProtocol QSslSocket::sessionProtocol() const

ソケットの SSL/TLS プロトコル、または接続が暗号化されていない場合は UnknownProtocol を返す。セッションのソケットプロトコルはハンドシェークフェーズで設定される。

protocol() およびsetProtocol()も参照 。

[static, since 6.1] bool QSslSocket::setActiveBackend(const QString &backendName)

backendName という名前のバックエンドがアクティブなバックエンドとして設定されていた場合は true を返す。backendName はavailableBackends() が返す名前のいずれかでなければならない。

この関数は Qt 6.1 で導入されました。

activeBackend() やavailableBackends()も参照 。

void QSslSocket::setLocalCertificate(const QSslCertificate &certificate)

ソケットのローカル証明書をcertificate に設定する。 ローカル証明書は、相手に対して自分の身元を確認する必要がある場合に必要である。ローカル証明書を設定する場合、秘密鍵も設定する必要がある。

ローカル証明書と秘密鍵は、サーバー・ソケットでは常に必要ですが、サーバーがクライアントの認証を必要とする場合、クライアント・ソケットでもまれに使用されます。

localCertificate() およびsetPrivateKey()も参照 。

void QSslSocket::setLocalCertificate(const QString &path, QSsl::EncodingFormat format = QSsl::Pem)

これはオーバーロードされた関数である。

ソケットのローカルcertificate を、指定されたformat に従って解析されたファイルpath で最初に見つかったものに設定する。

void QSslSocket::setLocalCertificateChain(const QList<QSslCertificate> &localChain)

SSL ハンドシェーク中に相手に提示する証明書チェーンをlocalChain に設定する。

localCertificateChain() およびQSslConfiguration::setLocalCertificateChain()も参照 。

void QSslSocket::setPeerVerifyDepth(int depth)

SSL ハンドシェーク・フェーズ中に確認する、ピアの証明書チェーン内の証明書の最大数をdepth に設定します。 深さを 0 に設定すると、最大深さが設定されないことになり、証明書チェーン全体を確認する必要があることを示します。

証明書は発行順にチェックされ、ピア自身の証明書から始まり、その発行者の証明書というようにチェックされます。

peerVerifyDepth() およびsetPeerVerifyMode()も参照の こと。

void QSslSocket::setPeerVerifyMode(QSslSocket::PeerVerifyMode mode)

ソケットのベリファイモードをmode に設定する。このモードは、QSslSocket がピアに証明書を要求するか(すなわち、クライアントがサーバに証明書を要求するか、サーバがクライアントに証明書を要求するか)、この証明書が有効であることを要求するかを決定する。

デフォルトのモードはAutoVerifyPeer で、QSslSocket に、クライアントにはVerifyPeer 、サーバーにはQueryPeer を使用するように指示する。

暗号化の開始後にこのモードを設定しても、現在の接続には影響しない。

peerVerifyMode()、setPeerVerifyDepth()、mode()も参照のこと 。

void QSslSocket::setPeerVerifyName(const QString &hostName)

証明書の検証用に、TCP接続に使用されるホスト名ではなく、hostName で指定される 別のホスト名を設定する。

peerVerifyName() およびconnectToHostEncrypted()も参照のこと 。

void QSslSocket::setPrivateKey(const QSslKey &key)

ソケットの秘密鍵key をkey に設定する。秘密鍵とローカル証明書certificate は、SSLピアに対して自分の身元を証明する必要があるクライアントとサーバで使用される。

SSL サーバーソケットを作成する場合は、キーとローカル証明書の両方が必要です。SSLクライアントソケットを作成する場合、クライアントがSSLサーバーに対して自身を識別する必要がある場合は、キーとローカル証明書が必要です。

privateKey() とsetLocalCertificate()も参照のこと 。

void QSslSocket::setPrivateKey(const QString &fileName, QSsl::KeyAlgorithm algorithm = QSsl::Rsa, QSsl::EncodingFormat format = QSsl::Pem, const QByteArray &passPhrase = QByteArray())

これはオーバーロードされた関数です。

ファイルfileName の文字列を読み込み、指定されたalgorithm とエンコードformat を用いてデコードし、SSL key を構築する。 エンコードされた鍵が暗号化されている場合、passPhrase を用いて復号化する。

ソケットの秘密鍵は構築された鍵に設定される。秘密鍵とローカル証明書certificate は、クライアントとサーバがSSLピアに対して自分の身元を証明するために使われる。

SSL サーバーソケットを作成する場合は、鍵とローカル証明書の両方が必要である。SSLクライアントソケットを作成する場合、クライアントがSSLサーバーに対して自身を識別する必要がある場合は、鍵とローカル証明書が必要です。

privateKey() およびsetLocalCertificate()も参照 。

void QSslSocket::setProtocol(QSsl::SslProtocol protocol)

ソケットのSSLプロトコルをprotocol に設定する。 これは、次にハンドシェークを開始するときに影響する。すでに暗号化されているソケットでこの関数を呼んでも、ソケットのプロトコルに影響しない。

protocol()も参照 。

[override virtual] void QSslSocket::setReadBufferSize(qint64 size)

再インプリメント：QAbstractSocket::setReadBufferSize(qint64 size).

QSslSocket の内部読み込みバッファのサイズをsize バイトに設定する。

[override virtual] bool QSslSocket::setSocketDescriptor(qintptr socketDescriptor, QAbstractSocket::SocketState state = ConnectedState, QIODeviceBase::OpenMode openMode = ReadWrite)

再実装する：QAbstractSocket::setSocketDescriptor(qintptr socketDescriptor, QAbstractSocket::SocketState socketState, QIODeviceBase::OpenMode openMode)。

ネイティブソケットディスクリプタsocketDescriptor でQSslSocket を初期化する。socketDescriptor が有効なソケットディスクリプタとして受け入れられた場合はtrue を返し、そうでない場合はfalse を返す。ソケットはopenMode で指定されたモードでオープンされ、state で指定されたソケット状態になる。

socketDescriptor()も参照のこと 。

[override virtual] void QSslSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

再実装：QAbstractSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value).

与えられたoption をvalue で指定された値に設定する。

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

void QSslSocket::setSslConfiguration(const QSslConfiguration &configuration)

ソケットのSSL設定をconfiguration の内容に設定する。 この関数は、ローカル証明書、暗号化方式、秘密鍵、CA証明書をconfiguration に格納されているものに設定する。

SSL-state関連フィールドを設定することはできない。

sslConfiguration(),setLocalCertificate(),setPrivateKey(),QSslConfiguration::setCaCertificates(),QSslConfiguration::setCiphers()も参照 。

[override virtual protected] qint64 QSslSocket::skipData(qint64 maxSize)

再インプリメント：QAbstractSocket::skipData(qint64 maxSize) を参照してください。

[override virtual] QVariant QSslSocket::socketOption(QAbstractSocket::SocketOption option)

再リプリメント：QAbstractSocket::socketOption(QAbstractSocket::SocketOption option)。

option オプションの値を返します。

setSocketOption()も参照 。

QSslConfiguration QSslSocket::sslConfiguration() const

ソケットのSSL設定状態を返す。ソケットのデフォルトのSSL設定は、デフォルトの暗号化方式、デフォルトのCA証明書、ローカルの秘密鍵や証明書を使用しないことである。

SSL設定には、予告なしに変更される可能性のあるフィールドも含まれる。

setSslConfiguration(),localCertificate(),peerCertificate(),peerCertificateChain(),sessionCipher(),privateKey(),QSslConfiguration::ciphers(),QSslConfiguration::caCertificates()も参照の こと。

[signal] void QSslSocket::sslErrors(const QList<QSslError> &errors)

QSslSocket は SSL ハンドシェイクの後にこのシグナルを発行し、 ピアの ID を確立する際に一つ以上のエラーが発生したことを示す。エラーは通常、 がピアを安全に識別できないことを示す。何らかのアクションを取らない限り、このシグナルが発せられた後に接続は切断されます。QSslSocket

エラーが発生したにもかかわらず接続を続行したい場合は、このシグナルに接続されたスロットの内部からQSslSocket::ignoreSslErrors() を呼び出す必要がある。後の時点でエラー・リストにアクセスする必要がある場合は、sslHandshakeErrors() を呼び出すことができる。

errors には、 がピアの ID を検証できないようなエラーが 1 つ以上含まれています。QSslSocket

peerVerifyError()も参照 。

QList<QSslError> QSslSocket::sslHandshakeErrors() const

最後に発生した SSL エラーのリストを返します。これは、QSslSocket がsslErrors() シグナル経由で渡すリストと同じです。接続が暗号化されており、エラーも発生していない場合、この関数は空のリストを返します。

connectToHostEncrypted()も参照 。

[static] long QSslSocket::sslLibraryBuildVersionNumber()

コンパイル時に使用されている SSL ライブラリのバージョン番号を返します。SSL サポートがない場合は -1 を返します。

sslLibraryVersionNumber()も参照 。

[static] QString QSslSocket::sslLibraryBuildVersionString()

コンパイル時に使用されている SSL ライブラリのバージョン文字列を返します。SSL サポートがない場合は空の値を返します。

sslLibraryVersionString()も参照 。

[static] long QSslSocket::sslLibraryVersionNumber()

使用中の SSL ライブラリのバージョン番号を返します。これはコンパイル時ではなく、実行時に使用されているライブラリのバージョンであることに注意してください。SSL サポートがない場合は -1 を返します。

[static] QString QSslSocket::sslLibraryVersionString()

使用中の SSL ライブラリのバージョン文字列を返します。これはコンパイル時ではなく、実行時に使用されているライブラリのバージョンであることに注意してください。SSL サポートが利用できない場合、空の値を返します。

[slot] void QSslSocket::startClientEncryption()

クライアント接続の遅延SSLハンドシェイクを開始する。この関数は、ソケットがConnectedState にあるが、まだUnencryptedMode にあるときに呼び出される。 まだ接続されていないか、すでに暗号化されている場合、この関数は何の効果もない。

STARTTLS機能を実装しているクライアントは、遅延SSLハンドシェイクを利用することが多い。他のほとんどのクライアントは、ハンドシェイクを自動的に実行するconnectToHostEncrypted() を代わりに使うことで、この関数を直接呼び出すことを避けることができる。

connectToHostEncrypted() とstartServerEncryption()も参照のこと 。

[slot] void QSslSocket::startServerEncryption()

サーバ接続の遅延SSLハンドシェイクを開始する。この関数は、ソケットがConnectedState にあるが、まだUnencryptedMode にあるときに呼び出すことができる。 ソケットが接続されていないか、すでに暗号化されている場合、この関数は何の効果もない。

サーバーソケットでは、この関数を呼び出すことがSSLハンドシェイクを開始する唯一の方法である。ほとんどのサーバーはコネクションを受け取った直後、もしくはSSLモードに入るためのプロトコル固有のコマンドを受け取った結果として、この関数を呼び出します(例えば、サーバーは "STARTTLSrRNA "という文字列を受け取ると、この関数を呼び出して応答します)。

SSLサーバーを実装する最も一般的な方法は、QTcpServer のサブクラスを作成し、QTcpServer::incomingConnection() を再実装することである。返されたソケットディスクリプタはQSslSocket::setSocketDescriptor() に渡される。

connectToHostEncrypted() とstartClientEncryption()も参照のこと 。

[static, since 6.1] QList<QSsl::SupportedFeature> QSslSocket::supportedFeatures(const QString &backendName = {})

この関数はbackendName というバックエンドがサポートする機能を返す。空のbackendName は、現在アクティブなバックエンドに関する問い合わせとして理解される。

この関数は Qt 6.1 で導入されました。

QSsl::SupportedFeature およびactiveBackend()も参照してください 。

[static, since 6.1] QList<QSsl::SslProtocol> QSslSocket::supportedProtocols(const QString &backendName = {})

backendName という名前のバックエンドが利用可能な場合、この関数はこのバックエンドがサポートする TLS プロトコルのバージョンのリストを返します。空のbackendName は、現在アクティブなバックエンドについての問い合わせとして理解される。そうでない場合、この関数は空のリストを返します。

この関数は Qt 6.1 で導入されました。

availableBackends(),activeBackend(),isProtocolSupported()も参照してください 。

[static] bool QSslSocket::supportsSsl()

このプラットフォームがSSLをサポートしている場合はtrue を返し、そうでない場合は false を返します。そうでない場合は false を返します。プラットフォームが SSL をサポートしていない場合、ソケットは接続フェーズで失敗します。

[override virtual] bool QSslSocket::waitForBytesWritten(int msecs = 30000)

再インプリメント：QAbstractSocket::waitForBytesWritten(int msecs) を返します。

[override virtual] bool QSslSocket::waitForConnected(int msecs = 30000)

再インプリメント: (int msecs)：QAbstractSocket::waitForConnected(int msecs).

ソケットが接続されるか、msecs ミリ秒のどちらか先になるまで待つ。接続が確立された場合、この関数はtrue を返し、そうでない場合はfalse を返す。

QAbstractSocket::waitForConnected()も参照のこと 。

[override virtual] bool QSslSocket::waitForDisconnected(int msecs = 30000)

再インプリメント：QAbstractSocket::waitForDisconnected(int msecs).

ソケットが切断されるかmsecs ミリ秒のどちらか早い方まで待つ。接続が切断された場合、この関数はtrue を返し、そうでない場合はfalse を返す。

QAbstractSocket::waitForDisconnected()も参照のこと 。

bool QSslSocket::waitForEncrypted(int msecs = 30000)

ソケットがSSLハンドシェイクを完了し、encrypted() を発行するまで待機する、またはmsecs ミリ秒のどちらか早い方。encrypted() が発信された場合、この関数は真を返す。そうでない場合(ソケットが切断された、SSLハンドシェイクに失敗したなど)、偽を返す。

以下の例では、ソケットが暗号化されるまで最大1秒待つ：

socket->connectToHostEncrypted("imap", 993);
if (socket->waitForEncrypted(1000))
    qDebug("Encrypted!");

msecs が -1 の場合、この関数はタイムアウトしない。

startClientEncryption(),startServerEncryption(),encrypted(),isEncrypted()も参照の こと。

[override virtual] bool QSslSocket::waitForReadyRead(int msecs = 30000)

再インプリメント：QAbstractSocket::waitForReadyRead(int msecs)。

[override virtual protected] qint64 QSslSocket::writeData(const char *data, qint64 len)

再インプリメント：QAbstractSocket::writeData(const char *data, qint64 size)。