doc/gsasl-callback-retrieve.texi

   1 @deftypefn Prototype int (*Gsasl_server_callback_retrieve) (Gsasl_session_ctx * @var{ctx}, char * @var{authentication_id}, char * @var{authorization_id}, char * @var{realm}, char * @var{key}, size_t * @var{keylen})
   2
   3 @var{ctx}:  libgsasl handle.
   4
   5 @var{authentication_id}:  input array with authentication identity.
   6
   7 @var{authorization_id}:  input array with authorization identity, or NULL.
   8
   9 @var{realm}:  input array with realm of user, or NULL.
  10
  11 @var{key}:  output array with key for authentication identity.
  12
  13 @var{keylen}: on input the maximum size of the key output array, on
  14 output contains the actual size of the key output array.
  15
  16 Type of callback function the application implements.  It should
  17 retrieve the password for the indicated user and return GSASL_OK, or
  18 an error code such as GSASL_AUTHENTICATION_ERROR.  The key must be
  19 encoded in UTF-8, but need not be normalized in any way.
  20
  21 If KEY is NULL, the function should only populate the KEYLEN output
  22 length field with the length, and return GSASL_OK.  This usage may be
  23 used by the caller to allocate the proper buffer size.
  24
  25 @end deftypefn