aboutsummaryrefslogblamecommitdiffstats
path: root/lib/public_key/doc/src/introduction.xml
blob: 17f4e5155a28bedc6e89637b0aabcea9c3844c71 (plain) (tree)
1
2
3
4
5
6
7
8
                                       





                                       
                       





























                                                                        

                                                                                     
                                                              

                                                                         

                                                       



                                


                                                                                

            
           




                                                                             

            

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

<chapter>
  <header>
    <copyright>
      <year>2008</year>
      <year>2013</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.

  The Initial Developer of the Original Code is Ericsson AB.
    </legalnotice>

    <title>Introduction</title>
    <prepared>Ingela Anderton Andin</prepared>
    <responsible></responsible>
    <docno></docno>
    <approved></approved>
    <checked></checked>
    <date>2008-01-22</date>
    <rev>A</rev>
    <file>introduction.xml</file>
  </header>

  <section>
    <title>Purpose</title>
    <p>The <c>public_key</c> application deals with public-key related file 
    formats, digital signatures, and <url href="http://www.ietf.org/rfc/rfc5280.txt">
    X-509 certificates</url>. It is a library application that
    provides encode/decode, sign/verify, encrypt/decrypt, and similar
    functionality. It does not read or write files, it expects or returns
    file contents or partial file contents as binaries.
    </p>
  </section>

  <section>
    <title>Prerequisites</title>
    <p>It is assumed that the reader is familiar with the Erlang programming 
    language and has a basic understanding of the concepts of using public-keys 
    and digital certificates.</p>
  </section>

  <section>
    <title>Performance Tips</title>
    <p>The <c>public_key</c> decode- and encode-functions try to use the NIFs
    in the <c>ASN.1</c> compilers runtime modules, if they can be found.
    Thus, to have the <c>ASN.1</c> application in the
    path of your system gives the best performance.</p>
  </section>

</chapter>