aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc/src/new_ssl.xml
diff options
context:
space:
mode:
authorDan Gudmundsson <[email protected]>2009-12-10 10:09:12 +0000
committerErlang/OTP <[email protected]>2009-12-10 10:09:12 +0000
commit8ac319031230b354dcea105d94ef2a232a9d7afe (patch)
tree139f52d1fad7786dcab88f4b65956f780cd3da00 /lib/ssl/doc/src/new_ssl.xml
parent9855ed863b58f7325f39b00c60813198ec41f528 (diff)
downloadotp-8ac319031230b354dcea105d94ef2a232a9d7afe.tar.gz
otp-8ac319031230b354dcea105d94ef2a232a9d7afe.tar.bz2
otp-8ac319031230b354dcea105d94ef2a232a9d7afe.zip
Cleaned up docs
Diffstat (limited to 'lib/ssl/doc/src/new_ssl.xml')
-rw-r--r--lib/ssl/doc/src/new_ssl.xml23
1 files changed, 5 insertions, 18 deletions
diff --git a/lib/ssl/doc/src/new_ssl.xml b/lib/ssl/doc/src/new_ssl.xml
index f50f714fe6..a11919eb51 100644
--- a/lib/ssl/doc/src/new_ssl.xml
+++ b/lib/ssl/doc/src/new_ssl.xml
@@ -437,30 +437,17 @@ end
</func>
<func>
- <name>peercert(Socket) -> </name>
- <name>peercert(Socket, Opts) -> {ok, Cert} | {error, Reason}</name>
+ <name>peercert(Socket) -> {ok, Cert} | {error, Reason}</name>
<fsummary>Return the peer certificate.</fsummary>
<type>
<v>Socket = sslsocket()</v>
- <v>Opts = [] | [otp] | [plain] </v>
- <v>Cert = term()</v>
+ <v>Cert = binary()</v>
<v>Subject = term()</v>
</type>
<desc>
- <p><c>peercert(Cert)</c> is equivalent to <c>peercert(Cert, [])</c>.
- </p>
- <p>The form of the returned certificate depends on the
- options.
- </p>
- <p>If the options list is empty the certificate is returned as
- a DER encoded binary.
- </p>
- <p>The option <c>otp</c> or <c>plain</c> implies that the
- certificate will be returned as a parsed ASN.1 structure in the
- form of an Erlang term. For detail see the public_key application.
- Currently only plain is officially supported see the public_key users
- guide.
- </p>
+ <p>The peer certificate is returned as a DER encoded binary.
+ The certificate can be decoded with <c>public_key:pkix_decode_cert/2</c>.
+ </p>
</desc>
</func>
<func>