crypto: Add type specs for all documented functions

1 files changed, 89 insertions, 0 deletions

diff --git a/lib/crypto/src/crypto.erl b/lib/crypto/src/crypto.erl
index 38b7bbc056..a93e336605 100644
--- a/lib/crypto/src/crypto.erl
+++ b/lib/crypto/src/crypto.erl
@@ -82,6 +82,9 @@
 		    aes_cbc_256_encrypt, aes_cbc_256_decrypt,
 		    info_lib]).
 
+-type digest_type() :: 'md5' | 'sha'.
+-type crypto_integer() :: binary() | integer().
+
 -define(nif_stub,nif_stub_error(?LINE)).
 
 -on_load(on_load/0).
@@ -146,6 +149,12 @@ version() -> ?CRYPTO_VSN.
 %%
 %%  MD5
 %%
+
+-spec md5(iodata()) -> binary().
+-spec md5_init() -> binary().
+-spec md5_update(binary(), iodata()) -> binary().
+-spec md5_final(binary()) -> binary().
+
 md5(_Data) -> ?nif_stub.
 md5_init() -> ?nif_stub.
 md5_update(_Context, _Data) -> ?nif_stub.
@@ -154,6 +163,11 @@ md5_final(_Context) -> ?nif_stub.
 %%
 %%  MD4
 %%
+-spec md4(iodata()) -> binary().
+-spec md4_init() -> binary().
+-spec md4_update(binary(), iodata()) -> binary().
+-spec md4_final(binary()) -> binary().
+
 md4(_Data) -> ?nif_stub.
 md4_init() -> ?nif_stub.
 md4_update(_Context, _Data) -> ?nif_stub.
@@ -162,6 +176,11 @@ md4_final(_Context) -> ?nif_stub.
 %%
 %% SHA
 %%
+-spec sha(iodata()) -> binary().
+-spec sha_init() -> binary().
+-spec sha_update(binary(), iodata()) -> binary().
+-spec sha_final(binary()) -> binary().
+
 sha(_Data) -> ?nif_stub.
 sha_init() -> ?nif_stub.
 sha_update(_Context, _Data) -> ?nif_stub.
@@ -175,6 +194,9 @@ sha_final(_Context) -> ?nif_stub.
 %%
 %%  MD5_MAC
 %%
+-spec md5_mac(iodata(), iodata()) -> binary.
+-spec md5_mac_96(iodata(), iodata()) -> binary.
+
 md5_mac(Key, Data) ->
     md5_mac_n(Key,Data,16).
 
@@ -186,6 +208,9 @@ md5_mac_n(_Key,_Data,_MacSz) -> ?nif_stub.
 %%
 %%  SHA_MAC
 %%
+-spec sha_mac(iodata(), iodata()) -> binary.
+-spec sha_mac_96(iodata(), iodata()) -> binary.
+
 sha_mac(Key, Data) ->
     sha_mac_n(Key,Data,20).
 
@@ -201,6 +226,9 @@ sha_mac_n(_Key,_Data,_MacSz) -> ?nif_stub.
 %%
 %% DES - in cipher block chaining mode (CBC)
 %%
+-spec des_cbc_encrypt(iodata(), binary(), iodata()) -> binary().
+-spec des_cbc_decrypt(iodata(), binary(), iodata()) -> binary().
+
 des_cbc_encrypt(Key, IVec, Data) ->
     des_cbc_crypt(Key, IVec, Data, true).
 
@@ -215,6 +243,8 @@ des_cbc_crypt(_Key, _IVec, _Data, _IsEncrypt) -> ?nif_stub.
 %% Returns the IVec to be used in the next iteration of 
 %% des_cbc_[encrypt|decrypt].
 %%
+-spec des_cbc_ivec(iodata()) -> binary().
+
 des_cbc_ivec(Data) when is_binary(Data) -> 
     {_, IVec} = split_binary(Data, size(Data) - 8),
     IVec;
@@ -224,6 +254,9 @@ des_cbc_ivec(Data) when is_list(Data) ->
 %%
 %% DES - in electronic codebook mode (ECB)
 %%
+-spec des_ecb_encrypt(iodata(), iodata()) -> binary().
+-spec des_ecb_decrypt(iodata(), iodata()) -> binary().
+
 des_ecb_encrypt(Key, Data) ->
     des_ecb_crypt(Key, Data, true).
 des_ecb_decrypt(Key, Data) ->
@@ -233,6 +266,11 @@ des_ecb_crypt(_Key, _Data, _IsEncrypt) -> ?nif_stub.
 %%
 %% DES3 - in cipher block chaining mode (CBC)
 %%
+-spec des3_cbc_encrypt(iodata(), iodata(), iodata(), binary(), iodata()) ->
+			     binary().
+-spec des3_cbc_decrypt(iodata(), iodata(), iodata(), binary(), iodata()) ->
+			     binary().
+
 des3_cbc_encrypt(Key1, Key2, Key3, IVec, Data) ->
     des_ede3_cbc_encrypt(Key1, Key2, Key3, IVec, Data).
 des_ede3_cbc_encrypt(Key1, Key2, Key3, IVec, Data) ->
@@ -248,6 +286,14 @@ des_ede3_cbc_crypt(_Key1, _Key2, _Key3, _IVec, _Data, _IsEncrypt) -> ?nif_stub.
 %%
 %% Blowfish
 %%
+-spec blowfish_ecb_encrypt(iodata(), iodata()) -> binary().
+-spec blowfish_ecb_decrypt(iodata(), iodata()) -> binary().
+-spec blowfish_cbc_encrypt(iodata(), binary(), iodata()) -> binary().
+-spec blowfish_cbc_decrypt(iodata(), binary(), iodata()) -> binary().
+-spec blowfish_cfb64_encrypt(iodata(), binary(), iodata()) -> binary().
+-spec blowfish_cfb64_decrypt(iodata(), binary(), iodata()) -> binary().
+-spec blowfish_ofb64_encrypt(iodata(), binary(), iodata()) -> binary().
+
 blowfish_ecb_encrypt(Key, Data) ->
     bf_ecb_crypt(Key,Data, true).
 
@@ -277,6 +323,9 @@ blowfish_ofb64_encrypt(_Key, _IVec, _Data) -> ?nif_stub.
 %%
 %% AES in cipher feedback mode (CFB)
 %%
+-spec aes_cfb_128_encrypt(iodata(), binary(), iodata()) -> binary().
+-spec aes_cfb_128_decrypt(iodata(), binary(), iodata()) -> binary().
+
 aes_cfb_128_encrypt(Key, IVec, Data) ->
     aes_cfb_128_crypt(Key, IVec, Data, true).
 
@@ -289,6 +338,10 @@ aes_cfb_128_crypt(_Key, _IVec, _Data, _IsEncrypt) -> ?nif_stub.
 %% 
 %% RAND - pseudo random numbers using RN_ functions in crypto lib
 %%
+-spec rand_bytes(non_neg_integer()) -> binary().
+-spec rand_uniform(crypto_integer(), crypto_integer()) ->
+			  crypto_integer().
+
 rand_bytes(_Bytes) -> ?nif_stub.
 rand_bytes(_Bytes, _Topmask, _Bottommask) -> ?nif_stub.
 
@@ -331,6 +384,10 @@ mod_exp_nif(_Base,_Exp,_Mod) -> ?nif_stub.
 %%
 %% DSS, RSA - verify
 %%
+-spec dss_verify(binary(), binary(), [binary()]) -> boolean().
+-spec rsa_verify(binary(), binary(), [binary()]) -> boolean().
+-spec rsa_verify(digest_type(), binary(), binary(), [binary()]) ->
+			boolean().
 
 %% Key = [P,Q,G,Y]   P,Q,G=DSSParams  Y=PublicKey
 dss_verify(_Data,_Signature,_Key) -> ?nif_stub.    
@@ -345,6 +402,10 @@ rsa_verify(_Type,_Data,_Signature,_Key) -> ?nif_stub.
 %% DSS, RSA - sign
 %%
 %% Key = [P,Q,G,X]   P,Q,G=DSSParams  X=PrivateKey
+-spec dss_sign(binary(), [binary()]) -> binary().
+-spec rsa_sign(binary(), [binary()]) -> binary().
+-spec rsa_sign(digest_type(), binary(), [binary()]) -> binary().
+
 dss_sign(Data, Key) ->
     case dss_sign_nif(Data,Key) of
 	error -> erlang:error(badkey, [Data, Key]);
@@ -368,6 +429,16 @@ rsa_sign_nif(_Type,_Data,_Key) -> ?nif_stub.
 %%
 %%  rsa_public_encrypt
 %%  rsa_private_decrypt
+-type rsa_padding() :: 'rsa_pkcs1_padding' | 'rsa_pkcs1_oaep_padding' | 'rsa_no_padding'.
+
+-spec rsa_public_encrypt(binary(), [binary()], rsa_padding()) ->
+				binary().
+-spec rsa_public_decrypt(binary(), [binary()], rsa_padding()) ->
+				binary().
+-spec rsa_private_encrypt(binary(), [binary()], rsa_padding()) ->
+				binary().
+-spec rsa_private_decrypt(binary(), [binary()], rsa_padding()) ->
+				binary().
 
 %% Binary, Key = [E,N]
 rsa_public_encrypt(BinMesg, Key, Padding) ->
@@ -409,6 +480,14 @@ rsa_public_decrypt(BinMesg, Key, Padding) ->
 %%
 %% AES - with 128 or 256 bit key in cipher block chaining mode (CBC)
 %%
+-spec aes_cbc_128_encrypt(iodata(), binary(), iodata()) ->
+				 binary().
+-spec aes_cbc_128_decrypt(iodata(), binary(), iodata()) ->
+				 binary().
+-spec aes_cbc_256_encrypt(iodata(), binary(), iodata()) ->
+				 binary().
+-spec aes_cbc_256_decrypt(iodata(), binary(), iodata()) ->
+				 binary().
 
 aes_cbc_128_encrypt(Key, IVec, Data) ->
     aes_cbc_crypt(Key, IVec, Data, true).
@@ -443,11 +522,15 @@ aes_cbc_ivec(Data) when is_list(Data) ->
 %% NB doesn't check that they are the same size, just concatenates
 %% them and sends them to the driver
 %%
+-spec exor(iodata(), iodata()) -> binary().
+
 exor(_A, _B) -> ?nif_stub.
 
 %%
 %% RC4 - symmetric stream cipher
 %%
+-spec rc4_encrypt(iodata(), iodata()) -> binary().
+
 rc4_encrypt(_Key, _Data) -> ?nif_stub.
 rc4_set_key(_Key) -> ?nif_stub.
 rc4_encrypt_with_state(_State, _Data) -> ?nif_stub.
@@ -490,6 +573,10 @@ dh_check([_Prime,_Gen]) -> ?nif_stub.
 
 %% DHParameters = [P (Prime)= mpint(), G(Generator) = mpint()]
 %% PrivKey = mpint()
+-spec dh_generate_key([binary()]) -> {binary(),binary()}.
+-spec dh_generate_key(binary()|undefined, [binary()]) ->
+			     {binary(),binary()}.
+
 dh_generate_key(DHParameters) ->
     dh_generate_key(undefined, DHParameters).
 dh_generate_key(PrivateKey, DHParameters) ->
@@ -502,6 +589,8 @@ dh_generate_key_nif(_PrivateKey, _DHParameters) -> ?nif_stub.
 
 %% DHParameters = [P (Prime)= mpint(), G(Generator) = mpint()]
 %% MyPrivKey, OthersPublicKey = mpint() 
+-spec dh_compute_key(binary(), binary(), [binary()]) -> binary().
+
 dh_compute_key(OthersPublicKey, MyPrivateKey, DHParameters) ->
     case dh_compute_key_nif(OthersPublicKey,MyPrivateKey,DHParameters) of
 	error -> erlang:error(computation_failed, [OthersPublicKey,MyPrivateKey,DHParameters]);