summaryrefslogtreecommitdiff
path: root/lib/crypto/doc/src/crypto_app.xml
blob: 2b9e5059884e79dc053630ec8411de581ea104f8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE appref SYSTEM "appref.dtd">

<appref>
  <header>
    <copyright>
      <year>1999</year>
      <year>2016</year>
      <holder>Ericsson AB, All Rights Reserved</holder>
    </copyright>
    <legalnotice>
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

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

    <title>crypto</title>
    <file>crypto_app.sgml</file>
  </header>
  <app>crypto</app>
  <appsummary>The Crypto Application</appsummary>
  <description>
    <p>The purpose of the Crypto application is to provide an Erlang API
    to cryptographic functions, see <seealso marker="crypto">crypto(3)</seealso>.
    Note that the API is on a fairly low level and there are some
    corresponding API functions available in <seealso marker="public_key:public_key">public_key(3)</seealso>,
    on a higher abstraction level, that uses the crypto application in its implementation.
    </p>
  </description>

  <section>
    <title>DEPENDENCIES</title>

    <p>The current crypto implementation uses nifs to interface OpenSSLs crypto library
    and requires <em>OpenSSL</em> package version 0.9.8 or higher.</p>
    <p>Source releases of OpenSSL can be downloaded from the <url href="http://www.openssl.org">OpenSSL</url> project home page,
    or mirror sites listed there.
    </p>
    </section>

  <section>
    <title>SEE ALSO</title>
    <p>application(3)</p>
  </section>
</appref>