sasl_client_step(3sasl)

1sasl_client_sStiempp(l3eSAASuLt)hentication Security Layer LibrarysaFsuln_cctliioennst_step(3SASL)
2
3
4

NAME

6       sasl_client_step - acquire an auxiliary property context
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsasl   [ library ... ]
10       #include <sasl/sasl.h>
11
12       int sasl_client_step(sasl_conn_t *conn, const char *serverin,
13            sasl_interact_t **unsigned serverinlen, prompt_need,
14            const char **clientout, sasl_interact_t **unsigned *clientoutlen);
15
16

DESCRIPTION

18       Use the sasl_client_step() interface performs a step in the authentica‐
19       tion negotiation. sasl_client_step() returns SASL_OK  if  the  complete
20       negotiation is successful. If the negotiation on step is completed suc‐
21       cessfuly, but at least one more step  is  required,  sasl_client_step()
22       returns  SASL_CONTINUE.  A  client  should not assume an authentication
23       negotiaion is successful because the server  signaled  success  through
24       the  protocol.  For  example,  if the server signaled OK Authentication
25       succeeded in IMAP, sasl_client_step() should be called  one  more  time
26       with a serverinlen of zero.
27
28
29       If  a  call  to  sasl_client_step()  returns SASL_INTERACT, the library
30       requires  some  values  before  sasl_client_step()  can  proceed.   The
31       prompt_need structure will be filled with the requests. The application
32       should fulfull these requests and call  sasl_client_step()  again  with
33       identical  parameters.  The  prompt_need  parameter  will  be  the same
34       pointer as before, but it will have been filled in by the application.
35

PARAMETERS

37       conn            The SASL connection context.
38
39
40       serverin        The data given by the server. The data  is  decoded  if
41                       the protocol encodes requests sent over the wire.
42
43
44       serverinlen     The length of the serverin.
45
46
47       clientout       clientout  and  clientoutlen  are created. They contain
48       clientoutlen    the initial client response to send to the  server.  It
49                       is  the job of the client to send them over the network
50                       to the server. Any protocol  specific  encodingthat  is
51                       necessary, for example base64 encoding, must be done by
52                       the client.
53
54
55       prompt_need     A list of prompts that are needed to continue, if  nec‐
56                       essary.
57
58

RETURN VALUES

60       sasl_client_step()  returns an integer that corresponds to a SASL error
61       code.
62

ERRORS

64       SASL_OK          The  call  to  sasl_client_start()   was   successful.
65                        Authentication is complete.
66
67
68       SASL_CONTINUE    The call to sasl_client_start() was successful, but at
69                        least one more step is required for authentication.
70
71
72       SASL_INTERACT    The    library    requires    some    values    before
73                        sasl_client_step() can proceed.
74
75
76
77       All other error codes indicate an error situation that must be handled,
78       or the authentication session should be  quit.  See  sasl_errors(3SASL)
79       for information on SASL error codes.
80

ATTRIBUTES

82       See attributes(5) for descriptions of the following attributes:
83
84
85
86
87       ┌─────────────────────────────┬─────────────────────────────┐
88       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
89       ├─────────────────────────────┼─────────────────────────────┤
90       │Availability                 │SUNWlibsasl                  │
91       ├─────────────────────────────┼─────────────────────────────┤
92       │Interface Stability          │Evolving                     │
93       ├─────────────────────────────┼─────────────────────────────┤
94       │MT-Level                     │Safe                         │
95       └─────────────────────────────┴─────────────────────────────┘
96