doc/man3/SSL_CTX_use_psk_identity_hint.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_use_psk_identity_hint, SSL_use_psk_identity_hint,
   6 SSL_CTX_set_psk_server_callback, SSL_set_psk_server_callback - set PSK
   7 identity hint to use
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ssl.h>
  12
  13  int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *hint);
  14  int SSL_use_psk_identity_hint(SSL *ssl, const char *hint);
  15
  16  void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx,
  17         unsigned int (*callback)(SSL *ssl, const char *identity,
  18         unsigned char *psk, int max_psk_len));
  19  void SSL_set_psk_server_callback(SSL *ssl,
  20         unsigned int (*callback)(SSL *ssl, const char *identity,
  21         unsigned char *psk, int max_psk_len));
  22
  23
  24 =head1 DESCRIPTION
  25
  26 SSL_CTX_use_psk_identity_hint() sets the given B<NULL>-terminated PSK
  27 identity hint B<hint> to SSL context object
  28 B<ctx>. SSL_use_psk_identity_hint() sets the given B<NULL>-terminated
  29 PSK identity hint B<hint> to SSL connection object B<ssl>. If B<hint>
  30 is B<NULL> the current hint from B<ctx> or B<ssl> is deleted.
  31
  32 In the case where PSK identity hint is B<NULL>, the server
  33 does not send the ServerKeyExchange message to the client.
  34
  35 A server application must provide a callback function which is called
  36 when the server receives the ClientKeyExchange message from the
  37 client. The purpose of the callback function is to validate the
  38 received PSK identity and to fetch the pre-shared key used during the
  39 connection setup phase. The callback is set using functions
  40 SSL_CTX_set_psk_server_callback() or
  41 SSL_set_psk_server_callback(). The callback function is given the
  42 connection in parameter B<ssl>, B<NULL>-terminated PSK identity sent
  43 by the client in parameter B<identity>, and a buffer B<psk> of length
  44 B<max_psk_len> bytes where the pre-shared key is to be stored.
  45
  46
  47 =head1 RETURN VALUES
  48
  49 SSL_CTX_use_psk_identity_hint() and SSL_use_psk_identity_hint() return
  50 1 on success, 0 otherwise.
  51
  52 Return values from the server callback are interpreted as follows:
  53
  54 =over 4
  55
  56 =item Z<>0
  57
  58 PSK identity was not found. An "unknown_psk_identity" alert message
  59 will be sent and the connection setup fails.
  60
  61 =item E<gt>0
  62
  63 PSK identity was found and the server callback has provided the PSK
  64 successfully in parameter B<psk>. Return value is the length of
  65 B<psk> in bytes. It is an error to return a value greater than
  66 B<max_psk_len>.
  67
  68 If the PSK identity was not found but the callback instructs the
  69 protocol to continue anyway, the callback must provide some random
  70 data to B<psk> and return the length of the random data, so the
  71 connection will fail with decryption_error before it will be finished
  72 completely.
  73
  74 =back
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
  79
  80 Licensed under the OpenSSL license (the "License").  You may not use
  81 this file except in compliance with the License.  You can obtain a copy
  82 in the file LICENSE in the source distribution or at
  83 L<https://www.openssl.org/source/license.html>.
  84
  85 Copyright 2005 Nokia.
  86
  87 =cut