From 8a8cfa06be6d9c2df39dedcdcef92e8b32e370f7 Mon Sep 17 00:00:00 2001 From: Tuncer Ayaz Date: Thu, 12 Dec 2013 13:02:30 +0100 Subject: Consistently format public_key(3) When documenting public_key/0 and private_key/0, I noticed the inconsistent state of formatting in public_key(3)'s Data Types section. This should be fixed for consistency and readability. --- lib/public_key/doc/src/public_key.xml | 43 +++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 6391bc5305..bd19d0e434 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -71,7 +71,7 @@

Use the following include directive to get access to the records and constant macros described here and in the User's Guide.

- -include_lib("public_key/include/public_key.hrl"). + -include_lib("public_key/include/public_key.hrl").

Data Types

@@ -84,46 +84,49 @@

der_encoded() = binary()

pki_asn1_type() = 'Certificate' | 'RSAPrivateKey'| 'RSAPublicKey' | - 'DSAPrivateKey' | 'DSAPublicKey' | 'DHParameter' | 'SubjectPublicKeyInfo' | - 'PrivateKeyInfo' | 'CertificationRequest' | 'ECPrivateKey'| - 'EcpkParameters'

+ 'DSAPrivateKey' | 'DSAPublicKey' | 'DHParameter' | + 'SubjectPublicKeyInfo' | 'PrivateKeyInfo' | + 'CertificationRequest' | 'ECPrivateKey' | 'EcpkParameters'

pem_entry () = {pki_asn1_type(), binary(), %% DER or encrypted DER - not_encrypted | cipher_info()}

+ not_encrypted | cipher_info()}

-

cipher_info() = {"RC2-CBC | "DES-CBC" | "DES-EDE3-CBC", crypto:rand_bytes(8)} | - 'PBES2-params'}

+

cipher_info() = {"RC2-CBC | "DES-CBC" | "DES-EDE3-CBC", + crypto:rand_bytes(8)} | 'PBES2-params'}

public_key() = rsa_public_key() | dsa_public_key() | ec_public_key()

private_key() = rsa_public_key() | dsa_public_key() | ec_public_key()

rsa_public_key() = #'RSAPublicKey'{}

-

rsa_private_key() = #'RSAPrivateKey'{}

+

rsa_private_key() = #'RSAPrivateKey'{}

-

dsa_public_key() = {integer(), #'Dss-Parms'{}}

+

dsa_public_key() = {integer(), #'Dss-Parms'{}}

dsa_private_key() = #'DSAPrivateKey'{}

-

ec_public_key() = {#'ECPoint'{}, #'EcpkParameters'{} | {namedCurve, oid()}}

+

ec_public_key() = {#'ECPoint'{}, #'EcpkParameters'{} | + {namedCurve, oid()}}

ec_private_key() = #'ECPrivateKey'{}

-

public_crypt_options() = [{rsa_pad, rsa_padding()}].

+

public_crypt_options() = [{rsa_pad, rsa_padding()}].

-

rsa_padding() = 'rsa_pkcs1_padding' | 'rsa_pkcs1_oaep_padding' - | 'rsa_no_padding'

+

rsa_padding() = 'rsa_pkcs1_padding' | 'rsa_pkcs1_oaep_padding' | + 'rsa_no_padding'

-

rsa_digest_type() = 'md5' | 'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'

+

rsa_digest_type() = 'md5' | 'sha' | 'sha224' | 'sha256' | 'sha384' | + 'sha512'

-

dss_digest_type() = 'sha'

+

dss_digest_type() = 'sha'

-

ecdsa_digest_type() = 'sha'| 'sha224' | 'sha256' | 'sha384' | 'sha512'

+

ecdsa_digest_type() = 'sha'| 'sha224' | 'sha256' | 'sha384' | 'sha512'

-

crl_reason() = unspecified | keyCompromise | cACompromise | affiliationChanged | superseded | cessationOfOperation | certificateHold | privilegeWithdrawn | aACompromise -

+

crl_reason() = unspecified | keyCompromise | cACompromise | + affiliationChanged | superseded | cessationOfOperation | + certificateHold | privilegeWithdrawn | aACompromise

-

ssh_file() = openssh_public_key | rfc4716_public_key | - known_hosts | auth_keys

+

ssh_file() = openssh_public_key | rfc4716_public_key | known_hosts | + auth_keys

-- cgit v1.2.3