diff options
author | Luca Di Sera <luca.disera@qt.io> | 2021-09-15 16:41:31 +0200 |
---|---|---|
committer | Luca Di Sera <luca.disera@qt.io> | 2021-09-16 15:52:27 +0200 |
commit | 10eedd175e99a8be191d116d5c81c340d6c3c5b6 (patch) | |
tree | 5d9feef6004d00495fc7960b2a038ebd785856ab /src/network | |
parent | 0246bfd40a2cc5ea9cfc035146e6dd865b334c68 (diff) |
Doc: Centralize RFC documentation-links in rfc.qdoc
In the effort of repairing broken links as per QTBUG-96127,
a series of RFC links referring to `tools.ietf.org/html/*` were modified
to point to the new address that the site redirected to.
To simplify executing a similar task and to diminish the duplication of
manually inserted urls, the already existing `rfc.qdoc` file, containing
`\externalpage` commands directing to RFC locations, was enhanced with
links to all RFCs that were mentioned in the current documentation, so
as to aggregate this common category of links.
All links pointing to a `ietf` domain inside QDoc documentation blocks
were then changed to use the newly provided external-references.
Task-number: QTBUG-96127
Pick-to: 6.2
Change-Id: I2a52eb6aa8c9e346f64ef1a627b039220d9f6c2a
Reviewed-by: MÃ¥rten Nordheim <marten.nordheim@qt.io>
Diffstat (limited to 'src/network')
-rw-r--r-- | src/network/doc/src/ssl.qdoc | 2 | ||||
-rw-r--r-- | src/network/kernel/qhostaddress.cpp | 2 | ||||
-rw-r--r-- | src/network/kernel/qhostinfo.cpp | 5 | ||||
-rw-r--r-- | src/network/ssl/qdtls.cpp | 8 | ||||
-rw-r--r-- | src/network/ssl/qocspresponse.cpp | 2 | ||||
-rw-r--r-- | src/network/ssl/qpassworddigestor.cpp | 4 | ||||
-rw-r--r-- | src/network/ssl/qssl.cpp | 2 | ||||
-rw-r--r-- | src/network/ssl/qtlsbackend.cpp | 2 |
8 files changed, 13 insertions, 14 deletions
diff --git a/src/network/doc/src/ssl.qdoc b/src/network/doc/src/ssl.qdoc index ed04e13487..2dcae744ac 100644 --- a/src/network/doc/src/ssl.qdoc +++ b/src/network/doc/src/ssl.qdoc @@ -72,7 +72,7 @@ eavesdropping, tampering, or message forgery. The DTLS protocol is based on the stream-oriented Transport Layer Security (TLS) protocol. QtNetwork enables the use of DTLS with User Datagram Protocol (UDP), as defined by - \l {https://tools.ietf.org/html/rfc6347}{RFC 6347}. + \l {RFC 6347}. \section1 Import and Export Restrictions diff --git a/src/network/kernel/qhostaddress.cpp b/src/network/kernel/qhostaddress.cpp index 1418d42334..b614c65cfb 100644 --- a/src/network/kernel/qhostaddress.cpp +++ b/src/network/kernel/qhostaddress.cpp @@ -1143,7 +1143,7 @@ bool QHostAddress::isLoopback() const Note that IPv6 unique local unicast addresses are considered global addresses (see isUniqueLocalUnicast()), as are IPv4 addresses reserved for - local networks by \l {https://tools.ietf.org/html/rfc1918}{RFC 1918}. + local networks by \l {RFC 1918}. Also note that IPv6 site-local addresses are deprecated and should be considered as global in new applications. This function returns true for diff --git a/src/network/kernel/qhostinfo.cpp b/src/network/kernel/qhostinfo.cpp index fbc3248815..fdf2844447 100644 --- a/src/network/kernel/qhostinfo.cpp +++ b/src/network/kernel/qhostinfo.cpp @@ -234,7 +234,7 @@ bool QHostInfoResult::event(QEvent *event) QHostInfo::localHostName() function. QHostInfo uses the mechanisms provided by the operating system - to perform the lookup. As per {https://tools.ietf.org/html/rfc6724}{RFC 6724} + to perform the lookup. As per \l {RFC 6724} there is no guarantee that all IP addresses registered for a domain or host will be returned. @@ -245,8 +245,7 @@ bool QHostInfoResult::event(QEvent *event) \note Since Qt 4.6.3 QHostInfo is using a small internal 60 second DNS cache for performance improvements. - \sa QAbstractSocket, {http://www.rfc-editor.org/rfc/rfc3492.txt}{RFC 3492}, - {https://tools.ietf.org/html/rfc6724}{RFC 6724} + \sa QAbstractSocket, {RFC 3492}, {RFC 6724} */ static int nextId() diff --git a/src/network/ssl/qdtls.cpp b/src/network/ssl/qdtls.cpp index e62a4b4043..e315ba9910 100644 --- a/src/network/ssl/qdtls.cpp +++ b/src/network/ssl/qdtls.cpp @@ -58,7 +58,7 @@ The QDtlsClientVerifier class implements server-side DTLS cookie generation and verification. Datagram security protocols are highly susceptible to a - variety of Denial-of-Service attacks. According to \l {https://tools.ietf.org/html/rfc6347#section-4.2.1}{RFC 6347, section 4.2.1}, + variety of Denial-of-Service attacks. According to \l {RFC 6347, section 4.2.1}, these are two of the more common types of attack: \list @@ -71,7 +71,7 @@ which can be quite large, thus flooding the victim machine with datagrams. \endlist - As a countermeasure to these attacks, \l {https://tools.ietf.org/html/rfc6347#section-4.2.1}{RFC 6347, section 4.2.1} + As a countermeasure to these attacks, \l {RFC 6347, section 4.2.1} proposes a stateless cookie technique that a server may deploy: \list @@ -119,7 +119,7 @@ \note The default secret is shared by all objects of the classes QDtlsClientVerifier and QDtls. Since this can impose security risks, RFC 6347 recommends to change - the server's secret frequently. Please see \l {https://tools.ietf.org/html/rfc6347}{RFC 6347, section 4.2.1} + the server's secret frequently. Please see \l {RFC 6347, section 4.2.1} for hints about possible server implementations. Cookie generator parameters can be set using the class QDtlsClientVerifier::GeneratorParameters and setCookieGeneratorParameters(): @@ -250,7 +250,7 @@ \warning It's recommended to call shutdown() before destroying the client's QDtls object if you are planning to re-use the same port number to connect to the server later. Otherwise, the server may drop incoming ClientHello messages, - see \l{https://tools.ietf.org/html/rfc6347#page-25}{RFC 6347, section 4.2.8} + see \l {RFC 6347, section 4.2.8} for more details and implementation hints. If the server does not use QDtlsClientVerifier, it \e must configure its diff --git a/src/network/ssl/qocspresponse.cpp b/src/network/ssl/qocspresponse.cpp index b63312506d..c69c463345 100644 --- a/src/network/ssl/qocspresponse.cpp +++ b/src/network/ssl/qocspresponse.cpp @@ -95,7 +95,7 @@ QT_BEGIN_NAMESPACE \inmodule QtNetwork - This enumeration describes revocation reasons, defined in \l{https://tools.ietf.org/html/rfc5280#section-5.3.1}{RFC 5280, section 5.3.1} + This enumeration describes revocation reasons, defined in \l{RFC 5280, section 5.3.1} \value None \value Unspecified diff --git a/src/network/ssl/qpassworddigestor.cpp b/src/network/ssl/qpassworddigestor.cpp index 706fa1de05..248336dd8e 100644 --- a/src/network/ssl/qpassworddigestor.cpp +++ b/src/network/ssl/qpassworddigestor.cpp @@ -60,7 +60,7 @@ namespace QPasswordDigestor { \since 5.12 Returns a hash computed using the PBKDF1-algorithm as defined in - \l {https://tools.ietf.org/html/rfc8018#section-5.1} {RFC 8018}. + \l {RFC 8018, section 5.1}. The function takes the \a data and \a salt, and then hashes it repeatedly for \a iterations iterations using the specified hash \a algorithm. If the @@ -126,7 +126,7 @@ Q_NETWORK_EXPORT QByteArray deriveKeyPbkdf1(QCryptographicHash::Algorithm algori \since 5.12 Derive a key using the PBKDF2-algorithm as defined in - \l {https://tools.ietf.org/html/rfc8018#section-5.2} {RFC 8018}. + \l {RFC 8018, section 5.2}. This function takes the \a data and \a salt, and then applies HMAC-X, where the X is \a algorithm, repeatedly. It internally concatenates intermediate diff --git a/src/network/ssl/qssl.cpp b/src/network/ssl/qssl.cpp index 515970175e..8ece3b091f 100644 --- a/src/network/ssl/qssl.cpp +++ b/src/network/ssl/qssl.cpp @@ -204,7 +204,7 @@ Q_LOGGING_CATEGORY(lcSsl, "qt.network.ssl"); \ingroup ssl \inmodule QtNetwork - See \l{https://tools.ietf.org/html/rfc8446#page-85}{RFC 8446, section 6} + See \l{RFC 8446, section 6} for the possible values and their meaning. \value CloseNotify, diff --git a/src/network/ssl/qtlsbackend.cpp b/src/network/ssl/qtlsbackend.cpp index d45deeadf1..f6a25a85cb 100644 --- a/src/network/ssl/qtlsbackend.cpp +++ b/src/network/ssl/qtlsbackend.cpp @@ -2083,7 +2083,7 @@ DtlsBase::~DtlsBase() = default; and \c false otherwise. If no valid cookie was found in the \a dgram, this verifier should use \a socket to send a HelloVerifyRequest message, using \a address and \a port as the destination and a source material for cookie generation, see also - \l {https://tools.ietf.org/html/rfc6347#section-4.2.1}{RFC 6347, section 4.2.1} + \l {RFC 6347, section 4.2.1} \sa QDtlsClientVerifier */ |