From 7a9b5514b88923ae342a2bf140a534244791a6ff Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Thu, 15 Nov 2012 16:28:32 +0100
Subject: public_key: Add PKCS-10 documentation and PKCS-7 test case

Note that PKCS-7 is an undocumented feature for now.

Also added some minor enhancements to the documentation.
---
 lib/public_key/doc/src/cert_records.xml | 43 ++++++++++++++++++++++++++++++---
 lib/public_key/doc/src/introduction.xml | 14 +++++------
 lib/public_key/doc/src/public_key.xml   |  4 +--
 3 files changed, 49 insertions(+), 12 deletions(-)

(limited to 'lib/public_key/doc')

diff --git a/lib/public_key/doc/src/cert_records.xml b/lib/public_key/doc/src/cert_records.xml
index ad4f5812cb..edef664245 100644
--- a/lib/public_key/doc/src/cert_records.xml
+++ b/lib/public_key/doc/src/cert_records.xml
@@ -5,7 +5,7 @@
   <header>
     <copyright>
       <year>2008</year>
-      <year>2011</year>
+      <year>2012</year>
       <holder>Ericsson AB, All Rights Reserved</holder>
     </copyright>
     <legalnotice>
@@ -37,7 +37,10 @@
   <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 5280.
+  component for this we refer you to <url
+  href="http://www.ietf.org/rfc/rfc5280.txt">RFC 5280</url>. Also
+  descirbed is <p>CertificationRequest</p> that is defined by <url
+  href=http://www.rsa.com/rsalabs/node.asp?id=2124">PKCS-10</url>.
   </p>
 
   <p>Use the following include directive to get access to the
@@ -630,6 +633,40 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'</p>
 	 aACompromise        
        </c></p>
  </section>
- 
+
+ <section>
+   <marker id="PKCS10"></marker>
+   <title>PKCS#10 Certification Request</title>
+   <code>
+#'CertificationRequest'{
+          certificationRequestInfo #'CertificationRequestInfo'{},
+	  signatureAlgorithm	   #'CertificationRequest_signatureAlgorithm'{}}.
+	  signature                {0, binary()} - asn1 compact bitstring
+	  }
+
+#'CertificationRequestInfo'{
+	  version       atom(),
+	  subject       {rdnSequence, [#AttributeTypeAndValue'{}]} ,
+	  subjectPKInfo #'CertificationRequestInfo_subjectPKInfo'{},
+	  attributes    [#AttributeTypeAndValue'{}]
+	  }
+
+#'CertificationRequestInfo_subjectPKInfo'{
+          algorithm		#'CertificationRequestInfo_subjectPKInfo_algorithm'{}
+	  subjectPublicKey 	 {0, binary()} - asn1 compact bitstring
+	  }
+
+#'CertificationRequestInfo_subjectPKInfo_algorithm'{
+     algorithm = oid(),
+     parameters = asn1_der_encoded()
+}	  
+
+#'CertificationRequest_signatureAlgorithm'{
+     algorithm = oid(),
+     parameters = asn1_der_encoded()
+     }  
+   </code> 
+ </section>
+
 </section>
 </chapter>
diff --git a/lib/public_key/doc/src/introduction.xml b/lib/public_key/doc/src/introduction.xml
index a21fcf3576..b1d1114a6c 100644
--- a/lib/public_key/doc/src/introduction.xml
+++ b/lib/public_key/doc/src/introduction.xml
@@ -1,11 +1,11 @@
-<?xml version="1.0" encoding="latin1" ?>
+<?xml version="1.0" encoding="iso-8859-1" ?>
 <!DOCTYPE chapter SYSTEM "chapter.dtd">
 
 <chapter>
   <header>
     <copyright>
       <year>2008</year>
-      <year>2011</year>
+      <year>2012</year>
       <holder>Ericsson AB, All Rights Reserved</holder>
     </copyright>
     <legalnotice>
@@ -37,15 +37,15 @@
   <section>
     <title>Purpose</title>
     <p> This application provides an API to public key infrastructure
-    from  RFC 3280 (X.509 certificates) and public key formats defined
-    by the PKCS-standard.</p>
+    from <url href="http://www.ietf.org/rfc/rfc5280.txt">RFC
+    5280</url> (X.509 certificates) and public key formats defined by
+    the <url href=http://www.rsa.com/rsalabs/node.asp?id=2124"> PKCS-standard</url></p>
   </section>
 
   <section>
     <title>Prerequisites</title>
-    <p>It is assumed that the reader is familiar with the Erlang
-    programming language, concepts of OTP and has a basic understanding
-    of the concepts of using public keys.</p>
+    <p>It is assumed that the reader has a basic understanding
+    of the concepts of using public keys and digital certificates.</p>
   </section>
 
   <section>
diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index 5c227557f2..2ec1fcff9d 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -34,7 +34,7 @@
   <modulesummary> API module for public key infrastructure.</modulesummary>
   <description>
     <p>This module provides functions to handle public key infrastructure
-    from RFC 5280 - X.509 certificates and some parts of the PKCS-standard.
+    from <url href="http://www.ietf.org/rfc/rfc5280.txt">RFC 5280</url>- X.509 certificates and some parts of the PKCS-standard.
     </p>
   </description>
 
@@ -61,7 +61,7 @@
     <p><code>string = [bytes()]</code></p>
    
     <p><code>pki_asn1_type() = 'Certificate' | 'RSAPrivateKey'| 'RSAPublicKey'
-    'DSAPrivateKey' | 'DSAPublicKey' | 'DHParameter' | 'SubjectPublicKeyInfo'| 'PrivateKeyInfo'</code></p>
+    'DSAPrivateKey' | 'DSAPublicKey' | 'DHParameter' | 'SubjectPublicKeyInfo'| 'PrivateKeyInfo' | 'CertificationRequest'</code></p>
     
     <p><code>pem_entry () = {pki_asn1_type(), binary(), %% DER or encrypted DER
           not_encrypted | cipher_info()} </code></p>
-- 
cgit v1.2.3