diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/base.h | 2 | ||||
| -rw-r--r-- | include/modules.h | 2 | ||||
| -rw-r--r-- | include/modules/ssl.h | 40 |
3 files changed, 22 insertions, 22 deletions
diff --git a/include/base.h b/include/base.h index deeabf255..41ed723c5 100644 --- a/include/base.h +++ b/include/base.h @@ -239,7 +239,7 @@ enum ServiceType { SERVICE_METADATA, /** is a data processing provider (MD5, SQL) */ SERVICE_DATA, - /** is an I/O hook provider (SSL) */ + /** is an I/O hook provider */ SERVICE_IOHOOK, /** Service managed by a module */ SERVICE_CUSTOM diff --git a/include/modules.h b/include/modules.h index 75bbcb8de..82684cac8 100644 --- a/include/modules.h +++ b/include/modules.h @@ -376,7 +376,7 @@ class CoreExport Module : public classbase, public usecountbase /** Called on rehash. * This method is called when a user initiates a module-specific rehash. This can be used to do - * expensive operations (such as reloading SSL certificates) that are not executed on a normal + * expensive operations (such as reloading TLS (SSL) certificates) that are not executed on a normal * rehash for efficiency. A rehash of this type does not reload the core configuration. * * @param user The user performing the rehash. diff --git a/include/modules/ssl.h b/include/modules/ssl.h index 88a6751e4..01e08b2e2 100644 --- a/include/modules/ssl.h +++ b/include/modules/ssl.h @@ -30,7 +30,7 @@ #include <string> #include "iohook.h" -/** ssl_cert is a class which abstracts SSL certificate +/** ssl_cert is a class which abstracts TLS (SSL) certificate * and key information. * * Because gnutls and openssl represent key information in @@ -153,7 +153,7 @@ class ssl_cert : public refcountbase class SSLIOHook : public IOHook { protected: - /** Peer SSL certificate, set by the SSL module + /** Peer TLS (SSL) certificate, set by the TLS (SSL) module */ reference<ssl_cert> certificate; @@ -167,7 +167,7 @@ class SSLIOHook : public IOHook if ((sendq.size() <= 1) || (sendq.front().length() >= targetsize)) return; - // Avoid multiple repeated SSL encryption invocations + // Avoid multiple repeated TLS (SSL) encryption invocations // This adds a single copy of the queue, but avoids // much more overhead in terms of system calls invoked // by an IOHook. @@ -198,7 +198,7 @@ class SSLIOHook : public IOHook /** * Get the certificate sent by this peer - * @return The SSL certificate sent by the peer, NULL if no cert was sent + * @return The TLS (SSL) certificate sent by the peer, NULL if no cert was sent */ virtual ssl_cert* GetCertificate() const { @@ -207,7 +207,7 @@ class SSLIOHook : public IOHook /** * Get the fingerprint of the peer's certificate - * @return The fingerprint of the SSL client certificate sent by the peer, + * @return The fingerprint of the TLS (SSL) client certificate sent by the peer, * empty if no cert was sent */ virtual std::string GetFingerprint() const @@ -225,14 +225,14 @@ class SSLIOHook : public IOHook virtual void GetCiphersuite(std::string& out) const = 0; - /** Retrieves the name of the SSL connection which is sent via SNI. + /** Retrieves the name of the TLS (SSL) connection which is sent via SNI. * @param out String that the server name will be appended to. * returns True if the server name was retrieved; otherwise, false. */ virtual bool GetServerName(std::string& out) const = 0; }; -/** Helper functions for obtaining SSL client certificates and key fingerprints +/** Helper functions for obtaining TLS (SSL) client certificates and key fingerprints * from StreamSockets */ class SSLClientCert @@ -240,8 +240,8 @@ class SSLClientCert public: /** * Get the client certificate from a socket - * @param sock The socket to get the certificate from, the socket does not have to use SSL - * @return The SSL client certificate information, NULL if the peer is not using SSL + * @param sock The socket to get the certificate from, the socket does not have to use TLS (SSL) + * @return The TLS (SSL) client certificate information, NULL if the peer is not using TLS (SSL) */ static ssl_cert* GetCertificate(StreamSocket* sock) { @@ -255,9 +255,9 @@ class SSLClientCert /** * Get the fingerprint of a client certificate from a socket * @param sock The socket to get the certificate fingerprint from, the - * socket does not have to use SSL - * @return The key fingerprint from the SSL certificate sent by the peer, - * empty if no cert was sent or the peer is not using SSL + * socket does not have to use TLS (SSL) + * @return The key fingerprint from the TLS (SSL) certificate sent by the peer, + * empty if no cert was sent or the peer is not using TLS (SSL) */ static std::string GetFingerprint(StreamSocket* sock) { @@ -276,22 +276,22 @@ class UserCertificateAPIBase : public DataProvider { } - /** Get the SSL certificate of a user + /** Get the TLS (SSL) certificate of a user * @param user The user whose certificate to get, user may be remote - * @return The SSL certificate of the user or NULL if the user is not using SSL + * @return The TLS (SSL) certificate of the user or NULL if the user is not using TLS (SSL) */ virtual ssl_cert* GetCertificate(User* user) = 0; - /** Set the SSL certificate of a user. + /** Set the TLS (SSL) certificate of a user. * @param user The user whose certificate to set. - * @param cert The SSL certificate to set for the user. + * @param cert The TLS (SSL) certificate to set for the user. */ virtual void SetCertificate(User* user, ssl_cert* cert) = 0; /** Get the key fingerprint from a user's certificate * @param user The user whose key fingerprint to get, user may be remote - * @return The key fingerprint from the user's SSL certificate or an empty string - * if the user is not using SSL or did not provide a client certificate + * @return The key fingerprint from the user's TLS (SSL) certificate or an empty string + * if the user is not using TLS (SSL) or did not provide a client certificate */ std::string GetFingerprint(User* user) { @@ -302,9 +302,9 @@ class UserCertificateAPIBase : public DataProvider } }; -/** API implemented by m_sslinfo that allows modules to retrive the SSL certificate +/** API implemented by m_sslinfo that allows modules to retrive the TLS (SSL) certificate * information of local and remote users. It can also be used to find out whether a - * user is using SSL or not. + * user is using TLS (SSL) or not. */ class UserCertificateAPI : public dynamic_reference<UserCertificateAPIBase> { |