From 150fbc75ca713527faa8dda0dee819f1e06f1ea1 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Mon, 21 Jun 2010 11:50:44 +0200
Subject: Refreshed documentation to reflect the change of default
 implementation. Started to improve code documentation by using -spec
 directive, and some small refactorings to avoid ugly code.

---
 lib/ssl/src/ssl_tls1.erl | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'lib/ssl/src/ssl_tls1.erl')

diff --git a/lib/ssl/src/ssl_tls1.erl b/lib/ssl/src/ssl_tls1.erl
index 70db632835..f4a12a5a52 100644
--- a/lib/ssl/src/ssl_tls1.erl
+++ b/lib/ssl/src/ssl_tls1.erl
@@ -36,6 +36,8 @@
 %% Internal application API
 %%====================================================================
 
+-spec master_secret(binary(), binary(), binary()) -> binary().
+
 master_secret(PreMasterSecret, ClientRandom, ServerRandom) ->
     %% RFC 2246 & 4346 - 8.1 %% master_secret = PRF(pre_master_secret,
     %%                           "master secret", ClientHello.random +
@@ -43,6 +45,8 @@ master_secret(PreMasterSecret, ClientRandom, ServerRandom) ->
     prf(PreMasterSecret, <<"master secret">>, 
 	[ClientRandom, ServerRandom], 48).
 
+-spec finished(client | server, binary(), {binary(), binary()}) -> binary().
+
 finished(Role, MasterSecret, {MD5Hash, SHAHash}) ->
     %% RFC 2246 & 4346 - 7.4.9. Finished
     %% struct {
@@ -56,6 +60,7 @@ finished(Role, MasterSecret, {MD5Hash, SHAHash}) ->
     SHA = hash_final(?SHA, SHAHash),
     prf(MasterSecret, finished_label(Role), [MD5, SHA], 12).
 
+-spec certificate_verify(key_algo(), {binary(), binary()}) -> binary().
 
 certificate_verify(Algorithm, {MD5Hash, SHAHash}) when Algorithm == rsa;
 						       Algorithm == dhe_rsa ->
@@ -65,7 +70,11 @@ certificate_verify(Algorithm, {MD5Hash, SHAHash}) when Algorithm == rsa;
 
 certificate_verify(dhe_dss, {_, SHAHash}) ->
     hash_final(?SHA, SHAHash).
-    
+
+-spec setup_keys(binary(), binary(), binary(), integer(), 
+		 integer(), integer()) -> {binary(), binary(), binary(), 
+					  binary(), binary(), binary()}.  
+
 setup_keys(MasterSecret, ServerRandom, ClientRandom, HashSize,
 	   KeyMatLen, IVSize) ->
     %% RFC 2246 - 6.3. Key calculation
@@ -112,6 +121,9 @@ setup_keys(MasterSecret, ServerRandom, ClientRandom, HashSize,
 %%     {ClientWriteMacSecret, ServerWriteMacSecret, ClientWriteKey,
 %%      ServerWriteKey, undefined, undefined}.
 
+-spec mac_hash(integer(), binary(), integer(), integer(), tls_version(),
+	       integer(), binary()) -> binary(). 
+
 mac_hash(Method, Mac_write_secret, Seq_num, Type, {Major, Minor}, 
 	 Length, Fragment) ->
     %% RFC 2246 & 4346 - 6.2.3.1.
@@ -132,6 +144,8 @@ mac_hash(Method, Mac_write_secret, Seq_num, Type, {Major, Minor},
     ?DBG_HEX(Mac),
     Mac.
 
+-spec suites() -> list().
+    
 suites() ->
     [ 
       ?TLS_DHE_RSA_WITH_AES_256_CBC_SHA,
-- 
cgit v1.2.3