1sasl_client_start(10 July 2001)                sasl_client_start(10 July 2001)
2
3
4

NAME

6       sasl_client_start - Begin an authentication negotiation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_client_start(sasl_conn_t * conn,
12                       const char * mechlist,
13                       sasl_interact_t ** prompt_need,
14                       const char ** clientout,
15                       unsigned * clientoutlen,
16                       const char ** mech);
17
18

DESCRIPTION

20       sasl_client_start()  selects  a mechanism for authentication and starts
21       the authentication session. The mechlist is the list of mechanisms  the
22       client  might like to use. The mechanisms in the list are not necessar‐
23       ily supported by the client or even valid.  SASL  determines  which  of
24       these to use based upon the security preferences specified earlier. The
25       list of mechanisms is typically a list of mechanisms  the  server  sup‐
26       ports acquired from a capability request.
27
28       If SASL_INTERACT is returned the library needs some values to be filled
29       in before it can proceed. The prompt_need structure will be  filled  in
30       with  requests.  The application should fulfill these requests and call
31       sasl_client_start again  with  identical  parameters  (the  prompt_need
32       parameter  will  be  the  same  pointer  as before but filled in by the
33       application).
34
35
36       mechlist is a list of mechanisms the server has available.  Punctuation
37       is ignored.
38
39       prompt_need  is filled in with a list of prompts needed to continue (if
40       necessary).
41
42       clientout and  clientoutlen  is  created.  It  is  the  initial  client
43       response  to send to the server. It is the job of the client to send it
44       over the network to the server.  Any protocol specific  encoding  (such
45       as base64 encoding) necessary needs to be done by the client.
46
47       If  the protocol lacks client-send-first capability, then set clientout
48       to NULL.
49
50       If there is no initial client-send, then *clientout will be set to NULL
51       on return.
52
53       mech contains the name of the chosen SASL mechanism (on success)
54
55

RETURN VALUE

57       sasl_client_start  returns  an  integer which corresponds to one of the
58       following codes. SASL_CONTINUE indicates success  and  that  there  are
59       more  steps  needed in the authentication. All other return codes indi‐
60       cate errors and should either be handled or the authentication  session
61       should be quit.
62
63

CONFORMING TO

65       RFC 2222
66

SEE ALSO

68       sasl(3),    sasl_callbacks(3),   sasl_errors(3),   sasl_client_init(3),
69       sasl_client_new(3), sasl_client_step(3)
70
71
72
73SASL man pages                       SASL      sasl_client_start(10 July 2001)
Impressum