Revise the public_key API

Cleaned up and documented the public_key API to
make it useful for general use.

1 files changed, 29 insertions, 8 deletions

diff --git a/lib/public_key/doc/src/cert_records.xml b/lib/public_key/doc/src/cert_records.xml
index 8cfe57f670..0d6113acef 100644
--- a/lib/public_key/doc/src/cert_records.xml
+++ b/lib/public_key/doc/src/cert_records.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="latin1" ?>
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <!DOCTYPE chapter SYSTEM "chapter.dtd">
 
 <chapter>
@@ -37,7 +37,7 @@
   <p>This chapter briefly describes erlang records derived from asn1
   specifications used to handle X509 certificates. The intent is to
   describe the data types and not to specify the meaning of each
-  component for this we refer you to RFC 3280.
+  component for this we refer you to RFC 5280.
   </p>
 
   <p>Use the following include directive to get access to the
@@ -45,11 +45,7 @@
   
   <code> -include_lib("public_key/include/public_key.hrl"). </code>
 
-  <p>The used specification is available in <c>OTP-PKIX.asn1</c>,
-    which is an amelioration of
-    the <c>PKIX1Explicit88.asn1</c>, <c>PKIX1Implicit88.asn1</c>
-    and <c>PKIX1Algorithms88.asn1</c> modules.     
-    You find all these modules in the <c>asn1</c> subdirectory
+  <p>The used asn1 specifications are available <c>asn1</c> subdirectory
     of the application <c>public_key</c>.
   </p>
 
@@ -62,6 +58,9 @@
      marker="public_key">public key reference manual </seealso> or
     follows here.</p>
 
+    <p><c>oid() - a tuple of integers 
+    as generated by the asn1 compiler.</c></p>
+
     <p><c>time() = uct_time() | general_time()</c></p>
     
     <p><c>uct_time() = {utcTime, "YYMMDDHHMMSSZ"} </c></p>
@@ -119,9 +118,31 @@
 	  algorithm,  % oid() 
 	  parameters  % asn1_der_encoded()
 	 }.
+</code>
+
+<code>
+#'OTPCertificate'{
+		tbsCertificate,        % #'OTPTBSCertificate'{}
+		signatureAlgorithm,    % #'SignatureAlgorithm'
+		signature              % {0, binary()} - asn1 compact bitstring
+	       }.
+
+#'OTPTBSCertificate'{
+	  version,              % v1 | v2 | v3 
+	  serialNumber,         % integer() 
+	  signature,            % #'SignatureAlgorithm'
+	  issuer,               % {rdnSequence, [#AttributeTypeAndValue'{}]} 
+	  validity,             % #'Validity'{}
+	  subject,              % {rdnSequence, [#AttributeTypeAndValue'{}]} 
+	  subjectPublicKeyInfo, % #'SubjectPublicKeyInfo'{}
+	  issuerUniqueID,       % binary() | asn1_novalue
+	  subjectUniqueID,      % binary() | asn1_novalue
+	  extensions            % [#'Extension'{}] 
+	 }.
+	  
 #'SignatureAlgorithm'{
 	  algorithm,  % id_signature_algorithm()
-	  parameters  % public_key_params()
+	  parameters  % asn1_novalue | #'Dss-Parms'{}
 	 }.
 </code>