diff options
| author | Ingela Anderton Andin <[email protected]> | 2013-05-03 10:20:37 +0200 |
|---|---|---|
| committer | Ingela Anderton Andin <[email protected]> | 2013-05-08 10:39:22 +0200 |
| commit | cb1305212e71855890bbfb0a509a007543529d24 (patch) | |
| tree | f37e9017efdb10d43f9439f490709e460573aef6 /lib/crypto/doc/src/crypto_app.xml | |
| parent | a9add4e3d878bbd339fc2bb36e97d1053318b4e6 (diff) | |
| download | otp-cb1305212e71855890bbfb0a509a007543529d24.tar.gz otp-cb1305212e71855890bbfb0a509a007543529d24.tar.bz2 otp-cb1305212e71855890bbfb0a509a007543529d24.zip | |
ssl & crypto: Generalize the remaining crypto API
Diffstat (limited to 'lib/crypto/doc/src/crypto_app.xml')
| -rw-r--r-- | lib/crypto/doc/src/crypto_app.xml | 36 |
1 files changed, 11 insertions, 25 deletions
diff --git a/lib/crypto/doc/src/crypto_app.xml b/lib/crypto/doc/src/crypto_app.xml index 20f4ed5c45..6d26076c04 100644 --- a/lib/crypto/doc/src/crypto_app.xml +++ b/lib/crypto/doc/src/crypto_app.xml @@ -29,37 +29,23 @@ <app>crypto</app> <appsummary>The Crypto Application</appsummary> <description> - <p>The purpose of the Crypto application is to provide erlang - acess to crypto graphic functions in openssl. + <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>Configuration</title> - <p>The following environment configuration parameters are defined - for the Crypto application. Refer to application(3) for more - information about configuration parameters. - </p> - <taglist> - <tag><c><![CDATA[debug = true | false <optional>]]></c></tag> - <item> - <p>Causes debug information to be written to standard - error or standard output. Default is <c>false</c>. - </p> - </item> - </taglist> - </section> + <title>DEPENDENCIES</title> - <section> - <title>OpenSSL libraries</title> - <p>The current implementation of the Erlang Crypto application is - based on the <em>OpenSSL</em> package version 0.9.8 or higher. - There are source and binary releases on the web. - </p> + <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> + or mirror sites listed there. + </p> + </section> <section> <title>SEE ALSO</title> |