share/man/man3lib/libsasl.3lib

   1 '\" te
   2 .\" Copyright (c) 2003 by Sun Microsystems, Inc.  All rights reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LIBSASL 3LIB "Oct 27, 2003"
   7 .SH NAME
   8 libsasl \- simple authentication and security layer library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lsasl\fR [ \fIlibrary\fR... ]
  13 #include <\fBsasl/sasl.h\fR>
  14 #include <\fBsasl/prop.h\fR>
  15 #include <\fBsasl/saslutil.h\fR>
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 SASL is a security framework used by connection-oriented network applications
  22 primarily for authentication.  Another way to describe SASL is that it is a
  23 glue layer between a network application and some security mechanisms that
  24 allow applications to authenticate each other and provide additional security
  25 services such as data encryption.  As a glue layer, SASL hides the interface
  26 specifics of the security mechanism from the application, which allows greater
  27 portability and flexibility as new security mechanisms are implemented.  SASL
  28 is similar to the GSS-API in that it provides a layer of abstraction between an
  29 application and one or more security mechanisms.
  30 .sp
  31 .LP
  32 \fBlibsasl\fR provides both an API for applications and an SPI for various
  33 plug-ins. To link with this library, specify \fB-lsasl\fR on the \fBcc\fR
  34 command line.
  35 .SH INTERFACES
  36 .sp
  37 .LP
  38 The shared object \fBlibsasl.so.1\fR and associated include files provide the
  39 public interfaces defined below. The \fB*_t\fR interfaces are function
  40 prototypes for callbacks that are defined in the public SASL header files.
  41 While \fBlibsasl\fR provides default versions for some of the callbacks, this
  42 structure allows an application to define its own version of the some of the
  43 callback functions.
  44 .sp
  45 .LP
  46 See \fBIntro\fR(3) for additional information on shared object interfaces.
  47 .sp
  48
  49 .sp
  50 .TS
  51 l l
  52 l l .
  53 \fBprop_clear\fR        \fBprop_dispose\fR
  54 \fBprop_dup\fR  \fBprop_erase\fR
  55 \fBprop_format\fR       \fBprop_get\fR
  56 \fBprop_getnames\fR     \fBprop_new\fR
  57 \fBprop_request\fR      \fBprop_set\fR
  58 \fBprop_setvals\fR      \fBsasl_authorize_t\fR
  59 \fBsasl_auxprop\fR      \fBsasl_auxprop_add_plugin\fR
  60 \fBsasl_auxprop_getctx\fR       \fBsasl_auxprop_request\fR
  61 \fBsasl_canon_user_t\fR \fBsasl_canonuser_add_plugin\fR
  62 \fBsasl_chalprompt_t\fR \fBsasl_checkapop\fR
  63 \fBsasl_checkpass\fR    \fBsasl_client_add_plugin\fR
  64 \fBsasl_client_init\fR  \fBsasl_client_new\fR
  65 \fBsasl_client_plug_init_t\fR   \fBsasl_client_start\fR
  66 \fBsasl_client_step\fR  \fBsasl_decode\fR
  67 \fBsasl_decode64\fR     \fBsasl_dispose\fR
  68 \fBsasl_done\fR \fBsasl_encode\fR
  69 \fBsasl_encode64\fR     \fBsasl_encodev\fR
  70 \fBsasl_erasebuffer\fR  \fBsasl_errdetail\fR
  71 \fBsasl_errors\fR       \fBsasl_errstring\fR
  72 \fBsasl_getcallback_t\fR        \fBsasl_getopt_t\fR
  73 \fBsasl_getpath_t\fR    \fBsasl_getprop\fR
  74 \fBsasl_getrealm_t\fR   \fBsasl_getsecret_t\fR
  75 \fBsasl_getsimple_t\fR  \fBsasl_global_listmech\fR
  76 \fBsasl_idle\fR \fBsasl_listmech\fR
  77 \fBsasl_log_t\fR        \fBsasl_server_add_plugin\fR
  78 \fBsasl_server_init\fR  \fBsasl_server_new\fR
  79 \fBsasl_server_plug_init_t\fR   \fBsasl_server_start\fR
  80 \fBsasl_server_step\fR  \fBsasl_server_userdb_checkpass_t\fR
  81 \fBsasl_server_userdb_setpass_t\fR      \fBsasl_set_alloc\fR
  82 \fBsasl_set_mutex\fR    \fBsasl_seterror\fR
  83 \fBsasl_setpass\fR      \fBsasl_setprop\fR
  84 \fBsasl_utf8verify\fR   \fBsasl_verifyfile_t\fR
  85 \fBsasl_version\fR
  86 .TE
  87
  88 .SH FILES
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB/usr/lib/libsasl.so.1\fR\fR
  93 .ad
  94 .RS 25n
  95 shared object
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Evolving
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBIntro\fR(3), \fBattributes\fR(5),