aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/tls
diff options
context:
space:
mode:
authorRenĂ© Korthaus <[email protected]>2016-10-18 16:38:50 +0200
committerRenĂ© Korthaus <[email protected]>2016-10-19 09:13:45 +0200
commitda2e26b15f7f6882768f1cb7e8a5be1b1893bf8a (patch)
treeb83ce7adb7b8837981c210662675941febc645c4 /src/lib/tls
parent99d71e5693f45c2b34528158ad8d8b641bcc87e3 (diff)
Fix doxygen warnings [ci skip]
Diffstat (limited to 'src/lib/tls')
-rw-r--r--src/lib/tls/tls_callbacks.h14
-rw-r--r--src/lib/tls/tls_channel.h6
-rw-r--r--src/lib/tls/tls_client.h4
-rw-r--r--src/lib/tls/tls_messages.h1
-rw-r--r--src/lib/tls/tls_policy.h4
-rw-r--r--src/lib/tls/tls_record.h7
-rw-r--r--src/lib/tls/tls_session_key.h8
7 files changed, 25 insertions, 19 deletions
diff --git a/src/lib/tls/tls_callbacks.h b/src/lib/tls/tls_callbacks.h
index 75887c23f..17cd19b81 100644
--- a/src/lib/tls/tls_callbacks.h
+++ b/src/lib/tls/tls_callbacks.h
@@ -126,23 +126,27 @@ class BOTAN_DLL Compat_Callbacks final : public Callbacks
*
* @param alert_cb is called when a TLS alert is received
*
- * @param handshake_cb is called when a handshake is completed
+ * @param hs_cb is called when a handshake is completed
+ *
+ * @param hs_msg_cb is called for each handshake message received
+ *
+ * @param next_proto is called with ALPN protocol data sent by the client
*/
BOTAN_DEPRECATED("Use TLS::Callbacks (virtual interface).")
- Compat_Callbacks(output_fn out, data_cb app_data_cb, alert_cb alert_cb,
+ Compat_Callbacks(output_fn output_fn, data_cb app_data_cb, alert_cb alert_cb,
handshake_cb hs_cb, handshake_msg_cb hs_msg_cb = nullptr,
next_protocol_fn next_proto = nullptr)
- : m_output_function(out), m_app_data_cb(app_data_cb),
+ : m_output_function(output_fn), m_app_data_cb(app_data_cb),
m_alert_cb(std::bind(alert_cb, std::placeholders::_1, nullptr, 0)),
m_hs_cb(hs_cb), m_hs_msg_cb(hs_msg_cb), m_next_proto(next_proto) {}
BOTAN_DEPRECATED("Use TLS::Callbacks (virtual interface).")
- Compat_Callbacks(output_fn out, data_cb app_data_cb,
+ Compat_Callbacks(output_fn output_fn, data_cb app_data_cb,
std::function<void (Alert)> alert_cb,
handshake_cb hs_cb,
handshake_msg_cb hs_msg_cb = nullptr,
next_protocol_fn next_proto = nullptr)
- : m_output_function(out), m_app_data_cb(app_data_cb),
+ : m_output_function(output_fn), m_app_data_cb(app_data_cb),
m_alert_cb(alert_cb),
m_hs_cb(hs_cb), m_hs_msg_cb(hs_msg_cb), m_next_proto(next_proto) {}
diff --git a/src/lib/tls/tls_channel.h b/src/lib/tls/tls_channel.h
index ac5b4e377..2f4793211 100644
--- a/src/lib/tls/tls_channel.h
+++ b/src/lib/tls/tls_channel.h
@@ -27,6 +27,8 @@ class Connection_Cipher_State;
class Connection_Sequence_Numbers;
class Handshake_State;
class Handshake_Message;
+class Client_Hello;
+class Server_Hello;
/**
* Generic interface for TLS endpoint
@@ -221,8 +223,8 @@ class BOTAN_DLL Channel
/* secure renegotiation handling */
- void secure_renegotiation_check(const class Client_Hello* client_hello);
- void secure_renegotiation_check(const class Server_Hello* server_hello);
+ void secure_renegotiation_check(const Client_Hello* client_hello);
+ void secure_renegotiation_check(const Server_Hello* server_hello);
std::vector<byte> secure_renegotiation_data_for_client_hello() const;
std::vector<byte> secure_renegotiation_data_for_server_hello() const;
diff --git a/src/lib/tls/tls_client.h b/src/lib/tls/tls_client.h
index 1b67a1022..d3cff147e 100644
--- a/src/lib/tls/tls_client.h
+++ b/src/lib/tls/tls_client.h
@@ -72,7 +72,7 @@ class BOTAN_DLL Client final : public Channel
*
* @param alert_cb is called when a TLS alert is received
*
- * @param handshake_cb is called when a handshake is completed
+ * @param hs_cb is called when a handshake is completed
*
* @param session_manager manages session state
*
@@ -94,7 +94,7 @@ class BOTAN_DLL Client final : public Channel
* values just mean reallocations and copies are more likely.
*/
BOTAN_DEPRECATED("Use TLS::Client(TLS::Callbacks ...)")
- Client(output_fn out,
+ Client(output_fn output_fn,
data_cb app_data_cb,
alert_cb alert_cb,
handshake_cb hs_cb,
diff --git a/src/lib/tls/tls_messages.h b/src/lib/tls/tls_messages.h
index 25228c865..1e012a899 100644
--- a/src/lib/tls/tls_messages.h
+++ b/src/lib/tls/tls_messages.h
@@ -479,6 +479,7 @@ class BOTAN_DLL Certificate_Verify final : public Handshake_Message
* Check the signature on a certificate verify message
* @param cert the purported certificate
* @param state the handshake state
+ * @param policy the TLS policy
*/
bool verify(const X509_Certificate& cert,
const Handshake_State& state,
diff --git a/src/lib/tls/tls_policy.h b/src/lib/tls/tls_policy.h
index 73af80547..f387361f6 100644
--- a/src/lib/tls/tls_policy.h
+++ b/src/lib/tls/tls_policy.h
@@ -273,7 +273,7 @@ class BOTAN_DLL Policy
};
/**
-* NSA Suite B 128-bit security level (see @rfc 6460)
+* NSA Suite B 128-bit security level (RFC 6460)
*/
class BOTAN_DLL NSA_Suite_B_128 : public Policy
{
@@ -304,7 +304,7 @@ class BOTAN_DLL NSA_Suite_B_128 : public Policy
};
/**
-* Policy for DTLS. We require DTLS v1.2 and an AEAD mode
+* Policy for DTLS. We require DTLS v1.2 and an AEAD mode.
*/
class BOTAN_DLL Datagram_Policy : public Policy
{
diff --git a/src/lib/tls/tls_record.h b/src/lib/tls/tls_record.h
index b17d0a7b6..d4a2a9372 100644
--- a/src/lib/tls/tls_record.h
+++ b/src/lib/tls/tls_record.h
@@ -149,14 +149,11 @@ class Record_Raw_Input
/**
* Create a TLS record
* @param write_buffer the output record is placed here
-* @param msg_type is the type of the message (handshake, alert, ...)
-* @param msg is the plaintext message
-* @param msg_length is the length of msg
-* @param msg_sequence is the sequence number
+* @param rec_msg is the plaintext message
* @param version is the protocol version
+* @param msg_sequence is the sequence number
* @param cipherstate is the writing cipher state
* @param rng is a random number generator
-* @return number of bytes written to write_buffer
*/
void write_record(secure_vector<byte>& write_buffer,
Record_Message rec_msg,
diff --git a/src/lib/tls/tls_session_key.h b/src/lib/tls/tls_session_key.h
index 1faee7801..8399a9676 100644
--- a/src/lib/tls/tls_session_key.h
+++ b/src/lib/tls/tls_session_key.h
@@ -14,6 +14,8 @@ namespace Botan {
namespace TLS {
+class Handshake_State;
+
/**
* TLS Session Keys
*/
@@ -59,11 +61,11 @@ class Session_Keys
/**
* @param state state the handshake state
- * @param pre_master the pre-master secret
+ * @param pre_master_secret the pre-master secret
* @param resuming whether this TLS session is resumed
*/
- Session_Keys(const class Handshake_State* state,
- const secure_vector<byte>& pre_master,
+ Session_Keys(const Handshake_State* state,
+ const secure_vector<byte>& pre_master_secret,
bool resuming);
private: