usr/src/man/man3sasl/sasl_listmech.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_LISTMECH 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_listmech \- retrieve a list of the supported SASL mechanisms
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_listmech\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char *\fR\fIuser\fR, \fBconst char *\fR\fIprefix\fR,
  18      \fBconst char *\fR\fIsep\fR, \fBconst char *\fR\fIsuffix\fR, \fBconst char **\fR\fIresult\fR,
  19      \fBunsigned *\fR\fIplen\fR,\fBint *\fR\fIpcount\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBsasl_listmech()\fR interface returns a string listing the SASL names of
  26 all the mechanisms available to the specified user. This call is typically
  27 given to the client through a capability command or initial server response.
  28 Client applications need this list so that they know what mechanisms the server
  29 supports.
  30 .SH PARAMETERS
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIconn\fR\fR
  35 .ad
  36 .RS 10n
  37 The SASL context for this connection user restricts the mechanism list to those
  38 mechanisms available to the user. This parameter is optional.
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIuser\fR\fR
  45 .ad
  46 .RS 10n
  47 Restricts security mechanisms to those available to that user. The value of
  48 \fIuser\fR may be \fINULL\fR, and it is not used if called by the client
  49 application.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIprefix\fR\fR
  56 .ad
  57 .RS 10n
  58 Appended to the beginning of \fIresult\fR.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIsep\fR\fR
  65 .ad
  66 .RS 10n
  67 Appended between mechanisms.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fIsuffix\fR\fR
  74 .ad
  75 .RS 10n
  76 Appended to the end of \fIresult\fR.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fIresult\fR\fR
  83 .ad
  84 .RS 10n
  85 A null-terminated result string. \fIresult\fR must be allocated or freed by the
  86 library.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fIplen\fR\fR
  93 .ad
  94 .RS 10n
  95 The length of the result filled in by the library. The value of \fIplen\fR may
  96 be \fINULL\fR.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fIpcount\fR\fR
 103 .ad
 104 .RS 10n
 105 The number of mechanisms available. The value of \fIpcount\fR is filled in by
 106 the library. The value of \fIpcount\fR may be \fINULL\fR
 107 .RE
 108
 109 .SH RETURN VALUES
 110 .sp
 111 .LP
 112 \fBsasl_listmech()\fR returns an integer that corresponds to a SASL error code.
 113 .SH ERRORS
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBSASL_OK\fR\fR
 118 .ad
 119 .RS 11n
 120 The call to \fBsasl_listmech()\fR was successful.
 121 .RE
 122
 123 .sp
 124 .LP
 125 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 126 .SH ATTRIBUTES
 127 .sp
 128 .LP
 129 See \fBattributes\fR(5) for descriptions of the following attributes:
 130 .sp
 131
 132 .sp
 133 .TS
 134 box;
 135 c | c
 136 l | l .
 137 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 138 _
 139 Interface Stability     Evolving
 140 _
 141 MT-Level        MT-Safe
 142 .TE
 143
 144 .SH SEE ALSO
 145 .sp
 146 .LP
 147 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)