aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-07-06 17:27:49 +0000
committerlloyd <[email protected]>2012-07-06 17:27:49 +0000
commit1ae87eaf013dcbf0ed51947b69fbcff3a3679bf5 (patch)
treeda6ea2667ba04d29b0b11e56c863055982d956ec /doc
parente2af26e5dc92677f9a9d03f464dd9c5322a73c87 (diff)
Basic PSK documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/credentials_manager.rst18
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/credentials_manager.rst b/doc/credentials_manager.rst
index 57d262c45..b9718bf59 100644
--- a/doc/credentials_manager.rst
+++ b/doc/credentials_manager.rst
@@ -113,13 +113,25 @@ servers for SRP authentication.
Preshared Keys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+TLS and some other protocols support the use of pre shared keys for
+authentication.
+
+.. cpp:function:: SymmetricKey psk(const std::string& type, \
+ const std::string& context, \
+ const std::string& identity)
+
+ Return a symmetric key for use with *identity*
+
.. cpp:function:: std::string psk_identity_hint(const std::string& type, \
const std::string& context)
+ Returns an identity hint which may be provided to the client. This
+ can help a client understand what PSK to use.
+
.. cpp:function:: std::string psk_identity(const std::string& type, \
const std::string& context, \
const std::string& identity_hint)
-.. cpp:function:: SymmetricKey psk(const std::string& type, \
- const std::string& context, \
- const std::string& identity)
+ Returns the identity we would like to use given this *type* and
+ *context* and the optional *identity_hint*. Not all servers or
+ protocols will provide a hint.