From 601246b87b7df5247fc5ab1cf39e665935e335ae Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Tue, 4 Nov 2014 15:41:16 +0100
Subject: public_key: Improve CRL handling support

---
 lib/public_key/doc/src/public_key.xml | 71 ++++++++++++++++++++++++++++++-----
 1 file changed, 62 insertions(+), 9 deletions(-)

(limited to 'lib/public_key/doc/src')

diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index e3473f80d7..e8902c6da9 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -5,7 +5,7 @@
   <header>
     <copyright>
       <year>2008</year>
-      <year>2014</year>
+      <year>2015</year>
       <holder>Ericsson AB, All Rights Reserved</holder>
     </copyright>
     <legalnotice>
@@ -127,6 +127,8 @@
     affiliationChanged | superseded | cessationOfOperation |
     certificateHold | privilegeWithdrawn | aACompromise</code></p>
 
+    <p><code>issuer_name() = {rdnSequence,[#'AttributeTypeAndValue'{}]} </code> </p>
+
     <p><code>ssh_file()  = openssh_public_key | rfc4716_public_key | known_hosts |
     auth_keys</code></p>
     
@@ -404,22 +406,23 @@
     <type>
         <v>Cert = der_encode() | #'OTPCertificate'{}</v>
 	<v>IssuedBy = self | other</v>
-	<v>IssuerID = {integer(), {rdnSequence, [#'AttributeTypeAndValue'{}]}}</v>
+	<v>IssuerID = {integer(), issuer_name()}</v>
 	<d>The issuer id consists of the serial number and the issuers name.</d>
 	<v>Reason = term()</v>
-  </type> 
-  <desc> 
-    <p> Returns the issuer id.</p> 
-  </desc> 
+    </type> 
+    <desc> 
+      <p> Returns the issuer id.</p> 
+    </desc> 
   </func>
-
+  
+ 
   <func>
     <name>pkix_normalize_name(Issuer) -> Normalized</name>
     <fsummary>Normalizes a issuer name so that it can be easily
     compared to another issuer name. </fsummary>
     <type>
-      <v>Issuer = {rdnSequence,[#'AttributeTypeAndValue'{}]}</v>
-      <v>Normalized = {rdnSequence, [#'AttributeTypeAndValue'{}]}</v>
+      <v>Issuer = issuer_name()</v>
+      <v>Normalized = issuer_name()</v>
   </type> 
   <desc> 
     <p>Normalizes a issuer name so that it can be easily
@@ -527,6 +530,17 @@ fun(OtpCert :: #'OTPCertificate'{},
     </desc>
    </func>
 
+    <func>  
+      <name>pkix_crl_issuer(CRL) -> issuer_name()</name>
+      <fsummary>Returns the issuer of the <c>CRL</c>.</fsummary>
+      <type>
+	<v>CRL = der_encoded() | #'CertificateList'{} </v> 
+      </type> 
+      <desc> 
+	<p>Returns the issuer of the <c>CRL</c>.</p>
+      </desc> 
+    </func> 
+   
    <func>
      <name>pkix_crls_validate(OTPCertificate, DPAndCRLs, Options) -> CRLStatus()</name>
      <fsummary> Performs CRL validation.</fsummary>
@@ -574,7 +588,46 @@ fun(#'DistributionPoint'{}, #'CertificateList'{},
       </taglist>
     </desc>
    </func>
+   
+   <func>  
+     <name>pkix_crl_verify(CRL, Cert) -> boolean()</name>
+     <fsummary> Verify that  <c>Cert</c>  is the <c> CRL</c>  signer. </fsummary>
+     <type>
+       <v>CRL = der_encoded() | #'CertificateList'{} </v> 
+       <v>Cert = der_encoded() | #'OTPCertificate'{} </v> 
+     </type> 
+     <desc> 
+       <p>Verify that <c>Cert</c> is the <c>CRL</c> signer.</p>
+     </desc> 
+   </func>
 
+   <func>  
+     <name>pkix_dist_point(Cert) -> DistPoint</name>
+     <fsummary>Creates a distribution point for CRLs issued by the same issuer as <c>Cert</c>.</fsummary>
+     <type>
+       <v> Cert  = der_encoded() | #'OTPCertificate'{} </v> 
+       <v> DistPoint =  #'DistributionPoint'{}</v> 
+     </type> 
+     <desc> 
+       <p>Creates a distribution point for CRLs issued by the same issuer as <c>Cert</c>.
+       Can be used as input to <seealso
+       marker="#pkix_crls_validate-3">pkix_crls_validate/3 </seealso>
+       </p>
+     </desc> 
+   </func>
+   
+   <func>  
+     <name>pkix_dist_points(Cert) -> DistPoints</name>
+     <fsummary> Extracts distribution points from the certificates extensions.</fsummary>
+     <type>
+       <v> Cert  = der_encoded() | #'OTPCertificate'{} </v> 
+       <v> DistPoints =  [#'DistributionPoint'{}]</v> 
+     </type> 
+     <desc> 
+       <p> Extracts distribution points from the certificates extensions.</p>
+     </desc> 
+ </func>
+   
   <func>
     <name>pkix_sign(#'OTPTBSCertificate'{}, Key) -> der_encode()</name>
     <fsummary>Signs certificate.</fsummary>
-- 
cgit v1.2.3