sasl_getsecret_t(3sasl)

1sasl_getsecreSti_mtp(l3eSAASuLt)hentication Security Layer LibrarysaFsuln_cgteitosnescret_t(3SASL)
2
3
4

NAME

6       sasl_getsecret_t - the SASL callback function for secrets (passwords)
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsasl   [ library ... ]
10       #include <sasl/sasl.h>
11
12       int sasl_getsecret_t(sasl_conn_t *conn, void *context,
13            int id, sasl_secret_t **psecret);
14
15

DESCRIPTION

17       Use  the  sasl_getsecret_t()  function  to retrieve the secret from the
18       application.     Allocate      a      sasl_secret_t      to      length
19       sizeof(sasl_secret_t)+<length  of secret>. sasl_secret_t has two fields
20       of len which contain the length of secret in bytes and  the  data  con‐
21       tained  in  secret.  The  secret string does not need to be null-termi‐
22       nated.
23

PARAMETERS

25       conn       The connection context
26
27
28       context    The context from the callback structure
29
30
31       id         The callback ID
32
33
34       psecret    To cancel, set the value of psecret to NULL. Otherwise,  set
35                  the value to the password structure. The structure must per‐
36                  sist until the next call to sasl_getsecret_t() in  the  same
37                  connection.  Middleware erases password data when it is done
38                  with it.
39
40

RETURN VALUES

42       Like other SASL callback functions, sasl_getsecret_t() returns an inte‐
43       ger  that corresponds to a SASL error code. See <sasl.h> for a complete
44       list of SASL error codes.
45

ERRORS

47       SASL_OK    The call to sasl_getsecret_t() was successful.
48
49
50
51       See sasl_errors(3SASL) for information on SASL error codes.
52

ATTRIBUTES

54       See attributes(5) for descriptions of the following attributes:
55
56
57
58
59       ┌─────────────────────────────┬─────────────────────────────┐
60       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
61       ├─────────────────────────────┼─────────────────────────────┤
62       │Availability                 │SUNWlibsasl                  │
63       ├─────────────────────────────┼─────────────────────────────┤
64       │Interface Stability          │Evolving                     │
65       ├─────────────────────────────┼─────────────────────────────┤
66       │MT-Level                     │MT-Safe                      │
67       └─────────────────────────────┴─────────────────────────────┘
68