Skip to content

Commit a7766d8

Browse files
authored
mongo/util/net/README.md: fix some links
Fixex a few code links in mongo/util/net/README.md. Note that this still leaves some of the links or descriptions outdated (e.g. the "The Transport Layer" seems to link to some files that do not exist anymore).
1 parent a1c9ea9 commit a7766d8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/mongo/util/net/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ implementations of TLS:
3535
available exclusively on _MacOS_.
3636

3737
We manage TLS through an interface called
38-
[`SSLManagerInterface`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L181). There are
38+
[`SSLManagerInterface`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L204). There are
3939
three different implementations of this interface for each implementation of TLS respectively:
4040

4141
1. [`SSLManagerOpenSSL`](ssl_manager_openssl.cpp)
@@ -44,10 +44,10 @@ three different implementations of this interface for each implementation of TLS
4444

4545
Every SSLManager has a set of key methods that describe the general idea of establishing a connection over TLS:
4646

47-
- [`connect`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L193): initiates a TLS connection
48-
- [`accept`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L201): waits for a peer to
47+
- [`connect`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L241): initiates a TLS connection
48+
- [`accept`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L249): waits for a peer to
4949
initiate a TLS connection
50-
- [`parseAndValidatePeerCertificate`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L268):
50+
- [`parseAndValidatePeerCertificate`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L381):
5151
parses a certificate acquired from a peer during connection negotiation and validates it.
5252

5353
The SSLManagers are wrappers around these TLS implementations such that they conform to our practices and standards, and
@@ -91,10 +91,10 @@ into certificates along with the public key and certificate metadata. Internal a
9191
stored in the database, is more commonly used for acquiring access rights, and X.509 authorization is not a typical
9292
use case of certificates in general. We do not provide any utility for generating these unique certificates, but the
9393
logic for parsing them is in
94-
[`parsePeerRoles`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L294).
94+
[`parsePeerRoles`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L458).
9595

9696
X.509 certificates _are_ commonly used for _authentication_.
97-
[`SSLManager::parseAndValidatePeerCertificate`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L268)
97+
[`SSLManager::parseAndValidatePeerCertificate`](https://github.com/mongodb/mongo/blob/master/src/mongo/util/net/ssl_manager.h#L381)
9898
extracts information required for authentication, such as the client name, during connection negotiation. We use
9999
TLS for authentication, as being able to successfully perform a cryptographic handshake after key exchange should be as
100100
sufficient proof of authenticity as providing a username and password. This idea is the same as using one's RSA public
@@ -104,7 +104,7 @@ with TLS (using the
104104
mechanism), it receives a certificate from the client during the initial TLS handshake, extracts the subject name, which
105105
MongoDB will consider a username, and performs the cryptographic handshake. If the handshake succeeds, then the server
106106
will note that the client proved ownership of the presented certificate. The authentication logic happens in the
107-
[`authX509`](https://github.com/mongodb/mongo/blob/master/src/mongo/client/authenticate.cpp#L127) function, although
107+
[`authX509`](https://github.com/mongodb/mongo/blob/master/src/mongo/client/authenticate.cpp#L135-L147) function, although
108108
there are many callers of this function that use it in different ways. Later, when that client tries to authenticate,
109109
the server will know that the previous TLS handshake has proved their authenticity, and will grant themm the appropriate
110110
access rights.

0 commit comments

Comments
 (0)