From ea4114d5d4156bae207788e5be7d0157e32adfe9 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:01:30 +0200 Subject: [crypto] Correct documentation Fix mistakes found by 'xmllint'. --- lib/crypto/doc/src/crypto.xml | 84 +++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 42 deletions(-) (limited to 'lib/crypto') diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index 291a5145e4..8d082bf3fe 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -66,29 +66,29 @@
DATA TYPES -

key_value() = integer() | binary()

+ key_value() = integer() | binary()

Always binary() when used as return value

-

rsa_public() = [key_value()] = [E, N]

+ rsa_public() = [key_value()] = [E, N]

Where E is the public exponent and N is public modulus.

-

rsa_private() = [key_value()] = [E, N, D] | [E, N, D, P1, P2, E1, E2, C]

+ rsa_private() = [key_value()] = [E, N, D] | [E, N, D, P1, P2, E1, E2, C]

Where E is the public exponent, N is public modulus and D is the private exponent.The longer key format contains redundant information that will make the calculation faster. P1,P2 are first and second prime factors. E1,E2 are first and second exponents. C is the CRT coefficient. Terminology is taken from RFC 3447.

-

dss_public() = [key_value()] = [P, Q, G, Y]

+ dss_public() = [key_value()] = [P, Q, G, Y]

Where P, Q and G are the dss parameters and Y is the public key.

-

dss_private() = [key_value()] = [P, Q, G, X]

+ dss_private() = [key_value()] = [P, Q, G, X]

Where P, Q and G are the dss parameters and X is the private key.

-

srp_public() = key_value()

+ srp_public() = key_value()

Where is A or B from SRP design

-

srp_private() = key_value()

+ srp_private() = key_value()

Where is a or b from SRP design

Where Verifier is v, Generator is g and Prime is N, DerivedKey is X, and Scrambler is @@ -96,29 +96,29 @@ Version = '3' | '6' | '6a'

-

dh_public() = key_value()

+ dh_public() = key_value() -

dh_private() = key_value()

+ dh_private() = key_value() -

dh_params() = [key_value()] = [P, G]

+ dh_params() = [key_value()] = [P, G] -

ecdh_public() = key_value()

+ ecdh_public() = key_value() -

ecdh_private() = key_value()

+ ecdh_private() = key_value() -

ecdh_params() = ec_named_curve() | ec_explicit_curve()

+ ecdh_params() = ec_named_curve() | ec_explicit_curve() -

ec_explicit_curve() = - {ec_field(), Prime :: key_value(), Point :: key_value(), Order :: integer(), CoFactor :: none | integer()}

+ ec_explicit_curve() = + {ec_field(), Prime :: key_value(), Point :: key_value(), Order :: integer(), CoFactor :: none | integer()} -

ec_field() = {prime_field, Prime :: integer()} | - {characteristic_two_field, M :: integer(), Basis :: ec_basis()}

+ ec_field() = {prime_field, Prime :: integer()} | + {characteristic_two_field, M :: integer(), Basis :: ec_basis()} -

ec_basis() = {tpbasis, K :: non_neg_integer()} | + ec_basis() = {tpbasis, K :: non_neg_integer()} | {ppbasis, K1 :: non_neg_integer(), K2 :: non_neg_integer(), K3 :: non_neg_integer()} | - onbasis

+ onbasis -

ec_named_curve() -> + ec_named_curve() -> sect571r1| sect571k1| sect409r1| sect409k1| secp521r1| secp384r1| secp224r1| secp224k1| secp192k1| secp160r2| secp128r2| secp128r1| sect233r1| sect233k1| sect193r2| sect193r1| sect131r2| sect131r1| sect283r1| sect283k1| sect163r2| secp256k1| secp160k1| secp160r1| @@ -128,42 +128,42 @@ brainpoolP224t1| brainpoolP256r1| brainpoolP256t1| brainpoolP320r1| brainpoolP320t1| brainpoolP384r1| brainpoolP384t1| brainpoolP512r1| brainpoolP512t1 - Note that the sect curves are GF2m (characteristic two) curves and are only supported if the +

Note that the sect curves are GF2m (characteristic two) curves and are only supported if the underlying OpenSSL has support for them. See also crypto:supports/0

-

stream_cipher() = rc4 | aes_ctr

+ stream_cipher() = rc4 | aes_ctr -

block_cipher() = aes_cbc128 | aes_cfb8 | aes_cfb128 | aes_ige256 | blowfish_cbc | + block_cipher() = aes_cbc128 | aes_cfb8 | aes_cfb128 | aes_ige256 | blowfish_cbc | blowfish_cfb64 | des_cbc | des_cfb | des3_cbc | des3_cbf - | des_ede3 | rc2_cbc

+ | des_ede3 | rc2_cbc -

aead_cipher() = aes_gcm | chacha20_poly1305

+ aead_cipher() = aes_gcm | chacha20_poly1305 -

stream_key() = aes_key() | rc4_key()

+ stream_key() = aes_key() | rc4_key() -

block_key() = aes_key() | blowfish_key() | des_key()| des3_key()

+ block_key() = aes_key() | blowfish_key() | des_key()| des3_key() -

aes_key() = iodata() Key length is 128, 192 or 256 bits

+ aes_key() = iodata()

Key length is 128, 192 or 256 bits

-

rc4_key() = iodata() Variable key length from 8 bits up to 2048 bits (usually between 40 and 256)

+ rc4_key() = iodata()

Variable key length from 8 bits up to 2048 bits (usually between 40 and 256)

-

blowfish_key() = iodata() Variable key length from 32 bits up to 448 bits

+ blowfish_key() = iodata()

Variable key length from 32 bits up to 448 bits

-

des_key() = iodata() Key length is 64 bits (in CBC mode only 8 bits are used)

+ des_key() = iodata()

Key length is 64 bits (in CBC mode only 8 bits are used)

-

des3_key() = [binary(), binary(), binary()] Each key part is 64 bits (in CBC mode only 8 bits are used)

+ des3_key() = [binary(), binary(), binary()]

Each key part is 64 bits (in CBC mode only 8 bits are used)

-

digest_type() = md5 | sha | sha224 | sha256 | sha384 | sha512

+ digest_type() = md5 | sha | sha224 | sha256 | sha384 | sha512 -

hash_algorithms() = md5 | ripemd160 | sha | sha224 | sha256 | sha384 | sha512 md4 is also supported for hash_init/1 and hash/2. + hash_algorithms() = md5 | ripemd160 | sha | sha224 | sha256 | sha384 | sha512

md4 is also supported for hash_init/1 and hash/2. Note that both md4 and md5 are recommended only for compatibility with existing applications.

-

cipher_algorithms() = des_cbc | des_cfb | des3_cbc | des3_cbf | des_ede3 | - blowfish_cbc | blowfish_cfb64 | aes_cbc128 | aes_cfb8 | aes_cfb128| aes_cbc256 | aes_ige256 | aes_gcm | chacha20_poly1305 | rc2_cbc | aes_ctr| rc4

-

public_key_algorithms() = rsa |dss | ecdsa | dh | ecdh | ec_gf2m - Note that ec_gf2m is not strictly a public key algorithm, but a restriction on what curves are supported + cipher_algorithms() = des_cbc | des_cfb | des3_cbc | des3_cbf | des_ede3 | + blowfish_cbc | blowfish_cfb64 | aes_cbc128 | aes_cfb8 | aes_cfb128| aes_cbc256 | aes_ige256 | aes_gcm | chacha20_poly1305 | rc2_cbc | aes_ctr| rc4 + public_key_algorithms() = rsa |dss | ecdsa | dh | ecdh | ec_gf2m +

Note that ec_gf2m is not strictly a public key algorithm, but a restriction on what curves are supported with ecdsa and ecdh.

@@ -381,8 +381,8 @@

Computes a HMAC of type Type from Data using - Key as the authentication key.

MacLength - will limit the size of the resultant Mac. + Key as the authentication key.

MacLength + will limit the size of the resultant Mac.

 @@ -650,7 +650,7 @@

Creates a digital signature.

Algorithm dss can only be used together with digest type sha.

- See also public_key:sign/3 +

See also public_key:sign/3.

@@ -802,7 +802,7 @@

Algorithm dss can only be used together with digest type sha.

- See also public_key:verify/4 +

See also public_key:verify/4.

-- cgit v1.2.3