path: root/lib/ssl/doc/src/ssl_crl_cache.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<erlref>
  <header>
    <copyright>
      <year>2015</year><year>2015</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      The contents of this file are subject to the Erlang Public License,
      Version 1.1, (the "License"); you may not use this file except in
      compliance with the License. You should have received a copy of the
      Erlang Public License along with this software. If not, it can be
      retrieved online at http://www.erlang.org/.

      Software distributed under the License is distributed on an "AS IS"
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
      the License for the specific language governing rights and limitations
      under the License.
    </legalnotice>
    <title>ssl_crl_cache</title>
    <file>ssl_crl_cache.xml</file>
  </header>
  
  <module>ssl_crl_cache</module>
  <modulesummary>CRL cache </modulesummary>
  <description>
    <p>
      Implements an internal CRL (Certificate Revocation List) cache.
      In addition to implementing the <seealso
      marker="ssl_cache_crl_api"> ssl_cache_crl_api</seealso> behaviour
      the following functions are available.
    </p>
  </description>
  
    <funcs>
      <func>
      <name>insert(CRLSrc) -> ok | {error, Reason}</name>
      <name>insert(URI, CRLSrc) -> ok | {error, Reason}</name>
      <fsummary> </fsummary>
      <type>
	<v> CRLSrc = {file, string()} | {der, [ <seealso
	marker="public_key:public_key"> der_encoded() </seealso> ]}</v>
	<v> URI = http_uri:uri()</v>
	<v> Reason = term()</v>
      </type>
      <desc>
	Insert CRLs into the ssl applications local cache.
      </desc>
    </func>

     <func>
      <name>delete(Entries) -> ok |  {error, Reason} </name>
      <fsummary> </fsummary>
      <type>
	<v> Entries =  http_uri:uri() | {file, string()} | {der, [<seealso
	marker="public_key:public_key"> der_encoded() </seealso>]}</v>
	<v> Reason = term()</v>
      </type>
      <desc>
	Delete CRLs from the ssl applications local cache.
      </desc>
     </func>     
    </funcs>
</erlref>