diff options
author | bentley <> | 2014-10-12 09:33:04 +0000 |
---|---|---|
committer | bentley <> | 2014-10-12 09:33:04 +0000 |
commit | 82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch) | |
tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_get_psk_identity.3 | |
parent | 0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff) | |
download | openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.gz openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.bz2 openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.zip |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_psk_identity.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_get_psk_identity.3 | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_get_psk_identity.3 b/src/lib/libssl/doc/SSL_get_psk_identity.3 new file mode 100644 index 0000000000..b3a72cca29 --- /dev/null +++ b/src/lib/libssl/doc/SSL_get_psk_identity.3 | |||
@@ -0,0 +1,41 @@ | |||
1 | .Dd $Mdocdate: October 12 2014 $ | ||
2 | .Dt SSL_GET_PSK_IDENTITY 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm SSL_get_psk_identity , | ||
6 | .Nm SSL_get_psk_identity_hint | ||
7 | .Nd get PSK client identity and hint | ||
8 | .Sh SYNOPSIS | ||
9 | .In openssl/ssl.h | ||
10 | .Ft const char * | ||
11 | .Fn SSL_get_psk_identity_hint "const SSL *ssl" | ||
12 | .Ft const char * | ||
13 | .Fn SSL_get_psk_identity "const SSL *ssl" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_get_psk_identity_hint | ||
16 | is used to retrieve the PSK identity hint used during the connection setup | ||
17 | related to | ||
18 | .Vt SSL | ||
19 | object | ||
20 | .Fa ssl . | ||
21 | Similarly, | ||
22 | .Fn SSL_get_psk_identity | ||
23 | is used to retrieve the PSK identity used during the connection setup. | ||
24 | .Sh RETURN VALUES | ||
25 | If | ||
26 | .Pf non- Dv NULL , | ||
27 | .Fn SSL_get_psk_identity_hint | ||
28 | returns the PSK identity hint and | ||
29 | .Fn SSL_get_psk_identity | ||
30 | returns the PSK identity. | ||
31 | Both are | ||
32 | .Dv NULL Ns -terminated. | ||
33 | .Fn SSL_get_psk_identity_hint | ||
34 | may return | ||
35 | .Dv NULL | ||
36 | if no PSK identity hint was used during the connection setup. | ||
37 | .Pp | ||
38 | Note that the return value is valid only during the lifetime of the | ||
39 | .Vt SSL | ||
40 | object | ||
41 | .Fa ssl . | ||